Skip to main content
POST
General Chat API
  • Unified chat API interface supporting all text generation models
  • Select different AI models via the model parameter
  • Compatible with OpenAI Chat Completions API format

Usage Examples

Basic Conversation

System Prompt

Multi-turn Conversation

Streaming Output

Notes

  • Use stream: true for SSE streaming responses.
  • Different models may support different context lengths, output limits, and optional parameters.
  • For new OpenAI-compatible workflows that need tools or multimodal structured input, use the Responses API.

Authorizations

Authorization
string
header
required

All API endpoints require Bearer Token authentication.

Get your API Key:

Visit the API Key Management Page to get your API Key

Add it to the request header:

Body

application/json
model
string
required

Model name. Example: gpt-5.2, claude-sonnet-4-5-20250929, gemini-3-flash-preview.

Example:

"gpt-5.2"

messages
object[]
required

List of conversation messages. Each message contains a role and content. Use system to define model behavior, user for user input, and assistant for previous model responses in multi-turn conversations. Example: [{"role": "user", "content": "Explain vector databases in one sentence."}].

temperature
number

Controls output randomness, range 0-2. Lower values such as 0.2 make output more deterministic. Higher values such as 1.8 make output more random. Default: 1.0.

Required range: 0 <= x <= 2
Example:

1

max_tokens
integer

Maximum number of tokens to generate. Different models have different maximum limits.

Required range: x >= 1
Example:

256

stream
boolean

Whether to use streaming output. true returns a streaming response in SSE format. false returns the complete response at once. Default: false.

Example:

false

top_p
number

Nucleus sampling parameter, range 0-1. Controls diversity of generated text. We recommend using either top_p or temperature, not both. Default: 1.0.

Required range: 0 <= x <= 1
Example:

1

frequency_penalty
number

Frequency penalty, range -2.0 to 2.0. Positive values reduce the likelihood of repeating the same words. Default: 0.

Required range: -2 <= x <= 2
Example:

0

presence_penalty
number

Presence penalty, range -2.0 to 2.0. Positive values increase the likelihood of talking about new topics. Default: 0.

Required range: -2 <= x <= 2
Example:

0

stop

Stop sequences. Up to 4 sequences where generation will stop when encountered.

Example:

"\n\nHuman:"

n
integer

Number of completions to generate. Default: 1. Must be a plain number such as 1; do not use quotes.

Required range: x >= 1
Example:

1

Response

200 - application/json

Completion created

code
integer
Example:

200

data
object