跳转到内容

接入指南

提交与查询

批量提交、任务状态和结果读取规则。

  • 请求体直接使用 JSON 数组,最少 1 项、最多 50 项。
  • 每项包含 question、platformCode 和可选的 options、webhookUrl、clientReference。
  • 每项只能包含一个问题和一个平台。
  • 每项独立返回 taskId,独立执行、计费和通知。
  • 内容完全相同的任务允许重复提交,不会被合并。
  • 任一项不合法时,整次请求都不会被接受。

Idempotency-Key 只用于避免同一次 HTTP 请求因重试而重复创建。复用相同键和相同请求体会返回原 taskId;相同键对应不同请求体会返回 HTTP 409。

状态 含义
pending 已接受,等待处理
processing 正在处理
completed 已完成
failed 未完成
stopped 已停止

建议按 2、4、8 秒逐步延长查询间隔,最长间隔 30 秒;也可以使用完成通知。

任务完成后,content 返回回答正文。回答包含商品、视频、图片、文档或文件时,content 会带有可直接渲染的 Markdown 卡片及类型标签;同时可从 products、videos、media 读取结构化数据。

这三个数组共用同一套 position:将数组合并并按 position 升序排列,可以得到富媒体的完整展示顺序。商品点击应优先使用 products[].url,并根据 urlType 区分网页和 App 深链;App 深链不可用时再尝试 fallbackUrl。字段是否存在取决于本次平台实际返回的数据。

完整字段说明与示例见查询单个任务。完成通知中的 task 使用同一结果结构;内容过大并被省略时,应使用 taskId 再次查询。

结果内容默认保留 7 天。过期后,taskId、状态和积分仍可查询,expired 为 true。