Search the documentation

Pick a page and open it with Enter.

Requests & responses

Request shape, content types, and the response format.

Every endpoint speaks JSON over HTTP. Shape, encoding, and response format are the same everywhere.

Base URL

Every path hangs off api_prefix — /api/v1 by default. In the examples the backend runs locally at http://localhost:8000.

bash
http://localhost:8000/api/v1

Chat body limits

messagesarray · 1–1000

role is system | user | assistant; content allows up to 400000 characters. User messages can include attachment_ids.

chat_idstring | null · up to 64 characters

Required with attachment_ids. Identifies the conversation that owns the uploaded files and working directory.

temperaturenumber · 0–2

null = default from configuration.

max_tokensinteger · 1–32000

Counts thinking tokens on reasoning models.

top_pnumber · >0–1

null = default.

Stateless

Send the full message history with every chat call. A chat_id links file references and the working directory across turns; it does not add earlier messages to the request automatically.