API Documentation

API Reference

Chat

Create Chat Completion

Create Chat Completion

Supported Model Code

Loading models...

Create chat completion

https://api.modelstream.ai

POST/v1/chat/completions

Authentication

BearerAuth

AuthenticationBearer <token>

All API requests must be authenticated using a Bearer token in the Authorization header. Please ensure your API key is active.Authorization: Bearer sk-xxxxxx

Parameter Location: Header Param

Request Body

application/json

Due to parameter differences across provider models, we recommend referring to the complete form parameter instructions during the specific model trial. The form view intuitively shows parameter types, and the JSON view reveals the exact parameters requested.

model*string

Model ID used

Required

messages*array

List of conversation messages so far

Required

temperature?number

Sampling temperature, between 0 and 2

Example Value: 1Value Range: 0 ≤ value ≤ 2

top_p?number

Nucleus sampling parameter, between 0 and 1

Example Value: 1Value Range: 0 ≤ value ≤ 1

n?integer

Number of responses to generate

Example Value: 1Value Range: 1 ≤ value ≤ ∞

stream?boolean

Whether to return incremental responses as a stream

Example Value: false

stream_options?object

Parameter description for Stream Options

include_usage?boolean

stop?oneOf

Character sequence to stop generation

max_tokens?integer

Limit on maximum tokens to generate

max_completion_tokens?integer

Parameter description for Max Completion Tokens

presence_penalty?number

Presence penalty (-2.0 to 2.0)

Example Value: 0Value Range: -2 ≤ value ≤ 2

frequency_penalty?number

Frequency penalty (-2.0 to 2.0)

Example Value: 0Value Range: -2 ≤ value ≤ 2

logit_bias?object

Parameter description for Logit Bias

user?string

End user identifier

tools?array

Parameter description for Tools

tool_choice?oneOf

Parameter description for Tool Choice

response_format?object

Response Data Format

type?string

Parameter description for Type

json_schema?object

Parameter description for Json Schema

seed?integer

Parameter description for Seed

reasoning_effort?string

Parameter description for Reasoning Effort

Enum/Options:

"low""medium""high"

modalities?array

Parameter description for Modalities

audio?object

Parameter description for Audio

voice?string

format?string

Response Parameters

application/json

200apiDocs.responses.successCreateResponse

id?string

Parameter description for Id

object?string

Parameter description for Object

created?integer

Parameter description for Created

model?string

Model ID used

choices?array

Parameter description for Choices

usage?object

Parameter description for Usage

prompt_tokens?integer

Parameter description for Prompt Tokens

completion_tokens?integer

Parameter description for Completion Tokens

total_tokens?integer

Parameter description for Total Tokens

prompt_tokens_details?object

Parameter description for Prompt Tokens Details

completion_tokens_details?object

Parameter description for Completion Tokens Details

system_fingerprint?string

Parameter description for System Fingerprint

400apiDocs.responses.badRequestParams

error?object

Parameter description for Error

message?string

Error Message

type?string

Error Type

param?string

Related Parameters

code?string

Error Code

429apiDocs.responses.rateLimited

error?object

Parameter description for Error

message?string

Error Message

type?string

Error Type

param?string

Related Parameters

code?string

Error Code

curl -X POST "https://api.modelstream.ai/v1/chat/completions" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
  "model": "gpt-4",
  "messages": null,
  "temperature": 0,
  "top_p": 0,
  "n": 0,
  "stream": true,
  "stream_options": null,
  "stop": null,
  "max_tokens": 0,
  "max_completion_tokens": 0,
  "presence_penalty": 0,
  "frequency_penalty": 0,
  "logit_bias": null,
  "user": "string",
  "tools": null,
  "tool_choice": null,
  "response_format": null,
  "seed": 0,
  "reasoning_effort": "string",
  "modalities": null,
  "audio": null
}'

{
  "id": "string",
  "object": "chat.completion",
  "created": 0,
  "model": "string",
  "choices": [
    {
      "index": 0,
      "message": {
        "role": "system",
        "content": null,
        "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"
}