Response Format

Standard Response

{
  "choices": [
    {
      "finish_reason": "stop",
      "index": 0,
      "message": {
        "content": "Hello! How can I help you today? 😊",
        "padding": "abcdefghijklmnopqrstuvwxyz",
        "role": "assistant"
      }
    }
  ],
  "id": "chatcmpl-BsUWgXcLO95QZEJsoaLdtj9HHf9sj",
  "usage": {
    "completion_tokens": 11,
    "prompt_tokens": 8,
    "prompt_tokens_details": {
      "cached_tokens": 0
    },
    "total_tokens": 19
  },
  "model": "auto",
  "system_fingerprint": "fp_07e970ab25"
}

Streaming Response

When stream: true, responses are sent as Server-Sent Events:

data: {"choices":[],"created":0,"id":""}

data: {"choices":[{"index":0,"delta":{"content":"","role":"assistant"}}],"created":1752331931,"id":"chatcmpl-BsVsBmSED2kGgzlZFq9xLxNSkE03L","model":"auto","system_fingerprint":"fp_07e970ab25"}

data: {"choices":[{"index":0,"delta":{"content":"Hello"}}],"created":1752331931,"id":"chatcmpl-BsVsBmSED2kGgzlZFq9xLxNSkE03L","model":"auto","system_fingerprint":"fp_07e970ab25"}

data: {"choices":[{"index":0,"delta":{"content":"!"}}],"created":1752331931,"id":"chatcmpl-BsVsBmSED2kGgzlZFq9xLxNSkE03L","model":"auto","system_fingerprint":"fp_07e970ab25"}

data: {"choices":[{"index":0,"delta":{"content":" How"}}],"created":1752331931,"id":"chatcmpl-BsVsBmSED2kGgzlZFq9xLxNSkE03L","model":"auto","system_fingerprint":"fp_07e970ab25"}

data: {"choices":[{"index":0,"delta":{"content":" can"}}],"created":1752331931,"id":"chatcmpl-BsVsBmSED2kGgzlZFq9xLxNSkE03L","model":"auto","system_fingerprint":"fp_07e970ab25"}

data: {"choices":[{"index":0,"delta":{"content":" I"}}],"created":1752331931,"id":"chatcmpl-BsVsBmSED2kGgzlZFq9xLxNSkE03L","model":"auto","system_fingerprint":"fp_07e970ab25"}

data: {"choices":[{"index":0,"delta":{"content":" help"}}],"created":1752331931,"id":"chatcmpl-BsVsBmSED2kGgzlZFq9xLxNSkE03L","model":"auto","system_fingerprint":"fp_07e970ab25"}

data: {"choices":[{"index":0,"delta":{"content":" you"}}],"created":1752331931,"id":"chatcmpl-BsVsBmSED2kGgzlZFq9xLxNSkE03L","model":"auto","system_fingerprint":"fp_07e970ab25"}

data: {"choices":[{"index":0,"delta":{"content":" today"}}],"created":1752331931,"id":"chatcmpl-BsVsBmSED2kGgzlZFq9xLxNSkE03L","model":"auto","system_fingerprint":"fp_07e970ab25"}

data: {"choices":[{"index":0,"delta":{"content":"?"}}],"created":1752331931,"id":"chatcmpl-BsVsBmSED2kGgzlZFq9xLxNSkE03L","model":"auto","system_fingerprint":"fp_07e970ab25"}

data: {"choices":[{"index":0,"delta":{"content":" 😊"}}],"created":1752331931,"id":"chatcmpl-BsVsBmSED2kGgzlZFq9xLxNSkE03L","model":"auto","system_fingerprint":"fp_07e970ab25"}

data: {"choices":[{"finish_reason":"stop","index":0,"delta":{"content":null}}],"created":1752331931,"id":"chatcmpl-BsVsBmSED2kGgzlZFq9xLxNSkE03L","usage":{"completion_tokens":11,"prompt_tokens":9,"total_tokens":20},"model":"auto","system_fingerprint":"fp_07e970ab25"}

data: [DONE]

Error Responses

The API returns standard HTTP status codes and error objects:

400 Bad Request

{
  "error": {
    "message": "Invalid request format",
    "type": "invalid_request_error",
  }
}

401 Unauthorized

{
  "error": {
    "message": "Invalid API key provided",
    "type": "invalid_request_error",
  }
}

429 Too Many Requests

{
  "error": {
    "message": "Rate limit exceeded",
    "type": "requests_error",
  }
}

500 Internal Server Error

{
  "error": {
    "message": "Internal server error",
    "type": "server_error",
  }
}

On this page