Create completion

POST /completions

cURL

cURL

curl --request POST \
  --url https://aigw.portkey.ai/v1/completions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "model": "<string>",
  "prompt": "<|endoftext|>",
  "best_of": 1,
  "echo": false,
  "frequency_penalty": 0,
  "logit_bias": {},
  "logprobs": 2,
  "max_tokens": 16,
  "n": 1,
  "presence_penalty": 0,
  "seed": 0,
  "stop": "<|endoftext|>",
  "stream": false,
  "stream_options": {
    "include_usage": true
  },
  "suffix": "<string>",
  "temperature": 1,
  "top_p": 1,
  "user": "<string>"
}
'

200

{
  "id": "<string>",
  "choices": [
    {
      "finish_reason": "stop",
      "index": 123,
      "logprobs": {
        "text_offset": [
          123
        ],
        "token_logprobs": [
          123
        ],
        "tokens": [
          "<string>"
        ],
        "top_logprobs": [
          {}
        ]
      },
      "text": "<string>"
    }
  ],
  "created": 123,
  "model": "<string>",
  "object": "text_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.

Body

application/json

model · string enum<string> · required

prompt · string string[] integer[] integer[][] · default: <|endoftext|> · required

best_of · integer | null · default: 1

Required range: 0 <= x <= 20

echo · boolean | null · default: false

frequency_penalty · number | null · default: 0

Required range: -2 <= x <= 2

logit_bias · object | null

Show child attributes

logprobs · integer | null

Required range: 0 <= x <= 5

max_tokens · integer | null · default: 16

Required range: x >= 0

n · integer | null · default: 1

Required range: 1 <= x <= 128

presence_penalty · number | null · default: 0

Required range: -2 <= x <= 2

seed · integer | null

Required range: -9223372036854776000 <= x <= 9223372036854776000

stop · string string[] · default: <|endoftext|>

stream · boolean | null · default: false

stream_options · object | null

Show child attributes

suffix · string | null

temperature · number | null · default: 1

Required range: 0 <= x <= 2

top_p · number | null · default: 1

Required range: 0 <= x <= 1

user · string

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: text_completion

system_fingerprint · string

usage · object

Show child attributes