ChatCompletions format.

OpenAI Chat Completions-compatible endpoint. Supports standard chat requests, and can also be used to call image-capable Gemini models via the OpenAI chat format.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

model*string

ID of the model to invoke.

messages*array<>

List of conversation messages in order.

temperature?number

Sampling temperature; higher values produce more random output.

top_p?number

Nucleus sampling parameter that controls the cumulative probability range of candidate tokens.

max_tokens?integer

Maximum number of tokens allowed in the generated response.

stream?boolean

Whether to return the response as a stream.

tools?array<>

List of tool definitions available for the model to call.

tool_choice?|

Tool call strategy; can specify automatic selection or force a specific tool call.

response_format?

Response format constraint, such as JSON Object or JSON Schema.

Response Body

`application/json`

curl -X POST "https://example.com/v1/chat/completions" \  -H "Content-Type: application/json" \  -d '{    "model": "gpt-5.4-nano",    "messages": [      {        "role": "user",        "content": "Write a concise launch note."      }    ]  }'

{
  "id": "chatcmpl_123",
  "object": "chat.completion",
  "created": 0,
  "model": "string",
  "choices": [
    {
      "index": 0,
      "message": {
        "role": "system",
        "content": "string",
        "name": "string",
        "tool_call_id": "string",
        "tool_calls": [
          {}
        ]
      },
      "delta": {},
      "finish_reason": "string"
    }
  ],
  "usage": {
    "prompt_tokens": 0,
    "completion_tokens": 0,
    "total_tokens": 0,
    "input_tokens": 0,
    "output_tokens": 0
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "string"
  }
}

Request Body

Response Body

200application/json

401application/json

429application/json

`application/json`

`application/json`

`application/json`