Chat Completions

OpenAI-compatible route for generating inference and optionally logging the request.

POST /chat/completions

cURL

cURL

curl --request POST \
  --url https://api.openpipe.ai/api/v1/chat/completions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "messages": [
    {
      "content": "",
      "name": "<string>"
    }
  ],
  "model": "<string>",
  "audio": {},
  "functions": [
    {
      "name": "<string>",
      "parameters": {},
      "description": "<string>",
      "strict": true
    }
  ],
  "tools": [
    {
      "function": {
        "name": "<string>",
        "parameters": {},
        "description": "<string>",
        "strict": true
      }
    }
  ],
  "n": 123,
  "max_tokens": 123,
  "max_completion_tokens": 123,
  "temperature": 123,
  "top_p": 123,
  "presence_penalty": 123,
  "frequency_penalty": 123,
  "stop": "<string>",
  "response_format": {},
  "logprobs": true,
  "top_logprobs": 123,
  "store": true,
  "metadata": {},
  "stream": false
}
'

200

{
  "id": "<string>",
  "created": 123,
  "model": "<string>",
  "choices": [
    {
      "index": 123,
      "message": {
        "reasoning_content": "<string>",
        "content": null,
        "refusal": "<string>",
        "function_call": {
          "name": "",
          "arguments": ""
        },
        "tool_calls": [
          {
            "id": "<string>",
            "function": {
              "name": "<string>",
              "arguments": "<string>"
            }
          }
        ]
      },
      "logprobs": null,
      "content_filter_results": {},
      "criteria_results": {}
    }
  ],
  "usage": {
    "prompt_tokens": 123,
    "completion_tokens": 123,
    "total_tokens": 123,
    "prompt_cache_hit_tokens": 123,
    "prompt_cache_miss_tokens": 123,
    "completion_tokens_details": {
      "reasoning_tokens": 123,
      "audio_tokens": 123,
      "text_tokens": 123,
      "accepted_prediction_tokens": 123,
      "rejected_prediction_tokens": 123
    },
    "prompt_tokens_details": {
      "cached_tokens": 123,
      "audio_tokens": 123
    },
    "criteria": {}
  }
}

Authorizations

Authorization · string · header · required

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

Body

application/json

messages · object[] · required

Option 1

Option 2

Option 3

Option 4

Option 5

Option 6

Show child attributes

model · string · required

audio · object

Show child attributes

function_call · Option 1 · enum<string> Option 2 · enum<string> Option 3 · object

Available options: none

functions · object[]

Show child attributes

tool_choice · Option 1 · enum<string> Option 2 · enum<string> Option 3 · enum<string> Option 4 · object

Available options: none

tools · object[]

Show child attributes

n · number

max_tokens · number | null

max_completion_tokens · number | null

temperature · number

top_p · number | null

presence_penalty · number | null

frequency_penalty · number | null

stop · string string[]

response_format · object

Option 1

Option 2

Option 3

Show child attributes

logprobs · boolean

top_logprobs · number | null

stream_options · object

Show child attributes

store · boolean

metadata · object

Show child attributes

stream · boolean · default: false

Response

200

application/json

object | null

Successful response

id · string · required

object · enum<string> · required

Available options: chat.completion

created · number · required

model · string · required

choices · object[] · required

Show child attributes

usage · object

Show child attributes