Skip to main content
POST
Chat Completions (OpenAI-compatible)

Headers

x-api-key
string
required

Body

application/json
model
string
required

Model to use for completion

messages
ChatMessage · object[]
required

A list of messages comprising the conversation

temperature
number | null
default:0.5

Sampling temperature (0 to 2)

Required range: 0 <= x <= 2
top_p
number | null

Nucleus sampling parameter

n
integer | null
default:1

Number of completions to generate

stream
boolean | null
default:false

Whether to stream partial results

max_tokens
integer | null

Maximum tokens to generate

max_completion_tokens
integer | null

Maximum completion tokens (takes precedence over max_tokens)

presence_penalty
number | null

Presence penalty

frequency_penalty
number | null

Frequency penalty

user
string | null

Unique identifier for the end-user

max_loops
integer | null
default:1

Maximum number of agent reasoning loops (Swarms extension). Defaults to 1 (single pass). Use via extra_body in the OpenAI SDK.

Response

Successful Response

id
string
required
created
integer
required
model
string
required
choices
ChatCompletionChoice · object[]
required
usage
CompletionUsage · object
required
object
string
default:chat.completion