语言
中文
POST

Create a chat completion

对话补全。GPT-5.4 等模型默认侧重推理:用 reasoning_effort 控制推理深度(如 none / low / medium / high / xhigh,具体取值因模型而异),用 verbosity 控制答复详略,用 max_completion_tokens 限制总生成量(含推理 token)。

鉴权方式

在请求头中使用 Bearer Token 进行鉴权。你可以前往控制台的 API Keys 页面生成密钥。
AuthorizationstringRequired

格式为 Bearer $HY_API_KEY。

Headers

发送 POST 请求时,需指定内容类型(大多数 HTTP 客户端及 SDK 会自动处理)。
Content-TypestringOptional

通常为 application/json。

Request

此端点需要接收一个 JSON 对象作为请求体。
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 objectsOptional

Function 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

API 请求失败时可能返回以下 HTTP 状态码:
POST
1import OpenAI from 'openai'
2
3const client = new OpenAI({
4 apiKey: process.env.HY_API_KEY,
5 baseURL: 'https://apiclaw.cc/v1',
6})
7
8const 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})
16console.log(response.choices[0].message.content)
POST

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可选

遇到这些字符串时停止生成。

REQUEST
1const 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});
27const data = await response.json();
28console.log(data);
RESPONSE

点击 Send request 查看响应

Response
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}