メインコンテンツへスキップ

エンドポイント

説明

特定のタスクの現在のステータス、結果、およびメタデータを取得します。このエンドポイントを使用してタスクの進行状況を確認したり、最終結果を取得したりします。

認証

必要: はい ヘッダーにAPIキーを含めてください:

リクエスト

パスパラメータ

ヘッダー

レスポンス

成功レスポンス

ステータス: 200 OK ヘッダー:
  • X-Workflow-ID: Temporalワークフロー識別子(タスクIDと同じ)
ボディ:

レスポンスフィールド

ステータス値

  • TASK_STATUS_UNSPECIFIED - ステータス不明
  • TASK_STATUS_QUEUED - 実行待ち
  • TASK_STATUS_RUNNING - 現在実行中
  • TASK_STATUS_COMPLETED - 成功裏に完了
  • TASK_STATUS_FAILED - エラーで失敗
  • TASK_STATUS_PAUSED - ユーザーまたはHITLレビューにより一時停止
  • TASK_STATUS_CANCELLED - ユーザーによってキャンセル
  • TASK_STATUS_TIMEOUT - タイムアウト制限を超えた

実行モード値

  • EXECUTION_MODE_SIMPLE - 単一のLLM呼び出し、ツールなし
  • EXECUTION_MODE_STANDARD - ツールを使用したマルチステップ
  • EXECUTION_MODE_COMPLEX - 高度な推論パターン

タスクステータスの確認

レスポンス(キュー中):
レスポンス(実行中):
レスポンス(完了):
レスポンス(失敗):

ディープリサーチレスポンスペイロード

force_research: trueでタスクが提出されると、完了したレスポンスには構造化されたリサーチデータを含む追加のメタデータフィールドが含まれます。

ディープリサーチメタデータフィールド

ディープリサーチタスクの場合、metadataオブジェクトには以下が含まれます:

例: 深い研究の完了レスポンス

抽出された事実 (オプション)

enable_fact_extraction: true がリクエストコンテキストに設定されている場合:

引用オブジェクトスキーマ

metadata.citations 配列内の各引用の位置は、インライン参照で使用される [n] インデックスに対応しています。

検証オブジェクトスキーマ

深い研究データへのアクセス: metadata.citations 配列と metadata.verification オブジェクトは、研究ワークフロー (force_research: true) のみで populated されます。シンプルなタスクの場合、これらのフィールドはレスポンスに存在しません。

エラーレスポンス

401 Unauthorized

404 Not Found

500 Internal Server Error

コード例

Python - シンプルなステータスチェック

Python - 完了までポーリング

JavaScript/Node.js

JavaScript - Poll with Async/Await

Go

Bash - Monitor Task Progress

Use Cases

1. Submit and Wait Pattern

2. ダッシュボードステータスウィジェット

3. バッチステータスチェック

ベストプラクティス

1. ポーリングの代わりにストリーミングを使用

長時間実行されるタスクには、ポーリングの代わりにSSEストリーミングを使用します:

2. すべてのステータス状態を処理

3. 指数バックオフを実装

4. ステータスレスポンスをキャッシュ

5. メタデータを抽出

関連エンドポイント

タスクを送信

POST /api/v1/tasks

イベントをストリーム

リアルタイムモニタリング

Python SDK

client.get_status()を使用

注意事項

本番環境でのポーリングは避けてください: 長時間実行されるタスクには、ポーリングの代わりにストリーミングエンドポイントを使用してください。ポーリングは不必要な負荷を生み出し、レイテンシを追加します。
セッショントラッキング: session_idフィールドを使用すると、タスクがどのセッションに属しているかを追跡できます。これは、マルチターンの会話やコストの帰属に役立ちます。