仕組み
すべてのリクエストは非同期です。タスクを送信するとキューに入り、ワーカーが対象エンジンに 問い合わせて結果を抽出します。結果はWebhookで受け取るか、ポーリングで取得します。1
タスクを送信
taskType と payload を指定して POST /v1/async/task を呼び出します。タスク id が
ステータス QUEUED で即座に返ります。2
エンジンに問い合わせ
ワーカーがタスクを取得してエンジンに問い合わせ、回答テキスト、ソース、エンジン固有の追加情報を抽出します。
3
結果を受け取る
webhook.url を指定した場合は、結果をそのURLにPOSTします。指定しない場合は、status が
COMPLETED または FAILED になるまで GET /v1/async/task/{id} をポーリングしてください。返ってくるもの
エンジンにかかわらず、すべての結果の中核は同じ形です。string
エンジンの回答をプレーンテキストで返します。
array
エンジンが回答に付けた引用です。
position、url、通常は label を含みます。ベースURL
/health と /ready を除くすべてのエンドポイントにはBearerトークンが必要です。
ここから始める
最初のタスクを送信し、5分以内に結果を受け取りましょう。