ChatCompletions 格式

ChatCompletions 格式

根据对话历史创建模型响应。支持流式和非流式响应。兼容 OpenAI Chat Completions API。

字段值
Base URLhttps://token.easyapi.com/v1
认证Authorization: Bearer `API_KEY`
示例模型gpt-4
格式OpenAI Chat Completions 兼容
计费按量计费
注意: 完整路径为 POST /v1/chat/completions。OpenAI SDK 的 base_url 需填写完整路径(含 /v1)。支持 usage.include(响应返回费用)、models(回退模型序列)与 provider.sort(路由偏好),见下方请求体说明。

示例模型

下文均以 gpt-4(GPT-4)为例;更换其他模型时,请替换 model 参数,并参考控制台模型说明调整 size、quality 等字段。

创建聊天补全

POSThttps://token.easyapi.com/v1/chat/completions

根据对话历史创建模型响应,兼容 OpenAI Chat Completions API,支持流式与非流式。

请求参数

名称位置类型必选说明
Authorizationheaderstring是EasyAPI API Key。格式:Bearer `API_KEY`
Content-Typeheaderstring是请求体格式

请求体

名称类型必选说明
modelstring是模型 ID
messagesarray<object>是对话消息列表
temperaturenumber否采样温度,默认 1,范围 0–2
top_pnumber否核采样参数,默认 1,范围 0–1
ninteger否生成数量,默认 1,范围 ≥ 1
streamboolean否是否流式响应,默认 false
stream_optionsobject否流式响应附加选项
stopstring | array<string>否停止序列,字符串或字符串数组
max_tokensinteger否最大生成 Token 数
max_completion_tokensinteger否最大补全 Token 数
presence_penaltynumber否存在惩罚,默认 0,范围 -2–2
frequency_penaltynumber否频率惩罚,默认 0,范围 -2–2
logit_biasobject否调整指定 token 出现概率
userstring否终端用户标识,便于滥用监测
toolsarray<object>否可调用的工具定义列表
tool_choicestring | object否工具选择策略,字符串或对象
response_formatobject否响应格式,如 JSON Schema
seedinteger否随机种子,用于尽量复现结果
reasoning_effortstring否medium
modalitiesarray<string>否输出模态,如 text、audio
audioobject否音频输出相关配置
usageobject否设为 usage.include = true 时,响应的 usage 对象会多一个 cost 字段(本次调用费用,USD);流式请求在最后一个带 usage 的块里返回。最终扣费以 GET /v1/generation 为准
modelsarray<string>否回退模型序列(最多 5 个)。主模型没有可用渠道,或上游失败且尚未开始输出时,按顺序换用下一个模型重试;仅限本 Key 允许的模型
providerobject否同优先级渠道内的路由偏好:provider.sort 取 price 选最便宜的渠道;latency 选实测首字延迟最低的(非流式按端到端耗时);throughput 选实测输出 tokens/s 最高的。latency 与 throughput 用该模型在各渠道的真实请求实测,没有实测数据时退回渠道测速。模型名后缀 :floor 等价 sort=price,:nitro 等价 sort=throughput

示例

{
  "model": "gpt-4",
  "messages": [
    {
      "role": "system",
      "content": "You are a helpful assistant."
    },
    {
      "role": "user",
      "content": "Hello!"
    }
  ],
  "temperature": 0.7,
  "stream": false,
  "usage": {
    "include": true
  }
}

返回示例

{
  "id": "chatcmpl-123",
  "object": "chat.completion",
  "created": 1718452800,
  "model": "gpt-4",
  "choices": [
    {
      "index": 0,
      "message": {
        "role": "assistant",
        "content": "Hello! How can I help you today?"
      },
      "finish_reason": "stop"
    }
  ],
  "usage": {
    "prompt_tokens": 20,
    "completion_tokens": 12,
    "total_tokens": 32,
    "prompt_tokens_details": {
      "cached_tokens": 0,
      "text_tokens": 20,
      "audio_tokens": 0,
      "image_tokens": 0
    },
    "completion_tokens_details": {
      "text_tokens": 12,
      "audio_tokens": 0,
      "reasoning_tokens": 0
    },
    "cost": 0.000124
  },
  "system_fingerprint": "fp_abc123"
}