ChatCompletions Format

Creates model responses based on chat history. Supports streaming and non-streaming responses.

Compatible with OpenAI Chat Completions API.

Authorization

AuthorizationBearer <token>

Authenticate with a Bearer token. Format: Authorization: Bearer sk-xxxxxx

In: header

Request Body

modelstring

Model ID

messages

List of conversation messages

temperature?number

Sampling temperature

Default1

Range0 <= value <= 2

top_p?number

Nucleus sampling parameter

Default1

Range0 <= value <= 1

n?integer

Number of items to generate

Default1

Range1 <= value

stream?boolean

Whether to stream the response

Defaultfalse

stream_options?

stop?string|

Stop sequences

max_tokens?integer

Maximum generated tokens

max_completion_tokens?integer

Maximum completion tokens

presence_penalty?number

Default0

Range-2 <= value <= 2

frequency_penalty?number

Default0

Range-2 <= value <= 2

logit_bias?

user?string

tools?

tool_choice?string|

response_format?

seed?integer

reasoning_effort?string

Reasoning effort (for models supporting reasoning)

Value in"low" | "medium" | "high"

modalities?array<string>

audio?

Response Body

application/json

curl -X POST "https://api.beeaicloud.com/v1/chat/completions" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "gpt-4",
    "messages": [
      {
        "role": "system",
        "content": "string"
      }
    ]
  }'

curl -X POST "https://api.beeaicloud.com/v1/chat/completions" \  -H "Content-Type: application/json" \  -d '{    "model": "gpt-4",    "messages": [      {        "role": "system",        "content": "string"      }    ]  }'

{
  "id": "string",
  "object": "chat.completion",
  "created": 0,
  "model": "string",
  "choices": [
    {
      "index": 0,
      "message": {
        "role": "system",
        "content": "string",
        "name": "string",
        "tool_calls": [
          {
            "id": "string",
            "type": "function",
            "function": {
              "name": "string",
              "arguments": "string"
            }
          }
        ],
        "tool_call_id": "string",
        "reasoning_content": "string"
      },
      "finish_reason": "stop"
    }
  ],
  "usage": {
    "prompt_tokens": 0,
    "completion_tokens": 0,
    "total_tokens": 0,
    "prompt_tokens_details": {
      "cached_tokens": 0,
      "text_tokens": 0,
      "audio_tokens": 0,
      "image_tokens": 0
    },
    "completion_tokens_details": {
      "text_tokens": 0,
      "audio_tokens": 0,
      "reasoning_tokens": 0
    }
  },
  "system_fingerprint": "string"
}

{
  "error": {
    "message": "string",
    "type": "string",
    "param": "string",
    "code": "string"
  }
}

{
  "error": {
    "message": "string",
    "type": "string",
    "param": "string",
    "code": "string"
  }
}

Authorization

Request Body

Response Body

200application/json

400application/json

429application/json

application/json

application/json

application/json