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": [] } }
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, "allowedFrameOrigins": [ string, ... ], "audioSynthesisSource": "None", "audioSynthesisVoice": string?, "audioSynthesisInstruction": string?, "summarizeTextBeforeAudioSynthesis": boolean } }{ "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" }, "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" } } } } }
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, "allowedFrameOrigins": [ string, ... ], "audioSynthesisSource": "None", "audioSynthesisVoice": string?, "audioSynthesisInstruction": string?, "summarizeTextBeforeAudioSynthesis": boolean }, "integrations": { "zapiIntegration": { "instanceId": string, "instanceToken": string, "clientToken": string?, "sessionDuration": any }?, "telegramIntegration": { "botToken": 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" }, "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" } } }, "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" ] } } } } }
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, "allowedFrameOrigins": [ string, ... ], "audioSynthesisSource": "None", "audioSynthesisVoice": string?, "audioSynthesisInstruction": string?, "summarizeTextBeforeAudioSynthesis": boolean } }{ "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" }, "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" } } } } }
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 }? } }{ "type": "object", "properties": { "integrationType": { "type": "string", "enum": [ "Zapi", "Telegram" ] }, "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" ] } } } } }
Responses:
- 200
Web client integrations updated 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
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.
{ "term": "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, "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, "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.
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 }{ "type": "object", "properties": { "collectionName": { "type": "string" } } }
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 }{ "type": "object", "properties": { "collectionName": { "type": "string" } } }
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, ... ]? }{ "type": "object", "properties": { "contents": { "type": "string" }, "name": { "type": "string" }, "reference": { "type": [ "string", "null" ] }, "tags": { "items": { "type": "string" }, "type": [ "array", "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 }{ "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 } } }
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, ... ], "knowledgeCollections": [ any, ... ], "knowledgeBaseMaximumResults": number, "knowledgeBaseMinimumScore": number, "knowledgeUseReferences": 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": {} }, ... ], "systemInstructionsSources": [ { "name": string, "description": string?, "url": string, "headers": {} }, ... ], "enabledMultimodalFeatures": [ "Image", ... ], "toolContextCount": number?, "sentinelOptions": { "enabledFunctions": [ "WebSearch", ... ] }?, "builtinFunctionsOptions": { "webSearchMode": "Full", "webSearchMaxResults": number, "imageGenerationMaxResults": number, "imageGenerationQuality": "Low", "imageGenerationAllowMatureContent": boolean, "imageGenerationModelName": string?, "includeAllMemoryContext": boolean }?, "moderationParameters": { "violenceThreshold": number, "sexualExplicitThreshold": number, "politicalThreshold": number, "dangerousContentThreshold": number, "jailbreakThreshold": number }?, "knownToolHandlerName": string?, "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": {} }, "knowledgeCollections": { "type": "array", "items": {} }, "knowledgeBaseMaximumResults": { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 }, "knowledgeBaseMinimumScore": { "type": "number" }, "knowledgeUseReferences": { "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" ] } }, "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" } } }, "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" } } }, "required": [ "name", "url" ] } }, "enabledMultimodalFeatures": { "type": "array", "items": { "type": "string", "enum": [ "Image", "Audio", "Video" ] } }, "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" }, "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" ] }, "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, ... ], "knowledgeCollections": [ any, ... ], "knowledgeBaseMaximumResults": number, "knowledgeBaseMinimumScore": number, "knowledgeUseReferences": 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": {} }, ... ], "systemInstructionsSources": [ { "name": string, "description": string?, "url": string, "headers": {} }, ... ], "enabledMultimodalFeatures": [ "Image", ... ], "toolContextCount": number?, "sentinelOptions": { "enabledFunctions": [ "WebSearch", ... ] }?, "builtinFunctionsOptions": { "webSearchMode": "Full", "webSearchMaxResults": number, "imageGenerationMaxResults": number, "imageGenerationQuality": "Low", "imageGenerationAllowMatureContent": boolean, "imageGenerationModelName": string?, "includeAllMemoryContext": boolean }?, "moderationParameters": { "violenceThreshold": number, "sexualExplicitThreshold": number, "politicalThreshold": number, "dangerousContentThreshold": number, "jailbreakThreshold": number }?, "knownToolHandlerName": string?, "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": {} }, "knowledgeCollections": { "type": "array", "items": {} }, "knowledgeBaseMaximumResults": { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 }, "knowledgeBaseMinimumScore": { "type": "number" }, "knowledgeUseReferences": { "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" ] } }, "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" } } }, "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" } } }, "required": [ "name", "url" ] } }, "enabledMultimodalFeatures": { "type": "array", "items": { "type": "string", "enum": [ "Image", "Audio", "Video" ] } }, "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" }, "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" ] }, "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, ... ], "knowledgeCollections": [ any, ... ], "knowledgeBaseMaximumResults": number, "knowledgeBaseMinimumScore": number, "knowledgeUseReferences": 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": {} }, ... ], "systemInstructionsSources": [ { "name": string, "description": string?, "url": string, "headers": {} }, ... ], "enabledMultimodalFeatures": [ "Image", ... ], "toolContextCount": number?, "sentinelOptions": { "enabledFunctions": [ "WebSearch", ... ] }?, "builtinFunctionsOptions": { "webSearchMode": "Full", "webSearchMaxResults": number, "imageGenerationMaxResults": number, "imageGenerationQuality": "Low", "imageGenerationAllowMatureContent": boolean, "imageGenerationModelName": string?, "includeAllMemoryContext": boolean }?, "moderationParameters": { "violenceThreshold": number, "sexualExplicitThreshold": number, "politicalThreshold": number, "dangerousContentThreshold": number, "jailbreakThreshold": number }?, "knownToolHandlerName": string?, "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": {} }, "knowledgeCollections": { "type": "array", "items": {} }, "knowledgeBaseMaximumResults": { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 }, "knowledgeBaseMinimumScore": { "type": "number" }, "knowledgeUseReferences": { "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" ] } }, "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" } } }, "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" } } }, "required": [ "name", "url" ] } }, "enabledMultimodalFeatures": { "type": "array", "items": { "type": "string", "enum": [ "Image", "Audio", "Video" ] } }, "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" }, "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" ] }, "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.
Data structures
API entities
AiGatewayQueryStrategy: [
"Plain",
"Concatenate",
"FullRewrite",
"UserRewrite",
"QueryFunction"
]
InferenceMultimodalResolveType: [
"Image",
"Audio",
"Video"
]
AiModelFlags: [
"NoSystemInstruct",
"NoTemperature",
"ThinkingProcess",
"NoAssistantPrefilling",
"ReturnReasoningTokens",
"DisableMultiModalInput",
"DiffusingStream",
"OpenAiStrictJson",
"StructuredOutputSupport",
"PreserveThinkingTokens",
"New",
"Preview",
"Deprecated",
"NoStopParameter",
"NoReasoningEffort",
"RewriteToolCallsAsUserMessages",
"Discounted",
"Free",
"DisableReasoningSummary",
"DisableReasoningDetails"
]
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"
]