How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Algolia

Algolia Agent Studio API

Algolia's agent-building runtime: agents, conversations, tools, memory, guardrails and per-turn context, exposed as 42 REST operations. Notably, Agent Studio can itself consume third-party MCP tools, so Algolia is both an MCP server and an MCP client.

Documentation Provider Profile APIs.io OpenAPI GitHub

This API exposes 42 operations across 23 paths, and defines 133 schemas. It is described by OpenAPI 3.2.0, at version 0.1.0.

Requests are made against a single base URL, https://{APPLICATION_ID}.algolia.net/agent-studio.

42 operations 23 paths 133 schemas 10 DELETE17 GET4 PATCH10 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
0.1.0
Base URL
https://{APPLICATION_ID}.algolia.net/agent-studio
Authentication
API Key, API Key
Resource Areas
1

Authentication & Security 2

Algolia Agent Studio API declares 2 security schemes for authenticating requests. An API key is passed in the header as x-algolia-application-id (appId). An API key is passed in the header as x-algolia-api-key (apiKey). By default, every request must be authenticated.

  • appId — Your Algolia application ID.
  • apiKey — Your Algolia API key with the necessary permissions to make the request. Permissions are controlled through access control lists (ACL) and access restrictions.…

Paths & Operations 42

Across 23 paths, the API surfaces 42 operations — 10 DELETE, 17 GET, 4 PATCH, 10 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

agent-studio 42
GET
/1/agents
List Agents
listAgents 3 params → 200422
POST
/1/agents
Create Agent
createAgent body → 201422
GET
/1/agents/{agentId}
Get Agent
getAgent 1 param → 200422
PATCH
/1/agents/{agentId}
Update Agent
updateAgent 1 param body → 200422
DELETE
/1/agents/{agentId}
Delete Agent
deleteAgent 1 param → 204422
GET
/1/agents/{agentId}/allowed-domains
List Allowed Domains
listAgentAllowedDomains 1 param → 200422
POST
/1/agents/{agentId}/allowed-domains
Create Allowed Domain
createAgentAllowedDomain 1 param body → 201422
POST
/1/agents/{agentId}/allowed-domains/bulk
Bulk Insert Allowed Domains
bulkCreateAllowedDomains 1 param body → 201422
DELETE
/1/agents/{agentId}/allowed-domains/bulk
Bulk Delete Allowed Domains
bulkDeleteAllowedDomains 1 param body → 204422
GET
/1/agents/{agentId}/allowed-domains/{domainId}
Get Allowed Domain
getAllowedDomain 2 params → 200422
DELETE
/1/agents/{agentId}/allowed-domains/{domainId}
Delete Allowed Domain
deleteAllowedDomain 2 params → 204422
DELETE
/1/agents/{agentId}/cache
Invalidate Agent Cache
invalidateAgentCache 2 params → 204422
POST
/1/agents/{agentId}/completions
Create Completion
createAgentCompletion 7 params body → 200422
GET
/1/agents/{agentId}/conversations
List Conversations
listAgentConversations 8 params → 200422
DELETE
/1/agents/{agentId}/conversations
Delete Conversations
deleteAgentConversations 3 params → 204422
GET
/1/agents/{agentId}/conversations/export
Export Conversations
exportConversations 3 params → 200422
GET
/1/agents/{agentId}/conversations/{conversationId}
Get Conversation
getConversation 4 params → 200422
DELETE
/1/agents/{agentId}/conversations/{conversationId}
Delete Conversation
deleteConversation 2 params → 204422
POST
/1/agents/{agentId}/publish
Publish Agent
publishAgent 1 param → 200422
POST
/1/agents/{agentId}/unpublish
Unpublish Agent
unpublishAgent 1 param → 200422
GET
/1/configuration
Get Configuration
getConfiguration → 200422
PATCH
/1/configuration
Patch Configuration
updateConfiguration body → 200422
POST
/1/feedback
Create Feedback
createFeedback body → 201422
GET
/1/providers
List Providers
listProviders 2 params → 200422
POST
/1/providers
Create Provider
createProvider body → 201422
GET
/1/providers/models
Get Provider Models
listModels → 200422
GET
/1/providers/{providerId}
Get Provider
getProvider 1 param → 200422
PATCH
/1/providers/{providerId}
Update Provider
updateProvider 1 param body → 200422
DELETE
/1/providers/{providerId}
Delete Provider
deleteProvider 1 param → 204422
GET
/1/providers/{providerId}/models
Get Provider Models By Id
listProviderModels 1 param → 200422
GET
/1/secret-keys
List Secret Keys
listSecretKeys 2 params → 200422
POST
/1/secret-keys
Create Secret Key
createSecretKey body → 201422
GET
/1/secret-keys/{secretKeyId}
Get Secret Key
getSecretKey 1 param → 200422
PATCH
/1/secret-keys/{secretKeyId}
Patch Secret Key
updateSecretKey 1 param body → 200422
DELETE
/1/secret-keys/{secretKeyId}
Delete Secret Key
deleteSecretKey 1 param → 204422
GET
/1/user-data/{userToken}
Get Data By User Token
getUserData 1 param → 200422
DELETE
/1/user-data/{userToken}
Delete Data By User Token
deleteUserData 1 param → 204422
GET
/{path}
Send requests to the Algolia REST API
customGet 2 params → 200400402403404
POST
/{path}
Send requests to the Algolia REST API
customPost 2 params body → 200400402403404
PUT
/{path}
Send requests to the Algolia REST API
customPut 2 params body → 200400402403404
DELETE
/{path}
Send requests to the Algolia REST API
customDelete 2 params → 200400402403404
GET
/setClientApiKey
Switch the API key used to authenticate requests
setClientApiKey 1 param → 204

Schemas 133

The contract defines 133 schemas that model the data the API accepts and returns. The most detailed are SearchParameters (66 properties), ConversationFullResponse (15 properties), MemoryRecord (14 properties), ConversationBaseResponse (14 properties). Each schema is shown below with its type and property counts.

ToolPartV5
object
Model for tool invocation in a Message.
10 properties 2 required
NaturalLanguagesUnion
OptionalWordsUnion
IgnorePluralsUnion
ToolState
string
MessageRole
string
Role of a message in the conversation.
AllowedDomainResponse
object
Single allowed domain in API responses.
6 properties 6 required
ToolInvocationPartV4
object
2 properties 1 required
NumericFiltersUnion
ToolConfigInput
RemoveStopWordsUnion
ProviderAuthenticationPatch
object
2 properties
NumberParam
object
A number search parameter with exposure control and optional constraints.
3 properties 1 required
AllowedToolsUnion
StartPart
object
1 property 1 required
AlgoliaDisplayResultsToolConfig
object
Configuration for the algoliadisplayresults tool.
6 properties 1 required
VoteEnum
integer
DistinctUnion
FeedbackResponse
object
9 properties 7 required
ProviderAuthenticationCreate
object
3 properties 3 required
AgentWithVersionResponse
object
14 properties 10 required
StringArrayParamConstraint
object
Constraints for a string array parameter.
1 property
ToolResultPart
object
5 properties 4 required
RemoveWordsIfNoResults
string
Strategy for removing words from the query when it doesn't return any results. This helps to avoid returning empty search results. - none. No words are removed…
AllowedDomainBulkInsert
object
Request body for bulk insert.
1 property 1 required
AgentConfigCreate
object
9 properties 2 required
AssistantMessageV4
object
5 properties 2 required
AgentTestConfiguration
object
Dynamic configuration for testing agents.
7 properties 3 required
ClientToolsArgsSchema
object
3 properties
PaginatedSecretKeysResponse
object
2 properties 2 required
ErrorBase
object
Error.
1 property
MessageV4
AroundRadiusUnion
FeedbackUnion
ConversationFullResponse
object
Response model for a conversation with all its messages.
15 properties 5 required
SecretKeyCreate
object
Secret key creation payload.
2 properties 1 required
ConversationBaseResponse
object
Lightweight response model without its messages.
14 properties 4 required
TagFiltersUnion
SearchParametersOverridesMapNullable
ToolInvocationV4
object
Model for tool invocation in a Message.
10 properties 2 required
OptionalFiltersUnion
UserDataResponse
object
2 properties 2 required
AroundPrecisionUnion
MessageV5
SearchParameters
object
Algolia Search API parameters that can be predefined for the search tool. Reference: https://www.algolia.com/doc/api-reference/search-api-parameters/ The param…
66 properties
AlgoliaRecommendToolConfig-Input
object
Configuration for the Algolia Recommend tool. Allows specifying recommend models and related parameters.
4 properties 2 required
ProviderAuthenticationResponse
object
7 properties 6 required
Facets
object
Order of facet names.
1 property
PaginatedProviderAuthenticationsResponse
object
2 properties 2 required
AlgoliaSearchToolIndexConfig
object
5 properties 2 required
MessageResponse
object
Response model for a message.
10 properties 6 required
AllowedDomainListResponse
object
List of allowed domains for an application.
1 property 1 required
InsideBoundingBoxUnion
AdvancedSyntaxFeaturesUnion
AnthropicProviderInput
object
Anthropic-specific provider input.
2 properties 1 required
ValidationError
object
5 properties 3 required
ReasoningPart
object
2 properties 2 required
ReasoningPartV4
object
2 properties 1 required
AlgoliaRecommendToolIndexConfig
object
3 properties 2 required
StepStartPartV5
object
1 property
UserMessageMetadataV5
object
Client-supplied metadata on a v5 user message. turncontext is namespaced so other callers can use metadata for unrelated purposes without collision. Unknown ke…
1 property
QueryType
string
Determines if and how query words are interpreted as prefixes. By default, only the last query word is treated as a prefix (prefixLast). To turn off prefix sea…
ReasoningPartV5
object
2 properties 1 required
FacetFiltersUnion
SearchParametersOverrides
object
Algolia Search API parameters that can be predefined for the search tool. Reference: https://www.algolia.com/doc/api-reference/search-api-parameters/ A subset…
8 properties
CompatibilityMode
string
Support Compatibility modes for the completion API.
MemoryRecord
object
Universal storage model for all memory types (semantic, episodic). This is the ONLY model that touches storage (Algolia). Domain models (SemanticMemory, Episod…
14 properties 2 required
LocationItemUnion
AgentStatus
string
ReRankingApplyFilterUnion
ExactOnSingleWordQuery
string
Determines how the [Exact ranking criterion](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/in-dep…
ToolResultOutput
object
2 properties 2 required
MemoryType
string
Memory types implemented so far. Follows LangMem's ontology: https://langchain-ai.github.io/langmem/concepts/conceptualguide/memory-types.
AssistantMessageV5
object
3 properties 1 required
ToolInvocationsUnion
AgentConfigUpdate
object
9 properties
AgentIdUnion
ProviderInputNullable
AlternativesAsExactUnion
ToolConfig
TextPartV4
object
2 properties 1 required
TypoToleranceEnum
string
- min. Return matches with the lowest number of typos. For example, if you have matches without typos, only include those. But if there are no matches without…
AllowedDomainCreate
object
Request body to add a single allowed domain.
1 property 1 required
AzureOpenAIProviderInput
object
Azure OpenAI-specific provider input.
4 properties 3 required
TypoToleranceUnion
FeedbackCreationRequest
object
Request model for creating a feedback entry.
5 properties 3 required
OpenAICompatibleProviderInput
object
OpenAI-compatible provider input. Contrary to the OpenAIProviderInput, the baseurl is required. A model is required to verify connectivity and get saved as the…
3 properties 3 required
NumberParamConstraint
object
Constraints for a number parameter.
2 properties
ToolResultOutputType
string
The valid 'type' of tool results.
PaginationMetadata
object
4 properties 4 required
UnknownToolConfig
object
Exists only to ensure that when you change branch from toolX to feat/toolY, your config stays valid.
2 properties 2 required
QueryLanguagesUnion
McpToolConfig
object
2 properties
AgentCompletionAlgoliaParams
object
2 properties
PaginatedConversationsResponse
object
2 properties 2 required
BaseProviderInput
object
Base input that all providers must have.
1 property 1 required
AllowedDomainBulkDelete
object
Request body for bulk delete by IDs.
1 property 1 required
McpServerToolConfig
object
7 properties 4 required
ToolCallPart
object
6 properties 4 required
PaginatedAgentsResponse
object
2 properties 2 required
AgentCompletionRequest
object
Request model for creating a completion for an assistant.
5 properties
ConversationMetadata
object
Public metadata exposed on conversation responses.
1 property
OpenAIProviderInput
object
OpenAI-specific provider input.
2 properties 1 required
InsidePolygonUnion
StartStepPart
object
1 property 1 required
ApplicationConfigPatch
object
1 property
MessagesUnion
TextPart
object
2 properties 2 required
AlternativesAsExact
string
AlternativesAsExact.
MessagePart
TextParam
object
A text search parameter with exposure control.
2 properties 1 required
UserMessageV4
object
5 properties 2 required
HTTPValidationError
object
1 property
AdvancedSyntaxFeatures
string
AdvancedSyntaxFeatures.
Episode
object
Episodic memory schema following LangMem's OTAR pattern: Observation → Thoughts → Action → Result Captures complete interaction experiences for agent learning.…
4 properties 4 required
FacetsUnion
SecretKeyResponse
object
8 properties 7 required
ApplicationConfigResponse
object
1 property 1 required
ToolApprovalRequestPart
object
8 properties 4 required
AssistantPartV4
FacetsParam
object
A facets parameter that is always hidden from the LLM.
2 properties
TextPartV5
object
2 properties 1 required
StepStartPartV4
object
1 property
AssistantPartV5
StringArrayParam
object
A string array search parameter with exposure control, constraints, and merge behavior.
4 properties 1 required
SupportedLanguage
string
ISO code for a supported language.
ClientSideToolConfig
object
4 properties 4 required
AlgoliaSearchToolConfig
object
3 properties 3 required
ProviderInput
UserMessageV5
object
4 properties 1 required
ProviderName
string
IndexSearchParameters
object
Structured search parameters configuration for an Algolia index. Each parameter controls whether it is exposed to the LLM, its default value, optional constrai…
7 properties
SecretKeyPatch
object
Secret key patch payload.
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

algolia-agent-studio-api-openapi.yml Raw ↑
#Artificial Intelligence#Agents#REST
← Back to A APIs
API Details
ID
algolia:algolia-agent-studio-api
Base URL
https://{APPLICATION_ID}.algolia.net/agent-studio
Docs
https://www.algolia.com/doc/guides/algolia-ai/agent-studio
Provider
Algolia
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=algolia-algolia-agent-studio-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/algolia-algolia-agent-studio-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Algolia Agent Studio API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.