移行手順
実装範囲
対応
POST /v1/async/taskPOST /v1/async/task/batchGET /v1/async/task/{id}Webhookコールバック未実装
/v1/monitor/* 同期エンドポイント/v1/async/status/v1/monitor/* 系は意図的に提供していません。ここのすべてのエンジンは非同期で動作し、問い合わせに
かかる時間だけリクエストをブロックする形はこのサービスでは提供しません。
挙動が異なる箇所
1. レート制限なし、バッチを使う
1. レート制限なし、バッチを使う
キー単位のレート制限はありません。大量のリクエストはバッチ送信で往復回数を減らしてください。地域とベストプラクティスを参照してください。
2. クレジットはエンジンごと
2. クレジットはエンジンごと
credits はエンベロープの一部としてすべてのレスポンスに含まれます。送信とポーリングのレスポンスは
{ "creditsToCharge": 0, "creditsCharged": 0 } を報告し、Webhookはエンジンごとのクレジットコスト
(エンジンにより1–3クレジット)を報告します。失敗したタスクには課金しません。クレジット残高はダッシュボードで確認できます。3. 一部のエンジン × 地域の組み合わせは即時拒否
3. 一部のエンジン × 地域の組み合わせは即時拒否
まったく提供できない組み合わせが1つあります。
CHATGPT/PERPLEXITY/GEMINI を CN に向ける場合で、
出口の供給がなくリクエストが対象に届きません。受け付けずに即座に 422 REGION_UNSUPPORTED で失敗します。
同じ状況の一時的なものは 422 REGION_UNAVAILABLE です。正しい形式の送信はすべて受け付けられると想定しているクライアントには、ここで分岐が必要です。
地域を参照してください。4. includeフラグはほとんど効果なし
4. includeフラグはほとんど効果なし
payload.include フラグは受け付けますが、ここのほとんどのエンジンは固定形のレスポンスを返し、フラグを
無視します。すべてのフラグに従うのは ChatGPT だけで、GEMINI は markdown と rawResponse のみに従います。たとえば Gemini に html を要求しても、エラーもフィールドもなく黙って無視されます。
フラグ対応表を参照してください。5. ステータスコードが1つ追加: 422
5. ステータスコードが1つ追加: 422
それ以外のエラー処理は一般的です。検証失敗は
400、401 は MISSING_API_KEY、404 は
RESOURCE_NOT_FOUND を報告し、details が問題のフィールドを示します。追加は上で説明した 422 の2つ(REGION_UNSUPPORTED、REGION_UNAVAILABLE)だけです。提供できない地域を
事前に伝えるため、422 を扱ったことのないクライアントもこれを受け取るようになります。6. 失敗したタスクにはトップレベルの error 文字列が付く
6. 失敗したタスクにはトップレベルの error 文字列が付く
FAILED タスクに GET /v1/async/task/{id} を呼ぶと、タスクステータスのスキーマでは定義されていない
トップレベルの error フィールドが返ります。リクエストレベルのエラーが使う {code, message, timestamp}
オブジェクトではなく、プレーンな文字列です。body.error が真ならリクエストが失敗したとみなすクライアントは、正常に取得できた失敗タスクを
誤解します。task.status で分岐してください。これらの挙動はスキーマを読んでではなく、このAPIを実際に呼び出して確認したものです。公開仕様と実際の
レスポンスが食い違う場合、このドキュメントは実際のレスポンスを記載します。
適切な taskType を選ぶ
現在エンジンごとのエンドポイントを呼んでいる場合、エンジン名は次の taskType に対応します。
GOOGLE が「AI による概要」を意味するのは命名上の慣例で、Google の製品名ではありません。レスポンスは
aioverview をnullableメンバーとして持つSERPエンベロープです。GOOGLE のレスポンス形を参照してください。切り替えの検証
しばらく既存の連携とこの連携を並行稼働させ、実際に使うフィールドを比較してください。実務上はresponse.text、response.sources[]、response.markdown です。シャドー比較は、値は入っているが順序が
異なるソース一覧のように、スキーマチェックでは捉えられない形の差異を捉えます。