API 文档

豆包 API 提供文本生成、文本向量、图像生成与相关开发能力，适用于应用集成、内部工具、自动化流程与开发测试场景。

基本地址：https://api.doubao-ai.com/v1

认证

所有 API 请求都应在 Authorization 请求头中携带有效密钥。未通过认证的请求通常无法进入后续接口处理流程。

Authorization: Bearer YOUR_API_KEY

错误码

接口调用建议同时检查 HTTP 状态码、错误返回结构与请求上下文。对重试、限流、参数校验与日志记录进行显式处理，有助于提升集成稳定性。

状态码	含义	处理建议
400	请求参数错误	检查参数类型、字段结构与必填项
401	认证失败	检查 API Key 是否有效以及请求头格式是否正确
429	请求频率受限	建议配合退避重试并检查调用频率
500	服务端错误	记录错误上下文，并在适当场景下进行重试

对话生成（Chat Completions）

用于根据消息序列生成对话结果，适合单轮问答与多轮会话等文本交互场景。

请求参数

参数名	类型	必选	说明
model	string	是	模型标识，例如 `doubao-pro-v1`
messages	array	是	按顺序排列的消息列表，用于承载上下文内容
temperature	float	否	采样温度，取值范围通常为 0–2，默认值一般为 0.7

示例代码

curl https://api.doubao-ai.com/v1/chat/completions \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $DB_API_KEY" \
  -d '{
    "model": "doubao-pro-v1",
    "messages": [
      {"role": "system", "content": "你是一个有用的助手。"},
      {"role": "user", "content": "你好！"}
    ]
  }'

import os
from doubao import DoubaoClient

client = DoubaoClient(api_key=os.environ.get("DB_API_KEY"))

completion = client.chat.completions.create(
  model="doubao-pro-v1",
  messages=[
    {"role": "system", "content": "你是一个有用的助手。"},
    {"role": "user", "content": "你好！"}
  ]
)

print(completion.choices[0].message.content)

import Doubao from "doubao-ai";

const doubao = new Doubao({ apiKey: process.env.DB_API_KEY });

const completion = await doubao.chat.completions.create({
  model: "doubao-pro-v1",
  messages: [
    { role: "system", content: "你是一个有用的助手。" },
    { role: "user", content: "你好！" }
  ]
});

console.log(completion.choices[0].message.content);

文本向量（Embeddings）

用于生成文本向量表示，适合语义检索、排序、聚类、召回与相似度匹配等场景。

参数名	类型	必选	说明
model	string	是	向量模型标识
input	string / array	是	待编码的文本或文本列表

文生图（Image Generation）

根据文本提示生成图像，适用于概念草图、创意视觉、内容配图与后续人工复核场景。

请求参数

参数名	类型	必选	说明
prompt	string	是	图像描述文本
size	string	否	图像尺寸，例如 `1024x1024`

curl https://api.doubao-ai.com/v1/images/generations \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $DB_API_KEY" \
  -d '{
    "prompt": "A futuristic city skyline at sunset",
    "size": "1024x1024"
  }'

图像编辑（Image Editing）

在支持的能力范围内，可结合原始图像与新增提示进行调整、补充或修改，适合迭代式图像处理流程。