Rivya AI ドキュメント

生成ステータス

公開タスク ID で Rivya API の生成ジョブをポーリングし、queued、processing、succeeded、failed の状態を読み取り、結果 URL を利用します。

2026/05/10 最終レビュー

非同期生成ジョブを確認するには、GET /api/v1/generations/{taskId} を使います。

エンドポイント

GET https://rivya.ai/api/v1/generations/{taskId}

必須ヘッダー:

Authorization: Bearer rvya_sk_...

curl 例

curl https://rivya.ai/api/v1/generations/task_public_id \
  -H "Authorization: Bearer rvya_sk_..."

ステータス値

公開ステータス値:

  • queued: タスクは受理済みで、まだ完了していません
  • processing: 生成が実行中です
  • succeeded: 結果を利用できます
  • failed: タスクは失敗し、公開 error オブジェクトを含む場合があります

成功応答

{
  "id": "task_public_id",
  "status": "succeeded",
  "model": "z-image",
  "reserved_credits": 1,
  "final_credits": 1,
  "created_at": "2026-05-10T00:00:00.000Z",
  "updated_at": "2026-05-10T00:01:00.000Z",
  "result": {
    "primary_url": "https://media.example/result.png",
    "urls": ["https://media.example/result.png"]
  },
  "error": null
}

primary_url は利便性のための最初の結果 URL です。urls には、利用可能な場合に公開結果 URL の一覧が含まれます。

失敗応答

{
  "id": "task_public_id",
  "status": "failed",
  "model": "z-image",
  "reserved_credits": 1,
  "final_credits": 0,
  "created_at": "2026-05-10T00:00:00.000Z",
  "updated_at": "2026-05-10T00:01:00.000Z",
  "result": null,
  "error": {
    "code": "generation_failed",
    "message": "The generation failed."
  }
}

ポーリングの目安

最初は短い待機を置き、その後ポーリング間隔を伸ばしてください。短いループで連続実行することは避けてください。

推奨パターン:

  • 送信後に 2-3 秒待つ
  • 通常ジョブは 5-10 秒ごとにポーリングする
  • 長い動画と音声ジョブでは間隔を遅くする
  • ステータスが succeeded または failed になったらポーリングを停止する

所有境界

タスクは API キーの背後にある同じ Rivya アカウントに属している必要があります。見つからない、またはそのアカウントに所有されていない場合、エンドポイントは not_found を返します。

関連ページ

目次