Agent Studio API

The Agent Studio API lets you build and operate generative AI agents that use Algolia data, tools, and your chosen LLM provider.

Use it to create, configure, publish, and update agents, then generate chat completions grounded in live data from your Algolia indices. You can manage LLM providers, Agent Studio tools, conversations, feedback, secret keys, user data, caching, and application settings for your AI experiences.

Client libraries

Use Algolia’s API clients and libraries to reliably integrate Algolia’s APIs with your apps. The official API clients are covered by Algolia’s Service Level Agreement.

For more information, see Algolia’s ecosystem.

Base URLs

Base URLs for the Agent Studio API:

• https://{APPLICATION_ID}.algolia.net
• https://{APPLICATION_ID}-dsn.algolia.net. If your subscription includes a Distributed Search Network, this ensures that requests are sent to servers closest to users.

Both URLs provide high availability by distributing requests with load balancing.

All Agent Studio paths are prefixed with /agent-studio.

All requests must use HTTPS.

Retry strategy

To guarantee high availability, implement a retry strategy for all API requests using the URLs of your servers as fallbacks:

• https://{APPLICATION_ID}-1.algolianet.com
• https://{APPLICATION_ID}-2.algolianet.com
• https://{APPLICATION_ID}-3.algolianet.com

These URLs use a different DNS provider than the primary URLs. Randomize this list to ensure an even load across the three servers.

All Algolia API clients implement this retry strategy.

Authentication

Add these headers to authenticate requests:

• x-algolia-application-id. Your Algolia application ID.
• x-algolia-api-key. An API key with the necessary permissions to make the request. The required access control list (ACL) to make a request is listed in each endpoint’s reference.

You can find your application ID and API key in the Algolia dashboard.

Rate limits

The Agent Studio API rate-limits requests. Responses include X-RateLimit-Limit and X-RateLimit-Remaining headers with the current limit. When you exceed the limit, the API returns a 429 status with a Retry-After header.

Request format

Request bodies must be JSON objects.

Parameters

Parameters are passed as query parameters for GET and DELETE requests, and in the request body for POST and PUT requests.

Query parameters must be URL-encoded. Non-ASCII characters must be UTF-8 encoded. Plus characters (+) are interpreted as spaces.

Response status and errors

The Agent Studio API returns JSON responses. Since JSON doesn’t guarantee any specific ordering, don’t rely on the order of attributes in the API response.

Successful responses return 2xx statuses. Client errors return 4xx statuses. Server errors return 5xx statuses. Error responses have a message property with more information.

Version

The current version of the Agent Studio API is version 1, indicated by the /1/ in each endpoint’s URL.