openapi: 3.2.0 info: title: Agent Studio API description: "The Agent Studio API lets you build and operate generative AI agents that use Algolia data, tools, and your chosen LLM provider.\n\nUse 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.\n\n## Client libraries\n\nUse Algolia's API clients and libraries to reliably integrate Algolia's APIs with your apps.\n\nFor more information, see [Algolia's ecosystem](https://www.algolia.com/doc/libraries).\n\n## Base URL\n\nBase URL for the Agent Studio API:\n\n- `https://{APPLICATION_ID}.algolia.net/agent-studio`\n\n**All requests must use HTTPS.**\n\n## Authentication\n\nAdd these headers to authenticate requests:\n\n- `x-algolia-application-id`. Your Algolia application ID.\n- `x-algolia-api-key`. An API key with the necessary permissions to make the request.\n The required access control list (ACL) to make a request is listed in each endpoint's reference.\n\nYou can find your application ID and API key in the [Algolia dashboard](https://dashboard.algolia.com/account/api-keys).\n\n## Request format\n\nRequest bodies must be JSON objects.\n\n## Response status and errors\n\nThe 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.\n\nSuccessful responses return `2xx` statuses. Client errors return `4xx` statuses. Server errors return `5xx` statuses.\nError responses have a `message` property with more information.\n\n## Version\n\nThe current version of the Agent Studio API is version 1, indicated by the `/1/` in each endpoint's URL.\n" version: 0.1.0 servers: - url: https://{APPLICATION_ID}.algolia.net/agent-studio description: Agent Studio API. variables: APPLICATION_ID: default: EXAMPLE description: Your Algolia application ID. security: - appId: [] apiKey: [] tags: - name: agent-studio paths: /1/agents: get: tags: - agent-studio operationId: listAgents x-acl: - settings summary: List Agents description: List all agents with pagination and filtering. parameters: - name: page in: query required: false schema: type: integer minimum: 1 description: Page number. default: 1 title: page description: Page number. - name: limit in: query required: false schema: type: integer minimum: 1 description: Items per page. default: 10 title: limit description: Items per page. - name: providerId in: query required: false schema: oneOf: - type: string - type: 'null' description: Filter by provider id. title: providerid description: Filter by provider id. responses: '200': description: Successful Response. content: application/json: schema: $ref: '#/components/schemas/PaginatedAgentsResponse' '422': description: Validation Error. content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' post: tags: - agent-studio operationId: createAgent x-acl: - editSettings summary: Create Agent description: Create a new agent. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AgentConfigCreate' responses: '201': description: Successful Response. content: application/json: schema: $ref: '#/components/schemas/AgentWithVersionResponse' '422': description: Validation Error. content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /1/agents/{agentId}: get: tags: - agent-studio operationId: getAgent x-acl: - settings summary: Get Agent description: Retrieve details of the specified agent. parameters: - name: agentId in: path required: true schema: type: string title: agentId description: The agentId. responses: '200': description: Successful Response. content: application/json: schema: $ref: '#/components/schemas/AgentWithVersionResponse' '422': description: Validation Error. content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' patch: tags: - agent-studio operationId: updateAgent x-acl: - editSettings summary: Update Agent description: Update the specified agent. parameters: - name: agentId in: path required: true schema: type: string title: agentId description: The agentId. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AgentConfigUpdate' responses: '200': description: Successful Response. content: application/json: schema: $ref: '#/components/schemas/AgentWithVersionResponse' '422': description: Validation Error. content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' delete: tags: - agent-studio operationId: deleteAgent x-acl: - editSettings summary: Delete Agent description: Delete the specified agent. parameters: - name: agentId in: path required: true schema: type: string title: agentId description: The agentId. responses: '204': description: Successful Response. '422': description: Validation Error. content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /1/agents/{agentId}/allowed-domains: get: tags: - agent-studio operationId: listAgentAllowedDomains x-acl: - settings summary: List Allowed Domains description: List all allowed domain patterns for this agent. parameters: - name: agentId in: path required: true schema: type: string title: agentId description: The agentId. responses: '200': description: Successful Response. content: application/json: schema: $ref: '#/components/schemas/AllowedDomainListResponse' '422': description: Validation Error. content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' post: tags: - agent-studio operationId: createAgentAllowedDomain x-acl: - editSettings summary: Create Allowed Domain description: Add a single allowed domain pattern (e.g. https://app.example.com or *.example.com). parameters: - name: agentId in: path required: true schema: type: string title: agentId description: The agentId. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AllowedDomainCreate' responses: '201': description: Successful Response. content: application/json: schema: $ref: '#/components/schemas/AllowedDomainResponse' '422': description: Validation Error. content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /1/agents/{agentId}/allowed-domains/bulk: post: tags: - agent-studio operationId: bulkCreateAllowedDomains x-acl: - editSettings summary: Bulk Insert Allowed Domains description: Add multiple allowed domain patterns. Duplicates are skipped. parameters: - name: agentId in: path required: true schema: type: string title: agentId description: The agentId. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AllowedDomainBulkInsert' responses: '201': description: Successful Response. content: application/json: schema: $ref: '#/components/schemas/AllowedDomainListResponse' '422': description: Validation Error. content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' delete: tags: - agent-studio operationId: bulkDeleteAllowedDomains x-acl: - editSettings summary: Bulk Delete Allowed Domains description: Delete allowed domains by id list. parameters: - name: agentId in: path required: true schema: type: string title: agentId description: The agentId. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AllowedDomainBulkDelete' responses: '204': description: Successful Response. '422': description: Validation Error. content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /1/agents/{agentId}/allowed-domains/{domainId}: get: tags: - agent-studio operationId: getAllowedDomain x-acl: - settings summary: Get Allowed Domain description: Get a single allowed domain by id. parameters: - name: domainId in: path required: true schema: type: string title: domainId description: The domainId. - name: agentId in: path required: true schema: type: string title: agentId description: The agentId. responses: '200': description: Successful Response. content: application/json: schema: $ref: '#/components/schemas/AllowedDomainResponse' '422': description: Validation Error. content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' delete: tags: - agent-studio operationId: deleteAllowedDomain x-acl: - editSettings summary: Delete Allowed Domain description: Remove an allowed domain by id. parameters: - name: domainId in: path required: true schema: type: string title: domainId description: The domainId. - name: agentId in: path required: true schema: type: string title: agentId description: The agentId. responses: '204': description: Successful Response. '422': description: Validation Error. content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /1/agents/{agentId}/cache: delete: tags: - agent-studio operationId: invalidateAgentCache x-acl: - editSettings summary: Invalidate Agent Cache description: Invalidate cached completions for this agent. Filter with `before` (exclusive). parameters: - name: agentId in: path required: true schema: type: string title: agentId description: The agentId. - name: before in: query required: false schema: oneOf: - type: string - type: 'null' description: Delete entries strictly before this date (exclusive, YYYY-MM-DD). title: before description: Delete entries strictly before this date (exclusive, YYYY-MM-DD). responses: '204': description: Successful Response. '422': description: Validation Error. content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /1/agents/{agentId}/completions: post: tags: - agent-studio operationId: createAgentCompletion x-acl: - search x-streaming: true summary: Create Completion description: 'Create a completion for the specified agent. This endpoint handles two types of requests: 1. Normal completion request: User message -> Agent response 2. Tool approval response: User approval -> Execute tool -> Agent response Tool Approval Flow (for MCP tools with requiresApproval: true): - Request 1: User sends message -> Agent requests tool call -> Return approval request - Request 2: User approves -> Execute tool -> Agent continues with result.' parameters: - name: agentId in: path required: true schema: $ref: '#/components/schemas/AgentIdUnion' description: The agentId. - name: compatibilityMode in: query required: true schema: $ref: '#/components/schemas/CompatibilityMode' description: Compatibility mode for the completion API. - name: stream in: query required: false schema: type: boolean description: Whether to stream the response or not. default: true title: stream description: Whether to stream the response or not. - name: cache in: query required: false schema: type: boolean description: Use cached responses if available. default: true title: cache description: Use cached responses if available. - name: memory in: query required: false schema: oneOf: - const: false type: boolean - type: 'null' description: Set to false to disable memory (enabled by default). title: memory description: Set to false to disable memory (enabled by default). - name: analytics in: query required: false schema: type: boolean description: 'Set to false to skip analytics for this completion (default: true). Disables Agent Studio BigQuery analytics, Algolia search analytics, click analytics, and query-suggestions training. Useful for offline-eval workflows.' default: true title: analytics description: 'Set to false to skip analytics for this completion (default: true). Disables Agent Studio BigQuery analytics, Algolia search analytics, click analytics, and query-suggestions training. Useful for offline-eval workflows.' - name: X-Algolia-Secure-User-Token in: header required: false schema: oneOf: - type: string - type: 'null' title: x-Algolia-Secure-User-Token description: The X-Algolia-Secure-User-Token. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AgentCompletionRequest' responses: '200': description: Successful Response. content: application/json: schema: type: object additionalProperties: true '422': description: Validation Error. content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /1/agents/{agentId}/conversations: get: tags: - agent-studio operationId: listAgentConversations x-acl: - logs summary: List Conversations description: Retrieves the conversations for the given agent ID. parameters: - name: agentId in: path required: true schema: $ref: '#/components/schemas/AgentIdUnion' description: The agentId. - name: startDate in: query required: false schema: oneOf: - type: string - type: 'null' description: 'Filter conversations created after this date (format: YYYY-MM-DD).' title: startdate description: 'Filter conversations created after this date (format: YYYY-MM-DD).' - name: endDate in: query required: false schema: oneOf: - type: string - type: 'null' description: 'Filter conversations created before this date (format: YYYY-MM-DD).' title: enddate description: 'Filter conversations created before this date (format: YYYY-MM-DD).' - name: includeFeedback in: query required: false schema: oneOf: - type: boolean - type: 'null' description: Include feedback per conversation. default: false title: includefeedback description: Include feedback per conversation. - name: feedbackVote in: query required: false schema: oneOf: - type: integer maximum: 1 minimum: 0 - type: 'null' description: Filter by feedback value (requires includeFeedback=true). title: feedbackvote description: Filter by feedback value (requires includeFeedback=true). - name: page in: query required: false schema: type: integer minimum: 1 description: Page number. default: 1 title: page description: Page number. - name: limit in: query required: false schema: type: integer maximum: 100 minimum: 1 description: Items per page. default: 20 title: limit description: Items per page. - name: X-Algolia-Secure-User-Token in: header required: false schema: oneOf: - type: string - type: 'null' title: x-Algolia-Secure-User-Token description: The X-Algolia-Secure-User-Token. responses: '200': description: Successful Response. content: application/json: schema: $ref: '#/components/schemas/PaginatedConversationsResponse' '422': description: Validation Error. content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' delete: tags: - agent-studio operationId: deleteAgentConversations x-acl: - logs summary: Delete Conversations description: Deletes the conversations matching the given filers. parameters: - name: agentId in: path required: true schema: type: string title: agentId description: The agentId. - name: startDate in: query required: false schema: oneOf: - type: string - type: 'null' description: 'Filter conversations created after this date (format: YYYY-MM-DD).' title: startdate description: 'Filter conversations created after this date (format: YYYY-MM-DD).' - name: endDate in: query required: false schema: oneOf: - type: string - type: 'null' description: 'Filter conversations created before this date (format: YYYY-MM-DD).' title: enddate description: 'Filter conversations created before this date (format: YYYY-MM-DD).' responses: '204': description: Successful Response. '422': description: Validation Error. content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /1/agents/{agentId}/conversations/export: get: tags: - agent-studio operationId: exportConversations x-acl: - logs summary: Export Conversations description: Exports all conversations based on the passed filters. parameters: - name: agentId in: path required: true schema: type: string title: agentId description: The agentId. - name: startDate in: query required: false schema: oneOf: - type: string - type: 'null' description: 'Filter conversations created after this date (format: YYYY-MM-DD).' title: startdate description: 'Filter conversations created after this date (format: YYYY-MM-DD).' - name: endDate in: query required: false schema: oneOf: - type: string - type: 'null' description: 'Filter conversations created before this date (format: YYYY-MM-DD).' title: enddate description: 'Filter conversations created before this date (format: YYYY-MM-DD).' responses: '200': description: Successful Response. content: application/json: schema: type: array items: $ref: '#/components/schemas/ConversationFullResponse' '422': description: Validation Error. content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /1/agents/{agentId}/conversations/{conversationId}: get: tags: - agent-studio operationId: getConversation x-acl: - logs summary: Get Conversation description: Retrieves the conversation and its messages for the given ID. parameters: - name: conversationId in: path required: true schema: type: string title: conversationId description: The conversationId. - name: agentId in: path required: true schema: $ref: '#/components/schemas/AgentIdUnion' description: The agentId. - name: includeFeedback in: query required: false schema: type: boolean description: Include feedback for the conversation. default: false title: includefeedback description: Include feedback for the conversation. - name: X-Algolia-Secure-User-Token in: header required: false schema: oneOf: - type: string - type: 'null' title: x-Algolia-Secure-User-Token description: The X-Algolia-Secure-User-Token. responses: '200': description: Successful Response. content: application/json: schema: $ref: '#/components/schemas/ConversationFullResponse' '422': description: Validation Error. content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' delete: tags: - agent-studio operationId: deleteConversation x-acl: - logs summary: Delete Conversation description: Deletes the conversation with the given ID. parameters: - name: conversationId in: path required: true schema: type: string title: conversationId description: The conversationId. - name: agentId in: path required: true schema: type: string title: agentId description: The agentId. responses: '204': description: Successful Response. '422': description: Validation Error. content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /1/agents/{agentId}/publish: post: tags: - agent-studio operationId: publishAgent x-acl: - editSettings summary: Publish Agent description: Publish the specified agent. parameters: - name: agentId in: path required: true schema: type: string title: agentId description: The agentId. responses: '200': description: Successful Response. content: application/json: schema: $ref: '#/components/schemas/AgentWithVersionResponse' '422': description: Validation Error. content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /1/agents/{agentId}/unpublish: post: tags: - agent-studio operationId: unpublishAgent x-acl: - editSettings summary: Unpublish Agent description: Unpublish the specified agent. parameters: - name: agentId in: path required: true schema: type: string title: agentId description: The agentId. responses: '200': description: Successful Response. content: application/json: schema: $ref: '#/components/schemas/AgentWithVersionResponse' '422': description: Validation Error. content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /1/configuration: get: tags: - agent-studio operationId: getConfiguration x-acl: - logs summary: Get Configuration description: Get Configuration. responses: '200': description: Successful Response. content: application/json: schema: $ref: '#/components/schemas/ApplicationConfigResponse' '422': description: Validation Error. content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' patch: tags: - agent-studio operationId: updateConfiguration x-acl: - logs summary: Patch Configuration description: Patch Configuration. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ApplicationConfigPatch' responses: '200': description: Successful Response. content: application/json: schema: $ref: '#/components/schemas/ApplicationConfigResponse' '422': description: Validation Error. content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /1/feedback: post: tags: - agent-studio operationId: createFeedback x-acl: - search summary: Create Feedback description: Create new feedback entry. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/FeedbackCreationRequest' responses: '201': description: Successful Response. content: application/json: schema: $ref: '#/components/schemas/FeedbackResponse' '422': description: Validation Error. content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /1/providers: get: tags: - agent-studio operationId: listProviders x-acl: - settings summary: List Providers description: List Providers. parameters: - name: page in: query required: false schema: type: integer minimum: 1 description: Page number. default: 1 title: page description: Page number. - name: limit in: query required: false schema: type: integer minimum: 1 description: Items per page. default: 10 title: limit description: Items per page. responses: '200': description: Successful Response. content: application/json: schema: $ref: '#/components/schemas/PaginatedProviderAuthenticationsResponse' '422': description: Validation Error. content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' post: tags: - agent-studio operationId: createProvider x-acl: - editSettings summary: Create Provider description: Create Provider. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ProviderAuthenticationCreate' responses: '201': description: Successful Response. content: application/json: schema: $ref: '#/components/schemas/ProviderAuthenticationResponse' '422': description: Validation Error. content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /1/providers/models: get: tags: - agent-studio operationId: listModels x-acl: - settings summary: Get Provider Models description: Get Provider Models. responses: '200': description: Successful Response. content: application/json: schema: type: object additionalProperties: type: array items: type: string title: responseGetProviderModels1ProvidersModelsGet '422': description: Validation Error. content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /1/providers/{providerId}: get: tags: - agent-studio operationId: getProvider x-acl: - settings summary: Get Provider description: Get Provider. parameters: - name: providerId in: path required: true schema: type: string title: providerId description: The providerId. responses: '200': description: Successful Response. content: application/json: schema: $ref: '#/components/schemas/ProviderAuthenticationResponse' '422': description: Validation Error. content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' patch: tags: - agent-studio operationId: updateProvider x-acl: - editSettings summary: Update Provider description: Update Provider. parameters: - name: providerId in: path required: true schema: type: string title: providerId description: The providerId. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ProviderAuthenticationPatch' responses: '200': description: Successful Response. content: application/json: schema: $ref: '#/components/schemas/ProviderAuthenticationResponse' '422': description: Validation Error. content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' delete: tags: - agent-studio operationId: deleteProvider x-acl: - editSettings summary: Delete Provider description: Delete Provider. parameters: - name: providerId in: path required: true schema: type: string title: providerId description: The providerId. responses: '204': description: Successful Response. '422': description: Validation Error. content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /1/providers/{providerId}/models: get: tags: - agent-studio operationId: listProviderModels x-acl: - settings summary: Get Provider Models By Id description: Get available models for a specific provider. parameters: - name: providerId in: path required: true schema: type: string title: providerId description: The providerId. responses: '200': description: Successful Response. content: application/json: schema: type: array items: type: string title: responseGetProviderModelsById1ProvidersProviderIdModelsGet '422': description: Validation Error. content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /1/secret-keys: get: tags: - agent-studio operationId: listSecretKeys x-acl: - settings summary: List Secret Keys description: List Secret Keys. parameters: - name: page in: query required: false schema: type: integer minimum: 1 description: Page number. default: 1 title: page description: Page number. - name: limit in: query required: false schema: type: integer minimum: 1 description: Items per page. default: 10 title: limit description: Items per page. responses: '200': description: Successful Response. content: application/json: schema: $ref: '#/components/schemas/PaginatedSecretKeysResponse' '422': description: Validation Error. content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' post: tags: - agent-studio operationId: createSecretKey x-acl: - admin summary: Create Secret Key description: Create Secret Key. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/SecretKeyCreate' responses: '201': description: Successful Response. content: application/json: schema: $ref: '#/components/schemas/SecretKeyResponse' '422': description: Validation Error. content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /1/secret-keys/{secretKeyId}: get: tags: - agent-studio operationId: getSecretKey x-acl: - settings summary: Get Secret Key description: Get Secret Key. parameters: - name: secretKeyId in: path required: true schema: type: string title: secretKeyId description: The secretKeyId. responses: '200': description: Successful Response. content: application/json: schema: $ref: '#/components/schemas/SecretKeyResponse' '422': description: Validation Error. content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' patch: tags: - agent-studio operationId: updateSecretKey x-acl: - admin summary: Patch Secret Key description: Patch Secret Key. parameters: - name: secretKeyId in: path required: true schema: type: string title: secretKeyId description: The secretKeyId. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/SecretKeyPatch' responses: '200': description: Successful Response. content: application/json: schema: $ref: '#/components/schemas/SecretKeyResponse' '422': description: Validation Error. content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' delete: tags: - agent-studio operationId: deleteSecretKey x-acl: - admin summary: Delete Secret Key description: Delete Secret Key. parameters: - name: secretKeyId in: path required: true schema: type: string title: secretKeyId description: The secretKeyId. responses: '204': description: Successful Response. '422': description: Validation Error. content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /1/user-data/{userToken}: get: tags: - agent-studio operationId: getUserData x-acl: - logs summary: Get Data By User Token description: Retrieves all memories, conversations and their messages for the given user token. parameters: - name: userToken in: path required: true schema: type: string title: userToken description: The userToken. responses: '200': description: Successful Response. content: application/json: schema: $ref: '#/components/schemas/UserDataResponse' '422': description: Validation Error. content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' delete: tags: - agent-studio operationId: deleteUserData x-acl: - logs summary: Delete Data By User Token description: Permanently deletes all messages for the given user token. Does not delete conversations. parameters: - name: userToken in: path required: true schema: type: string title: userToken description: The userToken. responses: '204': description: Successful Response. '422': description: Validation Error. content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /{path}: get: operationId: customGet summary: Send requests to the Algolia REST API description: This method lets you send requests to the Algolia REST API. parameters: - $ref: '#/components/parameters/PathInPath' - $ref: '#/components/parameters/Parameters' responses: '200': description: OK content: application/json: schema: type: object '400': $ref: '#/components/responses/BadRequest' '402': $ref: '#/components/responses/FeatureNotEnabled' '403': $ref: '#/components/responses/MethodNotAllowed' '404': $ref: '#/components/responses/IndexNotFound' tags: - agent-studio post: operationId: customPost requestBody: description: Parameters to send with the custom request. content: application/json: schema: type: object summary: Send requests to the Algolia REST API description: This method lets you send requests to the Algolia REST API. parameters: - $ref: '#/components/parameters/PathInPath' - $ref: '#/components/parameters/Parameters' responses: '200': description: OK content: application/json: schema: type: object '400': $ref: '#/components/responses/BadRequest' '402': $ref: '#/components/responses/FeatureNotEnabled' '403': $ref: '#/components/responses/MethodNotAllowed' '404': $ref: '#/components/responses/IndexNotFound' tags: - agent-studio put: operationId: customPut requestBody: description: Parameters to send with the custom request. content: application/json: schema: type: object summary: Send requests to the Algolia REST API description: This method lets you send requests to the Algolia REST API. parameters: - $ref: '#/components/parameters/PathInPath' - $ref: '#/components/parameters/Parameters' responses: '200': description: OK content: application/json: schema: type: object '400': $ref: '#/components/responses/BadRequest' '402': $ref: '#/components/responses/FeatureNotEnabled' '403': $ref: '#/components/responses/MethodNotAllowed' '404': $ref: '#/components/responses/IndexNotFound' tags: - agent-studio delete: operationId: customDelete summary: Send requests to the Algolia REST API description: This method lets you send requests to the Algolia REST API. parameters: - $ref: '#/components/parameters/PathInPath' - $ref: '#/components/parameters/Parameters' responses: '200': description: OK content: application/json: schema: type: object '400': $ref: '#/components/responses/BadRequest' '402': $ref: '#/components/responses/FeatureNotEnabled' '403': $ref: '#/components/responses/MethodNotAllowed' '404': $ref: '#/components/responses/IndexNotFound' tags: - agent-studio /setClientApiKey: get: x-helper: true x-asynchronous-helper: false x-acl: [] tags: - agent-studio operationId: setClientApiKey summary: Switch the API key used to authenticate requests description: 'Switch the API key used to authenticate requests. ' parameters: - in: query name: apiKey description: API key to use for subsequent requests. required: true schema: type: string responses: '204': description: No content. components: schemas: ToolPartV5: properties: type: type: string title: type toolCallId: type: string title: toolcallid state: $ref: '#/components/schemas/ToolState' input: additionalProperties: true type: object title: input output: type: object additionalProperties: true title: output errorText: type: string title: errortext providerOptions: additionalProperties: true type: object title: provideroptions requiresApproval: type: boolean title: requiresapproval description: type: string title: description argsHash: type: string title: argshash type: object required: - type - toolCallId title: toolPartV5 description: Model for tool invocation in a Message. NaturalLanguagesUnion: oneOf: - items: $ref: '#/components/schemas/SupportedLanguage' type: array - type: 'null' OptionalWordsUnion: oneOf: - type: string - items: type: string type: array - type: 'null' IgnorePluralsUnion: oneOf: - type: boolean - items: $ref: '#/components/schemas/SupportedLanguage' type: array - type: 'null' ToolState: type: string enum: - input-streaming - input-available - output-available - output-error MessageRole: type: string enum: - user - assistant title: messageRole description: Role of a message in the conversation. AllowedDomainResponse: properties: id: type: string title: id appId: type: string title: appid agentId: type: string title: agentid domain: type: string title: domain createdAt: type: string title: createdat updatedAt: type: string title: updatedat type: object required: - id - appId - agentId - domain - createdAt - updatedAt title: allowedDomainResponse description: Single allowed domain in API responses. ToolInvocationPartV4: properties: type: type: string const: tool-invocation title: type default: tool-invocation toolInvocation: $ref: '#/components/schemas/ToolInvocationV4' type: object required: - toolInvocation title: toolInvocationPartV4 NumericFiltersUnion: oneOf: - type: string - type: array items: $ref: '#/components/schemas/NumericFiltersUnion' - type: 'null' ToolConfigInput: oneOf: - $ref: '#/components/schemas/ClientSideToolConfig' - $ref: '#/components/schemas/AlgoliaSearchToolConfig' - $ref: '#/components/schemas/AlgoliaRecommendToolConfig-Input' - $ref: '#/components/schemas/AlgoliaDisplayResultsToolConfig' - $ref: '#/components/schemas/McpServerToolConfig' - $ref: '#/components/schemas/UnknownToolConfig' discriminator: propertyName: type mapping: algolia_display_results: '#/components/schemas/AlgoliaDisplayResultsToolConfig' algolia_recommend: '#/components/schemas/AlgoliaRecommendToolConfig-Input' algolia_search_index: '#/components/schemas/AlgoliaSearchToolConfig' client_side: '#/components/schemas/ClientSideToolConfig' mcp_tools: '#/components/schemas/McpServerToolConfig' unknown: '#/components/schemas/UnknownToolConfig' RemoveStopWordsUnion: oneOf: - type: boolean - items: $ref: '#/components/schemas/SupportedLanguage' type: array - type: 'null' ProviderAuthenticationPatch: properties: name: oneOf: - type: string maxLength: 128 minLength: 1 - type: 'null' title: name input: $ref: '#/components/schemas/ProviderInputNullable' additionalProperties: false type: object title: providerPatch NumberParam: properties: exposed: type: boolean title: exposed default: oneOf: - type: integer - type: 'null' title: default constraint: oneOf: - $ref: '#/components/schemas/NumberParamConstraint' - type: 'null' type: object required: - exposed title: numberParam description: A number search parameter with exposure control and optional constraints. AllowedToolsUnion: oneOf: - additionalProperties: $ref: '#/components/schemas/ToolConfig' type: object - type: 'null' StartPart: properties: type: type: string const: start title: type default: start type: object title: startPart required: - type AlgoliaDisplayResultsToolConfig: properties: name: type: string const: algolia_display_results title: name default: algolia_display_results type: type: string const: algolia_display_results title: type default: algolia_display_results minGroups: type: integer minimum: 1 title: mingroups default: 1 maxGroups: type: integer minimum: 1 title: maxgroups default: 3 minResultsPerGroup: type: integer minimum: 1 title: minresultspergroup default: 3 maxResultsPerGroup: type: integer minimum: 1 title: maxresultspergroup default: 6 type: object title: algoliaDisplayResultsToolConfig description: Configuration for the algolia_display_results tool. required: - type VoteEnum: type: integer enum: - 0 - 1 x-enum-varnames: - downvote - upvote DistinctUnion: oneOf: - type: boolean - type: integer - type: 'null' FeedbackResponse: properties: id: type: string title: id agentId: type: string title: agentid messageId: type: string title: messageid vote: type: integer title: vote tags: items: type: string type: array title: tags notes: oneOf: - type: string - type: 'null' title: notes model: oneOf: - type: string - type: 'null' title: model createdAt: type: string title: createdat updatedAt: type: string title: updatedat type: object required: - id - agentId - messageId - vote - tags - createdAt - updatedAt title: feedbackResponse ProviderAuthenticationCreate: properties: name: type: string maxLength: 128 minLength: 1 title: name providerName: $ref: '#/components/schemas/ProviderName' input: $ref: '#/components/schemas/ProviderInput' additionalProperties: false type: object required: - name - providerName - input title: providerAuthenticationCreate AgentWithVersionResponse: properties: id: type: string title: id name: type: string title: name description: oneOf: - type: string - type: 'null' title: description status: $ref: '#/components/schemas/AgentStatus' providerId: oneOf: - type: string - type: 'null' title: providerid model: oneOf: - type: string - type: 'null' title: model instructions: type: string title: instructions systemPrompt: oneOf: - type: string - type: 'null' title: systemprompt config: additionalProperties: true type: object title: config tools: items: $ref: '#/components/schemas/ToolConfigInput' type: array title: tools templateType: oneOf: - type: string - type: 'null' title: templatetype createdAt: type: string title: createdat updatedAt: oneOf: - type: string - type: 'null' title: updatedat lastUsedAt: oneOf: - type: string - type: 'null' title: lastusedat type: object required: - id - name - description - status - providerId - instructions - config - createdAt - updatedAt - lastUsedAt title: agentWithVersionResponse StringArrayParamConstraint: properties: values: oneOf: - items: type: string type: array - type: 'null' title: values type: object title: stringArrayParamConstraint description: Constraints for a string array parameter. ToolResultPart: properties: type: type: string const: tool-result title: type default: tool-result toolCallId: type: string title: toolcallid toolName: type: string title: toolname output: $ref: '#/components/schemas/ToolResultOutput' providerOptions: oneOf: - type: object additionalProperties: true - type: 'null' title: provideroptions type: object required: - type - toolCallId - toolName - output title: toolResultPart RemoveWordsIfNoResults: type: string enum: - none - lastWords - firstWords - allOptional title: removeWordsIfNoResults description: 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 when a query doesn't return results. - `lastWords`. Treat the last (then second to last, then third to last) word as optional, until there are results or at most 5 words have been removed. - `firstWords`. Treat the first (then second, then third) word as optional, until there are results or at most 5 words have been removed. - `allOptional`. Treat all words as optional. For more information, see [Remove words to improve results](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/empty-or-insufficient-results/in-depth/why-use-remove-words-if-no-results). AllowedDomainBulkInsert: properties: domains: items: type: string type: array title: domains description: List of domain patterns to add. type: object required: - domains title: allowedDomainBulkInsert description: Request body for bulk insert. AgentConfigCreate: properties: name: type: string title: name description: type: string title: description providerId: type: string title: providerid model: type: string title: model instructions: type: string title: instructions description: 'The agent prompt: defines the agent''s role, tone, and goals. Guides how it answers using the provided context. Corresponds to the ''Agent prompt'' field in the dashboard.' systemPrompt: type: string title: systemprompt description: 'The system prompt: defines system-level rules and constraints. Guides how the agent uses tools, features, and generates context. Prepended before `instructions` in the final prompt sent to the LLM. Typically injected by an agent template — modify with caution, as changes may affect behavior, tool usage, or response accuracy. Corresponds to the ''System prompt'' field in the dashboard.' templateType: type: string title: templatetype config: additionalProperties: true type: object title: config default: {} example: sendUsage: true sendReasoning: true temperature: 0.7 max_tokens: 1500 reasoning: '{summary: auto}' features: '[memory]' tools: items: $ref: '#/components/schemas/ToolConfigInput' type: array title: tools type: object required: - name - instructions title: agentConfigCreate AssistantMessageV4: properties: id: type: string title: id role: type: string const: assistant title: role default: assistant content: type: string title: content parts: items: $ref: '#/components/schemas/AssistantPartV4' type: array title: parts toolInvocations: $ref: '#/components/schemas/ToolInvocationsUnion' type: object required: - role - content title: assistantMessageV4 AgentTestConfiguration: properties: id: type: string title: id providerId: type: string title: providerid model: type: string title: model instructions: type: string title: instructions systemPrompt: type: string title: systemprompt config: additionalProperties: true type: object title: config tools: items: $ref: '#/components/schemas/ToolConfigInput' type: array title: tools type: object required: - instructions - config - tools title: agentTestConfiguration description: Dynamic configuration for testing agents. ClientToolsArgsSchema: properties: type: type: string const: object title: type default: object properties: additionalProperties: true type: object title: properties required: items: type: string type: array title: required type: object title: clientToolsArgsSchema PaginatedSecretKeysResponse: properties: data: items: $ref: '#/components/schemas/SecretKeyResponse' type: array title: data pagination: $ref: '#/components/schemas/PaginationMetadata' type: object required: - data - pagination title: paginatedSecretKeysResponse ErrorBase: description: Error. type: object x-keep-model: true additionalProperties: true properties: message: type: string example: Invalid Application-Id or API-Key MessageV4: oneOf: - $ref: '#/components/schemas/UserMessageV4' - $ref: '#/components/schemas/AssistantMessageV4' discriminator: propertyName: role mapping: assistant: '#/components/schemas/AssistantMessageV4' user: '#/components/schemas/UserMessageV4' AroundRadiusUnion: oneOf: - type: integer - type: string - type: 'null' FeedbackUnion: oneOf: - items: $ref: '#/components/schemas/FeedbackResponse' type: array - type: 'null' ConversationFullResponse: properties: id: type: string title: id agentId: type: string title: agentid title: oneOf: - type: string - type: 'null' title: title createdAt: type: string title: createdat updatedAt: type: string title: updatedat lastActivityAt: oneOf: - type: string - type: 'null' title: lastactivityat userToken: oneOf: - type: string - type: 'null' title: usertoken isFromDashboard: type: boolean title: isfromdashboard default: false messageCount: type: integer title: messagecount default: 0 totalInputTokens: type: integer title: totalinputtokens default: 0 totalOutputTokens: type: integer title: totaloutputtokens default: 0 totalTokens: type: integer title: totaltokens default: 0 conversationMetadata: oneOf: - $ref: '#/components/schemas/ConversationMetadata' - type: 'null' feedback: $ref: '#/components/schemas/FeedbackUnion' messages: items: $ref: '#/components/schemas/MessageResponse' type: array title: messages type: object required: - id - agentId - createdAt - updatedAt - messages title: conversationFullResponse description: Response model for a conversation with all its messages. SecretKeyCreate: properties: name: type: string maxLength: 128 minLength: 1 title: name description: The name of the secret key. agentIds: items: type: string type: array title: agentids description: List of agent IDs this secret key is associated with. type: object required: - name title: secretKeyCreate description: Secret key creation payload. ConversationBaseResponse: properties: id: type: string title: id agentId: type: string title: agentid title: oneOf: - type: string - type: 'null' title: title createdAt: type: string title: createdat updatedAt: type: string title: updatedat lastActivityAt: oneOf: - type: string - type: 'null' title: lastactivityat userToken: oneOf: - type: string - type: 'null' title: usertoken isFromDashboard: type: boolean title: isfromdashboard default: false messageCount: type: integer title: messagecount default: 0 totalInputTokens: type: integer title: totalinputtokens default: 0 totalOutputTokens: type: integer title: totaloutputtokens default: 0 totalTokens: type: integer title: totaltokens default: 0 conversationMetadata: oneOf: - $ref: '#/components/schemas/ConversationMetadata' - type: 'null' feedback: $ref: '#/components/schemas/FeedbackUnion' type: object required: - id - agentId - createdAt - updatedAt title: conversationBaseResponse description: Lightweight response model without its messages. TagFiltersUnion: oneOf: - type: string - type: array items: $ref: '#/components/schemas/TagFiltersUnion' - type: 'null' SearchParametersOverridesMapNullable: oneOf: - additionalProperties: $ref: '#/components/schemas/SearchParametersOverrides' type: object - type: 'null' ToolInvocationV4: properties: toolCallId: type: string title: toolcallid toolName: type: string title: toolname args: additionalProperties: true type: object title: args result: type: object additionalProperties: true title: result step: type: integer title: step state: type: string title: state providerOptions: additionalProperties: true type: object title: provideroptions requiresApproval: type: boolean title: requiresapproval description: type: string title: description argsHash: type: string title: argshash type: object required: - toolCallId - toolName title: toolInvocationV4 description: Model for tool invocation in a Message. OptionalFiltersUnion: oneOf: - type: string - type: array items: $ref: '#/components/schemas/OptionalFiltersUnion' - type: 'null' UserDataResponse: properties: conversations: items: $ref: '#/components/schemas/ConversationFullResponse' type: array title: conversations memories: items: $ref: '#/components/schemas/MemoryRecord' type: array title: memories type: object required: - conversations - memories title: userDataResponse AroundPrecisionUnion: oneOf: - type: integer - items: additionalProperties: type: integer type: object type: array - type: 'null' MessageV5: oneOf: - $ref: '#/components/schemas/UserMessageV5' - $ref: '#/components/schemas/AssistantMessageV5' discriminator: propertyName: role mapping: assistant: '#/components/schemas/AssistantMessageV5' user: '#/components/schemas/UserMessageV5' SearchParameters: properties: queryType: oneOf: - $ref: '#/components/schemas/QueryType' - type: 'null' similarQuery: oneOf: - type: string - type: 'null' title: similarquery queryLanguages: $ref: '#/components/schemas/QueryLanguagesUnion' advancedSyntax: oneOf: - type: boolean - type: 'null' title: advancedsyntax advancedSyntaxFeatures: $ref: '#/components/schemas/AdvancedSyntaxFeaturesUnion' alternativesAsExact: $ref: '#/components/schemas/AlternativesAsExactUnion' decompoundQuery: oneOf: - type: boolean - type: 'null' title: decompoundquery typoTolerance: $ref: '#/components/schemas/TypoToleranceUnion' allowTyposOnNumericTokens: oneOf: - type: boolean - type: 'null' title: allowtyposonnumerictokens minWordSizeFor1Typo: oneOf: - type: integer - type: 'null' title: minwordsizefor1Typo minWordSizeFor2Typos: oneOf: - type: integer - type: 'null' title: minwordsizefor2Typos disableTypoToleranceOnAttributes: oneOf: - items: type: string type: array - type: 'null' title: disabletypotoleranceonattributes filters: oneOf: - type: string - type: 'null' title: filters facetFilters: oneOf: - $ref: '#/components/schemas/FacetFiltersUnion' - type: 'null' facets: $ref: '#/components/schemas/FacetsUnion' maxValuesPerFacet: oneOf: - type: integer - type: 'null' title: maxvaluesperfacet maxFacetHits: oneOf: - type: integer - type: 'null' title: maxfacethits facetingAfterDistinct: oneOf: - type: boolean - type: 'null' title: facetingafterdistinct sortFacetValuesBy: oneOf: - type: string - type: 'null' title: sortfacetvaluesby numericFilters: $ref: '#/components/schemas/NumericFiltersUnion' tagFilters: $ref: '#/components/schemas/TagFiltersUnion' sumOrFiltersScores: oneOf: - type: boolean - type: 'null' title: sumorfiltersscores aroundLatLng: oneOf: - type: string - type: 'null' title: aroundlatlng aroundLatLngViaIp: oneOf: - type: boolean - type: 'null' title: aroundlatlngviaip aroundRadius: $ref: '#/components/schemas/AroundRadiusUnion' aroundPrecision: $ref: '#/components/schemas/AroundPrecisionUnion' minimumAroundRadius: oneOf: - type: integer - type: 'null' title: minimumaroundradius insideBoundingBox: $ref: '#/components/schemas/InsideBoundingBoxUnion' insidePolygon: $ref: '#/components/schemas/InsidePolygonUnion' attributesToRetrieve: oneOf: - items: type: string type: array - type: 'null' title: attributestoretrieve attributesToSnippet: oneOf: - items: type: string type: array - type: 'null' title: attributestosnippet snippetEllipsisText: oneOf: - type: string - type: 'null' title: snippetellipsistext restrictHighlightAndSnippetArrays: oneOf: - type: boolean - type: 'null' title: restricthighlightandsnippetarrays page: oneOf: - type: integer - type: 'null' title: page offset: oneOf: - type: integer - type: 'null' title: offset hitsPerPage: oneOf: - type: integer - type: 'null' title: hitsperpage length: oneOf: - type: integer - type: 'null' title: length getRankingInfo: oneOf: - type: boolean - type: 'null' title: getrankinginfo relevancyStrictness: oneOf: - type: integer - type: 'null' title: relevancystrictness minProximity: oneOf: - type: integer - type: 'null' title: minproximity attributeCriteriaComputedByMinProximity: oneOf: - type: boolean - type: 'null' title: attributecriteriacomputedbyminproximity distinct: $ref: '#/components/schemas/DistinctUnion' enableRules: oneOf: - type: boolean - type: 'null' title: enablerules enablePersonalization: oneOf: - type: boolean - type: 'null' title: enablepersonalization personalizationImpact: oneOf: - type: integer - type: 'null' title: personalizationimpact enableAbTest: oneOf: - type: boolean - type: 'null' title: enableabtest enableReRanking: oneOf: - type: boolean - type: 'null' title: enablereranking reRankingApplyFilter: $ref: '#/components/schemas/ReRankingApplyFilterUnion' ruleContexts: oneOf: - items: type: string type: array - type: 'null' title: rulecontexts removeStopWords: $ref: '#/components/schemas/RemoveStopWordsUnion' ignorePlurals: $ref: '#/components/schemas/IgnorePluralsUnion' removeWordsIfNoResults: oneOf: - $ref: '#/components/schemas/RemoveWordsIfNoResults' - type: 'null' optionalWords: $ref: '#/components/schemas/OptionalWordsUnion' optionalFilters: $ref: '#/components/schemas/OptionalFiltersUnion' synonyms: oneOf: - type: boolean - type: 'null' title: synonyms replaceSynonymsInHighlight: oneOf: - type: boolean - type: 'null' title: replacesynonymsinhighlight analytics: oneOf: - type: boolean - type: 'null' title: analytics analyticsTags: oneOf: - items: type: string type: array - type: 'null' title: analyticstags clickAnalytics: oneOf: - type: boolean - type: 'null' title: clickanalytics userToken: oneOf: - type: string - type: 'null' title: usertoken restrictSearchableAttributes: oneOf: - items: type: string type: array - type: 'null' title: restrictsearchableattributes disableExactOnAttributes: oneOf: - items: type: string type: array - type: 'null' title: disableexactonattributes exactOnSingleWordQuery: oneOf: - $ref: '#/components/schemas/ExactOnSingleWordQuery' - type: 'null' naturalLanguages: $ref: '#/components/schemas/NaturalLanguagesUnion' percentileComputation: oneOf: - type: boolean - type: 'null' title: percentilecomputation explain: oneOf: - items: type: string type: array - type: 'null' title: explain type: object title: searchParameters description: 'Algolia Search API parameters that can be predefined for the search tool. Reference: https://www.algolia.com/doc/api-reference/search-api-parameters/ The parameters that seemed irrelevant for the search tool have been commented out. Uses types from algoliasearch.search.models for better type safety.' AlgoliaRecommendToolConfig-Input: properties: name: type: string maxLength: 32 minLength: 3 title: name type: type: string const: algolia_recommend title: type default: algolia_recommend allowedConfigs: items: $ref: '#/components/schemas/AlgoliaRecommendToolIndexConfig' type: array title: allowedconfigs default: [] predefinedRecommendParameters: additionalProperties: true type: object title: predefinedrecommendparameters type: object required: - type - name title: algoliaRecommendToolConfig description: 'Configuration for the Algolia Recommend tool. Allows specifying recommend models and related parameters.' ProviderAuthenticationResponse: properties: id: type: string title: id name: type: string title: name providerName: type: string title: providername input: $ref: '#/components/schemas/ProviderInput' createdAt: type: string title: createdat updatedAt: type: string title: updatedat lastUsedAt: oneOf: - type: string - type: 'null' title: lastusedat type: object required: - id - name - providerName - input - createdAt - updatedAt title: provider Facets: properties: order: oneOf: - items: type: string type: array - type: 'null' title: order additionalProperties: true type: object title: facets description: Order of facet names. PaginatedProviderAuthenticationsResponse: properties: data: items: $ref: '#/components/schemas/ProviderAuthenticationResponse' type: array title: data pagination: $ref: '#/components/schemas/PaginationMetadata' type: object required: - data - pagination title: paginatedProviders AlgoliaSearchToolIndexConfig: properties: index: type: string maxLength: 100 minLength: 1 title: index description: type: string maxLength: 3000 minLength: 1 title: description enhancedDescription: type: string title: enhanceddescription default: '' searchParameters: oneOf: - $ref: '#/components/schemas/SearchParameters' - type: 'null' searchControls: oneOf: - $ref: '#/components/schemas/IndexSearchParameters' - type: 'null' type: object required: - index - description title: algoliaSearchToolIndexConfig MessageResponse: properties: id: type: string title: id conversationId: type: string title: conversationid role: $ref: '#/components/schemas/MessageRole' parts: items: $ref: '#/components/schemas/MessagePart' type: array title: parts createdAt: type: string title: createdat updatedAt: type: string title: updatedat model: oneOf: - type: string - type: 'null' title: model inputTokens: oneOf: - type: integer - type: 'null' title: inputtokens outputTokens: oneOf: - type: integer - type: 'null' title: outputtokens turnContext: oneOf: - additionalProperties: type: string type: object - type: 'null' title: turncontext type: object required: - id - conversationId - role - parts - createdAt - updatedAt title: messageResponse description: Response model for a message. AllowedDomainListResponse: properties: domains: items: $ref: '#/components/schemas/AllowedDomainResponse' type: array title: domains type: object required: - domains title: allowedDomainListResponse description: List of allowed domains for an application. InsideBoundingBoxUnion: oneOf: - type: string - items: items: type: number type: array type: array - type: 'null' AdvancedSyntaxFeaturesUnion: oneOf: - items: $ref: '#/components/schemas/AdvancedSyntaxFeatures' type: array - type: 'null' AnthropicProviderInput: properties: apiKey: type: string title: apikey baseUrl: oneOf: - type: string maxLength: 2083 minLength: 1 - type: 'null' title: baseurl type: object required: - apiKey title: anthropicProviderInput description: Anthropic-specific provider input. ValidationError: properties: loc: items: $ref: '#/components/schemas/LocationItemUnion' type: array title: location msg: type: string title: message type: type: string title: errorType input: title: input ctx: type: object title: context type: object required: - loc - msg - type title: validationError ReasoningPart: properties: type: type: string const: reasoning title: type default: reasoning text: type: string title: text type: object required: - type - text title: reasoningPart ReasoningPartV4: properties: type: type: string const: reasoning title: type default: reasoning reasoning: type: string title: reasoning type: object required: - reasoning title: reasoningPartV4 AlgoliaRecommendToolIndexConfig: properties: index: type: string maxLength: 100 minLength: 1 title: index modelName: type: string maxLength: 100 minLength: 1 title: modelname description: type: string title: description default: '' type: object required: - index - modelName title: algoliaRecommendToolIndexConfig StepStartPartV5: properties: type: type: string const: step-start title: type default: step-start type: object title: stepStartPartV5 UserMessageMetadataV5: properties: turnContext: additionalProperties: true type: object title: turncontext additionalProperties: true type: object title: userMessageMetadataV5 description: 'Client-supplied metadata on a v5 user message. `turn_context` is namespaced so other callers can use `metadata` for unrelated purposes without collision. Unknown keys are preserved and ignored by this pipeline. Note: `turn_context` is deliberately typed `dict[str, Any]` (not `TurnContext`). The metadata is parsed eagerly with the request body, but cap/charset validation must be deferred to `extract_turn_context_v5` so the kill-switch (`TURN_CONTEXT_ENABLED=false`) can silently drop payloads instead of 422-ing. See `test_invalid_metadata_does_not_raise_at_model_construction`.' QueryType: type: string enum: - prefixLast - prefixAll - prefixNone title: queryType description: 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 search, use `prefixNone`. Avoid `prefixAll`, which treats all query words as prefixes. This might lead to counterintuitive results and makes your search slower. For more information, see [Prefix searching](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/in-depth/prefix-searching). ReasoningPartV5: properties: type: type: string const: reasoning title: type default: reasoning text: type: string title: text type: object required: - text title: reasoningPartV5 FacetFiltersUnion: oneOf: - items: $ref: '#/components/schemas/FacetFiltersUnion' type: array - type: string SearchParametersOverrides: properties: filters: type: string title: filters attributesToRetrieve: items: type: string type: array title: attributestoretrieve restrictSearchableAttributes: items: type: string type: array title: restrictsearchableattributes distinct: $ref: '#/components/schemas/DistinctUnion' userToken: type: string title: usertoken enablePersonalization: type: boolean title: enablepersonalization personalizationImpact: type: integer title: personalizationimpact optionalFilters: $ref: '#/components/schemas/OptionalFiltersUnion' additionalProperties: false type: object title: searchParametersOverrides description: '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 of SearchParameters of specific params we allow for runtime override.' CompatibilityMode: type: string enum: - ai-sdk-4 - ai-sdk-5 title: compatibilityMode description: Support Compatibility modes for the completion API. MemoryRecord: properties: memoryType: $ref: '#/components/schemas/MemoryType' episode: oneOf: - $ref: '#/components/schemas/Episode' - type: 'null' text: type: string maxLength: 2000 minLength: 1 title: text description: Self-contained, first-person memory for long-term recall. rawExtract: type: string maxLength: 5000 minLength: 1 title: rawextract description: Verbatim conversation extract, not paraphrased. keywords: items: type: string type: array title: keywords description: '5-20 free-form keywords: entities, context, search terms (any words).' topics: items: type: string type: array title: topics description: '2-4 topics ONLY from this list: [complaints, entertainment, family, feedback, finance, food, goals, health, history, hobbies, learning, praise, preferences, schedule, shopping, technical, travel, work].' _tags: items: type: string type: array title: tags description: Arbitrary labels/themes for flexible categorization (e.g., 'Q1-goals', 'paris-trip', 'vip-customer'). recallTriggers: items: type: string type: array title: recalltriggers description: 3-5 natural phrases that should trigger this memory. objectID: oneOf: - type: string - type: 'null' title: objectid description: ObjectID of existing memory to update. Leave empty for new memory. appId: type: string title: appid description: Application ID. default: '' agentIDs: items: type: string type: array title: agentids description: 'Agent IDs with access: [''agent1''], [''*''] for all, [''*'', ''-agent1''] to exclude.' userID: type: string title: userid description: User ID. default: '' createdAt: type: integer title: createdat description: Epoch seconds. default: 0 updatedAt: type: integer title: updatedat description: Epoch seconds. default: 0 type: object required: - text - rawExtract title: memoryRecord description: 'Universal storage model for all memory types (semantic, episodic). This is the ONLY model that touches storage (Algolia). Domain models (SemanticMemory, EpisodicMemory) are used for LLM extraction and converted to MemoryRecord before saving. See https://langchain-ai.github.io/langmem/concepts/conceptual_guide/#memory-types for memory type definitions.' LocationItemUnion: oneOf: - type: string - type: integer AgentStatus: type: string enum: - draft - published ReRankingApplyFilterUnion: oneOf: - type: string - items: type: object additionalProperties: true type: array - type: 'null' ExactOnSingleWordQuery: type: string enum: - attribute - none - word title: exactOnSingleWordQuery description: Determines how the [Exact ranking criterion](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/in-depth/adjust-exact-settings/#turn-off-exact-for-some-attributes) is computed when the search query has only one word. - `attribute`. The Exact ranking criterion is 1 if the query word and attribute value are the same. For example, a search for "road" will match the value "road", but not "road trip". - `none`. The Exact ranking criterion is ignored on single-word searches. - `word`. The Exact ranking criterion is 1 if the query word is found in the attribute value. The query word must have at least 3 characters and must not be a stop word. Only exact matches will be highlighted, partial and prefix matches won't. ToolResultOutput: properties: type: $ref: '#/components/schemas/ToolResultOutputType' value: title: value type: object required: - type - value title: toolResultOutput MemoryType: type: string enum: - semantic - episodic title: memoryType description: 'Memory types implemented so far. Follows LangMem''s ontology: https://langchain-ai.github.io/langmem/concepts/conceptual_guide/#memory-types.' AssistantMessageV5: properties: id: type: string title: id role: type: string const: assistant title: role default: assistant parts: items: $ref: '#/components/schemas/AssistantPartV5' type: array title: parts type: object title: assistantMessageV5 required: - role ToolInvocationsUnion: oneOf: - items: $ref: '#/components/schemas/ToolInvocationV4' type: array - type: 'null' AgentConfigUpdate: properties: name: oneOf: - type: string - type: 'null' title: name description: oneOf: - type: string - type: 'null' title: description providerId: oneOf: - type: string - type: 'null' title: providerid model: oneOf: - type: string - type: 'null' title: model instructions: oneOf: - type: string - type: 'null' title: instructions description: 'The agent prompt: defines the agent''s role, tone, and goals. Guides how it answers using the provided context. Corresponds to the ''Agent prompt'' field in the dashboard.' systemPrompt: oneOf: - type: string - type: 'null' title: systemprompt description: 'The system prompt: defines system-level rules and constraints. Guides how the agent uses tools, features, and generates context. Prepended before `instructions` in the final prompt sent to the LLM. Typically injected by an agent template — modify with caution, as changes may affect behavior, tool usage, or response accuracy. Corresponds to the ''System prompt'' field in the dashboard.' config: oneOf: - additionalProperties: true type: object - type: 'null' title: config tools: oneOf: - items: $ref: '#/components/schemas/ToolConfigInput' type: array - type: 'null' title: tools templateType: oneOf: - type: string - type: 'null' title: templatetype type: object title: agentConfigUpdate AgentIdUnion: oneOf: - type: string - const: test type: string ProviderInputNullable: oneOf: - $ref: '#/components/schemas/OpenAIProviderInput' - $ref: '#/components/schemas/AzureOpenAIProviderInput' - $ref: '#/components/schemas/OpenAICompatibleProviderInput' - $ref: '#/components/schemas/BaseProviderInput' - $ref: '#/components/schemas/AnthropicProviderInput' - type: 'null' AlternativesAsExactUnion: oneOf: - items: $ref: '#/components/schemas/AlternativesAsExact' type: array - type: 'null' ToolConfig: oneOf: - $ref: '#/components/schemas/McpToolConfig' - type: boolean TextPartV4: properties: type: type: string const: text title: type default: text text: type: string title: text type: object required: - text title: textPartV4 TypoToleranceEnum: type: string enum: - min - strict - 'true' - 'false' title: typoToleranceEnum description: '- `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 typos (with 1 typo), include matches with 1 typo (2 typos). - `strict`. Return matches with the two lowest numbers of typos. With `strict`, the Typo ranking criterion is applied first in the `ranking` setting.' AllowedDomainCreate: properties: domain: type: string title: domain description: Domain or pattern, e.g. https://app.example.com or *.example.com. type: object required: - domain title: allowedDomainCreate description: Request body to add a single allowed domain. AzureOpenAIProviderInput: properties: apiKey: type: string title: apikey azureEndpoint: type: string maxLength: 2083 minLength: 1 title: azureendpoint azureDeployment: type: string minLength: 1 title: azuredeployment description: Azure model deployment name is required. apiVersion: oneOf: - type: string - type: 'null' title: apiversion default: 2024-12-01-preview type: object required: - apiKey - azureEndpoint - azureDeployment title: azureOpenAIProviderInput description: Azure OpenAI-specific provider input. TypoToleranceUnion: oneOf: - type: boolean - $ref: '#/components/schemas/TypoToleranceEnum' - type: 'null' FeedbackCreationRequest: properties: messageId: type: string title: messageid agentId: type: string title: agentid vote: $ref: '#/components/schemas/VoteEnum' tags: items: type: string maxLength: 50 type: array maxItems: 10 title: tags notes: type: string maxLength: 1000 title: notes type: object required: - messageId - agentId - vote title: feedbackCreationRequest description: Request model for creating a feedback entry. OpenAICompatibleProviderInput: properties: apiKey: type: string title: apikey baseUrl: type: string maxLength: 2083 minLength: 1 title: baseurl defaultModel: type: string minLength: 1 title: defaultmodel description: Default model for this provider. Used for validation and as fallback when no model is specified at agent level. type: object required: - apiKey - baseUrl - defaultModel title: openAICompatibleProviderInput description: 'OpenAI-compatible provider input. Contrary to the OpenAIProviderInput, the base_url is required. A model is required to verify connectivity and get saved as the default model. This can later be changed at the Agent level.' NumberParamConstraint: properties: min: oneOf: - type: integer - type: 'null' title: min max: oneOf: - type: integer - type: 'null' title: max type: object title: numberParamConstraint description: Constraints for a number parameter. ToolResultOutputType: type: string enum: - text - json - error-text - error-json - content title: toolResultOutputType description: The valid 'type' of tool results. PaginationMetadata: properties: page: type: integer title: page limit: type: integer title: limit totalCount: type: integer title: totalcount totalPages: type: integer title: totalpages type: object required: - page - limit - totalCount - totalPages title: paginationMetadata UnknownToolConfig: properties: name: type: string maxLength: 32 minLength: 3 title: name type: type: string const: unknown title: type default: unknown additionalProperties: true type: object required: - type - name title: unknownToolConfig description: Exists only to ensure that when you change branch from toolX to feat/toolY, your config stays valid. QueryLanguagesUnion: oneOf: - items: $ref: '#/components/schemas/SupportedLanguage' type: array - type: 'null' McpToolConfig: properties: requiresApproval: oneOf: - type: boolean - type: 'null' title: requiresapproval default: false alias: oneOf: - type: string maxLength: 32 minLength: 3 - type: 'null' title: alias type: object title: mcpToolConfig AgentCompletionAlgoliaParams: properties: mcpServers: additionalProperties: additionalProperties: additionalProperties: type: string type: object type: object type: object title: mcpservers searchParameters: $ref: '#/components/schemas/SearchParametersOverridesMapNullable' type: object title: agentCompletionAlgoliaParams PaginatedConversationsResponse: properties: data: items: $ref: '#/components/schemas/ConversationBaseResponse' type: array title: data pagination: $ref: '#/components/schemas/PaginationMetadata' type: object required: - data - pagination title: paginatedConversationsResponse BaseProviderInput: properties: apiKey: type: string title: apikey type: object required: - apiKey title: baseProviderInput description: Base input that all providers must have. AllowedDomainBulkDelete: properties: domainIds: items: type: string type: array title: domainids description: IDs of allowed domain records to delete. type: object required: - domainIds title: allowedDomainBulkDelete description: Request body for bulk delete by IDs. McpServerToolConfig: properties: url: type: string maxLength: 512 minLength: 1 title: url transport: type: string const: streamable_http title: transport default: streamable_http headers: additionalProperties: type: string type: object title: headers name: type: string maxLength: 32 minLength: 3 title: name type: type: string const: mcp_tools title: type default: mcp_tools id: oneOf: - type: string - type: 'null' title: id description: Stable unique identifier for this MCP tool. allowedTools: $ref: '#/components/schemas/AllowedToolsUnion' type: object required: - type - url - headers - name title: mcpServerToolConfig ToolCallPart: properties: type: type: string const: tool-call title: type default: tool-call toolCallId: type: string title: toolcallid toolName: type: string title: toolname args: title: args requiresApproval: oneOf: - type: boolean - type: 'null' title: requiresapproval providerOptions: oneOf: - type: object additionalProperties: true - type: 'null' title: provideroptions type: object required: - type - toolCallId - toolName - args title: toolCallPart PaginatedAgentsResponse: properties: data: items: $ref: '#/components/schemas/AgentWithVersionResponse' type: array title: data pagination: $ref: '#/components/schemas/PaginationMetadata' type: object required: - data - pagination title: paginatedAgentsResponse AgentCompletionRequest: properties: configuration: $ref: '#/components/schemas/AgentTestConfiguration' messages: $ref: '#/components/schemas/MessagesUnion' id: type: string maxLength: 128 title: id description: Optional conversation id. algolia: $ref: '#/components/schemas/AgentCompletionAlgoliaParams' toolApprovals: type: object title: toolApprovals description: Approval decisions for pending tool calls keyed by toolCallId. type: object title: agentCompletionRequest description: Request model for creating a completion for an assistant. ConversationMetadata: properties: cachedAt: oneOf: - type: string - type: 'null' title: cachedat type: object title: conversationMetadata description: Public metadata exposed on conversation responses. OpenAIProviderInput: properties: apiKey: type: string title: apikey baseUrl: oneOf: - type: string maxLength: 2083 minLength: 1 - type: 'null' title: baseurl type: object required: - apiKey title: openAIProviderInput description: OpenAI-specific provider input. InsidePolygonUnion: oneOf: - type: string - items: items: type: number type: array type: array - type: 'null' StartStepPart: properties: type: type: string const: start-step title: type default: start-step type: object title: startStepPart required: - type ApplicationConfigPatch: properties: maxRetentionDays: oneOf: - type: integer - type: 'null' title: maxretentiondays description: 'Maximum number of days to retain data. Valid values: [0, 30, 60, 90].' default: 90 type: object title: applicationConfigPatch MessagesUnion: oneOf: - items: $ref: '#/components/schemas/MessageV4' type: array - items: $ref: '#/components/schemas/MessageV5' type: array - type: 'null' TextPart: properties: type: type: string const: text title: type default: text text: type: string title: text type: object required: - type - text title: textPart AlternativesAsExact: type: string enum: - ignorePlurals - singleWordSynonym - multiWordsSynonym - ignoreConjugations title: alternativesAsExact description: AlternativesAsExact. MessagePart: oneOf: - $ref: '#/components/schemas/TextPart' - $ref: '#/components/schemas/ToolCallPart' - $ref: '#/components/schemas/ToolResultPart' - $ref: '#/components/schemas/StartPart' - $ref: '#/components/schemas/StartStepPart' - $ref: '#/components/schemas/ReasoningPart' - $ref: '#/components/schemas/ToolApprovalRequestPart' discriminator: propertyName: type mapping: reasoning: '#/components/schemas/ReasoningPart' start: '#/components/schemas/StartPart' start-step: '#/components/schemas/StartStepPart' text: '#/components/schemas/TextPart' tool-approval-request: '#/components/schemas/ToolApprovalRequestPart' tool-call: '#/components/schemas/ToolCallPart' tool-result: '#/components/schemas/ToolResultPart' TextParam: properties: exposed: type: boolean title: exposed default: oneOf: - type: string - type: 'null' title: default type: object required: - exposed title: textParam description: A text search parameter with exposure control. UserMessageV4: properties: id: type: string title: id role: type: string const: user title: role default: user content: type: string title: content parts: items: $ref: '#/components/schemas/TextPartV4' type: array title: parts annotations: items: additionalProperties: true type: object type: array title: annotations type: object required: - role - content title: userMessageV4 HTTPValidationError: properties: detail: items: $ref: '#/components/schemas/ValidationError' type: array title: detail type: object title: hTTPValidationError AdvancedSyntaxFeatures: type: string enum: - exactPhrase - excludeWords title: advancedSyntaxFeatures description: AdvancedSyntaxFeatures. Episode: properties: observation: type: string maxLength: 5000 minLength: 1 title: observation description: What user wanted + key context (1-2 sentences). Include prior failed attempts if they informed the approach. thoughts: type: string maxLength: 5000 minLength: 1 title: thoughts description: WHY this approach was chosen, which constraints/preferences drove decisions (1-3 sentences). Capture reasoning that applies to similar future scenarios. action: type: string maxLength: 5000 minLength: 1 title: action description: 'What was done with PRECISE details (1-3 sentences). WITH tool calls: use arrow notation `tool(param:value) → feedback → tool(refined_param:new_value)`. WITHOUT tool calls: capture communication/workflow pattern.' result: type: string maxLength: 5000 minLength: 1 title: result description: 'Learned pattern + effectiveness (1-3 sentences). What worked and WHY it''s replicable. Note efficiency: multi-turn refinements, which results were relevant, what made final attempt succeed. Use strict `param:value` syntax for learnings. Format: ''For [context], use [param:value] because [reason]''.' type: object required: - observation - thoughts - action - result title: episode description: 'Episodic memory schema following LangMem''s OTAR pattern: Observation → Thoughts → Action → Result Captures complete interaction experiences for agent learning. See https://langchain-ai.github.io/langmem/concepts/conceptual_guide/#episodic-memory-past-experiences.' FacetsUnion: oneOf: - items: type: string type: array - $ref: '#/components/schemas/Facets' - type: 'null' SecretKeyResponse: properties: id: type: string title: id name: type: string title: name value: type: string title: value createdAt: type: string title: createdat updatedAt: type: string title: updatedat lastUsedAt: oneOf: - type: string - type: 'null' title: lastusedat isDefault: type: boolean title: isdefault default: false agentIds: items: type: string type: array title: agentids type: object required: - id - name - value - createdAt - updatedAt - lastUsedAt - agentIds title: secretKeyResponse ApplicationConfigResponse: properties: maxRetentionDays: type: integer title: maxretentiondays type: object required: - maxRetentionDays title: applicationConfigResponse ToolApprovalRequestPart: properties: type: type: string const: tool-approval-request title: type default: tool-approval-request toolCallId: type: string title: toolcallid toolName: type: string title: toolname args: title: args description: oneOf: - type: string - type: 'null' title: description providerOptions: oneOf: - type: object additionalProperties: true - type: 'null' title: provideroptions argsHash: oneOf: - type: string - type: 'null' title: argshash appId: oneOf: - type: string - type: 'null' title: appid type: object required: - type - toolCallId - toolName - args title: toolApprovalRequestPart AssistantPartV4: oneOf: - $ref: '#/components/schemas/StepStartPartV4' - $ref: '#/components/schemas/ReasoningPartV4' - $ref: '#/components/schemas/TextPartV4' - $ref: '#/components/schemas/ToolInvocationPartV4' FacetsParam: properties: exposed: type: boolean const: false title: exposed default: false default: oneOf: - items: type: string type: array - type: 'null' title: default type: object title: facetsParam description: A facets parameter that is always hidden from the LLM. TextPartV5: properties: type: type: string const: text title: type default: text text: type: string title: text type: object required: - text title: textPartV5 StepStartPartV4: properties: type: type: string const: step-start title: type default: step-start type: object title: stepStartPartV4 AssistantPartV5: oneOf: - $ref: '#/components/schemas/StepStartPartV5' - $ref: '#/components/schemas/TextPartV5' - $ref: '#/components/schemas/ReasoningPartV5' - $ref: '#/components/schemas/ToolPartV5' StringArrayParam: properties: exposed: type: boolean title: exposed default: oneOf: - items: type: string type: array - type: 'null' title: default constraint: oneOf: - $ref: '#/components/schemas/StringArrayParamConstraint' - type: 'null' merge: oneOf: - type: boolean - type: 'null' title: merge type: object required: - exposed title: stringArrayParam description: A string array search parameter with exposure control, constraints, and merge behavior. SupportedLanguage: type: string enum: - af - ar - az - bg - bn - ca - cs - cy - da - de - el - en - eo - es - et - eu - fa - fi - fo - fr - ga - gl - he - hi - hu - hy - id - is - it - ja - ka - kk - ko - ku - ky - lt - lv - mi - mn - mr - ms - mt - nb - nl - 'no' - ns - pl - ps - pt - pt-br - qu - ro - ru - sk - sq - sv - sw - ta - te - th - tl - tn - tr - tt - uk - ur - uz - zh title: supportedLanguage description: ISO code for a supported language. ClientSideToolConfig: properties: name: type: string maxLength: 32 minLength: 3 title: name type: type: string const: client_side title: type default: client_side description: type: string maxLength: 200 minLength: 1 title: description inputSchema: $ref: '#/components/schemas/ClientToolsArgsSchema' type: object required: - type - name - description - inputSchema title: clientSideToolConfig AlgoliaSearchToolConfig: properties: name: type: string maxLength: 32 minLength: 3 title: name type: type: string const: algolia_search_index title: type default: algolia_search_index indices: items: $ref: '#/components/schemas/AlgoliaSearchToolIndexConfig' type: array title: indices type: object required: - type - name - indices title: algoliaSearchToolConfig ProviderInput: oneOf: - $ref: '#/components/schemas/OpenAIProviderInput' - $ref: '#/components/schemas/AzureOpenAIProviderInput' - $ref: '#/components/schemas/OpenAICompatibleProviderInput' - $ref: '#/components/schemas/BaseProviderInput' - $ref: '#/components/schemas/AnthropicProviderInput' UserMessageV5: properties: id: type: string title: id role: type: string const: user title: role default: user parts: items: $ref: '#/components/schemas/TextPartV5' type: array title: parts metadata: $ref: '#/components/schemas/UserMessageMetadataV5' type: object title: userMessageV5 required: - role ProviderName: type: string enum: - openai - azure_openai - google_genai - deepseek - openai_compatible - anthropic title: providerName IndexSearchParameters: properties: query: oneOf: - $ref: '#/components/schemas/TextParam' - type: 'null' hitsPerPage: $ref: '#/components/schemas/NumberParam' page: $ref: '#/components/schemas/NumberParam' attributesToRetrieve: $ref: '#/components/schemas/StringArrayParam' responseFields: $ref: '#/components/schemas/StringArrayParam' facets: oneOf: - $ref: '#/components/schemas/FacetsParam' - type: 'null' custom: oneOf: - additionalProperties: true type: object - type: 'null' title: custom type: object title: indexSearchParameters description: 'Structured search parameters configuration for an Algolia index. Each parameter controls whether it is exposed to the LLM, its default value, optional constraints, and merge behavior.' SecretKeyPatch: properties: name: oneOf: - type: string maxLength: 128 minLength: 1 - type: 'null' title: name description: The new name of the secret key. agentIds: oneOf: - items: type: string type: array - type: 'null' title: agentids description: Updated list of agent IDs this secret key is associated with. type: object title: secretKeyPatch description: Secret key patch payload. parameters: Parameters: name: parameters in: query description: Query parameters to apply to the current query. schema: type: object additionalProperties: true PathInPath: name: path in: path description: Path of the endpoint, for example `1/newFeature`. required: true schema: type: string example: /keys responses: FeatureNotEnabled: description: This feature is not enabled on your Algolia account. content: application/json: schema: $ref: '#/components/schemas/ErrorBase' MethodNotAllowed: description: Method not allowed with this API key. content: application/json: schema: $ref: '#/components/schemas/ErrorBase' BadRequest: description: Bad request or request arguments. content: application/json: schema: $ref: '#/components/schemas/ErrorBase' IndexNotFound: description: Index not found. content: application/json: schema: $ref: '#/components/schemas/ErrorBase' securitySchemes: appId: type: apiKey in: header name: x-algolia-application-id description: Your Algolia application ID. apiKey: type: apiKey in: header name: x-algolia-api-key description: 'Your Algolia API key with the necessary permissions to make the request. Permissions are controlled through access control lists (ACL) and access restrictions. The required ACL to make a request is listed in each endpoint''s reference. ' x-beta: true x-timeouts: browser: connect: 25000 read: 25000 write: 25000 server: connect: 25000 read: 25000 write: 25000