> ## Documentation Index
> Fetch the complete documentation index at: https://docs.xhuoapi.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Veo Tasks API の接続と使用

> Veo Video Generation 集成指南 - XHuoAPI

Veo Tasks API の主な機能は、Veo Videos Generation API によって生成されたタスクIDを入力することで、そのタスクの実行状況を照会することです。

この文書では、Veo Tasks API の接続説明を詳しく紹介し、簡単に統合し、この API の強力な機能を十分に活用できるようにします。Veo Tasks API を使用することで、Veo Videos Generation API のタスク実行状況を簡単に照会できます。

## 申請プロセス

Veo Tasks API を使用するには、まず申請ページ [Veo Videos Generation API](https://api.xhuoapi.ai/documents/63e01dc3-eb21-499e-8049-3025c460058f) にアクセスして、該当するサービスを申請し、その後、Veo Videos Generation API のタスクIDをコピーします。以下の図のように：

<p>
  <img src="https://cdn.xhuoapi.ai/txlg6g.png" width="500" className="m-auto" />
</p>

最後に、Tasks API ページ [Veo Tasks API](https://api.xhuoapi.ai/documents/52778f8b-93ce-4db3-a62c-bcf0a92e5f3c) にアクセスして、該当するサービスを申請します。ページに入ったら、「Acquire」ボタンをクリックします。以下の図のように：

![申請ページ](https://cdn.xhuoapi.ai/rci31i.png)

まだログインまたは登録していない場合は、自動的に[ログインページ](https://api.xhuoapi.ai)にリダイレクトされ、登録とログインを促されます。ログインまたは登録後、現在のページに自動的に戻ります。

初回申請時には無料のクレジットが付与され、この API を無料で使用できます。

## リクエスト例

Veo Tasks API は、Veo Videos Generation API の結果を照会するために使用できます。Veo Videos Generation API の使用方法については、文書 [Veo Videos Generation API](https://api.xhuoapi.ai/documents/63e01dc3-eb21-499e-8049-3025c460058f) を参照してください。

Veo Videos Generation API サービスから返されたタスクIDの例を用いて、この API の使用方法を示します。タスクID：1ebe4f2b-59ba-4385-a4ea-0ce8a3fe12ed があると仮定し、次にタスクIDを渡す方法を示します。

### タスク例図

<p>
  <img src="https://cdn.xhuoapi.ai/txlg6g.png" width="500" className="m-auto" />
</p>

### リクエストヘッダーとリクエストボディの設定

**Request Headers** には以下が含まれます：

* `accept`：JSON形式のレスポンス結果を受け取ることを指定します。ここには `application/json` を記入します。
* `authorization`：APIを呼び出すためのキーで、申請後に直接ドロップダウンから選択できます。

**Request Body** には以下が含まれます：

* `id`：アップロードされたタスクID。
* `action`：タスクの操作方法。

設定は以下の図のようになります：

<p>
  <img src="https://cdn.xhuoapi.ai/xztiqi.png" width="500" className="m-auto" />
</p>

### コード例

ページの右側には、さまざまな言語のコードが自動生成されていることがわかります。以下の図のように：

<p>
  <img src="https://cdn.xhuoapi.ai/bsqh3i.png" width="500" className="m-auto" />
</p>

一部のコード例は以下の通りです：

#### CURL

```bash theme={null}
curl -X POST 'https://api.xhuoapi.ai/v1/veo/tasks' \
-H 'accept: application/json' \
-H 'authorization: Bearer {token}' \
-H 'content-type: application/json' \
-d '{
  "id": "1ebe4f2b-59ba-4385-a4ea-0ce8a3fe12ed",
  "action": "retrieve"
}'
```

#### Python

```python theme={null}
import requests

url = "https://api.xhuoapi.ai/v1/veo/tasks"

headers = {
    "accept": "application/json",
    "authorization": "Bearer {token}",
    "content-type": "application/json"
}

payload = {
    "id": "1ebe4f2b-59ba-4385-a4ea-0ce8a3fe12ed",
    "action": "retrieve"
}

response = requests.post(url, json=payload, headers=headers)
print(response.text)
```

### レスポンス例

リクエストが成功すると、API はこのビデオタスクの詳細情報を返します。例えば：

```json theme={null}
{
  "_id": "68834c16550a4144a5112589",
  "id": "1ebe4f2b-59ba-4385-a4ea-0ce8a3fe12ed",
  "api_id": "52a0fa83-3c78-4793-b45a-c1a5c869ae46",
  "application_id": "b7341df0-3a87-40ef-8f3c-a7dda97816a2",
  "created_at": 1753435158.509,
  "credential_id": "1f64eaaa-eff0-4f18-bfc2-8c5b1e7949ae",
  "request": {
    "callback_url": "https://webhook.site/aed5cd28-f8aa-4dca-9480-8ec9b42137dc",
    "action": "text2video",
    "model": "veo2",
    "prompt": "白いセラミックのコーヒーマグが光沢のある大理石のカウンタートップに置かれ、朝の窓の光が当たっています。カメラはマグの周りを360度ゆっくり回転し、ハンドルのところで一時停止します。"
  },
  "trace_id": "d1d53c04-58c5-4c40-bb63-f00188540e56",
  "type": "videos",
  "user_id": "ad7afe47-cea9-4cda-980f-2ad8810e51cf",
  "response": {
    "success": true,
    "task_id": "1ebe4f2b-59ba-4385-a4ea-0ce8a3fe12ed",
    "trace_id": "d1d53c04-58c5-4c40-bb63-f00188540e56",
    "data": [
      {
        "id": "2f43ceed37944b4d836e1a1899dad0a1",
        "video_url": "https://platform.cdn.xhuoapi.ai/veo/1ebe4f2b-59ba-4385-a4ea-0ce8a3fe12ed.mp4",
        "created_at": "2025-07-25 17:19:20",
        "complete_at": "2025-07-25 17:21:45",
        "state": "succeeded"
      }
    ]
  }
}
```

返された結果には複数のフィールドがあり、request フィールドはタスクを開始したときの request body です。また、response フィールドはタスク完了後に返される response body です。フィールドの説明は以下の通りです。

* `id`：このビデオタスクを生成するための ID で、今回のビデオ生成タスクを一意に識別します。
* `request`：ビデオタスク内のリクエスト情報を照会します。
* `response`：ビデオタスク内の返却情報を照会します。

## バッチ照会操作

これは複数のタスクIDに対してビデオタスクの詳細を照会するもので、上記とは異なり、action を retrieve\_batch に設定する必要があります。

**Request Body** には以下が含まれます：

* `ids`：アップロードされたタスクIDの配列。
* `action`：タスクの操作方法。

設定は以下の図のようになります：

<p>
  <img src="https://cdn.xhuoapi.ai/4p5uvq.png" width="500" className="m-auto" />
</p>

### コード例

ページの右側には、さまざまな言語のコードが自動生成されていることがわかります。以下の図のように：

<p>
  <img src="https://cdn.xhuoapi.ai/g3b7g6.png" width="500" className="m-auto" />
</p>

一部のコード例は以下の通りです：

### レスポンス例

リクエストが成功すると、API は今回のすべてのバッチビデオタスクの具体的な詳細情報を返します。例えば：

```json theme={null}
{
  "items": [
    {
      "_id": "68834c16550a4144a5112589",
      "id": "1ebe4f2b-59ba-4385-a4ea-0ce8a3fe12ed",
      "api_id": "52a0fa83-3c78-4793-b45a-c1a5c869ae46",
      "application_id": "b7341df0-3a87-40ef-8f3c-a7dda97816a2",
      "created_at": 1753435158.509,
      "credential_id": "1f64eaaa-eff0-4f18-bfc2-8c5b1e7949ae",
      "request": {
        "callback_url": "https://webhook.site/aed5cd28-f8aa-4dca-9480-8ec9b42137dc",
        "action": "text2video",
        "model": "veo2",
        "prompt": "光沢のある大理石のカウンタートップに置かれた白いセラミックのコーヒーマグ。カメラはマグの周りを360度ゆっくり回転し、ハンドルのところで一時停止します。"
      },
      "trace_id": "d1d53c04-58c5-4c40-bb63-f00188540e56",
      "type": "videos",
      "user_id": "ad7afe47-cea9-4cda-980f-2ad8810e51cf",
      "response": {
        "success": true,
        "task_id": "1ebe4f2b-59ba-4385-a4ea-0ce8a3fe12ed",
        "trace_id": "d1d53c04-58c5-4c40-bb63-f00188540e56",
        "data": [
          {
            "id": "2f43ceed37944b4d836e1a1899dad0a1",
            "video_url": "https://platform.cdn.xhuoapi.ai/veo/1ebe4f2b-59ba-4385-a4ea-0ce8a3fe12ed.mp4",
            "created_at": "2025-07-25 17:19:20",
            "complete_at": "2025-07-25 17:21:45",
            "state": "succeeded"
          }
        ]
      }
    },
    {
      "_id": "68834c16550a4144a5112589",
      "id": "1ebe4f2b-59ba-4385-a4ea-0ce8a3fe12ed",
      "api_id": "52a0fa83-3c78-4793-b45a-c1a5c869ae46",
      "application_id": "b7341df0-3a87-40ef-8f3c-a7dda97816a2",
      "created_at": 1753435158.509,
      "credential_id": "1f64eaaa-eff0-4f18-bfc2-8c5b1e7949ae",
      "request": {
        "callback_url": "https://webhook.site/aed5cd28-f8aa-4dca-9480-8ec9b42137dc",
        "action": "text2video",
        "model": "veo2",
        "prompt": "光沢のある大理石のカウンタートップに置かれた白いセラミックのコーヒーマグ。カメラはマグの周りを360度ゆっくり回転し、ハンドルのところで一時停止します。"
      },
      "trace_id": "d1d53c04-58c5-4c40-bb63-f00188540e56",
      "type": "videos",
      "user_id": "ad7afe47-cea9-4cda-980f-2ad8810e51cf",
      "response": {
        "success": true,
        "task_id": "1ebe4f2b-59ba-4385-a4ea-0ce8a3fe12ed",
        "trace_id": "d1d53c04-58c5-4c40-bb63-f00188540e56",
        "data": [
          {
            "id": "2f43ceed37944b4d836e1a1899dad0a1",
            "video_url": "https://platform.cdn.xhuoapi.ai/veo/1ebe4f2b-59ba-4385-a4ea-0ce8a3fe12ed.mp4",
            "created_at": "2025-07-25 17:19:20",
            "complete_at": "2025-07-25 17:21:45",
            "state": "succeeded"
          }
        ]
      }
    }
  ],
  "count": 2
}
```

返却結果には複数のフィールドが含まれており、itemsはバッチ動画タスクの具体的な詳細情報を含んでいます。各動画タスクの具体的な情報は上記のフィールドと同じです。

* `items`、バッチ動画タスクのすべての具体的な詳細情報。これは配列であり、各配列の要素は上記の単一タスクの返却結果の形式と同じです。
* `count`、ここでのバッチ動画タスクの数。

#### CURL

```bash theme={null}
curl -X POST 'https://api.xhuoapi.ai/v1/veo/tasks' \
-H 'accept: application/json' \
-H 'authorization: Bearer {token}' \
-H 'content-type: application/json' \
-d '{
  "ids": ["1ebe4f2b-59ba-4385-a4ea-0ce8a3fe12ed","1ebe4f2b-59ba-4385-a4ea-0ce8a3fe12ed"],
  "action": "retrieve_batch"
}'
```

## エラーハンドリング

APIを呼び出す際にエラーが発生した場合、APIは対応するエラーコードと情報を返します。例えば：

* `400 token_mismatched`：不正なリクエスト、パラメータが不足しているか無効である可能性があります。
* `400 api_not_implemented`：不正なリクエスト、パラメータが不足しているか無効である可能性があります。
* `401 invalid_token`：未認証、無効または不足している認証トークン。
* `429 too_many_requests`：リクエストが多すぎます、レート制限を超えました。
* `500 api_error`：内部サーバーエラー、サーバーで何かがうまくいきませんでした。

### エラー応答の例

```json theme={null}
{
  "success": false,
  "error": {
    "code": "api_error",
    "message": "取得に失敗しました"
  },
  "trace_id": "2cf86e86-22a4-46e1-ac2f-032c0f2a4e89"
}
```

## 結論

この文書を通じて、Veo Tasks APIを使用して単一またはバッチ動画タスクのすべての具体的な詳細情報を取得する方法を理解しました。この文書がAPIの接続と使用に役立つことを願っています。ご不明な点がございましたら、いつでも技術サポートチームにお問い合わせください。
