Chat Completion

Create a chat completion

post

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

modelstringRequired

timeoutany ofOptionalDefault: null

numberOptional

or

integerOptional

or

nullOptional

temperatureany ofOptionalDefault: null

numberOptional

or

nullOptional

top_pany ofOptionalDefault: null

numberOptional

or

nullOptional

nany ofOptionalDefault: null

integerOptional

or

nullOptional

streamany ofOptionalDefault: null

booleanOptional

or

nullOptional

stopany ofOptionalDefault: null

objectOptional

or

nullOptional

max_tokensany ofOptionalDefault: null

integerOptional

or

nullOptional

presence_penaltyany ofOptionalDefault: null

numberOptional

or

nullOptional

frequency_penaltyany ofOptionalDefault: null

numberOptional

or

nullOptional

logit_biasany ofOptionalDefault: null

objectOptional

or

nullOptional

userany ofOptionalDefault: null

stringOptional

or

nullOptional

seedany ofOptionalDefault: null

integerOptional

or

nullOptional

tool_choicestring · enumOptional

Controls whether the model calls a tool. auto lets the model decide, none disables tool calls, required forces the model to call a tool.

Possible values:

logprobsany ofOptionalDefault: null

booleanOptional

or

nullOptional

top_logprobsany ofOptionalDefault: null

integerOptional

or

nullOptional

functionsany ofOptionalDefault: null

string[]Optional

or

nullOptional

function_callany ofOptionalDefault: null

stringOptional

or

nullOptional

Responses

200

Chat completion result. When stream: true, the response is returned as text/event-stream instead of JSON, with OpenAI-style data: {chunk}\n\n framing terminated by data: [DONE]\n\n.

application/json

objectOptional

OpenAI-compatible chat completion response. Standard fields (id, object, created, model, choices, usage) are returned; provider-specific extras are stripped before responding.

400

Invalid Format

application/json

401

Authentication Fails

application/json

402

Insufficient Balance

application/json

403

Permission Denied

application/json

404

Not Found

application/json

422

Invalid Parameters

application/json

429

Rate Limit Reached

application/json

500

Server Error

application/json

503

Server Overloaded

application/json

post

/v1/chat/completions

HTTPcURLJavaScriptPython

POST /v1/chat/completions HTTP/1.1
Host: api.arcee.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 433

{
  "model": "text",
  "messages": [
    {
      "content": "text",
      "role": "text",
      "name": "text"
    }
  ],
  "timeout": 1,
  "temperature": 1,
  "top_p": 1,
  "n": 1,
  "stream": true,
  "stop": {},
  "max_tokens": 1,
  "presence_penalty": 1,
  "frequency_penalty": 1,
  "logit_bias": {},
  "user": "text",
  "seed": 1,
  "tools": [
    {
      "type": "function",
      "function": {
        "name": "text",
        "description": "text",
        "parameters": {}
      }
    }
  ],
  "tool_choice": "auto",
  "logprobs": true,
  "top_logprobs": 1,
  "functions": [
    "text"
  ],
  "function_call": "text"
}

{}