API Reference

接口参考

按接口拆分查看请求地址、输入参数、输出参数与错误代码。

Gateway Protocols多标准协议兼容
OpenAIAnthropicGeminiOpenRouter
Chat / Responses / Messages / Claude Messages
POST /v1/chat/completions

对话 Chat API

OpenAI Chat Completions 兼容接口,请求体按 model + messages 形态提交;支持同步 JSON 与 SSE 流式返回。

接口信息

请求地址https://api.4stoken.cn
请求路径/v1/chat/completions
请求方式POST
协议标准OpenAI Chat Completions
能力分类文本对话
Content-Typeapplication/json
鉴权Authorization: Bearer sk-...

输入参数

参数类型必填说明
modelstringPortal 发布的模型编码;对应火山引擎方舟文档中的 Model ID / Endpoint ID 概念,由 Gateway 负责映射到上游。
messagesobject[]消息列表;不同模型支持文本、图片、视频、音频等不同模态。
messages[].rolestringsystem / user / assistant / tool;按所选模型和上游能力透传。
messages[].contentstring | object[]消息内容。纯文本可传 string;多模态按内容块数组传入。
messages[].content[].typestring多模态时内容块类型,例如 text、image_url、input_audio、video_url、file。
messages[].content[].textstring文本块文本内容。
messages[].content[].image_urlobject图片块图片 URL 或 Base64,以及 detail、image_pixel_limit 等上游支持字段。
streamboolean | null是否启用 SSE 流式返回。false 时一次性返回 JSON;true 时按 data: chunk 返回,并以 data: [DONE] 结束。
stream_options.include_usageboolean | null流式响应中是否额外返回整次请求的 token 用量统计。
thinkingobject火山引擎方舟扩展:控制支持模型的深度思考模式,例如 { "type": "enabled" }。
temperaturenumber | null采样温度。
top_pnumber | null核采样概率阈值;通常建议只调整 temperature 或 top_p 之一。
max_tokensinteger | null最大输出 token 数。
max_completion_tokensinteger | null部分模型支持的最大生成 token 数;不要与 max_tokens 同时设置。
stopstring | string[] | null停止词,最多 4 个字符串。
frequency_penalty / presence_penaltynumber | null重复惩罚与话题惩罚。
tools / tool_choiceobject[] / string / object函数调用工具定义与工具选择策略;是否生效取决于模型能力。
response_formatobject输出格式控制,例如 { "type": "json_object" } 或 json_schema。
service_tierstring | null火山引擎方舟服务等级字段;Gateway 会按线路能力透传。

输出参数

参数类型返回说明
idstring响应 ID。
objectstring通常为 chat.completion。
createdinteger上游创建时间戳。
modelstring实际响应的模型编码。
service_tierstring上游返回的服务等级。
choicesobject[]模型输出候选。
choices[].indexinteger候选下标。
choices[].message.rolestring非流式通常为 assistant。
choices[].message.contentstring | null非流式助手最终回复文本。
choices[].message.reasoning_contentstring | null推理模型推理模型可能返回的思考内容字段。
choices[].deltaobject流式流式响应 chunk 中的增量内容,可能包含 content、reasoning_content、tool_calls 等。
choices[].finish_reasonstring | null停止原因,例如 stop、length、tool_calls。
choices[].logprobsobject | null开启 logprobs 时的 token 概率信息。
usage.prompt_tokensinteger输入 token 数。
usage.completion_tokensinteger输出 token 数。
usage.total_tokensinteger总 token 数。
usage.prompt_tokens_detailsobject缓存、音频等输入 token 明细。
usage.completion_tokens_detailsobject推理 token 等输出 token 明细。

补充说明

  • 4SToken 对外标准入口为 POST /v1/chat/completions;如存量火山兼容接入仍使用 /api/v3/chat/completions,可继续按线路能力兼容。
  • 请求中的 model 请填写模型列表页展示的 modelCode,Gateway 会按线路映射到上游 Model ID / Endpoint ID。
  • stream=true 时响应 Content-Type 为 text/event-stream,每个 chunk 以 data: 开头,末尾为 data: [DONE];如需 usage,请传 stream_options.include_usage=true。
  • 多模态内容块、thinking、service_tier、reasoning_content、logprobs 等字段会按上游能力透传;不支持的模型可能忽略或返回参数错误。

错误代码

HTTP 状态码错误说明
400Bad Request参数格式错误、模型不支持该字段或模型未配置 chat.completions 线路。
401UnauthorizedClient Key 无效或未提供。
402Payment RequiredClient Key 配额或消费限额超限。

在线调试

model
your-model-code

仅展示该接口支持的已发布模型

暂无可用模型 →
stream

SSE 流式返回

false
JSON
max_tokens

生成 token 上限

user message

对话用户消息 content

curl -X POST 'https://api.4stoken.cn/v1/chat/completions' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  --data-raw '{"model":"your-model-code","messages":[{"role":"system","content":"你是人工智能助手"},{"role":"user","content":"Hello"}],"max_tokens":1024,"stream":false}'

# 4SToken 对外标准入口:POST /v1/chat/completions
# model 填 Portal 模型列表展示的 modelCode,Gateway 会映射到上游 Model ID / Endpoint ID
在线调试会向 Gateway 发起真实请求并可能产生费用。请确认参数无误后再点击。