文字 API · cURL
下面给出三条主流协议的完整 endpoint、认证头与最小请求体。SDK 通常只填 Base URL;直接发 HTTP 时请使用表中的完整路径。模型名称、价格与可用性一律以控制台为准。
协议与 endpoint
| 协议 | 方法与路径 | 认证 | 正文读哪里 |
|---|---|---|---|
| OpenAI Responses | POST /v1/responses | Authorization: Bearer | output[].content[].text |
| Chat Completions | POST /v1/chat/completions | Authorization: Bearer | choices[0].message.content |
| Anthropic Messages | POST /v1/messages | x-api-key(或兼容 Bearer) | content[].text |
OpenAI 兼容链路的 Base URL 填 https://app.helpday.work/v1;Anthropic SDK / Claude Code 的根地址填
https://app.helpday.work(不要再手写一层 /v1)。
Responses
用 input 提交提示词,适合 Codex 与支持 Responses 的工具。成功时常见
status: "completed";SDK 的 output_text 是便捷字段,原始 REST 顶层不一定带这个键。
curl https://app.helpday.work/v1/responses \
-H "Authorization: Bearer sk-请替换为你的密钥" \
-H "Content-Type: application/json" \
-d '{
"model": "你的模型名称",
"input": "用一句话确认 Yoriday 连接正常。"
}' Chat Completions
对话内容放在 messages 数组,是大多数 “OpenAI Compatible” 客户端的默认形态。不要把
Responses 专用的 input / 流式事件处理器混用到这条协议上。
curl https://app.helpday.work/v1/chat/completions \
-H "Authorization: Bearer sk-请替换为你的密钥" \
-H "Content-Type: application/json" \
-d '{
"model": "你的模型名称",
"messages": [
{"role": "user", "content": "用一句话确认 Yoriday 连接正常。"}
]
}' Anthropic Messages
请求体遵循 Anthropic 结构:max_tokens 必填,版本号通过请求头传递。Claude Code
通过环境变量接入时,通常会改用授权头;配置细节见
Claude Code 接入。
curl https://app.helpday.work/v1/messages \
-H "x-api-key: sk-请替换为你的密钥" \
-H "anthropic-version: 2023-06-01" \
-H "Content-Type: application/json" \
-d '{
"model": "你的模型名称",
"max_tokens": 128,
"messages": [
{"role": "user", "content": "用一句话确认 Yoriday 连接正常。"}
]
}' 流式输出
在请求体加入 "stream": true。不同协议的 SSE 事件形状不同,需要分别解析;同时处理 HTTP
错误、流内 error 事件、客户端断开与整体超时。
curl -N https://app.helpday.work/v1/responses \
-H "Authorization: Bearer sk-请替换为你的密钥" \
-H "Content-Type: application/json" \
-d '{
"model": "你的模型名称",
"input": "分三行输出一段简短说明。",
"stream": true
}' | 协议 | 关注点 |
|---|---|
| Responses | delta 文本事件、完成事件与 error |
| Chat Completions | 累加 choices[].delta.content 直到结束标记 |
| Messages | 按 Anthropic 的 content block / delta 事件处理 |
接入建议
- 先跑「仅模型 + 一条短文本」的非流式请求,再加流式、工具或结构化输出。
- 函数工具返回的是名称与参数,真正执行仍在你的业务侧;文件 / 命令类调用务必白名单与人工确认。
- 结构化 JSON 输出即使带 Schema,也要再做解析与业务校验。
调试失败时,先用本页 cURL 对照,再回到客户端。系统化步骤见 排错与安全。