Skip to main content
POST
/
openai
/
chat
/
completions
Chat Completions
import requests

url = "https://api.opper.ai/v2/openai/chat/completions"

payload = {
    "messages": [
        {
            "content": "<string>",
            "role": "<string>",
            "name": "<string>"
        }
    ],
    "tools": [
        {
            "function": {
                "name": "<string>",
                "description": "<string>",
                "parameters": {},
                "strict": True
            },
            "type": "<string>"
        }
    ],
    "stream": True
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
{
  "id": "<string>",
  "choices": [
    {
      "finish_reason": "stop",
      "index": 123,
      "message": {
        "role": "<string>",
        "content": "<string>",
        "refusal": "<string>",
        "annotations": [
          {
            "type": "<string>",
            "url_citation": {
              "end_index": 123,
              "start_index": 123,
              "title": "<string>",
              "url": "<string>"
            }
          }
        ],
        "audio": {
          "id": "<string>",
          "data": "<string>",
          "expires_at": 123,
          "transcript": "<string>"
        },
        "function_call": {
          "arguments": "<string>",
          "name": "<string>"
        },
        "tool_calls": [
          {
            "id": "<string>",
            "function": {
              "arguments": "<string>",
              "name": "<string>"
            },
            "type": "<string>"
          }
        ]
      },
      "logprobs": {
        "content": [
          {
            "token": "<string>",
            "logprob": 123,
            "top_logprobs": [
              {
                "token": "<string>",
                "logprob": 123,
                "bytes": [
                  123
                ]
              }
            ],
            "bytes": [
              123
            ]
          }
        ],
        "refusal": [
          {
            "token": "<string>",
            "logprob": 123,
            "top_logprobs": [
              {
                "token": "<string>",
                "logprob": 123,
                "bytes": [
                  123
                ]
              }
            ],
            "bytes": [
              123
            ]
          }
        ]
      }
    }
  ],
  "created": 123,
  "model": "<string>",
  "object": "<string>",
  "service_tier": "auto",
  "system_fingerprint": "<string>",
  "usage": {
    "completion_tokens": 123,
    "prompt_tokens": 123,
    "total_tokens": 123,
    "completion_tokens_details": {
      "accepted_prediction_tokens": 123,
      "audio_tokens": 123,
      "reasoning_tokens": 123,
      "rejected_prediction_tokens": 123
    },
    "prompt_tokens_details": {
      "audio_tokens": 123,
      "cached_tokens": 123
    }
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
messages
(ChatCompletionDeveloperMessageParam · object | ChatCompletionSystemMessageParam · object | ChatCompletionUserMessageParam · object | ChatCompletionAssistantMessageParam · object | ChatCompletionToolMessageParam · object | ChatCompletionFunctionMessageParam · object)[]
required

Developer-provided instructions that the model should follow, regardless of messages sent by the user. With o1 models and newer, developer messages replace the previous system messages.

​
model
​
audio
ChatCompletionAudioParam · object

Parameters for audio output.

Required when audio output is requested with modalities: ["audio"]. Learn more.

​
frequency_penalty
number | null
​
function_call
Available options:
none,
auto
​
functions
Function · object[]
​
logit_bias
Logit Bias · object
​
logprobs
boolean | null
​
max_completion_tokens
integer | null
​
max_tokens
integer | null
​
metadata
Metadata · object
​
modalities
enum<string>[] | null
Available options:
text,
audio
​
n
integer | null
​
parallel_tool_calls
boolean
​
prediction
ChatCompletionPredictionContentParam · object

Static predicted output content, such as the content of a text file that is being regenerated.

​
presence_penalty
number | null
​
prompt_cache_key
string
​
prompt_cache_retention
enum<string> | null
Available options:
in-memory,
24h
​
reasoning_effort
enum<string> | null
Available options:
none,
minimal,
low,
medium,
high,
xhigh
​
response_format
ResponseFormatText · object

Default response format. Used to generate text responses.

​
safety_identifier
string
​
seed
integer | null
​
service_tier
enum<string> | null
Available options:
auto,
default,
flex,
scale,
priority
​
stop
​
store
boolean | null
​
stream_options
ChatCompletionStreamOptionsParam · object

Options for streaming response. Only set this when you set stream: true.

​
temperature
number | null
​
tool_choice
Available options:
none,
auto,
required
​
tools
(ChatCompletionFunctionToolParam · object | ChatCompletionCustomToolParam · object)[]

A function tool that can be used to generate a response.

​
top_logprobs
integer | null
​
top_p
number | null
​
user
string
​
verbosity
enum<string> | null
Available options:
low,
medium,
high
​
web_search_options
WebSearchOptions · object

This tool searches the web for relevant results to use in a response. Learn more about the web search tool.

​
stream
boolean | null
​
tags
Tags · object
​
parent_span_id
string<uuid> | null

Response

Successful Response

Represents a chat completion response returned by model, based on the provided input.

​
id
string
required
​
choices
Choice · object[]
required
​
created
integer
required
​
model
string
required
​
object
string
required
Allowed value: "chat.completion"
​
service_tier
enum<string> | null
Available options:
auto,
default,
flex,
scale,
priority
​
system_fingerprint
string | null
​
usage
CompletionUsage · object

Usage statistics for the completion request.