Swiftype Site Search API

Name: Swiftype Site Search API
Brand: Swiftype Site Search API
Availability: InStock

✓ Official Vendor SpecDeveloper ToolsSource ControlapiKey4 EndpointsREST

For Agents

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

Install Jentic One Beta

Connect the Swiftype Site Search API to your agent

Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Swiftype Site Search API, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.

Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.

Step 1: Jentic One Host machine

# On the machine that will host your Jentic One instance:
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fswiftype.com%2Fswiftype" | sh

Step 2: Agent machine

# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fswiftype.com%2Fswiftype" | sh
jentic register       # connects your agent to your Jentic One instance

Jentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.

Capabilities

What an agent can do with Swiftype Site Search API.

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

GET STARTED

Start building with Swiftype Site Search API

Explore with Jentic

View OpenAPI Document

Use Cases

Patterns agents use Swiftype Site Search API for, with concrete tasks.

★ 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.

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.

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.

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

Key Endpoints

4 endpoints — swiftype site search api provides search and autocomplete functionality for websites and applications.

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)

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)

Why Jentic?

What agents get from Jentic-routed access to this vendor.

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 isolation

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.

Intent-based discovery

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

Alternatives and complements available in the Jentic catalogue.

Alternative

Github

Alternative developer tools API

Choose Github when you need a different approach to developer tools operations

Alternative

Gitlab

Alternative developer tools API

Choose Gitlab when you need a different approach to developer tools operations

FAQs

Specific to using Swiftype Site Search API through Jentic.

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.