XRToken API 文档

豆包智能体

调用豆包联网问答 Agent,获取回答、引用、卡片和追问数据

API 配置
保存后下方「Try It」面板会自动携带此 API Key 发送真实请求。
Base: api.xrtoken.net

XRToken 提供豆包联网问答 Agent 透传接口,支持非流式和 SSE 流式响应。

端点

POST /v1/agent/chat/completions

兼容别名:POST /v1/agent/chat/completionPOST /v1/agents/chat/completions

请求

{
  "bot_id": "你的智能体ID",
  "agent_variant": "lite",
  "stream": false,
  "messages": [
    { "role": "user", "content": "今天北京天气怎么样?" }
  ],
  "user_id": "user-123"
}

bot_idmessages 必填。bot_id 必须是已开通的 Agent。agent_variant 可选,取 litepro;不传时使用该 Agent 的默认档位。model 可选,支持 thinkingauto_thinkingreasoning_search

请求参数

参数类型必填说明
bot_idstringAgent 标识
messagesarray对话消息,支持 systemuserassistant
streamboolean是否使用 SSE 流式响应,默认 false
agent_variantstringlitepro,不传使用默认档位
user_idstring业务侧终端用户标识,用于保持同一用户的会话、记忆和个性化上下文;不是 XRToken 登录账号标识
device_idstring设备标识
location_infoobject当前位置信息;天气、出行等场景可传
navigation_infoobject导航信息;周边路线等场景可传
knowledgestring本轮请求需要注入的背景知识
memorystring用户画像或个性化记忆
modelstringthinkingauto_thinkingreasoning_search
extension_optionsobject高级能力开关,见下表

user_id 建议使用业务系统中稳定且不可变的用户编号。它不会替代 API Key 鉴权,也不会用于 XRToken 账户计费。

消息内容

文本消息:

{ "role": "user", "content": "你好" }

图文消息:

{
  "role": "user",
  "content": [
    { "type": "text", "text": "请描述这张图片" },
    { "type": "image_url", "image_url": { "url": "https://example.com/a.jpg" } }
  ]
}

文件消息:

{
  "role": "user",
  "content": [
    { "type": "text", "text": "请总结这个文件" },
    { "type": "file_url", "file_url": { "url": "https://example.com/a.pdf" } }
  ]
}

extension_options

参数类型说明
filter_emojibooleantrue 时过滤模型输出中的 emoji
enable_processing_statebooleantrue 时输出 Agent 执行的关键过程;仅流式响应生效
disable_source_type_douyin_videobooleantrue 时关闭控制台已配置的抖音视频内容源
disable_follow_upbooleantrue 时关闭控制台已开启的追问功能
disable_citationbooleantrue 时关闭引用角标
disable_image_text_mixbooleantrue 时关闭图文混排
disable_baike_highlightbooleantrue 时关闭百科划线词
disable_text_to_imagebooleantrue 时关闭搜图能力
enable_search_litebooleantrue 时开启极速搜索模式;耗时较短,但效果可能下降
browsing_modenumber联网模式:1 自动联网,2 强制联网,3 关闭联网。文搜使用 2 时至少使用一个搜索源
card_positionstring卡片返回位置:first_frame(默认,首帧)或 meta_frame(元数据帧)
enable_followup_in_responsebooleantrue 时开启回答结尾的强化追问
disable_ecom_linkbooleantrue 时禁用电商意图,电商链接不参与总结和出卡
disable_video_text_mixbooleantrue 时关闭视频文本混排
learn_modestring解题链路模式;传 auto_learning 时由系统按意图判断是否启用
reasoning_effortstring思维链长度:highmediumlow;自动深度思考模式下不生效
sitesstring[]限定搜索站点,最多 20 个;填写完整域名
block_hostsstring[]屏蔽搜索站点,最多 20 个;填写完整域名,优先级高于 sites
search_auth_info_levelnumber搜索站点权威度:0 不限制,1 仅非常权威站点

示例(强制联网并限定站点):

{
  "extension_options": {
    "browsing_mode": 2,
    "sites": ["gov.cn", "news.qq.com"],
    "block_hosts": ["example.com"],
    "disable_citation": false,
    "card_position": "meta_frame"
  }
}

未在网关文档中列出的请求字段也会按原样透传;字段是否可用由 Agent 配置和上游能力决定。

响应

非流式响应返回 Agent 原始 JSON,常见字段包括:

  • choices
  • references
  • search_results
  • follow_ups
  • cards
  • thinking_references
  • usage

流式响应使用 text/event-stream,每帧格式为 data:{...},以 data:[DONE] 结束。深度思考模式可能在 choices[].message.reasoning_content 或流式 delta 中返回思考内容。

On this page