API overview

Copy page

SAALT exposes a REST API so external applications can manage and call Agents without building an App. This page maps the surface and links to the full reference; for request/response schemas see the API reference.

Base URLs

• Core API — /api/v1/core (the SAALT contract for Agents, Spaces, LLM, Knowledge, cost control).
• OpenAI-compatible API — /api/openai/v1 (drop-in for OpenAI SDKs and tools).

Authentication

Create an API key in the SAALT dashboard under Developer Settings, granting it access to the Agents you need. Send it as:

• x-api-key: <key> — for the core API.
• x-api-key: <key> or Authorization: Bearer <key> — for the OpenAI-compatible API.

A key is either global — it reaches every Space and Agent its owner can reach — or scoped to a list of Spaces and Agents.

From Core 1.5.0, a global key can additionally be marked Can manage API keys in Developer Settings. Such a master key can create, list, update and delete its owner's other keys through the /api-keys endpoints below, for example to rotate keys from a deployment pipeline. Master keys themselves can only be created, changed or deleted in the dashboard, and they stop working for /api-keys once their owner loses the Create & Manage API Keys permission.

Core API endpoints

A grouped map — see the API reference for parameters, request bodies, and response shapes.

Agents

• GET /agents — list Agents.
• POST /agents — create an Agent.
• PUT /agents/{agentId} — update an Agent.
• PUT /agents/{agentId}/prompt — update an Agent's system prompt.
• DELETE /agents/{agentId} — delete an Agent.

Spaces

• GET /spaces — list Spaces.
• POST /spaces — create a Space.
• PATCH /spaces/{spaceId} — update a Space.
• DELETE /spaces/{spaceId} — delete a Space.

LLM

• POST /llm/{agentId}/generateText — generate text.
• POST /llm/{agentId}/generateObject — generate a structured object.
• POST /llm/{agentId}/generateImage — generate an image.
• GET /llm/{agentId}/models — list the Agent's allowed models.
• GET /llm/{agentId}/usage — usage for the Agent.

Conversations

• POST /llm/{agentId}/conversation — continue or create a conversation and get the assistant reply.
• GET /llm/{agentId}/conversation — list conversations.
• GET /llm/{agentId}/conversation/{conversationId}/messages — get a conversation's messages.

Knowledge

• GET / POST /knowledge/{agentId}/documents — list / add documents.
• PUT / DELETE /knowledge/{agentId}/documents/{documentId} — update / delete a document.
• GET / POST /knowledge/{agentId}/tags — list / create tags.
• PUT / DELETE /knowledge/{agentId}/tags/{tagId} — update / delete a tag.
• POST / DELETE /knowledge/{agentId}/documents/{documentId}/tags/{tagId} — attach / detach a tag.

Cost control

• GET / POST / PUT / DELETE /cost-control — read and manage spend limits.

API keys (Core 1.5.0+, master key only)

• GET /api-keys — list the owner's keys.
• POST /api-keys — create a key; the secret is returned only in this response.
• GET /api-keys/{keyId} — read one key.
• PATCH /api-keys/{keyId} — rename, enable or disable, change expiry or scope.
• DELETE /api-keys/{keyId} — delete a key.

OpenAI-compatible endpoints

Base /api/openai/v1 — see OpenAI-compatible API for details.

• POST /chat/completions — chat completions (streaming, tool calls, usage).
• GET /models — list available models.
• POST /embeddings — create embeddings.
• POST /rerank — rerank documents against a query (SAALT extension).

Next steps

• API reference — the full OpenAPI schemas.
• Postman collection — try the API quickly.
• OpenAI-compatible API — reuse existing OpenAI SDKs and tooling.