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

以下のリファレンスを使ってリクエストを構成し、API が返すレスポンスを解釈してください。

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

パラメーター	型	必須	説明
`actor`	string	はい	実行したいモデル actor を示します。
`webhook`	object	いいえ	任意の Webhook 設定。
`webhook.url`	string	いいえ	タスク完了時に結果を受信する HTTPS エンドポイント。
`input`	object	はい	prompt・モード・国コードなど actor 固有のパラメーター。

結果データ構造

フィールド	型	必須	説明
`status`	string	はい	タスク状態：`pending`、`running`、`success`、`failed`。
`message`	string	いいえ	失敗時のエラー文。
`task_result`	object	いいえ	actor 固有の結果。フィールドは各モデルのドキュメントを参照。

Webhook ペイロード

webhook.url を設定すると、Scrapeless は次の JSON を POST で送信します。

フィールド	型	必須	説明
`task_id`	string	はい	完了したタスク ID。
`status`	string	はい	`success` または `failed`。
`input`	string	はい	元のリクエストパラメーターを JSON 文字列化したもの。
`task_result`	object	いいえ	結果エンドポイントで取得する内容と同じ。

プッシュ例

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

HTTP ステータスコード

コード	意味
`200`	結果を正常に取得。
`201`	タスク作成に成功。
`202`	タスク実行中。しばらくして再試行してください。
`400`	リクエストが不正。エラーメッセージを確認。
`410`	結果が期限切れ（保持 12 時間）。
`429`	リクエスト制限を超過。

はじめる ChatGPT