非同期タスク

task ID を返す長時間実行の REST API オペレーションをポーリングし、実行中・完了・失敗のステータスを読み取る方法。

一部の REST API エンドポイントは、長時間実行される処理を開始し、処理の完了を待たずに非同期タスクを返します。これらのエンドポイントは タスクID とポーリング用の URL:

{
    "taskId": "abc123",
    "url": "https://api.roboflow.com/my-workspace/asynctasks/abc123"
}

ポーリング URL を使って、タスクがまだ実行中か、完了したか、失敗したかを確認します。

タスクのステータスを取得

次の GET リクエストを送信します: /:workspace/asynctasks/:id。 :workspace をタスクを所有する Workspace に置き換え、 :id を返された タスクID.

$ curl --location "https://api.roboflow.com/my-workspace/asynctasks/abc123?api_key=$ROBOFLOW_API_KEY"

API キーは、リクエストパスで使用されたのと同じ Workspace へのアクセス権を持っている必要があります。別の Workspace のタスクは 404.

レスポンスフィールド

- taskId (string) - 非同期タスクの ID。
- status (string) - 現在のタスク状態です。一般的な状態は created、running、completed、failed です。終了状態は completed と failed です。
- progress (object or null) - 利用可能な場合のタスクの進行状況で、形式は `{ "current": <number>, "total": <number> }` です。
- result (object) - タスクが正常に完了した場合に表示されます。
- error (string) - タスクが失敗した場合に表示されます。

実行中のタスク

{
    "taskId": "abc123",
    "status": "running",
    "progress": {
        "current": 42,
        "total": 100
    }
}

完了したタスク

この result object は、このタスクを作成したエンドポイントによって異なります。たとえば、完了した Universe Project の fork は、fork された Project の詳細を返します:

{
    "taskId": "abc123",
    "status": "completed",
    "progress": {
        "current": 100,
        "total": 100
    },
    "result": {
        "forked": true,
        "datasetUrl": "football-players-detection-3zvbc-a1b2c",
        "id": "my-workspace/football-players-detection-3zvbc-a1b2c",
        "name": "Football Players Detection",
        "url": "https://app.roboflow.com/my-workspace/football-players-detection-3zvbc-a1b2c"
    }
}

失敗したタスク

{
    "taskId": "abc123",
    "status": "failed",
    "progress": {
        "current": 64,
        "total": 100
    },
    "error": "Task failed"
}

エラー

- 404 - 非同期タスクは存在しないか、別の Workspace に属しています。