接入文档
OpenAI 协议兼容 + 火山方舟协议镜像,改一行 baseURL 即可接入。全部生成内容按《人工智能生成合成内容标识办法》携带显式与隐式标识。
三步快速接入
- 1
创建 API Key
/dashboard/keys明文只显示一次,记得保存
- 2
复制接口地址
/api/v1 - 3
运行示例
替换 Key 直接运行
API Key 管理
- 在 控制台 · API Key 管理 创建;明文只显示一次,请当场保存。
- 鉴权方式:请求头
Authorization: Bearer <你的 Key>(Key 形如sk-kl-…)。 - Key 走环境变量(如 KUNLUN_API_KEY),不要写进前端代码 / Git 仓库 / 客户端 App。
- 单个 Key 可限定可调用模型范围、设预算上限并按项目计量(明细在控制台用量页查看)。
错误码
错误信封与 OpenAI 一致({ "error": { message, type, param, code } }),openai / langchain / dify 这类 SDK 可直接读出 error.code 做分支处理。
| HTTP | code | 含义 | 怎么处理 |
|---|---|---|---|
| 401 | invalid_api_key | 缺少或无效的 API Key(type=authentication_error) | 检查 Authorization 头是否形如 Bearer sk-kl-… |
| 403 | permission_denied | Key 或账号被停用 | 换用有效 Key,或联系客服确认账号状态 |
| 403 | model_not_in_plan | 该模型不在当前套餐可调用范围内 | 换档位模型或升级套餐;本次未调上游、不扣费 |
| 402 | insufficient_quota | 余额 / 额度不足 | 充值后再试;不足时不调用上游 |
| 404 | model_not_found | model 未注册(param=model) | 对照下方模型清单填对外别名 |
| 429 | rate_limit_exceeded | 触发限流 | 按 Retry-After 退避重试,不要并发硬顶 |
| 400 | invalid_request_error | 请求参数不合规(如向量端点传了视频输入) | 按 message 修正入参 |
| 503 | pricing_missing | 平台价目缺失,主动拒服(不按 0 元放行) | 重试无效,联系客服补齐价目;本次未扣费 |
| 503 | moderation_unavailable | 内容审核繁忙 | 可退避重试;本次未调模型、未扣费 |
| 502 | upstream_error | 上游异常(不可归因于调用方) | 稍后重试 |
| 504 | upstream_timeout | 上游首字节超时 / 明确回超时 | 上游可能仍在算,稍后重试或缩短输入 |
1. 文字对话(OpenAI 协议)
把 OpenAI SDK 的 base_url 换成 https://api.yizhuruanjian.com/api/v1 即可,其余代码一行不改。 支持流式(SSE)、深度思考开关、透明前缀缓存。
curl https://api.yizhuruanjian.com/api/v1/chat/completions \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"model": "doubao-seed-2-1-pro",
"messages": [{"role": "user", "content": "你好"}]
}'火山方舟客户:把 base_url 换成 https://api.yizhuruanjian.com/api/v3 并保留原有 model 值(Model ID / 接入点 ID)即可, 协议 1:1 镜像,无需改任何请求字段。
2. 图片生成
OpenAI Images 协议兼容(/images/generations),同步返回图片 URL(数小时有效期,请及时转存)。建议不要传 size:不传时由上游按模型默认出图; 若要指定,注意本平台图片模型要求像素不小于 3,686,400(约 1920×1920), 传 1024×1024 会被上游拒绝(这是模型侧限制,不是接口问题)。 响应头 X-Kunlun-Charged-Cents 为本次实扣(分)。
| model | 价格 | 说明 |
|---|---|---|
| doubao-seedream-5-0-pro-260628 | ¥0.30 / 张(30 积分) | 火山公示价 ¥0.30/张 · Model ID 由台账确认 2026-09-20 · 按张固定价,无闲忙时 |
| doubao-seedream-5-0-lite-260128 | ¥0.22 / 张(22 积分) | 火山公示价 ¥0.22/张 · Model ID 由《遗留4项裁定-20260921》确认 2026-09-21 · 按张固定价,无闲忙时 |
| doubao-seedream-4-5-251128 | ¥0.25 / 张(25 积分) | 火山公示价 ¥0.25/张 · Model ID 由《遗留4项裁定-20260921》确认 2026-09-21 · 按张固定价,无闲忙时 |
| doubao-seedream-5-0-flash-260915 | ¥0.12 / 张(12 积分) | ¥0.12/张 = 12 分 · 按张固定价 | P11-04 2026-09-26 实拨 Model ID 直连 HTTP 200 出图(2496x1664)已开通,纳入图片 Auto 池 |
curl https://api.yizhuruanjian.com/api/v1/images/generations \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"model": "doubao-seedream-5-0-pro-260628",
"prompt": "一只戴墨镜的柴犬,赛博朋克风格"
}'3. 视频生成(异步任务)
与火山方舟一致的异步模式:提交任务 → 轮询查询。 提示词可用 --rs 720p 指定分辨率、--dur 5 指定时长(秒)。 任务提交即按平台价目扣费;若生成结果未通过内容安全审核,费用自动原路退回。
| model | 规格 | 价格 | 5 秒示例 |
|---|---|---|---|
| ep-20260920164120-g7c6r | 720p | ¥1.21 / 秒(121 积分) | ¥6.05 |
| ep-20260920164120-g7c6r | 480p | ¥0.56 / 秒(56 积分) | ¥2.80 |
| doubao-seedance-2-5-260628 | 720p | ¥1.51 / 秒(151 积分) | ¥7.55 |
| doubao-seedance-2-5-260628 | 480p | ¥0.67 / 秒(67 积分) | ¥3.35 |
| doubao-seedance-2-5-260628 | 1080p | ¥3.74 / 秒(374 积分) | ¥18.70 |
# ① 提交异步任务
curl https://api.yizhuruanjian.com/api/v1/contents/generations/tasks \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"model": "ep-20260920164120-g7c6r",
"content": [{"type": "text", "text": "航拍海岸线日出,电影感 --rs 720p --dur 5"}]
}'
# → {"id": "cgt-xxxx"}
# ② 轮询任务(建议 5~10 秒一次)
curl https://api.yizhuruanjian.com/api/v1/contents/generations/tasks/cgt-xxxx \
-H "Authorization: Bearer YOUR_API_KEY"4. 向量化(Embeddings · 知识库场景)
OpenAI 协议(/embeddings)与火山方舟镜像 (/api/v3/embeddings)双通道,均可直接喂给 FastGPT / Dify / LangChain 这类现成知识库。向量模型与火山同名同维度,model 填火山原值即可。 按输入 token计费;输入内容同样经过内容安全审核。
入参与返回:input传字符串数组时逐段返回(3 段 → 3 个向量,index 与顺序对应), 传单个字符串则返回 1 个向量;知识库批量入库请直接传数组。 方舟多模态端点(/api/v3/embeddings/multimodal)按火山语义把整段多模态输入融合为一个向量。 暂不支持视频输入(会明确返回 400,不做“不看内容直接向量化”的放行)。
| model | 计费档 | 价格(按输入) | 说明 |
|---|---|---|---|
| doubao-embedding-vision-251215 | 文本输入 | ¥0.70 / 百万 tokens(70 积分) | 火山公示价 ¥0.70/百万 tokens(文本输入)· 输出 2048 维 · 2026-09-23 探针实测可调用 |
| doubao-embedding-vision-251215 | 图片输入 | ¥1.80 / 百万 tokens(180 积分) | 火山公示价 ¥1.80/百万 tokens(图片输入)· 请求含图片时按此档计费 |
curl https://api.yizhuruanjian.com/api/v1/embeddings \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"model": "doubao-embedding-vision-251215",
"input": ["昆仑引擎是什么", "把它转成向量"]
}'
# → {"object":"list","data":[{"object":"embedding","index":0,"embedding":[0.01,...]}],"usage":{...}}兼容范围:文本输入(string 或 string[],OpenAI 语义)与图片输入(方舟原生多模态数组input:[{type:'image_url',image_url:{url}}]);图片输入按上表「图片输入」档计费。视频输入不支持,会明确返回 400, 不做"不看内容直接向量化"的放行。当前示例模型:doubao-embedding-vision-251215
5. 文字模型清单
| 中文名 | model(对外别名) | 定位 | 上下文 |
|---|---|---|---|
| 豆包·专业版 | doubao-seed-2-1-pro | 旗舰 · 复杂推理 | 256K |
| 豆包·旗舰版(持续进化) | doubao-seed-evolving | 旗舰 · 持续进化 | 1024K |
| 豆包·标准版 | doubao-seed-2-1-turbo | 高性价比 · 主力 | 256K |
| 豆包·极速版 | doubao-seed-2-0-mini | 轻量 · 按输入长度分段计价 | 256K |
| GLM-5.3-Flash | glm-5-3-flash-260828 | 高性价比 · 轻快对话 | — |
| DeepSeek-V4-Flash | deepseek-v4-flash-ga-260731 | 高性价比 · 通用 | — |
| DeepSeek-V4-Pro | deepseek-v4-pro-ga-260813 | 深度推理 · 复杂任务 | — |
越级调用会返回 403 model_not_in_plan, 该次请求不会调用上游、不扣费。
6. 流式 SSE
请求体加 stream: true 即走流式: 响应为 text/event-stream, 逐帧 data: {…}, 以 data: [DONE] 收尾 —— 与 OpenAI 完全一致, 官方 SDK 的 for await 可直接消费。
curl -N https://api.yizhuruanjian.com/api/v1/chat/completions \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"model":"doubao-seed-2-1-pro","stream":true,
"messages":[{"role":"user","content":"讲个一句话的冷笑话"}]}'
# ← data: {"choices":[{"delta":{"content":"为"},"index":0}]}
# ← data: [DONE]深度思考默认开启(思考 token 计入输出);要关闭就传 "thinking": {"type": "disabled"}(也认 enable_thinking: false 这种民间写法)。 流式同样按实际 token 计费,计费量在最后一帧的 usage 与响应头 X-Kunlun-Charged-Cents 里给出。
7. 火山方舟 → 昆仑引擎 迁移
仅两步:base_url 换成 https://api.yizhuruanjian.com/api/v3;api_key 换成昆仑 Key。model 字段不用改(火山 Model ID 与接入点 ID 均自动映射)。详见 迁移指南。
# 火山方舟(原)
base_url = "https://ark.cn-beijing.volces.com/api/v3"
api_key = "ARK_KEY"
# 昆仑引擎(改后)
base_url = "https://api.yizhuruanjian.com/api/v3"
api_key = "YOUR_API_KEY" # model 字段保持原值8. 计费与价目
全部模型按平台公示价计费(与 模型页 / 定价页 同一数据源,本页不硬编码任何价格)。平台积分口径为 1 元 = 100 积分(1 积分 = 1 分):
doubao-seed-2-1-pro:输入 ¥6.00(600 积分)/ 输出 ¥30.00(3000 积分)/ 缓存命中 ¥1.20(120 积分) (元 / 百万 tokens)doubao-seed-evolving:输入 ¥6.00(600 积分)/ 输出 ¥30.00(3000 积分)/ 缓存命中 ¥1.20(120 积分) (元 / 百万 tokens)doubao-seed-2-1-turbo:输入 ¥3.00(300 积分)/ 输出 ¥15.00(1500 积分)/ 缓存命中 ¥0.60(60 积分) (元 / 百万 tokens)doubao-seed-2-0-mini:输入 ¥0.20(20 积分)/ 输出 ¥2.00(200 积分)/ 缓存命中 ¥0.04(4 积分) (元 / 百万 tokens)- 输入 ≤ 32K:输入 ¥0.20 / 输出 ¥2.00 / 缓存 ¥0.04
- 输入 ≤ 128K:输入 ¥0.40 / 输出 ¥4.00 / 缓存 ¥0.08
- 输入 ≤ 256K:输入 ¥0.80 / 输出 ¥8.00 / 缓存 ¥0.16
glm-5-3-flash-260828:输入 ¥0.80(80 积分)/ 输出 ¥2.80(280 积分)/ 缓存命中 ¥0.00(0 积分) (元 / 百万 tokens)deepseek-v4-flash-ga-260731:输入 ¥3.00(300 积分)/ 输出 ¥9.00(900 积分)/ 缓存命中 ¥0.00(0 积分) (元 / 百万 tokens)deepseek-v4-pro-ga-260813:输入 ¥9.00(900 积分)/ 输出 ¥27.00(2700 积分)/ 缓存命中 ¥0.00(0 积分) (元 / 百万 tokens)doubao-embedding-vision-251215(向量 · 文本输入):输入 ¥0.70(70 积分)/ 百万 tokensdoubao-embedding-vision-251215(向量 · 图片输入):输入 ¥1.80(180 积分)/ 百万 tokens
- 按输入 / 输出 / 缓存三段计量,实时从余额扣;不足 1 分的零头结转到下次合并扣。
- 价目缺失的档位一律拒绝服务(返回 503 pricing_missing),绝不按 0 元静默放行。
- 响应头
X-Kunlun-Charged-Cents/X-Kunlun-Balance-Cents:本次扣费与扣后余额(分)。 - 余额不足返回
402,且不调用上游。
9. 安全与合规
- 文字 / 图片 / 视频 / 向量调用全部经过内容安全审核(本地引擎 + 腾讯云天御双审取更严)。
- 审核未通过不扣费:文字/图片在扣费前拦截;视频异步任务提交后拦截的自动原路退款。
- 生成内容按《人工智能生成合成内容标识办法》携带显式与隐式标识。
- 本页代码示例只含占位符
YOUR_API_KEY; Key 请走环境变量,不要写进前端代码 / Git 仓库 / 客户端 App。