Skip to main content
POST
/
v3
/
compat
/
chat
/
completions
Chat Completions API
curl --request POST \
  --url https://api.opper.ai/v3/compat/chat/completions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "messages": [
    {
      "content": "<unknown>",
      "role": "<string>",
      "name": "<string>",
      "tool_call_id": "<string>",
      "tool_calls": [
        {
          "function": {
            "arguments": "<string>",
            "name": "<string>"
          },
          "id": "<string>",
          "type": "<string>",
          "thought_signature": "<string>"
        }
      ]
    }
  ]
}
'
{
  "choices": [
    {
      "finish_reason": "<string>",
      "index": 123,
      "message": {
        "content": "<string>",
        "role": "<string>",
        "annotations": [
          {
            "type": "<string>",
            "url_citation": {
              "url": "<string>",
              "content": "<string>",
              "end_index": 123,
              "start_index": 123,
              "title": "<string>"
            }
          }
        ],
        "reasoning_content": "<string>",
        "tool_calls": [
          {
            "function": {
              "arguments": "<string>",
              "name": "<string>"
            },
            "id": "<string>",
            "type": "<string>",
            "thought_signature": "<string>"
          }
        ]
      }
    }
  ],
  "created": 123,
  "id": "<string>",
  "model": "<string>",
  "object": "<string>",
  "usage": {
    "completion_tokens": 123,
    "prompt_tokens": 123,
    "total_tokens": 123,
    "completion_tokens_details": {
      "reasoning_tokens": 123
    },
    "prompt_tokens_details": {
      "cache_creation_1h_tokens": 123,
      "cache_creation_tokens": 123,
      "cached_tokens": 123
    },
    "server_tool_use": {}
  },
  "cost": 123,
  "meta": {
    "guards": [
      {
        "flagged": true,
        "type": "<string>",
        "code": "<string>",
        "findings": [
          "<unknown>"
        ],
        "phase": "<string>",
        "rule_id": "<string>",
        "rule_name": "<string>",
        "scope_type": "<string>",
        "status": "<string>"
      }
    ],
    "trace_uuid": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

API key authentication. Pass your API key as a Bearer token.

Headers

​
X-Opper-Name
string

Function name for tracing and project-level guardrail function-scope filtering.

​
X-Opper-Parent-Span-Id
string<uuid>

Parent span ID for distributed tracing context.

Body

application/json
​
messages
object[]
required
​
custom_model_credentials
object
​
max_completion_tokens
integer
​
max_tokens
integer
​
model
string
​
output_schema
object
​
reasoning_effort
string
​
response_format
object
​
stop
string[]
​
stream
boolean
​
stream_options
object
​
temperature
number
​
tool_choice
any

Any value

​
tools
object[]
​
top_p
number

Response

Successful response

​
choices
object[]
required
​
created
integer
required
​
id
string
required
​
model
string
required
​
object
string
required
​
usage
object
required
​
cost
number
​
meta
object