taskType 选择引擎。所有任务的提交方式相同,所有结果也以相同的结果对象返回,只有其中的 response 对象因引擎而异。
所有任务的共同点
GET /v1/async/task/{id} 对每个引擎都返回相同的结果对象:success、task(id、状态和元数据)、credits,任务完成后还有 response 或 error。生命周期见异步任务,推送投递见 Webhook。
每个回答引擎都把回答放在 response.text,把引用的页面放在 response.sources:一个 { position, url, label } 数组,外加各引擎特有的字段。Google AI 概览是例外:概览位于搜索结果对象中的 response.aioverview。
回答引擎
SERP
WEB_SCRAPE:url 必填,一个公开页面或 PDF,最多 2,048 字符。render 在脚本执行后用浏览器读取,maxAge 接受最多 7 天前的缓存。
COMMERCE_SERP:site 必填,US 为 amazon、walmart、target、ebay、aliexpress、google_shopping、sephora、ulta,KR 为 coupang、oliveyoung、11st、lotteon、musinsa、kurly,JP 为 rakuten、yahoo_shopping、qoo10,IN 为 flipkart、myntra、nykaa,DE 为 zalando。query:必填,1-500 个字符。country:可选,默认是商城所在国家。limit:可选整数,1-40,默认 20。
COMMERCE_PRODUCT:url 必填,为商品页面:US 为 amazon、walmart、target、sephora、ulta,KR 为 11st、lotteon、musinsa、kurly、oliveyoung,JP 为 rakuten、yahoo_shopping、qoo10,IN 为 flipkart、myntra、nykaa,DE 为 zalando,最多 2,048 个字符。country:可选,默认是商城所在国家。
Search
WEB_SCRAPE:url 必填,一个公开页面或 PDF,最多 2,048 字符。render 在脚本执行后用浏览器读取,maxAge 接受最多 7 天前的缓存。
Search 和 Pro Search 在独立端点 POST /v1/search 上运行,并在同一响应中返回结果:每次搜索 0.5 积分,Pro Search 2 积分。
价格按每个完成的任务计算。预留、扣费和附加项见积分与限制。
读取哪个 payload 字段
对于下列引擎,校验接受带有prompt 或 query 之一、长度 1 到 100,000 个字符的任务(否则返回 400 VALIDATION_ERROR)。每个引擎先读取一个字段,缺少时回退到另一个,因此用另一个键发送的请求依然会执行:
CHATGPT、GEMINI、PERPLEXITY、COPILOT、BING_AIMODE、META_AI、QWEN、DOUBAO和BING_SEARCH先读prompt,再读query。GOOGLE_AIO、GOOGLE_AIMODE、GOOGLE_SERP、GOOGLE_PLACES、GOOGLE_NEWS、NAVER_AI_BRIEF、NAVER_AI_TAB、NAVER_SERP和BAIDU_AI_SEARCH先读query,再读prompt。BRAVE_SEARCH读取query,再读取prompt。
接受的别名
以下名称在提交时被接受,并按规范的 taskType 运行。新代码请发送规范名称。GOOGLE 和 AIMODE 是 GOOGLE_AIO 和 GOOGLE_AIMODE 的旧名称。任务以提交时使用的名称响应,用量、监控和报告中这两个引擎显示为 GOOGLE 和 AIMODE。
私有引擎会以
403 ENGINE_PRIVATE 拒绝。
实时列表
GET /v1/capabilities 无需 API 密钥,返回每个公开 taskType 的别名、端点、积分、必填和可选输入字段、是否接受 state 和 include.html、国家策略以及最小示例 payload。它与执行各项规则的代码同源,可以用来驱动引擎和国家选择器。
请求选项
- Markdown 与原始响应:各引擎支持哪些
include标志。 - 回答分析:在回答旁附带品牌、推荐、情感和来源类型。
- HTML 页面:引擎显示的画面,以可分享的页面返回。
- 地区与位置:国家、设备位置和容量。