アバター一覧
この API ガイドでは、アバターを一覧表示し、アバターのステータスを確認するプロセスの概要を説明します。
すべてのデフォルト アバターとパーソナライズされたアバターの一覧を表示し、ステータスを確認できます。 生成プロセスには時間がかかる場合があるため、進行状況を監視するにはアバターの 'id' を使用します。 準備ができたら、これらのアバターを使用してビデオを生成し、パーソナライズされたアバター機能でコンテンツを強化できます。 🦊
クイック スタート
パーソナライズされたアバターとデフォルト アバターを一覧表示する方法を詳しく見ていきましょう。
デフォルト
アバターの一覧表示 このエンドポイントは、プラットフォームによって提供されるすべてのデフォルト アバターを取得します。 応答には、各アバターに関する関連情報を提供する 'id'、'thumbnail'、'name'、'gender' などのフィールドが含まれます。
'id' を使用して、一括テンプレート または 一括リクエスト を作成できます
curl --request GET \
--url 'https://api.immersive-fox.com/v1/avatar/default_avatars/' \
--header 'X-Api-Key: <your-api-key>' \
--header 'Content-Type: application/json'
=== 「レスポンス」
```javascript
[
{
"id": 131,
"thumbnail": "https://storage.googleapis.com/my_bucket_name/avatar_thumbnail/my_thumbnail.png",
"name": "Riley",
"gender": "Male",
"gesture_support": "no",
"based_on": "Video",
"has_hand_wave": false
}
]
```
パーソナライズされたアバターの一覧表示
このエンドポイントは、作成したすべてのパーソナライズされたアバターを取得します。 応答には、各アバターに関する関連情報を提供する 'id'、'thumbnail'、'name'、'gender' などのフィールドが含まれます。 'id' を使用して、一括テンプレート または 一括リクエスト を作成できます。
curl --request GET \
--url https://api.immersive-fox.com/v1/avatar/personalized_avatars/ \
--header 'X-Api-Key: <your-api-key>' \
--header 'Content-Type: application/json'
=== 「レスポンス」
```javascript
[
{
"id": 131,
"thumbnail": "https://storage.googleapis.com/my_bucket_name/avatar_thumbnail/my_thumbnail.png",
"name": "Lucy",
"gender": "Female",
"gesture_support": "no",
"based_on": "Video",
"has_hand_wave": false
"status": "Completed",
}
]
```
パーソナライズされたアバターのステータスを取得する
このエンドポイントを使用すると、作成プロセス中にアバターの現在のステータスを確認できます。特定のアバターの 'id' を指定すると、その 'ステータス' に関する詳細が表示されます。たとえば、'id' 131 を指定すると、応答にはアバターが正常に作成されたかどうかが示され、'ステータス' が '完了' としてマークされているか、その他の関連する更新が表示されます。
curl --request GET \
--url 'https://api.immersive-fox.com/v1/avatar/status/<avatar_id>' \
--header 'X-Api-Key: <your-api-key>' \
--header 'Content-Type: application/json'
=== 「レスポンス」
```javascript
[
{
"id": 131,
"thumbnail": "https://storage.googleapis.com/my_bucket_name/avatar_thumbnail/my_thumbnail.png",
"name": "Lucy",
"gender": "Female",
"gesture_support": "no",
"based_on": "Video",
"has_hand_wave": false
"status": "Completed",
}
]
```