Create chat completion

POST /chat/completions

cURL

cURL

curl --request POST \
  --url https://aigw.portkey.ai/v1/chat/completions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "messages": [
    {
      "content": "<string>",
      "role": "system",
      "name": "<string>"
    }
  ],
  "model": "<string>",
  "frequency_penalty": 0,
  "logit_bias": {},
  "logprobs": false,
  "top_logprobs": 10,
  "max_tokens": 123,
  "max_completion_tokens": 123,
  "n": 1,
  "presence_penalty": 0,
  "response_format": {
    "type": "text"
  },
  "seed": 0,
  "stop": "<string>",
  "stream": false,
  "stream_options": {
    "include_usage": true
  },
  "thinking": {
    "type": "disabled",
    "budget_tokens": 2
  },
  "temperature": 1,
  "top_p": 1,
  "tools": [
    {
      "type": "function",
      "function": {
        "name": "<string>",
        "description": "<string>",
        "parameters": {},
        "strict": false
      }
    }
  ],
  "parallel_tool_calls": true,
  "user": "<string>",
  "functions": [
    {
      "name": "<string>",
      "description": "<string>",
      "parameters": {}
    }
  ]
}
'

200

{
  "id": "<string>",
  "choices": [
    {
      "finish_reason": "stop",
      "index": 123,
      "message": {
        "content": "<string>",
        "role": "assistant",
        "tool_calls": [
          {
            "id": "<string>",
            "type": "function",
            "function": {
              "name": "<string>",
              "arguments": "<string>"
            }
          }
        ],
        "function_call": {
          "arguments": "<string>",
          "name": "<string>"
        },
        "content_blocks": [
          {
            "type": "text",
            "text": "<string>"
          }
        ]
      },
      "logprobs": {
        "content": [
          {
            "token": "<string>",
            "logprob": 123,
            "bytes": [
              123
            ],
            "top_logprobs": [
              {
                "token": "<string>",
                "logprob": 123,
                "bytes": [
                  123
                ]
              }
            ]
          }
        ]
      }
    }
  ],
  "created": 123,
  "model": "<string>",
  "object": "chat.completion",
  "system_fingerprint": "<string>",
  "usage": {
    "completion_tokens": 123,
    "prompt_tokens": 123,
    "total_tokens": 123,
    "completion_tokens_details": {
      "reasoning_tokens": 123,
      "accepted_prediction_tokens": 123,
      "rejected_prediction_tokens": 123
    },
    "prompt_tokens_details": {
      "cached_tokens": 123
    }
  }
}

Authorizations

Authorization · string · header · required

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

Headers

x-portkey-trace-id · string

x-portkey-span-id · string

x-portkey-parent-span-id · string

x-portkey-span-name · string

x-portkey-metadata · object

x-portkey-cache-namespace · string

x-portkey-cache-force-refresh · boolean

Body

application/json

messages · (System message · object | Developer message · object | User message · object | Assistant message · object | Tool message · object | Function message · object)[] · required

Minimum array length: 1

System message

Developer message

User message

Assistant message

Tool message

Function message

Show child attributes

model · string enum<string> · required

frequency_penalty · number | null · default: 0

Required range: -2 <= x <= 2

logit_bias · object | null

Show child attributes

logprobs · boolean | null · default: false

top_logprobs · integer | null

Required range: 0 <= x <= 20

max_tokens · integer | null · deprecated

max_completion_tokens · integer | null

n · integer | null · default: 1

Required range: 1 <= x <= 128

presence_penalty · number | null · default: 0

Required range: -2 <= x <= 2

response_format · Text · object

Text

JSON schema

JSON object

Show child attributes

seed · integer | null

Required range: -9223372036854776000 <= x <= 9223372036854776000

stop · string string[]

stream · boolean | null · default: false

stream_options · object | null

Show child attributes

thinking · object | null

Show child attributes

temperature · number | null · default: 1

Required range: 0 <= x <= 2

top_p · number | null · default: 1

Required range: 0 <= x <= 1

tools · object[]

Show child attributes

tool_choice · enum<string> object

Available options: none, auto, required

parallel_tool_calls · boolean · default: true

user · string

function_call · enum<string> object · deprecated

Available options: none, auto

functions · object[] · deprecated

Required array length: 1 - 128 elements

Show child attributes

Response

200 - application/json

id · string · required

choices · object[] · required

Show child attributes

created · integer · required

model · string · required

object · enum<string> · required

Available options: chat.completion

system_fingerprint · string

usage · object

Show child attributes