API 使用指南
其他端点
Embeddings、旧版 Completions、异步视频、余额查询和健康检查。也列出网关不支持的端点。
端点总览
| 方法和路径 | 用途 | 文档 |
|---|---|---|
GET /v1/models | 列出密钥可用的模型 | 模型 |
POST /v1/chat/completions | Chat Completions | 聊天 |
POST /v1/responses | Responses | Responses API |
GET /v1/responses | Responses WebSocket | Responses API |
POST /v1/responses/compact | 压缩会话 | Responses API |
POST /v1/messages | Anthropic Messages | Messages |
POST /v1/images/generations | 生成图片 | 图片生成 |
POST /v1/images/edits | 编辑图片 | 图片生成 |
POST /v1/embeddings | 文本向量 | 本页 |
POST /v1/completions | 旧版文本补全 | 本页 |
POST /v1/videos 等 | 异步视频生成 | 本页 |
GET /user/balance、GET /api/codex/usage | 用 API 密钥查询余额 | 本页 |
/v1/codex/responses 是 /v1/responses 的别名。除视频端点外,以上端点也接受不带 /v1 的路径和 /api 前缀。
不支持的端点
以下端点不存在。用 POST 请求它们会返回 HTTP 404。用 GET 请求时,你可能收到网站的 HTML 页面,而不是 JSON。
- Gemini 原生端点(例如
/v1beta/models/...:generateContent)。Gemini 模型请通过 Chat Completions、Responses 或 Messages 调用。 - 音频端点
/v1/audio/*(语音转文字、文字转语音)。 - 文件、向量库、Assistants、Batch 等端点,例如
/v1/files。 POST /v1/messages/count_tokens。POST /v1/images/variations。
Embeddings
curl https://api.lynshen.org/v1/embeddings \
-H "Authorization: Bearer $LYNSHEN_API_KEY" \
-H "Content-Type: application/json" \
-d '{"model": "text-embedding-3-small", "input": ["第一段文本", "第二段文本"]}'{
"object": "list",
"data": [{ "object": "embedding", "index": 0, "embedding": [0.01, -0.02, 0.03] }],
"model": "text-embedding-3-small",
"usage": { "prompt_tokens": 5, "total_tokens": 5 }
}input必须是一个字符串,或字符串数组。- 这个端点不支持流式输出。
- 只有
/v1/models中有向量模型时才能使用。上面的模型名只是示例。
旧版 Completions
POST /v1/completions 接受旧版 OpenAI 文本补全格式。网关把它转换成一次 Chat Completions 请求:
curl https://api.lynshen.org/v1/completions \
-H "Authorization: Bearer $LYNSHEN_API_KEY" \
-H "Content-Type: application/json" \
-d '{"model": "deepseek-v4-pro", "prompt": "写一句问候语。", "max_tokens": 50}'prompt必须是一个字符串,或只含一个字符串的数组。suffix、echo、best_of、logprobs返回 HTTP400。- 响应的
object为text_completion,文本在choices[].text中。
异步视频生成
视频生成是异步任务。只有 /v1/models 中有视频模型时才能使用。视频端点必须保留 /v1 前缀。
创建任务:
curl https://api.lynshen.org/v1/videos \
-H "Authorization: Bearer $LYNSHEN_API_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: video-order-001" \
-d '{"model": "<视频模型>", "prompt": "一只猫走过花园", "duration": 6, "resolution": "720p"}'成功时返回 HTTP 202、以 video_ 开头的任务 ID 和 Location 响应头。
查询任务:
curl https://api.lynshen.org/v1/videos/video_TASK_ID \
-H "Authorization: Bearer $LYNSHEN_API_KEY"- 每 5 秒查询一次。状态有
queued、submitting、running、succeeded、failed、cancelled、unknown。 - 成功后,及时下载
output.url。上游链接会过期,网关不托管视频文件。 - 每次生成使用唯一的
Idempotency-Key。重试同一个请求时复用它。同一个值用于不同请求时返回409。 GET /v1/videos?limit=20&after=video_TASK_ID分页列出任务。每个密钥只能看到自己创建的任务。POST /v1/videos/{id}/cancel取消尚未开始提交的任务。- 状态为
unknown时,上游可能仍在处理。创建新任务前请联系客服。 - 创建时预扣固定价格。成功后结算,明确失败或在提交前取消时退款。
可选字段有 duration(1 到 60 秒)、resolution、aspect_ratio、input、provider_options。请求体上限为 1 MiB。
用 API 密钥查询余额
两个兼容端点返回密钥对应的余额,不产生费用:
curl https://api.lynshen.org/user/balance -H "Authorization: Bearer $LYNSHEN_API_KEY"{
"is_available": true,
"balance_infos": [
{ "currency": "USD", "total_balance": "1.25", "granted_balance": "0", "topped_up_balance": "1.25" }
]
}/user/balance使用 DeepSeek 的余额格式。支持查询 DeepSeek 余额的客户端可以直接使用它。/api/codex/usage使用 Codex 的用量格式,credits.balance是 USD 余额。- 余额单位是 USD。密钥开启了独立子账户时,返回子账户余额。否则返回账户钱包余额。
- 这两个路径没有其他别名。不要加
/v1。
健康检查
GET https://api.lynshen.org/readyz 不需要认证。网关可以处理请求时,它返回 HTTP 200。