Sign in

v1

latestOpenAPI 3.0.02026-07-26117076.0 KB
Text Series

General Chat API

OpenAI-compatible chat completions endpoint.

post/v1/chat/completions

Request body

modelstring required

Model name. Example: gpt-5.2, claude-sonnet-4-5-20250929, gemini-3-flash-preview.

temperaturenumber

Controls output randomness, range 0-2. Lower values such as 0.2 make output more deterministic. Higher values such as 1.8 make output more random. Default: 1.0.

max_tokensinteger

Maximum number of tokens to generate. Different models have different maximum limits.

streamboolean

Whether to use streaming output. true returns a streaming response in SSE format. false returns the complete response at once. Default: false.

top_pnumber

Nucleus sampling parameter, range 0-1. Controls diversity of generated text. We recommend using either top_p or temperature, not both. Default: 1.0.

frequency_penaltynumber

Frequency penalty, range -2.0 to 2.0. Positive values reduce the likelihood of repeating the same words. Default: 0.

presence_penaltynumber

Presence penalty, range -2.0 to 2.0. Positive values increase the likelihood of talking about new topics. Default: 0.

ninteger

Number of completions to generate. Default: 1. Must be a plain number such as 1; do not use quotes.

Example request

{
  "model": "gpt-5.2",
  "messages": [
    {
      "role": "user",
      "content": "Explain vector databases in one sentence."
    }
  ],
  "temperature": 1,
  "max_tokens": 256,
  "top_p": 1,
  "stop": "\n\nHuman:",
  "n": 1
}

Response

Completion created

codeinteger

Example response

{
  "code": 200,
  "data": {
    "id": "chatcmpl-9876543210",
    "object": "chat.completion",
    "created": 1677652288,
    "model": "gpt-5.2",
    "choices": [
      {
        "message": {
          "role": "user",
          "content": "Explain vector databases in one sentence."
        },
        "finish_reason": "stop"
      }
    ],
    "usage": {
      "prompt_tokens": 28,
      "completion_tokens": 320,
      "total_tokens": 348
    }
  }
}