AI API

LLM inference and chat completions

REST API endpoints for AI. 31 operations.

Generate speech

POST /v1/ai/audio/speech

Synthesizes audio from text (text-to-speech).

Auth: Bearer API key

Request body

application/json (required) — schema object.

Responses

operationId: generateSpeech

Transcribe audio

POST /v1/ai/audio/transcriptions

Converts an uploaded audio file to text (speech-to-text).

Auth: Bearer API key

Request body

multipart/form-data (required) — schema object.

Responses

operationId: transcribeAudio

Create a chat completion

POST /v1/ai/chat/completions

Runs an OpenAI-compatible chat completion and returns the model's response.

Auth: Bearer API key

Request body

application/json (required) — schema ChatCompletionRequest.

Responses

operationId: chatCompletion

Stream a chat completion

POST /v1/ai/chat/completions/stream

Runs an OpenAI-compatible chat completion and streams the response as server-sent events.

Auth: Bearer API key

Request body

application/json (required) — schema ChatCompletionRequest.

Responses

operationId: streamChatCompletion

Generate a document

POST /v1/ai/docgen/create

Generates a document from the supplied request.

Auth: Bearer API key

Request body

application/json (required) — schema object.

Responses

operationId: createDocgen

Download a generated document

GET /v1/ai/docgen/download/{doc_id}

Downloads the generated document file by id.

Auth: Bearer API key

Parameters

Responses

operationId: downloadDocgen

List docgen formats

GET /v1/ai/docgen/formats

Returns the output formats supported by document generation.

Auth: Bearer API key

Responses

operationId: listDocgenFormats

Get docgen history

GET /v1/ai/docgen/history

Returns the caller's document-generation history.

Auth: Bearer API key

Responses

operationId: getDocgenHistory

Preview a generated document

POST /v1/ai/docgen/preview

Returns a preview of a document without finalizing it.

Auth: Bearer API key

Request body

application/json (required) — schema object.

Responses

operationId: previewDocgen

Revise a generated document

POST /v1/ai/docgen/revise

Applies revisions to a previously generated document.

Auth: Bearer API key

Request body

application/json (required) — schema object.

Responses

operationId: reviseDocgen

Get docgen status

GET /v1/ai/docgen/status

Returns the status of the document-generation subsystem.

Auth: Bearer API key

Responses

operationId: getDocgenStatus

List docgen templates

GET /v1/ai/docgen/templates

Returns the available document-generation templates.

Auth: Bearer API key

Responses

operationId: listDocgenTemplates

List document versions

GET /v1/ai/docgen/versions/{doc_id}

Returns the version history of a generated document.

Auth: Bearer API key

Parameters

Responses

operationId: listDocgenVersions

Create embeddings

POST /v1/ai/embeddings

Generates vector embeddings for the supplied input (OpenAI-compatible).

Auth: Bearer API key

Request body

application/json (required) — schema object.

Responses

operationId: createEmbeddings

Generate images

POST /v1/ai/images/generations

Generates one or more images from a text prompt.

Auth: Bearer API key

Request body

application/json (required) — schema object.

Responses

operationId: generateImage

List AI models

GET /v1/ai/models

Returns the AI models available to the caller.

Auth: Bearer API key

Responses

operationId: listModels

List RAG documents

GET /v1/ai/rag/documents

Returns the documents indexed for retrieval-augmented generation.

Auth: Bearer API key

Responses

operationId: listRagDocuments

Delete a RAG document

DELETE /v1/ai/rag/documents/{doc_id}

Removes a document from the retrieval-augmented generation index.

Auth: Bearer API key

Parameters

Responses

operationId: deleteRagDocument

Query RAG documents

POST /v1/ai/rag/query

Runs a retrieval-augmented query over indexed documents and returns scored matches.

Auth: Bearer API key

Request body

application/json (required) — schema object.

Responses

operationId: queryRag

Get RAG status

GET /v1/ai/rag/status

Returns the status of the retrieval-augmented generation subsystem.

Auth: Bearer API key

Responses

operationId: getRagStatus

Upload a RAG document

POST /v1/ai/rag/upload

Uploads and indexes a document for retrieval-augmented generation.

Auth: Bearer API key

Request body

multipart/form-data (required) — schema object.

Responses

operationId: uploadRagDocument

Run web research

POST /v1/ai/research

Answers a question using live web research and returns the answer with sources.

Auth: Bearer API key

Request body

application/json (required) — schema object.

Responses

operationId: runResearch

Run deep web research

POST /v1/ai/research/deep

Runs a multi-step deep web research task and returns a synthesized answer with sources.

Auth: Bearer API key

Request body

application/json (required) — schema object.

Responses

operationId: runDeepResearch

Run a research search

POST /v1/ai/research/search

Performs a web research search and returns matching results.

Auth: Bearer API key

Request body

application/json (required) — schema object.

Responses

operationId: searchResearch

Get research status

GET /v1/ai/research/status

Returns the status of the web research subsystem.

Auth: Bearer API key

Responses

operationId: getResearchStatus

Autocomplete text

POST /v1/ai/text/autocomplete

Returns completion suggestions for the supplied text.

Auth: Bearer API key

Request body

application/json (required) — schema object.

Responses

operationId: autocompleteText

Check grammar

POST /v1/ai/text/grammar

Returns grammar corrections for the supplied text.

Auth: Bearer API key

Request body

application/json (required) — schema object.

Responses

operationId: checkGrammar

Analyze sentiment

POST /v1/ai/text/sentiment

Returns the sentiment of the supplied text.

Auth: Bearer API key

Request body

application/json (required) — schema object.

Responses

operationId: analyzeSentiment

Summarize text

POST /v1/ai/text/summarize

Returns a summary of the supplied text.

Auth: Bearer API key

Request body

application/json (required) — schema object.

Responses

operationId: summarizeText

Translate text

POST /v1/ai/text/translate

Translates the supplied text to a target language.

Auth: Bearer API key

Request body

application/json (required) — schema object.

Responses

operationId: translateText

Run in-context vector search

POST /v1/ai/text/vector-search

Runs a vector similarity search over supplied in-context text.

Auth: Bearer API key

Request body

application/json (required) — schema object.

Responses

operationId: textVectorSearch