Sign in

v1

latestOpenAPI 3.1.02026-07-1731010.0 KB

Create a chat completion.

Set stream: true to receive Server-Sent Events instead of a single JSON response. The optional X-Conversation-Id request header reuses a server-side session across turns when --conversations-max is non-zero.

post/v1/chat/completions

Headers

X-Conversation-Idstring

Stable identifier used to look up a cached session.

Request body

modelstring

Agent name to invoke. Defaults to the team's default agent when missing or unknown.

streamboolean
temperaturenumber

Validated; full runtime plumbing is in progress.

top_pnumber
max_tokensinteger

Response

OK. Either a JSON ChatCompletion or a text/event-stream of chat.completion.chunk events.

idstring required
object'chat.completion' required
createdinteger required
modelstring required