taskType がエンジンを選びます。タスクの送信方法はすべて同じで、結果も同じ結果オブジェクトで返ります。エンジンごとに変わるのは、その中の response オブジェクトだけです。
すべてのタスクに共通すること
GET /v1/async/task/{id} はすべてのエンジンで同じ結果オブジェクトを返します。success、task(id、ステータス、メタデータ)、credits、そしてタスクが終わると response または error です。ライフサイクルは非同期タスク、プッシュ配信はWebhookを参照してください。
すべての回答エンジンは回答を response.text に、引用したページを response.sources に入れます。sources は { position, url, label } にエンジン固有のフィールドを加えた配列です。例外は Google AIによる概要で、概要は検索結果オブジェクト内の response.aioverview に入ります。
回答エンジン
SERP
WEB_SCRAPE: url は必須。公開ページまたは PDF を 1 つ、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 を 1 つ、2,048 文字まで。render はスクリプト実行後のブラウザで読み、maxAge は最大 7 日前のキャッシュを受け入れます。
Search と Pro Search は専用のエンドポイント POST /v1/search で実行され、同じレスポンスで結果を返します。検索 1 回 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 の以前の名前です。タスクは送信時の名前で応答し、使用量、モニター、レポートではこの2つのエンジンが GOOGLE と AIMODE として表示されます。
非公開のエンジンは
403 ENGINE_PRIVATE で拒否されます。
最新の一覧
GET /v1/capabilities はAPIキーなしで使え、公開されているすべてのtaskTypeについて、エイリアス、エンドポイント、クレジット、必須と任意の入力フィールド、state と include.html を受け付けるか、国のポリシー、最小限のpayload例を返します。各ルールを適用するのと同じコードから作られるため、エンジンや国の選択UIに使ってください。
リクエストオプション
- Markdownと生のレスポンス: 各エンジンが有効にする
includeフラグ。 - 回答の分析: 回答とあわせて返すブランド、推薦、センチメント、出典の種類。
- HTMLページ: エンジンが表示した画面を共有できるページとして返します。
- 地域と位置情報: 国、端末の位置情報、処理能力。