OpenAI-compatible API

Copy page

OpenAI-compatible API

SAALT exposes an OpenAI-compatible API so you can reuse existing OpenAI SDKs and tooling. Point any OpenAI client at the SAALT base URL, authenticate with your SAALT API key, and call chat/completions, embeddings, and models as you would against OpenAI.

Base URL

Code
 
https://<your-host>/api/openai/v1

Set this as the baseURL of your OpenAI client. This is separate from the core REST API (which lives under /api/v1/core, documented in the API Reference).

Authentication

Authenticate with your SAALT API key using either header:

• Authorization: Bearer <key>
• x-api-key: <key>

Create and scope keys in the SAALT dashboard under Developer Settings, the same as for the core API.

Errors are returned in the OpenAI error envelope:

Code
 
{
  "error": {
    "message": "...",
    "type": "...",
    "param": null,
    "code": "..."
  }
}

Raw model gateway, not agent chat

The model field must be the id of a model configured in your SAALT instance. Retrieve the available ids from the GET /models endpoint below. An unknown model id returns 404 with code model_not_found.

POST /chat/completions

Create a chat completion.

Request

Field	Type	Notes
model	string	Required. A configured model id (see GET /models).
messages	array	Required. OpenAI-style chat messages.
temperature	number	Optional.
top_p	number	Optional.
max_completion_tokens	number	Optional. Takes precedence over max_tokens when both are sent.
max_tokens	number	Optional. Legacy alias for max_completion_tokens.
stop	string | string[]	Optional.
seed	number	Optional.
frequency_penalty	number	Optional.
presence_penalty	number	Optional.
tools	array	Optional. OpenAI tool definitions.
tool_choice	string | object	Optional.
stream	boolean	Optional. Stream the response as Server-Sent Events.
stream_options.include_usage	boolean	Optional. Include a final usage chunk when streaming.

Not supported: n, logprobs, response_format, logit_bias.

Response

For a non-streaming request, the response is a standard chat.completion object with choices[].message and a usage object.

When stream is true, the response is a Server-Sent Events stream of chat.completion.chunk objects (each carrying a choices[].delta), terminated by a final data: [DONE] line.

Errors

• 404 (model_not_found) — the requested model is not configured.
• 429 (type: "rate_limit_error", code: "usage_limit_exceeded") — the API key's usage limit has been exceeded.

Example — curl

Code
 
curl https://<your-host>/api/openai/v1/chat/completions \
  -H "Authorization: Bearer $SAALT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "<model-id-from-/models>",
    "messages": [
      { "role": "user", "content": "Hello!" }
    ]
  }'

Example — OpenAI Node SDK

Code
 
import OpenAI from "openai";

const client = new OpenAI({
  baseURL: "https://<your-host>/api/openai/v1",
  apiKey: process.env.SAALT_API_KEY,
});

const completion = await client.chat.completions.create({
  model: "<model-id-from-/models>",
  messages: [{ role: "user", content: "Hello!" }],
});

console.log(completion.choices[0].message.content);

POST /embeddings

Create embeddings for one or more inputs.

Request

Field	Type	Notes
model	string	Required. Must be a configured embedding model id.
input	string | string[]	Required. Up to 2048 inputs.
encoding_format	"float" | "base64"	Optional.
dimensions	number	Optional. Truncates each returned vector to this length.

Response

Code
 
{
  "object": "list",
  "data": [
    { "object": "embedding", "index": 0, "embedding": [/* ... */] }
  ],
  "model": "<model-id>",
  "usage": { "prompt_tokens": 0, "total_tokens": 0 }
}

Errors

• 404 — the requested model is not configured.
• 400 — more than 2048 inputs were supplied.

Example — curl

Code
 
curl https://<your-host>/api/openai/v1/embeddings \
  -H "Authorization: Bearer $SAALT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "<embedding-model-id>",
    "input": "The quick brown fox"
  }'

GET /models

List the configured chat and embedding models.

Response

Code
 
{
  "object": "list",
  "data": [
    {
      "id": "<model-id>",
      "object": "model",
      "created": 0,
      "owned_by": "<owner>"
    }
  ]
}

Example — curl

Code
 
curl https://<your-host>/api/openai/v1/models \
  -H "Authorization: Bearer $SAALT_API_KEY"