AI API reference

Access all Quant AI features programmatically via the v3 REST API. This page provides an overview of available endpoints organised by category.

Base URL

All AI endpoints share the following base URL.

https://api.quantcdn.io/api/v3/organisations/{org}/ai

Replace {org} with your organisation identifier.

Authentication

Include your project API token as a Bearer token in the Authorization header.

curl -H "Authorization: Bearer YOUR_API_TOKEN" \
  https://api.quantcdn.io/api/v3/organisations/{org}/ai/models

Find your API token in the Integrations section of your project dashboard.

Note

You need a valid API token with the appropriate AI permissions to access AI endpoints. See Authentication for details on generating tokens.

Models

Method	Endpoint	Description
GET	/models	List available AI models
GET	/models/{modelId}	Get model details and capabilities

Filter models by capability using query parameters: chat, embeddings, vision, streaming.

Chat inference

Method	Endpoint	Description
POST	/chat	Send a chat message (buffered response)
POST	/chat/stream	Send a chat message (streaming SSE response)
GET	/chat/executions/{id}	Poll for async execution result
POST	/chat/callback	Resume a durable execution

Example chat request:

curl -X POST https://api.quantcdn.io/api/v3/organisations/{org}/ai/chat \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "modelId": "anthropic.claude-sonnet-4-20250514-v1:0",
    "messages": [{"role": "user", "content": "Hello"}],
    "maxTokens": 1024
  }'

Embeddings

Method	Endpoint	Description
POST	/embeddings	Generate text embeddings

Image generation

Method	Endpoint	Description
POST	/image-generation	Generate images from text prompts

Sessions

Method	Endpoint	Description
GET	/sessions	List sessions
POST	/sessions	Create a session
GET	/sessions/{id}	Get session details
PUT	/sessions/{id}	Update a session
DELETE	/sessions/{id}	Delete a session
PUT	/sessions/{id}/extend	Extend session TTL

Agents

Method	Endpoint	Description
GET	/agents	List agents
POST	/agents	Create an agent
GET	/agents/{id}	Get agent details
PUT	/agents/{id}	Update an agent
DELETE	/agents/{id}	Delete an agent
POST	/agents/{id}/chat	Chat with an agent

Custom tools

Method	Endpoint	Description
GET	/custom-tools	List custom tools
POST	/custom-tools	Register a custom tool
DELETE	/custom-tools/{id}	Delete a custom tool
GET	/tools/executions/{id}	Get tool execution status

Vector database

Method	Endpoint	Description
GET	/vector-db/collections	List collections
POST	/vector-db/collections	Create a collection
DELETE	/vector-db/collections/{id}	Delete a collection
POST	/vector-db/collections/{id}/documents	Upload documents
DELETE	/vector-db/collections/{id}/documents	Delete documents
POST	/vector-db/collections/{id}/query	Search a collection

Tasks

Method	Endpoint	Description
GET	/tasks	List tasks
POST	/tasks	Create a task
GET	/tasks/{id}	Get task details
PUT	/tasks/{id}	Update a task
DELETE	/tasks/{id}	Delete a task
GET	/tasks/{id}/dependency-graph	Get task dependency graph

Orchestrations

Method	Endpoint	Description
GET	/orchestrations	List orchestrations
POST	/orchestrations	Create an orchestration
DELETE	/orchestrations/{id}	Delete an orchestration
POST	/orchestrations/{id}/start	Start an orchestration
POST	/orchestrations/{id}/pause	Pause an orchestration
POST	/orchestrations/{id}/resume	Resume an orchestration
POST	/orchestrations/{id}/cancel	Cancel an orchestration
GET	/orchestrations/{id}/batches	List orchestration batches

Files

Method	Endpoint	Description
GET	/files	List files
POST	/files	Upload a file
DELETE	/files/{id}	Delete a file

Usage

Method	Endpoint	Description
GET	/usage	Get usage statistics

Streaming responses

The /chat/stream endpoint returns Server-Sent Events (SSE). Each event contains a chunk of the response.

data: {"type":"content","content":"Hello"}
data: {"type":"content","content":" there!"}
data: {"type":"done"}

Tip

Streaming is recommended for interactive chat interfaces where you want to display responses as they are generated, rather than waiting for the full response.

Durable execution

For long-running operations, set async: true in your chat request. Poll with GET /chat/executions/{id} until the status is completed, then retrieve the result.

# Start an async chat request
curl -X POST https://api.quantcdn.io/api/v3/organisations/{org}/ai/chat \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "modelId": "anthropic.claude-sonnet-4-20250514-v1:0",
    "messages": [{"role": "user", "content": "Analyse this dataset..."}],
    "async": true
  }'

# Poll for the result
curl https://api.quantcdn.io/api/v3/organisations/{org}/ai/chat/executions/{id} \
  -H "Authorization: Bearer YOUR_API_TOKEN"

Note

Durable executions are ideal for operations that may take longer than typical HTTP timeout limits. The execution persists on the server and can be retrieved at any time.