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

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

以下のリファレンスを参照して、リクエストを構築し、タスクの実行期間中に AI Scraper API が返すすべてのレスポンスを解釈してください。

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

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

結果データ構造

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

Webhook プッシュペイロード

webhook.url を設定すると、Scrapeless は以下の JSON 形式で POST リクエストを発行します。

ParameterTypeRequiredDescription
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 ステータスコード

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