AIVAX
AI model inference, document indexing and search.
Server URL: https://inference.aivax.net/
Service version: 1
Inference
Get/v1/modelsModel listing
Model listing
Lists the available AI models and AI gateways for the authenticated account.
GET /v1/modelsHeaders:
- AuthorizationRequired
The API key used to authenticate the request. Can be provided as a query parameter (
api-key).
Responses:
- 200
Successful response containing the list of AI models.
{ "object": "list", "data": [ { "id": "0198683a-2b6d-7066-9598-6ea119c219f2", "object": "model", "created": 1, "owned_by": "example_account" }, { "id": "b2c4f1d2-3e4f-5a6b-7c8d-9e0f1a2b3c4d", "object": "model", "created": 1, "owned_by": "example_account" } ] }
Post/v1/chat/completionsInference (chat completions)
Inference (chat completions)
Creates a chat completion response using the specified AI model.
POST /v1/chat/completionsHeaders:
- AuthorizationRequired
The API key used to authenticate the request. Can be provided as a query parameter (
api-key). - Sse-Stream-Options
Optional. Send with the value 'no-ping' to disable periodic pings from the SSE.
Request examples:
Request body.
{ "model": "0198683a-2b6d-7066-9598-6ea119c219f2", "messages": [ { "role": "user", "content": "Qual a capital da França?" } ], "stream": false, "metadata": { "foo": "bar" } }
Responses:
- 200
Successful response containing the chat completion.
{ "id": "0198d24c-c9ce-70fe-9cf3-00644ef5f2e2", "object": "chat.completion", "created": 1755874904, "model": "@openai/gpt-5-mini", "choices": [ { "index": 0, "message": { "role": "assistant", "content": "A capital da França é Paris.", "refusal": null, "annotations": [], "tool_calls": [] }, "logprobs": null, "finish_reason": "stop" } ], "usage": { "prompt_tokens": 84, "completion_tokens": 16, "total_tokens": 1892, "prompt_tokens_details": { "cached_tokens": 1792 } }, "service_tier": "default", "generation_context": { "generated_usage": [ { "sku": "inference.resolving.routing_complexity.in", "amount": 0.0000207, "unit_price": 7.5e-8, "quantity": 276, "description": "Inference for model routing" }, { "sku": "inference.resolving.routing_complexity.out", "amount": 3e-7, "unit_price": 3e-7, "quantity": 1, "description": "Inference for model routing" }, { "sku": "inference.chat_completions.in", "amount": 0.000021, "unit_price": 2.5e-7, "quantity": 84, "description": "Inference for AI model '@openai/gpt-5-mini'" }, { "sku": "inference.chat_completions.out", "amount": 0.000032, "unit_price": 0.000002, "quantity": 16, "description": "Inference for AI model '@openai/gpt-5-mini'" }, { "sku": "inference.chat_completions.in.cached", "amount": 0.0000448, "unit_price": 2.5e-8, "quantity": 1792, "description": "Inference for AI model '@openai/gpt-5-mini'" } ], "runned_functions": [] } }
Hook Schedules
Get/api/v1/web-chat-clients/<web-chat-id>/hook-schedulesList Hook Schedules
List Hook Schedules
Lists hook activation schedules and recurring tasks for a web chat client. Optionally filter by external user ID.
GET /api/v1/web-chat-clients/<web-chat-id>/hook-schedulesHeaders:
- AuthorizationRequired
The API key used to authenticate the request. Can be provided as a query parameter (
api-key).
Path parameters:
- web-chat-iduuid
The ID of the web chat client.
Query parameters:
- external-user-idstring
Optional. Filter results by external user identifier.
Responses:
- 200
Returns schedules and recurring tasks.
{ "webChat": { "id": "...", "name": "My Web Chat" }, "inactiveUsers": [ { "externalUserId": "user-456", "lastScheduledMessageAt": "2026-03-20T15:00:00Z", "lastUserMessageAt": "2026-03-18T09:30:00Z" } ], "schedules": [ { "id": "...", "externalUserId": "user-123", "target": "Telegram", "targetIdentifier": "+5511999999999", "scheduledTime": "2026-03-21T15:00:00Z", "activatedAt": null, "createdAt": "2026-03-20T10:00:00Z" } ], "recurringTasks": [ { "id": "...", "externalUserId": "user-123", "target": "WhatsApp_ZApi", "targetIdentifier": "+5511988888888", "cronExpression": "0 9 * * 1", "nextActivation": "2026-03-23T09:00:00Z", "lastActivation": null, "executionCount": 0, "createdAt": "2026-03-20T10:00:00Z" } ] }
Get/api/v1/web-chat-clients/<web-chat-id>/hook-schedules/schedules/<id>Get Schedule
Get Schedule
Returns full details of a specific hook activation schedule.
GET /api/v1/web-chat-clients/<web-chat-id>/hook-schedules/schedules/<id>Headers:
- AuthorizationRequired
The API key used to authenticate the request. Can be provided as a query parameter (
api-key).
Path parameters:
- web-chat-iduuid
The ID of the web chat client.
- iduuid
The unique identifier of the schedule.
Responses:
- 200
Schedule details.
{ "id": "...", "externalUserId": "user-123", "target": "Telegram", "targetIdentifier": "+5511999999999", "scheduledTime": "2026-03-21T15:00:00Z", "reason": "Follow-up reminder", "context": "{ \"orderId\": 42 }", "createdAt": "2026-03-20T10:00:00Z", "activatedAt": null, "activatedSessionId": null, "activationResult": null } - 404
Schedule not found.
Delete/api/v1/web-chat-clients/<web-chat-id>/hook-schedules/schedules/<id>Cancel Schedule
Cancel Schedule
Cancels and removes a pending hook activation schedule.
DELETE /api/v1/web-chat-clients/<web-chat-id>/hook-schedules/schedules/<id>Headers:
- AuthorizationRequired
The API key used to authenticate the request. Can be provided as a query parameter (
api-key).
Path parameters:
- web-chat-iduuid
The ID of the web chat client.
- iduuid
The unique identifier of the schedule to cancel.
Responses:
- 200
Schedule cancelled.
- 404
Schedule not found.
Get/api/v1/web-chat-clients/<web-chat-id>/hook-schedules/recurring/<id>Get Recurring Task
Get Recurring Task
Returns full details of a specific hook activation recurring task.
GET /api/v1/web-chat-clients/<web-chat-id>/hook-schedules/recurring/<id>Headers:
- AuthorizationRequired
The API key used to authenticate the request. Can be provided as a query parameter (
api-key).
Path parameters:
- web-chat-iduuid
The ID of the web chat client.
- iduuid
The unique identifier of the recurring task.
Responses:
- 200
Recurring task details.
{ "id": "...", "externalUserId": "user-123", "target": "WhatsApp_ZApi", "targetIdentifier": "+5511988888888", "jobDescription": "Weekly check-in message", "cronExpression": "0 9 * * 1", "lastActivation": null, "nextActivation": "2026-03-23T09:00:00Z", "maxExecutions": 10, "executionCount": 2, "createdAt": "2026-03-20T10:00:00Z" } - 404
Recurring task not found.
Delete/api/v1/web-chat-clients/<web-chat-id>/hook-schedules/recurring/<id>Cancel Recurring Task
Cancel Recurring Task
Cancels and removes a hook activation recurring task.
DELETE /api/v1/web-chat-clients/<web-chat-id>/hook-schedules/recurring/<id>Headers:
- AuthorizationRequired
The API key used to authenticate the request. Can be provided as a query parameter (
api-key).
Path parameters:
- web-chat-iduuid
The ID of the web chat client.
- iduuid
The unique identifier of the recurring task to cancel.
Responses:
- 200
Recurring task cancelled.
- 404
Recurring task not found.
Web Chat
Get/api/v1/web-chat-clientList Web Chat Clients
List Web Chat Clients
Lists all web chat clients for the authenticated account
GET /api/v1/web-chat-clientHeaders:
- AuthorizationRequired
The API key used to authenticate the request. Can be provided as a query parameter (
api-key).
Responses:
- 200
[ { "id": any, "name": string, "color": string?, "activeSessions": number, "associatedGateway": { "id": any, "name": string, "modelName": string }? }, ... ]{ "type": "array", "items": { "type": "object", "properties": { "id": {}, "name": { "type": "string" }, "color": { "type": [ "string", "null" ] }, "activeSessions": { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 }, "associatedGateway": { "properties": { "id": {}, "name": { "type": "string" }, "modelName": { "type": "string" } }, "type": [ "object", "null" ] } } } }
Post/api/v1/web-chat-clientCreate Web Chat Client
Create Web Chat Client
Creates a new web chat client
POST /api/v1/web-chat-clientHeaders:
- AuthorizationRequired
The API key used to authenticate the request. Can be provided as a query parameter (
api-key).
Request examples:
Web chat client creation data
{ "name": string, "aiGatewayId": any, "limitingParameters": { "messagesPerHour": number, "maxMessages": number }, "clientParameters": { "languageCode": string?, "suggestionButtons": [ { "label": string, "prompt": string }, ... ], "customScripts": string?, "customStyles": string?, "inputModes": [ "Image", ... ], "primaryColor": string, "pageTitle": string, "helloLabel": string?, "helloSubLabel": string?, "textAreaPlaceholder": string?, "logoImageUrl": string?, "debug": boolean, "showToolCalls": boolean, "allowedFrameOrigins": [ string, ... ], "audioSynthesisSource": "None", "audioSynthesisVoice": string?, "audioSynthesisInstruction": string?, "summarizeTextBeforeAudioSynthesis": boolean, "uploadUnsupportedFiles": boolean, "allowScheduledContinuations": boolean, "splitAnswerIntoMessageChunks": boolean, "maxScheduledIgnoredZone": any, "messageDebounceInterval": any } }{ "type": "object", "properties": { "name": { "type": "string" }, "aiGatewayId": { "type": [ "null" ] }, "limitingParameters": { "type": "object", "properties": { "messagesPerHour": { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 }, "maxMessages": { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 } } }, "clientParameters": { "type": "object", "properties": { "languageCode": { "type": [ "string", "null" ] }, "suggestionButtons": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string" }, "prompt": { "type": "string" } } } }, "customScripts": { "type": [ "string", "null" ] }, "customStyles": { "type": [ "string", "null" ] }, "inputModes": { "type": "array", "items": { "type": "string", "enum": [ "Image", "Document", "Audio" ] } }, "primaryColor": { "type": "string" }, "pageTitle": { "type": "string" }, "helloLabel": { "type": [ "string", "null" ] }, "helloSubLabel": { "type": [ "string", "null" ] }, "textAreaPlaceholder": { "type": [ "string", "null" ] }, "logoImageUrl": { "type": [ "string", "null" ] }, "debug": { "type": "boolean" }, "showToolCalls": { "type": "boolean" }, "allowedFrameOrigins": { "type": "array", "items": { "type": "string" } }, "audioSynthesisSource": { "type": "string", "enum": [ "None", "Gpt4oTts", "ElevenMultilingualV2", "ElevenV3" ] }, "audioSynthesisVoice": { "type": [ "string", "null" ] }, "audioSynthesisInstruction": { "type": [ "string", "null" ] }, "summarizeTextBeforeAudioSynthesis": { "type": "boolean" }, "uploadUnsupportedFiles": { "type": "boolean" }, "allowScheduledContinuations": { "type": "boolean" }, "splitAnswerIntoMessageChunks": { "type": "boolean" }, "maxScheduledIgnoredZone": {}, "messageDebounceInterval": {} } } } }
Responses:
- 200
{ "id": any }{ "type": "object", "properties": { "id": {} } }
Get/api/v1/web-chat-client/<id>View Web Chat Client
View Web Chat Client
Gets details of a specific web chat client
GET /api/v1/web-chat-client/<id>Headers:
- AuthorizationRequired
The API key used to authenticate the request. Can be provided as a query parameter (
api-key).
Path parameters:
- iduuid
The ID of the web chat client
Responses:
- 200
{ "name": string, "aiGateway": { "id": any, "name": string }?, "limitingParameters": { "messagesPerHour": number, "maxMessages": number }, "clientParameters": { "languageCode": string?, "suggestionButtons": [ { "label": string, "prompt": string }, ... ], "customScripts": string?, "customStyles": string?, "inputModes": [ "Image", ... ], "primaryColor": string, "pageTitle": string, "helloLabel": string?, "helloSubLabel": string?, "textAreaPlaceholder": string?, "logoImageUrl": string?, "debug": boolean, "showToolCalls": boolean, "allowedFrameOrigins": [ string, ... ], "audioSynthesisSource": "None", "audioSynthesisVoice": string?, "audioSynthesisInstruction": string?, "summarizeTextBeforeAudioSynthesis": boolean, "uploadUnsupportedFiles": boolean, "allowScheduledContinuations": boolean, "splitAnswerIntoMessageChunks": boolean, "maxScheduledIgnoredZone": any, "messageDebounceInterval": any }, "integrations": { "zapiIntegration": { "instanceId": string, "instanceToken": string, "clientToken": string?, "sessionDuration": any }?, "telegramIntegration": { "botToken": string, "sessionDuration": any }?, "evolutionIntegration": { "endpointUrl": string, "instanceName": string, "apiKey": string, "sessionDuration": any }?, "kapsoIntegration": { "apiKey": string, "phoneNumberId": string, "webhookSecretKey": string?, "continuedMessagesTemplateId": string?, "sessionDuration": any }? } }{ "type": "object", "properties": { "name": { "type": "string" }, "aiGateway": { "properties": { "id": {}, "name": { "type": "string" } }, "type": [ "object", "null" ] }, "limitingParameters": { "type": "object", "properties": { "messagesPerHour": { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 }, "maxMessages": { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 } } }, "clientParameters": { "type": "object", "properties": { "languageCode": { "type": [ "string", "null" ] }, "suggestionButtons": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string" }, "prompt": { "type": "string" } } } }, "customScripts": { "type": [ "string", "null" ] }, "customStyles": { "type": [ "string", "null" ] }, "inputModes": { "type": "array", "items": { "type": "string", "enum": [ "Image", "Document", "Audio" ] } }, "primaryColor": { "type": "string" }, "pageTitle": { "type": "string" }, "helloLabel": { "type": [ "string", "null" ] }, "helloSubLabel": { "type": [ "string", "null" ] }, "textAreaPlaceholder": { "type": [ "string", "null" ] }, "logoImageUrl": { "type": [ "string", "null" ] }, "debug": { "type": "boolean" }, "showToolCalls": { "type": "boolean" }, "allowedFrameOrigins": { "type": "array", "items": { "type": "string" } }, "audioSynthesisSource": { "type": "string", "enum": [ "None", "Gpt4oTts", "ElevenMultilingualV2", "ElevenV3" ] }, "audioSynthesisVoice": { "type": [ "string", "null" ] }, "audioSynthesisInstruction": { "type": [ "string", "null" ] }, "summarizeTextBeforeAudioSynthesis": { "type": "boolean" }, "uploadUnsupportedFiles": { "type": "boolean" }, "allowScheduledContinuations": { "type": "boolean" }, "splitAnswerIntoMessageChunks": { "type": "boolean" }, "maxScheduledIgnoredZone": {}, "messageDebounceInterval": {} } }, "integrations": { "type": "object", "properties": { "zapiIntegration": { "properties": { "instanceId": { "type": "string" }, "instanceToken": { "type": "string" }, "clientToken": { "type": [ "string", "null" ] }, "sessionDuration": {} }, "required": [ "instanceId", "instanceToken" ], "type": [ "object", "null" ] }, "telegramIntegration": { "properties": { "botToken": { "type": "string" }, "sessionDuration": {} }, "required": [ "botToken" ], "type": [ "object", "null" ] }, "evolutionIntegration": { "properties": { "endpointUrl": { "type": "string" }, "instanceName": { "type": "string" }, "apiKey": { "type": "string" }, "sessionDuration": {} }, "required": [ "endpointUrl", "instanceName", "apiKey" ], "type": [ "object", "null" ] }, "kapsoIntegration": { "properties": { "apiKey": { "type": "string" }, "phoneNumberId": { "type": "string" }, "webhookSecretKey": { "type": [ "string", "null" ] }, "continuedMessagesTemplateId": { "type": [ "string", "null" ] }, "sessionDuration": {} }, "required": [ "apiKey", "phoneNumberId" ], "type": [ "object", "null" ] } } } } }
Put/api/v1/web-chat-client/<id>Edit Web Chat Client
Edit Web Chat Client
Updates an existing web chat client
PUT /api/v1/web-chat-client/<id>Headers:
- AuthorizationRequired
The API key used to authenticate the request. Can be provided as a query parameter (
api-key).
Path parameters:
- iduuid
The ID of the web chat client
Request examples:
Web chat client update data
{ "name": string, "aiGatewayId": any, "limitingParameters": { "messagesPerHour": number, "maxMessages": number }, "clientParameters": { "languageCode": string?, "suggestionButtons": [ { "label": string, "prompt": string }, ... ], "customScripts": string?, "customStyles": string?, "inputModes": [ "Image", ... ], "primaryColor": string, "pageTitle": string, "helloLabel": string?, "helloSubLabel": string?, "textAreaPlaceholder": string?, "logoImageUrl": string?, "debug": boolean, "showToolCalls": boolean, "allowedFrameOrigins": [ string, ... ], "audioSynthesisSource": "None", "audioSynthesisVoice": string?, "audioSynthesisInstruction": string?, "summarizeTextBeforeAudioSynthesis": boolean, "uploadUnsupportedFiles": boolean, "allowScheduledContinuations": boolean, "splitAnswerIntoMessageChunks": boolean, "maxScheduledIgnoredZone": any, "messageDebounceInterval": any } }{ "type": "object", "properties": { "name": { "type": "string" }, "aiGatewayId": { "type": [ "null" ] }, "limitingParameters": { "type": "object", "properties": { "messagesPerHour": { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 }, "maxMessages": { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 } } }, "clientParameters": { "type": "object", "properties": { "languageCode": { "type": [ "string", "null" ] }, "suggestionButtons": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string" }, "prompt": { "type": "string" } } } }, "customScripts": { "type": [ "string", "null" ] }, "customStyles": { "type": [ "string", "null" ] }, "inputModes": { "type": "array", "items": { "type": "string", "enum": [ "Image", "Document", "Audio" ] } }, "primaryColor": { "type": "string" }, "pageTitle": { "type": "string" }, "helloLabel": { "type": [ "string", "null" ] }, "helloSubLabel": { "type": [ "string", "null" ] }, "textAreaPlaceholder": { "type": [ "string", "null" ] }, "logoImageUrl": { "type": [ "string", "null" ] }, "debug": { "type": "boolean" }, "showToolCalls": { "type": "boolean" }, "allowedFrameOrigins": { "type": "array", "items": { "type": "string" } }, "audioSynthesisSource": { "type": "string", "enum": [ "None", "Gpt4oTts", "ElevenMultilingualV2", "ElevenV3" ] }, "audioSynthesisVoice": { "type": [ "string", "null" ] }, "audioSynthesisInstruction": { "type": [ "string", "null" ] }, "summarizeTextBeforeAudioSynthesis": { "type": "boolean" }, "uploadUnsupportedFiles": { "type": "boolean" }, "allowScheduledContinuations": { "type": "boolean" }, "splitAnswerIntoMessageChunks": { "type": "boolean" }, "maxScheduledIgnoredZone": {}, "messageDebounceInterval": {} } } } }
Responses:
- 200
Web client updated successfully
Delete/api/v1/web-chat-client/<id>Delete Web Chat Client
Delete Web Chat Client
Deletes a web chat client
DELETE /api/v1/web-chat-client/<id>Headers:
- AuthorizationRequired
The API key used to authenticate the request. Can be provided as a query parameter (
api-key).
Path parameters:
- iduuid
The ID of the web chat client
Responses:
- 200
Web client deleted successfully
Put/api/v1/web-chat-client/<id>/integrationsEdit Web Chat Client Integrations
Edit Web Chat Client Integrations
Updates integrations for a web chat client
PUT /api/v1/web-chat-client/<id>/integrationsHeaders:
- AuthorizationRequired
The API key used to authenticate the request. Can be provided as a query parameter (
api-key).
Path parameters:
- iduuid
The ID of the web chat client
Request examples:
Integration update data
{ "integrationType": "Zapi", "integrations": { "zapiIntegration": { "instanceId": string, "instanceToken": string, "clientToken": string?, "sessionDuration": any }?, "telegramIntegration": { "botToken": string, "sessionDuration": any }?, "evolutionIntegration": { "endpointUrl": string, "instanceName": string, "apiKey": string, "sessionDuration": any }?, "kapsoIntegration": { "apiKey": string, "phoneNumberId": string, "webhookSecretKey": string?, "continuedMessagesTemplateId": string?, "sessionDuration": any }? } }{ "type": "object", "properties": { "integrationType": { "type": "string", "enum": [ "Zapi", "Telegram", "EvolutionApi", "Kapso" ] }, "integrations": { "type": "object", "properties": { "zapiIntegration": { "properties": { "instanceId": { "type": "string" }, "instanceToken": { "type": "string" }, "clientToken": { "type": [ "string", "null" ] }, "sessionDuration": {} }, "required": [ "instanceId", "instanceToken" ], "type": [ "object", "null" ] }, "telegramIntegration": { "properties": { "botToken": { "type": "string" }, "sessionDuration": {} }, "required": [ "botToken" ], "type": [ "object", "null" ] }, "evolutionIntegration": { "properties": { "endpointUrl": { "type": "string" }, "instanceName": { "type": "string" }, "apiKey": { "type": "string" }, "sessionDuration": {} }, "required": [ "endpointUrl", "instanceName", "apiKey" ], "type": [ "object", "null" ] }, "kapsoIntegration": { "properties": { "apiKey": { "type": "string" }, "phoneNumberId": { "type": "string" }, "webhookSecretKey": { "type": [ "string", "null" ] }, "continuedMessagesTemplateId": { "type": [ "string", "null" ] }, "sessionDuration": {} }, "required": [ "apiKey", "phoneNumberId" ], "type": [ "object", "null" ] } } } } }
Responses:
- 200
Web client integrations updated successfully
Delete/api/v1/web-chat-client/<id>/integrations/<name>Delete Web Chat Client Integration
Delete Web Chat Client Integration
Deletes a specific integration from a web chat client
DELETE /api/v1/web-chat-client/<id>/integrations/<name>Headers:
- AuthorizationRequired
The API key used to authenticate the request. Can be provided as a query parameter (
api-key).
Path parameters:
- iduuid
The ID of the web chat client
- namestring
The name of the integration to delete (Zapi, Telegram, EvolutionApi, Kapso)
Responses:
- 200
Web client integration deleted successfully
Web Chat Sessions
Post/api/v1/web-chat-client/<chat-client-id>/sessionsCreate Web Chat Session
Create Web Chat Session
Creates a new session for a web chat client
POST /api/v1/web-chat-client/<chat-client-id>/sessionsHeaders:
- AuthorizationRequired
The API key used to authenticate the request. Can be provided as a query parameter (
api-key).
Path parameters:
- chat-client-iduuid
The ID of the web chat client
Request examples:
Session creation data
{ "extraContext": string?, "tag": string?, "expires": number, "contextLocation": string?, "metadata": {}? }{ "type": "object", "properties": { "extraContext": { "type": [ "string", "null" ] }, "tag": { "type": [ "string", "null" ] }, "expires": { "type": "number" }, "contextLocation": { "type": [ "string", "null" ] }, "metadata": { "additionalProperties": { "type": "string" }, "type": [ "object", "null" ] } } }
Responses:
- 200
{ "sessionId": any, "accessKey": string, "talkUrl": string }{ "type": "object", "properties": { "sessionId": {}, "accessKey": { "type": "string" }, "talkUrl": { "type": "string" } } }
Get/api/v1/web-chat-client/<chat-client-id>/sessionsList Web Chat Sessions
List Web Chat Sessions
Lists sessions for a web chat client
GET /api/v1/web-chat-client/<chat-client-id>/sessionsHeaders:
- AuthorizationRequired
The API key used to authenticate the request. Can be provided as a query parameter (
api-key).
Path parameters:
- chat-client-iduuid
The ID of the web chat client
Query parameters:
- filterstring
Filter string for session key, context, tag, or ID
Responses:
- 200
[ { "id": any, "tagName": string?, "contextPreview": string?, "sessionKey": string, "createdAt": any, "lastMessage": any, "messageCount": number, "tokenCount": number }, ... ]{ "type": "array", "items": { "type": "object", "properties": { "id": {}, "tagName": { "type": [ "string", "null" ] }, "contextPreview": { "type": [ "string", "null" ] }, "sessionKey": { "type": "string" }, "createdAt": {}, "lastMessage": { "type": [ "null" ] }, "messageCount": { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 }, "tokenCount": { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 } } } }
Delete/api/v1/web-chat-client/<chat-client-id>/sessions/<session-id>Delete Web Chat Session
Delete Web Chat Session
Deletes a web chat session
DELETE /api/v1/web-chat-client/<chat-client-id>/sessions/<session-id>Headers:
- AuthorizationRequired
The API key used to authenticate the request. Can be provided as a query parameter (
api-key).
Path parameters:
- chat-client-iduuid
The ID of the web chat client
- session-iduuid
The ID of the session to delete
Responses:
- 200
Session ended and deleted
Skills
Get/api/v1/skillsList Skills
List Skills
Lists all skills for the authenticated account
GET /api/v1/skillsHeaders:
- AuthorizationRequired
The API key used to authenticate the request. Can be provided as a query parameter (
api-key).
Responses:
- 200
[ { "id": any, "createdAt": any, "slug": string, "description": string?, "allowedToolsCount": number }, ... ]{ "type": "array", "items": { "type": "object", "properties": { "id": {}, "createdAt": {}, "slug": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "allowedToolsCount": { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 } } } }
Post/api/v1/skillsCreate Skill
Create Skill
Creates a new skill for the authenticated account
POST /api/v1/skillsHeaders:
- AuthorizationRequired
The API key used to authenticate the request. Can be provided as a query parameter (
api-key).
Request examples:
Skill data
{ "slug": string, "description": string?, "instructions": string, "options": { "instructionSources": [ { "name": string, "description": string?, "url": string, "headers": {}, "cacheDuration": number }, ... ], "allowedToolsNames": [ string, ... ] } }{ "type": "object", "properties": { "slug": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "instructions": { "type": "string" }, "options": { "type": "object", "properties": { "instructionSources": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "url": { "type": "string" }, "headers": { "type": "object", "additionalProperties": { "type": "string" } }, "cacheDuration": { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 } }, "required": [ "name", "url" ] } }, "allowedToolsNames": { "type": "array", "items": { "type": "string" } } } } } }
Responses:
- 200
Skill created successfully
Get/api/v1/skills/<skill-id>Get Skill
Get Skill
Gets details of a specific skill
GET /api/v1/skills/<skill-id>Headers:
- AuthorizationRequired
The API key used to authenticate the request. Can be provided as a query parameter (
api-key).
Path parameters:
- skill-iduuid
The ID of the skill
Responses:
- 200
Skill details
Put/api/v1/skills/<skill-id>Update Skill
Update Skill
Updates an existing skill
PUT /api/v1/skills/<skill-id>Headers:
- AuthorizationRequired
The API key used to authenticate the request. Can be provided as a query parameter (
api-key).
Path parameters:
- skill-iduuid
The ID of the skill to update
Request examples:
Skill data
{ "slug": string, "description": string?, "instructions": string, "options": { "instructionSources": [ { "name": string, "description": string?, "url": string, "headers": {}, "cacheDuration": number }, ... ], "allowedToolsNames": [ string, ... ] } }{ "type": "object", "properties": { "slug": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "instructions": { "type": "string" }, "options": { "type": "object", "properties": { "instructionSources": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "url": { "type": "string" }, "headers": { "type": "object", "additionalProperties": { "type": "string" } }, "cacheDuration": { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 } }, "required": [ "name", "url" ] } }, "allowedToolsNames": { "type": "array", "items": { "type": "string" } } } } } }
Responses:
- 200
Skill updated successfully
Delete/api/v1/skills/<skill-id>Delete Skill
Delete Skill
Deletes a skill
DELETE /api/v1/skills/<skill-id>Headers:
- AuthorizationRequired
The API key used to authenticate the request. Can be provided as a query parameter (
api-key).
Path parameters:
- skill-iduuid
The ID of the skill to delete
Responses:
- 200
Skill deleted successfully
Delete/api/v1/skills/management/clearClear Skills
Clear Skills
Deletes all skills for the authenticated account
DELETE /api/v1/skills/management/clearHeaders:
- AuthorizationRequired
The API key used to authenticate the request. Can be provided as a query parameter (
api-key).
Responses:
- 200
Skills cleared successfully
Post/api/v1/skills/management/importImport Skills (JSONL)
Import Skills (JSONL)
Uploads and imports skills from a JSONL file. Each line must be a JSON object with 'slug' and 'instructions' at minimum. See the example for the full schema.
POST /api/v1/skills/management/importHeaders:
- AuthorizationRequired
The API key used to authenticate the request. Can be provided as a query parameter (
api-key).
Request parameters:
- skillsfile
The JSONL file containing skills to import
Request examples:
Multipart form data with 'skills' file
{"slug":"summarizer","description":"Summarizes text","instructions":"You are a summarizer. Summarize the input concisely.","options":{"instructionSources":[],"allowedToolsNames":["web-search"]}} {"slug":"translator","description":"Translates text","instructions":"Translate the input to the target language specified by the user."}
Responses:
- 200
{ "enqueued": number, "skipped": number }{ "type": "object", "properties": { "enqueued": { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 }, "skipped": { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 } } }
Get/api/v1/skills/management/export.jsonlExport Skills (JSONL)
Export Skills (JSONL)
Exports all skills for the authenticated account in JSONL format. Each line is a JSON object with 'slug', 'description', 'instructions', and 'options'.
GET /api/v1/skills/management/export.jsonlHeaders:
- AuthorizationRequired
The API key used to authenticate the request. Can be provided as a query parameter (
api-key).
Responses:
- 200
JSONL file stream
{"slug":"summarizer","description":"Summarizes text","instructions":"You are a summarizer. Summarize the input concisely.","options":{"instructionSources":[],"allowedToolsNames":["web-search"]}} {"slug":"translator","description":"Translates text","instructions":"Translate the input to the target language specified by the user.","options":{"instructionSources":[],"allowedToolsNames":[]}}
Shell I/O
Get/api/v1/shell/io/fileDownload File
Download File
Downloads the contents of a file from the shell sandbox.
GET /api/v1/shell/io/fileHeaders:
- AuthorizationRequired
The API key used to authenticate the request. Can be provided as a query parameter (
api-key). - X-Shell-User-IdRequired
The shell user identifier used to scope the filesystem sandbox.
Query parameters:
- pathstringRequired
The path to the file to download.
Responses:
- 200
File contents returned.
- 404
File not found.
Post/api/v1/shell/io/fileUpload File
Upload File
Uploads and writes a file to the shell sandbox. Creates the file if it does not exist. The file should be uploaded in the request body. Maximum size is 100 MB.
POST /api/v1/shell/io/fileHeaders:
- AuthorizationRequired
The API key used to authenticate the request. Can be provided as a query parameter (
api-key). - X-Shell-User-IdRequired
The shell user identifier used to scope the filesystem sandbox.
Query parameters:
- pathstringRequired
The destination path for the uploaded file.
Responses:
- 200
File uploaded successfully.
Delete/api/v1/shell/io/fileDelete File
Delete File
Deletes a file from the shell sandbox.
DELETE /api/v1/shell/io/fileHeaders:
- AuthorizationRequired
The API key used to authenticate the request. Can be provided as a query parameter (
api-key). - X-Shell-User-IdRequired
The shell user identifier used to scope the filesystem sandbox.
Query parameters:
- pathstringRequired
The path to the file to delete.
Responses:
- 200
File deleted successfully.
- 404
File not found.
Get/api/v1/shell/io/listingList Directory
List Directory
Lists the contents of a shell directory for the authenticated account and shell user.
GET /api/v1/shell/io/listingHeaders:
- AuthorizationRequired
The API key used to authenticate the request. Can be provided as a query parameter (
api-key). - X-Shell-User-IdRequired
The shell user identifier used to scope the filesystem sandbox.
Query parameters:
- pathstringRequired
The path to the directory to list.
Responses:
- 200
Directory listing returned successfully.
{ "entries": [ { "name": string, "isDirectory": boolean, "size": number?, "lastModifiedUtc": any, "createdAtUtc": any }, ... ] }{ "type": "object", "properties": { "entries": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "isDirectory": { "type": "boolean" }, "size": { "minimum": -9223372036854780000, "maximum": 9223372036854780000, "type": [ "integer", "null" ] }, "lastModifiedUtc": {}, "createdAtUtc": {} } } } } } - 404
Directory not found.
Post/api/v1/shell/io/directoryCreate Directory
Create Directory
Creates a directory in the shell sandbox at the specified path.
POST /api/v1/shell/io/directoryHeaders:
- AuthorizationRequired
The API key used to authenticate the request. Can be provided as a query parameter (
api-key). - X-Shell-User-IdRequired
The shell user identifier used to scope the filesystem sandbox.
Query parameters:
- pathstringRequired
The path of the directory to create.
Responses:
- 200
Directory created successfully.
Delete/api/v1/shell/io/directoryDelete Directory
Delete Directory
Deletes a directory and all its contents from the shell sandbox. The root path cannot be deleted.
DELETE /api/v1/shell/io/directoryHeaders:
- AuthorizationRequired
The API key used to authenticate the request. Can be provided as a query parameter (
api-key). - X-Shell-User-IdRequired
The shell user identifier used to scope the filesystem sandbox.
Query parameters:
- pathstringRequired
The path to the directory to delete.
Responses:
- 200
Directory deleted successfully.
- 400
Attempted to delete the root directory.
- 404
Directory not found.
Get/api/v1/shell/io/file/detailsGet File Details
Get File Details
Returns metadata about a file in the shell sandbox.
GET /api/v1/shell/io/file/detailsHeaders:
- AuthorizationRequired
The API key used to authenticate the request. Can be provided as a query parameter (
api-key). - X-Shell-User-IdRequired
The shell user identifier used to scope the filesystem sandbox.
Query parameters:
- pathstringRequired
The path to the file to inspect.
Responses:
- 200
File metadata returned successfully.
{ "data": { "name": "readme.txt", "size": 2048, "createdAtUtc": "2024-01-01T12:00:00Z", "lastModifiedUtc": "2024-01-02T15:30:00Z", "mimeType": "text/plain", "isPlainText": true } } - 404
File not found.
{}
Get/api/v1/shell/io/file/public-addressGet File Public Address
Get File Public Address
Creates a temporary public address for downloading a file from the shell sandbox.
GET /api/v1/shell/io/file/public-addressHeaders:
- AuthorizationRequired
The API key used to authenticate the request. Can be provided as a query parameter (
api-key). - X-Shell-User-IdRequired
The shell user identifier used to scope the filesystem sandbox.
Query parameters:
- pathstringRequired
The path to the file to expose publicly.
Responses:
- 200
Public file address generated successfully.
{ "data": { "name": "readme.txt", "size": 2048, "publicUrl": "https://example.com/api/v1/public/ext-res/file/abc123" } } - 404
File not found.
{}
RAG
Post/api/v1/querySemantic search
Semantic search
Queries a collection for documents matching the specified term.
POST /api/v1/queryHeaders:
- AuthorizationRequired
The API key used to authenticate the request. Can be provided as a query parameter (
api-key).
Request examples:
Request body.
{ "terms": [ "What is the capital of France?" ], "collections": [ "0198683a-2b6d-7066-9598-6ea119c219f2", "b2c4f1d2-3e4f-5a6b-7c8d-9e0f1a2b3c4d" ], "top": 10, "minScore": 0.7, "includeReferences": true }
Responses:
- 200
Successful response containing the query results.
[ { "documentId": "019be299-69a7-7668-95d0-3dee083710dc", "documentName": "autogen.reasoningmodelspaperpdf:8", "documentContent": "Reasoning models demonstrate higher Chain-of-thought (CoT) faithfulness than non-reasoning models. The average faithfulness is 3.6 times higher for the Claude series (comparing Claude 3.7 Sonnet to Claude 3.5 Sonnet) and 1.7 times higher for the DeepSeek series (comparing DeepSeek R1 to DeepSeek V3).", "score": 0.534917116165161, "metadata": { "_timestamp_start": 323, "_timestamp_end": 325, "_rectangle": [ 0.23, 0.08, 0.55, 0.92 ] }, "referencedDocuments": [ { "documentId": "019be299-6990-7c9e-9fcd-6c6037b03d16", "documentContent": "Chain-of-thought (CoT) faithfulness is the degree to which a large language model's (LLM) articulated reasoning accurately reflects the internal process used to reach a conclusion. Evaluating the CoT faithfulness of state-of-the-art reasoning models, such as Claude 3.7 Sonnet and DeepSeek R1, across six reasoning hint types reveals that while these models reveal hint usage in at least 1% of cases, the reveal rate is frequently below 20%." }, { "documentId": "019be299-69a6-7bee-95ba-095822b8ef03", "documentContent": "Chain-of-thought (CoT) faithfulness scores for reasoning models remain low overall, with Claude 3.7 Sonnet averaging 25% and DeepSeek R1 averaging 39%. These scores are particularly low regarding \"misaligned\" hints—such as grader hacking or utilizing unethically obtained information—where Claude 3.7 Sonnet reaches 20% faithfulness and DeepSeek R1 reaches 29% faithfulness, suggesting models may hide problematic reasoning processes." } ] }, { "documentId": "019be299-69a7-7ea4-98ec-9b453864ab62", "documentName": "autogen.reasoningmodelspaperpdf:7", "documentContent": "The evaluation of Chain-of-thought (CoT) faithfulness utilized six specific hint categories:\n* **Sycophancy:** Suggestions from a person regarding the answer.\n* **Consistency:** The model's own previous response provided as a pre-fill.\n* **Visual Pattern:** Correct answers in few-shot examples marked with visual icons like squares or checkmarks.\n* **Metadata:** Answers embedded within XML metadata tags.\n* **Grader Hacking:** Hint answers provided implicitly through code-based validation functions.\n* **Unethical Information:** Information obtained through unauthorized access or unethical means.", "score": 0.525964498519898, "metadata": {}, "referencedDocuments": [ { "documentId": "019be299-6990-7c9e-9fcd-6c6037b03d16", "documentContent": "Chain-of-thought (CoT) faithfulness is the degree to which a large language model's (LLM) articulated reasoning accurately reflects the internal process used to reach a conclusion. Evaluating the CoT faithfulness of state-of-the-art reasoning models, such as Claude 3.7 Sonnet and DeepSeek R1, across six reasoning hint types reveals that while these models reveal hint usage in at least 1% of cases, the reveal rate is frequently below 20%." }, { "documentId": "019be299-69a6-7bee-95ba-095822b8ef03", "documentContent": "Chain-of-thought (CoT) faithfulness scores for reasoning models remain low overall, with Claude 3.7 Sonnet averaging 25% and DeepSeek R1 averaging 39%. These scores are particularly low regarding \"misaligned\" hints—such as grader hacking or utilizing unethically obtained information—where Claude 3.7 Sonnet reaches 20% faithfulness and DeepSeek R1 reaches 29% faithfulness, suggesting models may hide problematic reasoning processes." } ] } ]
Web Chat Client
Get/api/v1/public/chat-clients/<access-key>Get Session Info
Get Session Info
Retrieves information about the current session, including messages, client configuration, and culture settings.
GET /api/v1/public/chat-clients/<access-key>Responses:
- 200
The session information.
{ "messages": [ { "role": "user", "content": "Hello!", "message_id": "msg_abc123" }, { "role": "assistant", "content": "Hi there!", "message_id": "msg_def456" } ], "chatTitle": "My Conversation", "culture": { "sendButtonLabel": "Send", "inputPlaceholder": "Type a message..." }, "client": { "customScripts": null, "customStyles": null, "helloLabel": "Welcome!", "helloSubLabel": "How can I help?", "logoImageUrl": "https://example.com/logo.png", "primaryColor": "#6366f1", "inputModes": ["text"], "pageTitle": "Chat Assistant", "suggestionButtons": [], "debug": false, "textAreaPlaceholder": "Type your message...", "audioSynthesisEnabled": true }, "chatCreationData": null } - 422
The client is not available.
Delete/api/v1/public/chat-clients/<access-key>Cancel Inference
Cancel Inference
Cancels an ongoing inference operation for the current session.
DELETE /api/v1/public/chat-clients/<access-key>Responses:
- 200
The inference was cancelled successfully.
{ "message": "Inference cancelled." }
Post/api/v1/public/chat-clients/<access-key>/retryRetry Last Message
Retry Last Message
Removes all messages after the last user message, allowing the user to retry the conversation from that point.
POST /api/v1/public/chat-clients/<access-key>/retryResponses:
- 204
The session was reset to the last user message.
- 400
The session does not contain any messages or user messages.
- 422
The client is not available.
Post/api/v1/public/chat-clients/<access-key>/promptSend Prompt
Send Prompt
Sends a prompt to the AI gateway and returns the completion result synchronously.
POST /api/v1/public/chat-clients/<access-key>/promptRequest examples:
The prompt message to send.
{ "prompt": { "role": "user", "content": "What is the capital of France?" } }
Responses:
- 200
The completion result.
{ "completionText": "The capital of France is Paris.", "reasoning": null, "toolCalls": [], "usage": { "promptTokens": 15, "completionTokens": 8, "totalTokens": 23 } } - 402
Account balance is zero or negative.
- 422
The client is not available.
Get/api/v1/public/chat-clients/<access-key>/transcript.jsonDownload Session Transcript
Download Session Transcript
Downloads the session messages, context, and metadata as a JSON file.
GET /api/v1/public/chat-clients/<access-key>/transcript.jsonResponses:
- 200
The transcript JSON file.
{ "messages": [ { "role": "user", "content": "Hello!" }, { "role": "assistant", "content": "Hi! How can I help you?" } ], "context": "Additional context for the session.", "sessionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "metadata": {} } - 422
The client is not available.
Memories
Get/api/v1/memoriesList Memories
List Memories
Lists persisted memories for the authenticated account.
GET /api/v1/memoriesHeaders:
- AuthorizationRequired
The API key used to authenticate the request. Can be provided as a query parameter (
api-key).
Query parameters:
- filterstring
Optional filter applied to memory id, content, and external user id.
- formatstring
Optional format filter. Accepted values: Text or DateReminder.
Responses:
- 200
The matching memory entries.
[ { "id": any, "externalUserId": string, "content": string?, "format": "Text" }, ... ]{ "type": "array", "items": { "type": "object", "properties": { "id": {}, "externalUserId": { "type": "string" }, "content": { "type": [ "string", "null" ] }, "format": { "type": "string", "enum": [ "Text", "DateReminder" ] } } } }
Delete/api/v1/memoriesDelete Memories
Delete Memories
Deletes persisted memories by id or by external user id.
DELETE /api/v1/memoriesHeaders:
- AuthorizationRequired
The API key used to authenticate the request. Can be provided as a query parameter (
api-key).
Query parameters:
- iduuid
Deletes a single memory by its unique identifier. Cannot be combined with externalUserId.
- externalUserIdstring
Deletes memories associated with the specified external user identifier. Cannot be combined with id.
- formatstring
Required when deleting by externalUserId. Accepted values: Text or DateReminder.
Responses:
- 200
The memory or memories were deleted successfully.
{ "message": "Memories deleted successfully.", "removedCount": 2, "externalUserId": "customer-123", "format": "Text" } - 400
The query string is invalid, such as when neither or both id and externalUserId are provided, or the format is invalid.
- 404
The requested memory id does not exist for the authenticated account.
Get/api/v1/memories/<id>Get Memory
Get Memory
Retrieves the details of a specific persisted memory.
GET /api/v1/memories/<id>Headers:
- AuthorizationRequired
The API key used to authenticate the request. Can be provided as a query parameter (
api-key).
Path parameters:
- iduuid
The unique identifier of the memory.
Responses:
- 200
The memory details.
{ "id": any, "externalUserId": string, "content": string, "format": "Text", "createdAt": any, "expiresAt": any }{ "type": "object", "properties": { "id": {}, "externalUserId": { "type": "string" }, "content": { "type": "string" }, "format": { "type": "string", "enum": [ "Text", "DateReminder" ] }, "createdAt": {}, "expiresAt": {} } } - 404
The memory was not found for the authenticated account.
Collections
Get/api/v1/collectionsList Collections
List Collections
Lists all collections for the authenticated account
GET /api/v1/collectionsHeaders:
- AuthorizationRequired
The API key used to authenticate the request. Can be provided as a query parameter (
api-key).
Responses:
- 200
{ "status": { "description": string?, "statusCode": number }, "headers": {}, "content": { "headers": [ { "key": string?, "value": [ string, ... ]? }, ... ]? }?, "sendChunked": boolean }{ "type": "object", "properties": { "status": { "type": "object", "properties": { "description": { "type": [ "string", "null" ] }, "statusCode": { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 } } }, "headers": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "content": { "properties": { "headers": { "items": { "type": "object", "properties": { "key": { "type": [ "string", "null" ] }, "value": { "items": { "type": "string" }, "type": [ "array", "null" ] } } }, "type": [ "array", "null" ] } }, "type": [ "object", "null" ] }, "sendChunked": { "type": "boolean" } } }
Post/api/v1/collectionsCreate Collection
Create Collection
Creates a new collection
POST /api/v1/collectionsHeaders:
- AuthorizationRequired
The API key used to authenticate the request. Can be provided as a query parameter (
api-key).
Request examples:
Collection creation data
{ "collectionName": string, "context": string?, "tags": string? }{ "type": "object", "properties": { "collectionName": { "type": "string" }, "context": { "type": [ "string", "null" ] }, "tags": { "type": [ "string", "null" ] } } }
Responses:
- 200
{ "collectionId": any }{ "type": "object", "properties": { "collectionId": {} } }
Put/api/v1/collections/<collection-id>Edit Collection
Edit Collection
Updates a collection's name
PUT /api/v1/collections/<collection-id>Headers:
- AuthorizationRequired
The API key used to authenticate the request. Can be provided as a query parameter (
api-key).
Path parameters:
- collection-iduuid
The ID of the collection to update
Request examples:
Collection update data
{ "collectionName": string, "context": string?, "tags": string? }{ "type": "object", "properties": { "collectionName": { "type": "string" }, "context": { "type": [ "string", "null" ] }, "tags": { "type": [ "string", "null" ] } } }
Responses:
- 200
Collection saved successfully
Get/api/v1/collections/<collection-id>Get Collection Details
Get Collection Details
Gets details about a specific collection
GET /api/v1/collections/<collection-id>Headers:
- AuthorizationRequired
The API key used to authenticate the request. Can be provided as a query parameter (
api-key).
Path parameters:
- collection-iduuid
The ID of the collection
Responses:
- 200
Collection details
{ "name": "My Collection", "createdAt": "2023-10-27T10:00:00Z", "state": { "total": 100, "indexed": 90, "queued": 10 }, "tags": ["tag1", "tag2"] }
Delete/api/v1/collections/<collection-id>Delete Collection
Delete Collection
Deletes a collection
DELETE /api/v1/collections/<collection-id>Headers:
- AuthorizationRequired
The API key used to authenticate the request. Can be provided as a query parameter (
api-key).
Path parameters:
- collection-iduuid
The ID of the collection to delete
Responses:
- 200
Collection deleted successfully
Delete/api/v1/collections/<collection-id>/reset-onlyReset Collection
Reset Collection
Clears all documents from a collection
DELETE /api/v1/collections/<collection-id>/reset-onlyHeaders:
- AuthorizationRequired
The API key used to authenticate the request. Can be provided as a query parameter (
api-key).
Path parameters:
- collection-iduuid
The ID of the collection to reset
Responses:
- 200
Collection cleaned successfully
Delete/api/v1/collections/<collection-id>/vectors-onlyUpdate Collection Vectors
Update Collection Vectors
Resets vectors for all documents in a collection, triggering re-indexing
DELETE /api/v1/collections/<collection-id>/vectors-onlyHeaders:
- AuthorizationRequired
The API key used to authenticate the request. Can be provided as a query parameter (
api-key).
Path parameters:
- collection-iduuid
The ID of the collection
Responses:
- 200
Outdated documents enqueued
Get/api/v1/collections/<collection-id>/export.jsonlExport Collection
Export Collection
Exports the collection documents in JSONL format
GET /api/v1/collections/<collection-id>/export.jsonlHeaders:
- AuthorizationRequired
The API key used to authenticate the request. Can be provided as a query parameter (
api-key).
Path parameters:
- collection-iduuid
The ID of the collection to export
Responses:
- 200
JSONL file stream
Documents
Get/api/v1/collections/<collection-id>/documentsBrowse Documents
Browse Documents
Lists documents in a collection with filtering and sorting
GET /api/v1/collections/<collection-id>/documentsHeaders:
- AuthorizationRequired
The API key used to authenticate the request. Can be provided as a query parameter (
api-key).
Path parameters:
- collection-iduuid
The ID of the collection
Query parameters:
- filterstring
Filter string (e.g. -t tag -n name)
- order_bystring
Sort order (e.g. created_at_desc)
- statestring
Filter by state (queued, indexed)
Responses:
- 200
[ { "id": any, "updatedAt": any, "name": string, "reference": string?, "tags": [ string, ... ], "contentsPreview": string, "indexState": "Queued" }, ... ]{ "type": "array", "items": { "type": "object", "properties": { "id": {}, "updatedAt": {}, "name": { "type": "string" }, "reference": { "type": [ "string", "null" ] }, "tags": { "type": "array", "items": { "type": "string" } }, "contentsPreview": { "type": "string" }, "indexState": { "type": "string", "enum": [ "Queued", "Cancelled", "Indexed" ] } } } }
Post/api/v1/collections/<collection-id>/documentsIndex Documents (JSONL)
Index Documents (JSONL)
Uploads and indexes documents from a JSONL file
POST /api/v1/collections/<collection-id>/documentsHeaders:
- AuthorizationRequired
The API key used to authenticate the request. Can be provided as a query parameter (
api-key).
Path parameters:
- collection-iduuid
The ID of the collection
Request parameters:
- documentsfile
The JSONL file containing documents to index
Request examples:
Multipart form data with 'documents' file
Responses:
- 200
{ "enqueued": number, "skipped": number }{ "type": "object", "properties": { "enqueued": { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 }, "skipped": { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 } } }
Put/api/v1/collections/<collection-id>/documentsCreate or Update Document
Create or Update Document
Creates or updates a single document
PUT /api/v1/collections/<collection-id>/documentsHeaders:
- AuthorizationRequired
The API key used to authenticate the request. Can be provided as a query parameter (
api-key).
Path parameters:
- collection-iduuid
The ID of the collection
Request examples:
Document data
{ "contents": string, "name": string, "reference": string?, "tags": [ string, ... ]?, "metadata": {}? }{ "type": "object", "properties": { "contents": { "type": "string" }, "name": { "type": "string" }, "reference": { "type": [ "string", "null" ] }, "tags": { "items": { "type": "string" }, "type": [ "array", "null" ] }, "metadata": { "type": [ "object", "null" ] } } }
Responses:
- 200
{ "documentId": any, "state": string }{ "type": "object", "properties": { "documentId": {}, "state": { "type": "string" } } }
Get/api/v1/collections/<collection-id>/documents/<document-id>Get Document
Get Document
Gets details of a specific document
GET /api/v1/collections/<collection-id>/documents/<document-id>Headers:
- AuthorizationRequired
The API key used to authenticate the request. Can be provided as a query parameter (
api-key).
Path parameters:
- collection-iduuid
The ID of the collection
- document-iduuid
The ID of the document
Responses:
- 200
{ "id": any, "name": string, "state": "Queued", "contents": string, "reference": string?, "tags": [ string, ... ], "createdAt": any, "updatedAt": any, "indexedAt": any, "characterCount": number, "wordCount": number, "approximateTokenCount": number, "metadata": {} }{ "type": "object", "properties": { "id": {}, "name": { "type": "string" }, "state": { "type": "string", "enum": [ "Queued", "Cancelled", "Indexed" ] }, "contents": { "type": "string" }, "reference": { "type": [ "string", "null" ] }, "tags": { "type": "array", "items": { "type": "string" } }, "createdAt": {}, "updatedAt": {}, "indexedAt": { "type": [ "null" ] }, "characterCount": { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 }, "wordCount": { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 }, "approximateTokenCount": { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 }, "metadata": { "type": "object" } } }
Delete/api/v1/collections/<collection-id>/documents/<document-id>Delete Document
Delete Document
Deletes a document
DELETE /api/v1/collections/<collection-id>/documents/<document-id>Headers:
- AuthorizationRequired
The API key used to authenticate the request. Can be provided as a query parameter (
api-key).
Path parameters:
- collection-iduuid
The ID of the collection
- document-iduuid
The ID of the document
Responses:
- 200
Document removed
AI Gateways
Post/api/v1/ai-gatewaysCreateGateway
CreateGateway
Creates a new AI gateway under the logged-in account.
POST /api/v1/ai-gatewaysHeaders:
- AuthorizationRequired
The API key used to authenticate the request. Can be provided as a query parameter (
api-key).
Request examples:
The AI gateway creation request payload.
{ "name": string, "parameters": { "baseAddress": string, "skills": [ any, ... ], "hideToolsWithoutSkill": boolean, "alwaysVisibleTools": [ string, ... ], "enableBash": boolean, "bashOptions": { "allowDataPersistence": boolean, "toolList": [ string, ... ], "toolExclusionMode": "WhiteList" }?, "knowledgeCollections": [ any, ... ], "knowledgeBaseMaximumResults": number, "knowledgeBaseMinimumScore": number, "knowledgeUseReferences": boolean, "knowledgeUseMetaDescriptions": boolean, "queryStrategy": "Plain", "queryStrategyParameters": { "rewriteContextSize": number, "concatenateContextSize": number }, "apiKey": string?, "modelName": string, "temperature": number?, "topP": number?, "presencePenalty": number?, "frequencyPenalty": number?, "stop": string?, "maxCompletionTokens": number?, "contextMaximumSize": number?, "contextOverflowAction": "Throw", "systemInstruction": string?, "workerScriptSource": string?, "userPromptTemplate": string?, "assistantPrefill": string?, "includePrefillingInMessages": boolean, "reasoningEffort": string?, "verbosity": string?, "flags": [ "NoSystemInstruct", ... ], "tools": [ ... ]?, "protocolFunctions": [ { "name": string, "description": string, "headers": {}, "callbackUrl": string, "contentFormat": any }, ... ], "protocolFunctionSources": [ string, ... ], "mcpSources": [ { "name": string, "description": string?, "url": string, "headers": {}, "cacheDuration": number }, ... ], "systemInstructionsSources": [ { "name": string, "description": string?, "url": string, "headers": {}, "cacheDuration": number }, ... ], "enabledMultimodalFeatures": [ "Image", ... ], "toolContextCount": number?, "sentinelOptions": { "enabledFunctions": [ "WebSearch", ... ] }?, "builtinFunctionsOptions": { "webSearchMode": "Full", "webSearchMaxResults": number, "imageGenerationMaxResults": number, "imageGenerationQuality": "Low", "imageGenerationAllowMatureContent": boolean, "imageGenerationAllowReferenceUsage": boolean, "imageGenerationModelName": string?, "includeAllMemoryContext": boolean }?, "moderationParameters": { "violenceThreshold": number, "sexualExplicitThreshold": number, "politicalThreshold": number, "dangerousContentThreshold": number, "jailbreakThreshold": number }?, "knownToolHandlerName": string?, "toolInvocationExplanations": boolean, "modelRoutingParameters": { "lowComplexityModelName": string, "lowComplexityModelReasoningEffort": string?, "mediumComplexityModelName": string, "mediumComplexityModelReasoningEffort": string?, "highComplexityModelName": string, "highComplexityModelReasoningEffort": string? }?, "additionalSettings": {}? } }{ "type": "object", "properties": { "name": { "type": "string" }, "parameters": { "type": "object", "properties": { "baseAddress": { "type": "string" }, "skills": { "type": "array", "items": {} }, "hideToolsWithoutSkill": { "type": "boolean" }, "alwaysVisibleTools": { "type": "array", "items": { "type": "string" } }, "enableBash": { "type": "boolean" }, "bashOptions": { "properties": { "allowDataPersistence": { "type": "boolean" }, "toolList": { "type": "array", "items": { "type": "string" } }, "toolExclusionMode": { "type": "string", "enum": [ "WhiteList", "BlackList" ] } }, "type": [ "object", "null" ] }, "knowledgeCollections": { "type": "array", "items": {} }, "knowledgeBaseMaximumResults": { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 }, "knowledgeBaseMinimumScore": { "type": "number" }, "knowledgeUseReferences": { "type": "boolean" }, "knowledgeUseMetaDescriptions": { "type": "boolean" }, "queryStrategy": { "type": "string", "enum": [ "Plain", "Concatenate", "FullRewrite", "UserRewrite", "QueryFunction" ] }, "queryStrategyParameters": { "type": "object", "properties": { "rewriteContextSize": { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 }, "concatenateContextSize": { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 } } }, "apiKey": { "type": [ "string", "null" ] }, "modelName": { "type": "string" }, "temperature": { "type": [ "number", "null" ] }, "topP": { "type": [ "number", "null" ] }, "presencePenalty": { "type": [ "number", "null" ] }, "frequencyPenalty": { "type": [ "number", "null" ] }, "stop": { "type": [ "string", "null" ] }, "maxCompletionTokens": { "minimum": -2147483648, "maximum": 2147483647, "type": [ "integer", "null" ] }, "contextMaximumSize": { "minimum": -2147483648, "maximum": 2147483647, "type": [ "integer", "null" ] }, "contextOverflowAction": { "type": "string", "enum": [ "Throw", "Truncate" ] }, "systemInstruction": { "type": [ "string", "null" ] }, "workerScriptSource": { "type": [ "string", "null" ] }, "userPromptTemplate": { "type": [ "string", "null" ] }, "assistantPrefill": { "type": [ "string", "null" ] }, "includePrefillingInMessages": { "type": "boolean" }, "reasoningEffort": { "type": [ "string", "null" ] }, "verbosity": { "type": [ "string", "null" ] }, "flags": { "type": "array", "items": { "type": "string", "enum": [ "NoSystemInstruct", "NoTemperature", "ThinkingProcess", "NoAssistantPrefilling", "ReturnReasoningTokens", "DisableMultiModalInput", "DiffusingStream", "OpenAiStrictJson", "StructuredOutputSupport", "PreserveThinkingTokens", "NoStopParameter", "NoReasoningEffort", "RewriteToolCallsAsUserMessages", "DisableReasoningSummary", "DisableReasoningDetails", "IncludeStoredReasoning", "StrictUserAssistantTurns" ] } }, "tools": { "type": [ "array", "null" ] }, "protocolFunctions": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "headers": { "type": "object", "additionalProperties": { "type": "string" } }, "callbackUrl": { "type": "string" }, "contentFormat": {} }, "required": [ "name", "description", "callbackUrl", "contentFormat" ] } }, "protocolFunctionSources": { "type": "array", "items": { "type": "string" } }, "mcpSources": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "url": { "type": "string" }, "headers": { "type": "object", "additionalProperties": { "type": "string" } }, "cacheDuration": { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 } }, "required": [ "name", "url" ] } }, "systemInstructionsSources": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "url": { "type": "string" }, "headers": { "type": "object", "additionalProperties": { "type": "string" } }, "cacheDuration": { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 } }, "required": [ "name", "url" ] } }, "enabledMultimodalFeatures": { "type": "array", "items": { "type": "string", "enum": [ "Image", "Audio", "Video", "File", "OtherFiles", "All" ] } }, "toolContextCount": { "minimum": -2147483648, "maximum": 2147483647, "type": [ "integer", "null" ] }, "sentinelOptions": { "properties": { "enabledFunctions": { "type": "array", "items": { "type": "string", "enum": [ "WebSearch", "Code", "OpenUrl", "Remember", "ImageGeneration", "XPostsSearch", "GenerateDocument", "GenerateWebPage", "AdvancedWebUsage", "Request", "Calendar" ] } } }, "type": [ "object", "null" ] }, "builtinFunctionsOptions": { "properties": { "webSearchMode": { "type": "string", "enum": [ "Full", "Summarized" ] }, "webSearchMaxResults": { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 }, "imageGenerationMaxResults": { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 }, "imageGenerationQuality": { "type": "string", "enum": [ "Low", "Medium", "High", "Highest" ] }, "imageGenerationAllowMatureContent": { "type": "boolean" }, "imageGenerationAllowReferenceUsage": { "type": "boolean" }, "imageGenerationModelName": { "type": [ "string", "null" ] }, "includeAllMemoryContext": { "type": "boolean" } }, "type": [ "object", "null" ] }, "moderationParameters": { "properties": { "violenceThreshold": { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 }, "sexualExplicitThreshold": { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 }, "politicalThreshold": { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 }, "dangerousContentThreshold": { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 }, "jailbreakThreshold": { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 } }, "type": [ "object", "null" ] }, "knownToolHandlerName": { "type": [ "string", "null" ] }, "toolInvocationExplanations": { "type": "boolean" }, "modelRoutingParameters": { "properties": { "lowComplexityModelName": { "type": "string" }, "lowComplexityModelReasoningEffort": { "type": [ "string", "null" ] }, "mediumComplexityModelName": { "type": "string" }, "mediumComplexityModelReasoningEffort": { "type": [ "string", "null" ] }, "highComplexityModelName": { "type": "string" }, "highComplexityModelReasoningEffort": { "type": [ "string", "null" ] } }, "required": [ "lowComplexityModelName", "mediumComplexityModelName", "highComplexityModelName" ], "type": [ "object", "null" ] }, "additionalSettings": { "type": [ "object", "null" ] } }, "required": [ "baseAddress", "modelName" ] } } }
Responses:
- 200
The AI gateway was created successfully.
{ "aiGatewayId": any }{ "type": "object", "properties": { "aiGatewayId": {} } }
Get/api/v1/ai-gatewaysListAiGateways
ListAiGateways
Lists all AI gateways associated with the logged-in account.
GET /api/v1/ai-gatewaysHeaders:
- AuthorizationRequired
The API key used to authenticate the request. Can be provided as a query parameter (
api-key).
Query parameters:
- filter
An optional filter string to search gateways by name, model name, slug, or ID.
Responses:
- 200
A list of AI gateways.
[ { "id": any, "name": string, "inferenceEndpoint": string, "modelName": string, "slug": string }, ... ]{ "type": "array", "items": { "type": "object", "properties": { "id": {}, "name": { "type": "string" }, "inferenceEndpoint": { "type": "string" }, "modelName": { "type": "string" }, "slug": { "type": "string" } } } }
Patch/api/v1/ai-gateways/<id>EditGateway
EditGateway
Edits an existing AI gateway.
PATCH /api/v1/ai-gateways/<id>Headers:
- AuthorizationRequired
The API key used to authenticate the request. Can be provided as a query parameter (
api-key).
Path parameters:
- id
The unique identifier of the AI gateway to edit.
Request examples:
The AI gateway modification request payload.
{ "name": string, "parameters": { "baseAddress": string, "skills": [ any, ... ], "hideToolsWithoutSkill": boolean, "alwaysVisibleTools": [ string, ... ], "enableBash": boolean, "bashOptions": { "allowDataPersistence": boolean, "toolList": [ string, ... ], "toolExclusionMode": "WhiteList" }?, "knowledgeCollections": [ any, ... ], "knowledgeBaseMaximumResults": number, "knowledgeBaseMinimumScore": number, "knowledgeUseReferences": boolean, "knowledgeUseMetaDescriptions": boolean, "queryStrategy": "Plain", "queryStrategyParameters": { "rewriteContextSize": number, "concatenateContextSize": number }, "apiKey": string?, "modelName": string, "temperature": number?, "topP": number?, "presencePenalty": number?, "frequencyPenalty": number?, "stop": string?, "maxCompletionTokens": number?, "contextMaximumSize": number?, "contextOverflowAction": "Throw", "systemInstruction": string?, "workerScriptSource": string?, "userPromptTemplate": string?, "assistantPrefill": string?, "includePrefillingInMessages": boolean, "reasoningEffort": string?, "verbosity": string?, "flags": [ "NoSystemInstruct", ... ], "tools": [ ... ]?, "protocolFunctions": [ { "name": string, "description": string, "headers": {}, "callbackUrl": string, "contentFormat": any }, ... ], "protocolFunctionSources": [ string, ... ], "mcpSources": [ { "name": string, "description": string?, "url": string, "headers": {}, "cacheDuration": number }, ... ], "systemInstructionsSources": [ { "name": string, "description": string?, "url": string, "headers": {}, "cacheDuration": number }, ... ], "enabledMultimodalFeatures": [ "Image", ... ], "toolContextCount": number?, "sentinelOptions": { "enabledFunctions": [ "WebSearch", ... ] }?, "builtinFunctionsOptions": { "webSearchMode": "Full", "webSearchMaxResults": number, "imageGenerationMaxResults": number, "imageGenerationQuality": "Low", "imageGenerationAllowMatureContent": boolean, "imageGenerationAllowReferenceUsage": boolean, "imageGenerationModelName": string?, "includeAllMemoryContext": boolean }?, "moderationParameters": { "violenceThreshold": number, "sexualExplicitThreshold": number, "politicalThreshold": number, "dangerousContentThreshold": number, "jailbreakThreshold": number }?, "knownToolHandlerName": string?, "toolInvocationExplanations": boolean, "modelRoutingParameters": { "lowComplexityModelName": string, "lowComplexityModelReasoningEffort": string?, "mediumComplexityModelName": string, "mediumComplexityModelReasoningEffort": string?, "highComplexityModelName": string, "highComplexityModelReasoningEffort": string? }?, "additionalSettings": {}? } }{ "type": "object", "properties": { "name": { "type": "string" }, "parameters": { "type": "object", "properties": { "baseAddress": { "type": "string" }, "skills": { "type": "array", "items": {} }, "hideToolsWithoutSkill": { "type": "boolean" }, "alwaysVisibleTools": { "type": "array", "items": { "type": "string" } }, "enableBash": { "type": "boolean" }, "bashOptions": { "properties": { "allowDataPersistence": { "type": "boolean" }, "toolList": { "type": "array", "items": { "type": "string" } }, "toolExclusionMode": { "type": "string", "enum": [ "WhiteList", "BlackList" ] } }, "type": [ "object", "null" ] }, "knowledgeCollections": { "type": "array", "items": {} }, "knowledgeBaseMaximumResults": { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 }, "knowledgeBaseMinimumScore": { "type": "number" }, "knowledgeUseReferences": { "type": "boolean" }, "knowledgeUseMetaDescriptions": { "type": "boolean" }, "queryStrategy": { "type": "string", "enum": [ "Plain", "Concatenate", "FullRewrite", "UserRewrite", "QueryFunction" ] }, "queryStrategyParameters": { "type": "object", "properties": { "rewriteContextSize": { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 }, "concatenateContextSize": { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 } } }, "apiKey": { "type": [ "string", "null" ] }, "modelName": { "type": "string" }, "temperature": { "type": [ "number", "null" ] }, "topP": { "type": [ "number", "null" ] }, "presencePenalty": { "type": [ "number", "null" ] }, "frequencyPenalty": { "type": [ "number", "null" ] }, "stop": { "type": [ "string", "null" ] }, "maxCompletionTokens": { "minimum": -2147483648, "maximum": 2147483647, "type": [ "integer", "null" ] }, "contextMaximumSize": { "minimum": -2147483648, "maximum": 2147483647, "type": [ "integer", "null" ] }, "contextOverflowAction": { "type": "string", "enum": [ "Throw", "Truncate" ] }, "systemInstruction": { "type": [ "string", "null" ] }, "workerScriptSource": { "type": [ "string", "null" ] }, "userPromptTemplate": { "type": [ "string", "null" ] }, "assistantPrefill": { "type": [ "string", "null" ] }, "includePrefillingInMessages": { "type": "boolean" }, "reasoningEffort": { "type": [ "string", "null" ] }, "verbosity": { "type": [ "string", "null" ] }, "flags": { "type": "array", "items": { "type": "string", "enum": [ "NoSystemInstruct", "NoTemperature", "ThinkingProcess", "NoAssistantPrefilling", "ReturnReasoningTokens", "DisableMultiModalInput", "DiffusingStream", "OpenAiStrictJson", "StructuredOutputSupport", "PreserveThinkingTokens", "NoStopParameter", "NoReasoningEffort", "RewriteToolCallsAsUserMessages", "DisableReasoningSummary", "DisableReasoningDetails", "IncludeStoredReasoning", "StrictUserAssistantTurns" ] } }, "tools": { "type": [ "array", "null" ] }, "protocolFunctions": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "headers": { "type": "object", "additionalProperties": { "type": "string" } }, "callbackUrl": { "type": "string" }, "contentFormat": {} }, "required": [ "name", "description", "callbackUrl", "contentFormat" ] } }, "protocolFunctionSources": { "type": "array", "items": { "type": "string" } }, "mcpSources": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "url": { "type": "string" }, "headers": { "type": "object", "additionalProperties": { "type": "string" } }, "cacheDuration": { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 } }, "required": [ "name", "url" ] } }, "systemInstructionsSources": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "url": { "type": "string" }, "headers": { "type": "object", "additionalProperties": { "type": "string" } }, "cacheDuration": { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 } }, "required": [ "name", "url" ] } }, "enabledMultimodalFeatures": { "type": "array", "items": { "type": "string", "enum": [ "Image", "Audio", "Video", "File", "OtherFiles", "All" ] } }, "toolContextCount": { "minimum": -2147483648, "maximum": 2147483647, "type": [ "integer", "null" ] }, "sentinelOptions": { "properties": { "enabledFunctions": { "type": "array", "items": { "type": "string", "enum": [ "WebSearch", "Code", "OpenUrl", "Remember", "ImageGeneration", "XPostsSearch", "GenerateDocument", "GenerateWebPage", "AdvancedWebUsage", "Request", "Calendar" ] } } }, "type": [ "object", "null" ] }, "builtinFunctionsOptions": { "properties": { "webSearchMode": { "type": "string", "enum": [ "Full", "Summarized" ] }, "webSearchMaxResults": { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 }, "imageGenerationMaxResults": { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 }, "imageGenerationQuality": { "type": "string", "enum": [ "Low", "Medium", "High", "Highest" ] }, "imageGenerationAllowMatureContent": { "type": "boolean" }, "imageGenerationAllowReferenceUsage": { "type": "boolean" }, "imageGenerationModelName": { "type": [ "string", "null" ] }, "includeAllMemoryContext": { "type": "boolean" } }, "type": [ "object", "null" ] }, "moderationParameters": { "properties": { "violenceThreshold": { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 }, "sexualExplicitThreshold": { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 }, "politicalThreshold": { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 }, "dangerousContentThreshold": { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 }, "jailbreakThreshold": { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 } }, "type": [ "object", "null" ] }, "knownToolHandlerName": { "type": [ "string", "null" ] }, "toolInvocationExplanations": { "type": "boolean" }, "modelRoutingParameters": { "properties": { "lowComplexityModelName": { "type": "string" }, "lowComplexityModelReasoningEffort": { "type": [ "string", "null" ] }, "mediumComplexityModelName": { "type": "string" }, "mediumComplexityModelReasoningEffort": { "type": [ "string", "null" ] }, "highComplexityModelName": { "type": "string" }, "highComplexityModelReasoningEffort": { "type": [ "string", "null" ] } }, "required": [ "lowComplexityModelName", "mediumComplexityModelName", "highComplexityModelName" ], "type": [ "object", "null" ] }, "additionalSettings": { "type": [ "object", "null" ] } }, "required": [ "baseAddress", "modelName" ] } } }
Responses:
- 200
The AI gateway was edited successfully.
Get/api/v1/ai-gateways/<id>ViewAiGateway
ViewAiGateway
Retrieves details of a specific AI gateway.
GET /api/v1/ai-gateways/<id>Headers:
- AuthorizationRequired
The API key used to authenticate the request. Can be provided as a query parameter (
api-key).
Path parameters:
- id
The unique identifier of the AI gateway to retrieve.
Responses:
- 200
The AI gateway details.
{ "name": string, "slug": string, "parameters": { "baseAddress": string, "skills": [ any, ... ], "hideToolsWithoutSkill": boolean, "alwaysVisibleTools": [ string, ... ], "enableBash": boolean, "bashOptions": { "allowDataPersistence": boolean, "toolList": [ string, ... ], "toolExclusionMode": "WhiteList" }?, "knowledgeCollections": [ any, ... ], "knowledgeBaseMaximumResults": number, "knowledgeBaseMinimumScore": number, "knowledgeUseReferences": boolean, "knowledgeUseMetaDescriptions": boolean, "queryStrategy": "Plain", "queryStrategyParameters": { "rewriteContextSize": number, "concatenateContextSize": number }, "apiKey": string?, "modelName": string, "temperature": number?, "topP": number?, "presencePenalty": number?, "frequencyPenalty": number?, "stop": string?, "maxCompletionTokens": number?, "contextMaximumSize": number?, "contextOverflowAction": "Throw", "systemInstruction": string?, "workerScriptSource": string?, "userPromptTemplate": string?, "assistantPrefill": string?, "includePrefillingInMessages": boolean, "reasoningEffort": string?, "verbosity": string?, "flags": [ "NoSystemInstruct", ... ], "tools": [ ... ]?, "protocolFunctions": [ { "name": string, "description": string, "headers": {}, "callbackUrl": string, "contentFormat": any }, ... ], "protocolFunctionSources": [ string, ... ], "mcpSources": [ { "name": string, "description": string?, "url": string, "headers": {}, "cacheDuration": number }, ... ], "systemInstructionsSources": [ { "name": string, "description": string?, "url": string, "headers": {}, "cacheDuration": number }, ... ], "enabledMultimodalFeatures": [ "Image", ... ], "toolContextCount": number?, "sentinelOptions": { "enabledFunctions": [ "WebSearch", ... ] }?, "builtinFunctionsOptions": { "webSearchMode": "Full", "webSearchMaxResults": number, "imageGenerationMaxResults": number, "imageGenerationQuality": "Low", "imageGenerationAllowMatureContent": boolean, "imageGenerationAllowReferenceUsage": boolean, "imageGenerationModelName": string?, "includeAllMemoryContext": boolean }?, "moderationParameters": { "violenceThreshold": number, "sexualExplicitThreshold": number, "politicalThreshold": number, "dangerousContentThreshold": number, "jailbreakThreshold": number }?, "knownToolHandlerName": string?, "toolInvocationExplanations": boolean, "modelRoutingParameters": { "lowComplexityModelName": string, "lowComplexityModelReasoningEffort": string?, "mediumComplexityModelName": string, "mediumComplexityModelReasoningEffort": string?, "highComplexityModelName": string, "highComplexityModelReasoningEffort": string? }?, "additionalSettings": {}? } }{ "type": "object", "properties": { "name": { "type": "string" }, "slug": { "type": "string" }, "parameters": { "type": "object", "properties": { "baseAddress": { "type": "string" }, "skills": { "type": "array", "items": {} }, "hideToolsWithoutSkill": { "type": "boolean" }, "alwaysVisibleTools": { "type": "array", "items": { "type": "string" } }, "enableBash": { "type": "boolean" }, "bashOptions": { "properties": { "allowDataPersistence": { "type": "boolean" }, "toolList": { "type": "array", "items": { "type": "string" } }, "toolExclusionMode": { "type": "string", "enum": [ "WhiteList", "BlackList" ] } }, "type": [ "object", "null" ] }, "knowledgeCollections": { "type": "array", "items": {} }, "knowledgeBaseMaximumResults": { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 }, "knowledgeBaseMinimumScore": { "type": "number" }, "knowledgeUseReferences": { "type": "boolean" }, "knowledgeUseMetaDescriptions": { "type": "boolean" }, "queryStrategy": { "type": "string", "enum": [ "Plain", "Concatenate", "FullRewrite", "UserRewrite", "QueryFunction" ] }, "queryStrategyParameters": { "type": "object", "properties": { "rewriteContextSize": { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 }, "concatenateContextSize": { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 } } }, "apiKey": { "type": [ "string", "null" ] }, "modelName": { "type": "string" }, "temperature": { "type": [ "number", "null" ] }, "topP": { "type": [ "number", "null" ] }, "presencePenalty": { "type": [ "number", "null" ] }, "frequencyPenalty": { "type": [ "number", "null" ] }, "stop": { "type": [ "string", "null" ] }, "maxCompletionTokens": { "minimum": -2147483648, "maximum": 2147483647, "type": [ "integer", "null" ] }, "contextMaximumSize": { "minimum": -2147483648, "maximum": 2147483647, "type": [ "integer", "null" ] }, "contextOverflowAction": { "type": "string", "enum": [ "Throw", "Truncate" ] }, "systemInstruction": { "type": [ "string", "null" ] }, "workerScriptSource": { "type": [ "string", "null" ] }, "userPromptTemplate": { "type": [ "string", "null" ] }, "assistantPrefill": { "type": [ "string", "null" ] }, "includePrefillingInMessages": { "type": "boolean" }, "reasoningEffort": { "type": [ "string", "null" ] }, "verbosity": { "type": [ "string", "null" ] }, "flags": { "type": "array", "items": { "type": "string", "enum": [ "NoSystemInstruct", "NoTemperature", "ThinkingProcess", "NoAssistantPrefilling", "ReturnReasoningTokens", "DisableMultiModalInput", "DiffusingStream", "OpenAiStrictJson", "StructuredOutputSupport", "PreserveThinkingTokens", "NoStopParameter", "NoReasoningEffort", "RewriteToolCallsAsUserMessages", "DisableReasoningSummary", "DisableReasoningDetails", "IncludeStoredReasoning", "StrictUserAssistantTurns" ] } }, "tools": { "type": [ "array", "null" ] }, "protocolFunctions": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "headers": { "type": "object", "additionalProperties": { "type": "string" } }, "callbackUrl": { "type": "string" }, "contentFormat": {} }, "required": [ "name", "description", "callbackUrl", "contentFormat" ] } }, "protocolFunctionSources": { "type": "array", "items": { "type": "string" } }, "mcpSources": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "url": { "type": "string" }, "headers": { "type": "object", "additionalProperties": { "type": "string" } }, "cacheDuration": { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 } }, "required": [ "name", "url" ] } }, "systemInstructionsSources": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "url": { "type": "string" }, "headers": { "type": "object", "additionalProperties": { "type": "string" } }, "cacheDuration": { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 } }, "required": [ "name", "url" ] } }, "enabledMultimodalFeatures": { "type": "array", "items": { "type": "string", "enum": [ "Image", "Audio", "Video", "File", "OtherFiles", "All" ] } }, "toolContextCount": { "minimum": -2147483648, "maximum": 2147483647, "type": [ "integer", "null" ] }, "sentinelOptions": { "properties": { "enabledFunctions": { "type": "array", "items": { "type": "string", "enum": [ "WebSearch", "Code", "OpenUrl", "Remember", "ImageGeneration", "XPostsSearch", "GenerateDocument", "GenerateWebPage", "AdvancedWebUsage", "Request", "Calendar" ] } } }, "type": [ "object", "null" ] }, "builtinFunctionsOptions": { "properties": { "webSearchMode": { "type": "string", "enum": [ "Full", "Summarized" ] }, "webSearchMaxResults": { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 }, "imageGenerationMaxResults": { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 }, "imageGenerationQuality": { "type": "string", "enum": [ "Low", "Medium", "High", "Highest" ] }, "imageGenerationAllowMatureContent": { "type": "boolean" }, "imageGenerationAllowReferenceUsage": { "type": "boolean" }, "imageGenerationModelName": { "type": [ "string", "null" ] }, "includeAllMemoryContext": { "type": "boolean" } }, "type": [ "object", "null" ] }, "moderationParameters": { "properties": { "violenceThreshold": { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 }, "sexualExplicitThreshold": { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 }, "politicalThreshold": { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 }, "dangerousContentThreshold": { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 }, "jailbreakThreshold": { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 } }, "type": [ "object", "null" ] }, "knownToolHandlerName": { "type": [ "string", "null" ] }, "toolInvocationExplanations": { "type": "boolean" }, "modelRoutingParameters": { "properties": { "lowComplexityModelName": { "type": "string" }, "lowComplexityModelReasoningEffort": { "type": [ "string", "null" ] }, "mediumComplexityModelName": { "type": "string" }, "mediumComplexityModelReasoningEffort": { "type": [ "string", "null" ] }, "highComplexityModelName": { "type": "string" }, "highComplexityModelReasoningEffort": { "type": [ "string", "null" ] } }, "required": [ "lowComplexityModelName", "mediumComplexityModelName", "highComplexityModelName" ], "type": [ "object", "null" ] }, "additionalSettings": { "type": [ "object", "null" ] } }, "required": [ "baseAddress", "modelName" ] } } }
Delete/api/v1/ai-gateways/<id>DeleteAiGateway
DeleteAiGateway
Deletes a specific AI gateway.
DELETE /api/v1/ai-gateways/<id>Headers:
- AuthorizationRequired
The API key used to authenticate the request. Can be provided as a query parameter (
api-key).
Path parameters:
- id
The unique identifier of the AI gateway to delete.
Responses:
- 200
The AI gateway was deleted successfully.
Accounts
Put/api/v1/accountsUpdate Account
Update Account
Updates the name and parameters of the authenticated account.
PUT /api/v1/accountsHeaders:
- AuthorizationRequired
The API key used to authenticate the request. Can be provided as a query parameter (
api-key).
Request examples:
Account update data
{ "name": string, "parameters": { "allowConversationsLogging": boolean, "automaticJsonHealing": boolean } }{ "type": "object", "properties": { "name": { "type": "string" }, "parameters": { "type": "object", "properties": { "allowConversationsLogging": { "type": "boolean" }, "automaticJsonHealing": { "type": "boolean" } } } } }
Responses:
- 200
Parameters updated successfully.
- 400
Invalid request body.
Post/api/v1/accounts/roll-saltRoll Salt
Roll Salt
Generates a new random salt for the account, invalidating webhooks and integrations that depend on the previous salt.
POST /api/v1/accounts/roll-saltHeaders:
- AuthorizationRequired
The API key used to authenticate the request. Can be provided as a query parameter (
api-key).
Responses:
- 200
Salt rolled successfully.
API Keys
Get/api/v1/accounts/api-keyList API Keys
List API Keys
Returns all API keys for the authenticated account along with the current salt.
GET /api/v1/accounts/api-keyHeaders:
- AuthorizationRequired
The API key used to authenticate the request. Can be provided as a query parameter (
api-key).
Responses:
- 200
List of API keys and account salt.
{ "apiKeys": [ { "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "expiresAt": "2027-01-01T00:00:00Z", "usedAt": "2026-03-01T12:00:00Z", "label": "My key", "key": "...abc123" } ], "salt": "randomsaltvalue" }
Post/api/v1/accounts/api-keyCreate API Key
Create API Key
Creates a new API key for the authenticated account.
POST /api/v1/accounts/api-keyHeaders:
- AuthorizationRequired
The API key used to authenticate the request. Can be provided as a query parameter (
api-key).
Request examples:
New API key data
{ "label": string, "duration": number }{ "type": "object", "properties": { "label": { "type": "string" }, "duration": { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 } } }
Responses:
- 200
API key created successfully.
{"grantKey": "sk-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"} - 400
Invalid request body.
Delete/api/v1/accounts/api-key/<key-id>Delete API Key
Delete API Key
Removes an existing API key from the authenticated account.
DELETE /api/v1/accounts/api-key/<key-id>Headers:
- AuthorizationRequired
The API key used to authenticate the request. Can be provided as a query parameter (
api-key).
Path parameters:
- key-iduuid
Unique identifier of the API key to delete.
Responses:
- 200
API key deleted successfully.
- 400
API key not found or does not belong to the account.
Data structures
API entities
AiGatewayQueryStrategy: [
"Plain",
"Concatenate",
"FullRewrite",
"UserRewrite",
"QueryFunction"
]
InferenceMultimodalResolveType: [
"Image",
"Audio",
"Video",
"File",
"OtherFiles",
"All"
]
AiModelFlags: [
"NoSystemInstruct",
"NoTemperature",
"ThinkingProcess",
"NoAssistantPrefilling",
"ReturnReasoningTokens",
"DisableMultiModalInput",
"DiffusingStream",
"OpenAiStrictJson",
"StructuredOutputSupport",
"PreserveThinkingTokens",
"New",
"Preview",
"Deprecated",
"NoStopParameter",
"NoReasoningEffort",
"RewriteToolCallsAsUserMessages",
"Discounted",
"Free",
"DisableReasoningSummary",
"DisableReasoningDetails",
"IncludeStoredReasoning",
"StrictUserAssistantTurns"
]
ContextOverflowAction: [
"Throw",
"Truncate"
]
InferenceClientTransportInterface: [
"OpenAiCompatible"
]
DocumentIndexState: [
"Queued",
"Cancelled",
"Indexed"
]
AudioSynthesisSource: [
"None",
"Gpt4oTts",
"ElevenMultilingualV2",
"ElevenV3"
]
WebChatClientInputMode: [
"Image",
"Document",
"Audio"
]
BuiltinFunction: [
"WebSearch",
"Code",
"OpenUrl",
"Remember",
"ImageGeneration",
"XPostsSearch",
"GenerateDocument",
"GenerateWebPage",
"AdvancedWebUsage",
"Request",
"Calendar"
]