canonical: https://jentic.com/apis/swiftype.com/swiftype

# Swiftype Site Search API

Swiftype Site Search API provides search and autocomplete functionality for websites and applications. The API exposes 4 endpoints secured with apiKey authentication.

## For AI agents

Programmatically search an engine using the public API, search an engine using the public API (get). Covers 4 operations with apiKey authentication.

## Scope

Does not handle payments, communications, or crm - use for developer tools only.

## Capabilities

- Search an engine using the public API
- Autocomplete suggestions for an engine
- Integrate Swiftype Site Search API into automated workflows
- Query and filter Swiftype Site Search API records by parameters
- Monitor Swiftype Site Search API operational status and events

## Use cases

### Developer Tools Operations

Use the Swiftype Site Search API to perform developer tools operations programmatically. The API provides 4 endpoints covering core functionality including search an engine using the public API, search an engine using the public API (get), autocomplete suggestions for an engine.

Example prompt: Call POST /public/engines/search.json to search an engine using the public API

### Automated Autocomplete Management

Automate autocomplete operations by combining multiple Swiftype Site Search API endpoints. Agents can search an engine using the public API (get) and then autocomplete suggestions for an engine in a single workflow.

Example prompt: Call GET /public/engines/search.json to search an engine using the public API (get), then verify the result

### AI Agent Integration via Jentic

AI agents discover and call Swiftype Site Search API endpoints through Jentic without managing credentials directly. An agent searches for the required operation by intent, receives the matching endpoint schema, and executes the call with Jentic-managed authentication. This eliminates the need to read API documentation or handle apiKey tokens manually.

Example prompt: Search Jentic for 'search an engine using the public API', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | /public/engines/search.json | Search an engine using the public API |
| GET | /public/engines/search.json | Search an engine using the public API (GET) |
| POST | /public/engines/suggest.json | Autocomplete suggestions for an engine |
| GET | /public/engines/suggest.json | Autocomplete suggestions for an engine (GET) |

## Key resources

- **Autocomplete** — Operations related to Autocomplete
- **Search** — Operations related to Search

## Why Jentic

- **Setup:** Wiring the Swiftype Site Search API by hand means passing the engine_key as a query parameter on every call to the search-api.swiftype.com host and shaping the search and suggest requests yourself. Through Jentic you install once, import Swiftype from the API Directory, store the engine key once, and your agent calls it.
- **Permission scoping:** Swiftype takes the engine and query in the request body and parameters rather than a resource path, so scope the agent to the operations it needs, such as running a search or fetching suggestions. You choose that allowed set, and these public operations are read-only.
- **Credential handling:** Your Swiftype engine key is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'search a site engine' or 'get search suggestions', and Jentic returns the matching Swiftype operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Github** — Alternative developer tools API
- **Gitlab** — Alternative developer tools API

## FAQ

### What authentication does the Swiftype Site Search API use?

The Swiftype Site Search API uses an API key passed in the `engine_key` query. Through Jentic, these credentials are stored encrypted in your Jentic One instance and injected at execution time, so raw secrets never enter the agent context.

### Can I search an engine using the public API with the Swiftype Site Search API?

Yes. Use the POST /public/engines/search.json endpoint. The API returns structured JSON responses that agents can parse and act on directly.

### What are the rate limits for the Swiftype Site Search API?

Rate limits are not specified in the OpenAPI spec. Check the vendor documentation for current limits. Through Jentic, rate limiting is handled automatically with retry logic built into the execution layer.

### How do I search an engine using the public API through Jentic?

Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'search an engine using the public API'. Jentic returns the matching Swiftype Site Search API operation with its input schema. Load the schema and execute the call - credentials are injected automatically.

### How many endpoints does the Swiftype Site Search API have?

The Swiftype Site Search API exposes 4 endpoints covering autocomplete, search operations.

### Can I limit what my agent is allowed to do with the Swiftype Site Search API?

Yes. Because Jentic One is self-hosted, you set the rules that decide which Swiftype Site Search API operations your agent may call, and the Swiftype Site Search API takes the engine and query in the request body and parameters rather than a resource path, so you scope the agent to just the operations it needs. For example, you can allow it to run a search against POST or GET /public/engines/search.json while restricting or excluding autocomplete suggestions at /public/engines/suggest.json, or limit it to suggestions only. These public operations are read-only, so a scoped agent can query and fetch results without changing any data. The engine key backing those calls is stored encrypted by your own instance and injected only at execution time, so it never enters the agent's context.