Create a chat completion
对话补全。GPT-5.4 等模型默认侧重推理:用 reasoning_effort 控制推理深度(如 none / low / medium / high / xhigh,具体取值因模型而异),用 verbosity 控制答复详略,用 max_completion_tokens 限制总生成量(含推理 token)。
鉴权方式
AuthorizationstringRequired格式为 Bearer $HY_API_KEY。
Headers
Content-TypestringOptional通常为 application/json。
Request
modelstringRequired模型 ID,例如 gpt-5.3-chat、gpt-5.4、claude-haiku-4-5(以控制台/API Key 绑定为准)
messagesarray of objectsRequired消息数组:role(system / user / assistant / tool)与 content
streambooleanOptional是否 SSE 流式返回
toolsarray of objectsOptionalFunction Calling 工具定义
reasoning_effortstringOptional推理强度。官方枚举含 none、minimal、low、medium、high、xhigh 等;不同模型支持的集合不同(如 gpt-5.4 默认 none,可至 xhigh)。更低延迟用 none/low,复杂任务用 medium/high/xhigh。
temperaturenumberOptional新版 GPT-5.2 / GPT-5.4 在 reasoning_effort ≠ none 时不支持,请求将失败;仅在与官方兼容的旧模型或 reasoning_effort 为 none 时使用。
top_pnumberOptional与 temperature 相同限制:旗舰推理模型在 reasoning_effort ≠ none 时不可用。
presence_penaltynumberOptional存在惩罚。推理模型会自动丢弃该字段。
frequency_penaltynumberOptional频率惩罚。推理模型会自动丢弃该字段。
max_completion_tokensintegerOptional生成 token 上限,包含可见输出与推理 token;推理模型优先使用本字段(max_tokens 已逐步被替代且与部分 o/推理模型不兼容)。
response_formatobjectOptional如 { "type": "json_object" }
stopstring | arrayOptional遇到这些字符串时停止生成。
Errors
| 1 | import OpenAI from 'openai' |
| 2 | |
| 3 | const client = new OpenAI({ |
| 4 | apiKey: process.env.HY_API_KEY, |
| 5 | baseURL: 'https://apiclaw.cc/v1', |
| 6 | }) |
| 7 | |
| 8 | const response = await client.chat.completions.create({ |
| 9 | model: 'claude-sonnet-4-6', |
| 10 | messages: [ |
| 11 | { role: 'system', content: '你是一个专业的产品助手。' }, |
| 12 | { role: 'user', content: '写一个三行产品介绍' }, |
| 13 | ], |
| 14 | max_completion_tokens: 256, |
| 15 | }) |
| 16 | console.log(response.choices[0].message.content) |
Authorization
获取 API Key →Body Parameters
modelstring必填模型 ID,例如 gpt-5.3-chat、gpt-5.4、claude-haiku-4-5(以控制台/API Key 绑定为准)
messagesarray of objects必填消息数组:role(system / user / assistant / tool)与 content
streamboolean可选是否 SSE 流式返回
toolsarray of objects可选Function Calling 工具定义
reasoning_effortstring可选推理强度。官方枚举含 none、minimal、low、medium、high、xhigh 等;不同模型支持的集合不同(如 gpt-5.4 默认 none,可至 xhigh)。更低延迟用 none/low,复杂任务用 medium/high/xhigh。
temperaturenumber可选新版 GPT-5.2 / GPT-5.4 在 reasoning_effort ≠ none 时不支持,请求将失败;仅在与官方兼容的旧模型或 reasoning_effort 为 none 时使用。
top_pnumber可选与 temperature 相同限制:旗舰推理模型在 reasoning_effort ≠ none 时不可用。
presence_penaltynumber可选存在惩罚。推理模型会自动丢弃该字段。
frequency_penaltynumber可选频率惩罚。推理模型会自动丢弃该字段。
max_completion_tokensinteger可选生成 token 上限,包含可见输出与推理 token;推理模型优先使用本字段(max_tokens 已逐步被替代且与部分 o/推理模型不兼容)。
response_formatobject可选如 { "type": "json_object" }
stopstring | array可选遇到这些字符串时停止生成。
| 1 | const response = await fetch("https://apiclaw.cc/v1/chat/completions", { |
| 2 | method: "POST", |
| 3 | headers: { |
| 4 | "Authorization": "Bearer YOUR_API_KEY", |
| 5 | "Content-Type": "application/json", |
| 6 | }, |
| 7 | body: JSON.stringify({ |
| 8 | "model": "claude-sonnet-4-6", |
| 9 | "messages": [ |
| 10 | { |
| 11 | "role": "system", |
| 12 | "content": "You are a helpful assistant." |
| 13 | }, |
| 14 | { |
| 15 | "role": "user", |
| 16 | "content": "Hello!" |
| 17 | } |
| 18 | ], |
| 19 | "reasoning_effort": "medium", |
| 20 | "temperature": 1, |
| 21 | "top_p": 1, |
| 22 | "presence_penalty": 0, |
| 23 | "frequency_penalty": 0, |
| 24 | "max_completion_tokens": 512 |
| 25 | }), |
| 26 | }); |
| 27 | const data = await response.json(); |
| 28 | console.log(data); |
点击 Send request 查看响应
| 1 | { |
| 2 | "id": "chatcmpl_abc123", |
| 3 | "object": "chat.completion", |
| 4 | "model": "claude-sonnet-4-6", |
| 5 | "choices": [ |
| 6 | { |
| 7 | "index": 0, |
| 8 | "message": { |
| 9 | "role": "assistant", |
| 10 | "content": "这里是模型生成的内容。" |
| 11 | }, |
| 12 | "finish_reason": "stop" |
| 13 | } |
| 14 | ], |
| 15 | "usage": { |
| 16 | "prompt_tokens": 18, |
| 17 | "completion_tokens": 20, |
| 18 | "total_tokens": 38 |
| 19 | } |
| 20 | } |

