ドキュメントAI Scraperクイックスタートタスクのライフサイクル

タスクライフサイクルの詳細

以下のリファレンスを使用して、リクエストの形式を整え、タスクのライフタイム中にAI Scraper APIが返すすべてのレスポンスを解釈してください。

共通リクエストパラメータ

パラメータ型必須説明
actorstringはい使用するモデルを示す固定識別子。
webhookobjectいいえオプションのWebhook設定を含むオブジェクト。
webhook.urlstringいいえタスク完了時に結果を受信するHTTPSエンドポイント。
inputobjectはいプロンプト、モード、国などのActor固有のパラメータ。

結果データ構造

パラメータ型必須説明
statusstringはいタスクのステータス: pending、 running、 success、または failed。
messagestringいいえタスクが失敗した場合のエラーメッセージ。
task_resultobjectいいえactorの完全なペイロード。フィールドレベルの詳細についてはactorのドキュメントを参照してください。

Webhookプッシュペイロード

パラメータ webhook.url を設定すると、Scrapelessは次のJSON形式でPOSTリクエストを送信します:

パラメータ型必須説明
task_idstringはい完了したタスクの識別子。
statusstringはいsuccess または failed。
inputstringはい元のタスクパラメータをJSONとしてシリアライズしたもの。
task_resultobjectいいえ結果エンドポイントをポーリングしたときに受信するのと同じ構造。

プッシュの例

curl --location '{webhook.url}' \
  --header 'Content-Type: application/json' \
  --data '{
    "task_id": "",
    "status": "",
    "input": "",
    "task_result": {}
  }'

HTTPステータスコード

ステータス意味
200成功。結果が取得されました。
201タスクが正常に作成されました。
202タスクは実行中です。すぐに再試行してください。
400無効なリクエスト。詳細はエラーメッセージを確認してください。
410タスク結果の有効期限が切れました。結果は12時間利用可能です。
429レート制限を超えました。リクエスト頻度を減らすか、容量をアップグレードしてください。