アバター作成

この API ガイドでは、プラットフォーム上でアバターを作成する方法の概要を説明します。

すべてのデフォルトアバターとパーソナライズされたアバターのリストを表示し、ステータスを確認できます。生成プロセスには時間がかかる場合があるため、進行状況を監視するにはアバターの 'id' を使用します。準備ができたら、これらのアバターを使用してビデオを生成し、パーソナライズされたアバター機能でコンテンツを強化できます。 🦊

クイックスタート

プラットフォームでインスタントアバターとプレミアムアバターを作成する方法を詳しく見ていきましょう。

インスタントアバターを作成する

インスタントアバター は、提供した写真からすばやく生成され、アバターをすばやく作成できます。インスタントアバターを作成するには、これらのガイドラインに準拠した写真を提供する必要があります。アバターの品質は、提供された写真に完全に依存するためです。インスタントアバターの作成については、API にリクエストを送信してください。受け入れられる画像形式は、'png' と 'jpeg' です。サンプルリクエストで指定されたキーを使用して、ファイルやその他のデータを multipart/form-data として送信します。レスポンスでは、'id' が一括ビデオリクエストに使用するキー要素です。'thumbnail' は新しく作成されたアバターのプレビューを提供し、使用前に確認できます。'name'、'gender'、'user' などの追加の詳細もレスポンスに含まれます。アバターのステータスを確認するには、アバターステータス api を使用します。

リクエスト

curl --request POST \
 --url '<https://api.immersive-fox.com/v1/avatar_generation/create_instant_avatar/>' \
 --header 'X-Api-Key: <your-api-key>' \
 --header 'Content-Type: multipart/form-data' \
 -F 'file=@my_image.png' \
 -F 'name=John' \
 -F 'gender=Male' \
 -F 'remove_background=false'

=== 「レスポンス」

```javascript
{
    "id": 839,
    "thumbnail": "https://storage.googleapis.com/my_bucket_name/avatar_thumbnail/my_thumbnail.png",
    "name": "Smith",
    "gender": "Male",
    "user": 31,
    "remove_background": false,
    "based_on": "Photo",
    "has_hand_wave": false
    "generation_time": 20
}
```

プレミアムアバターの作成

プレミアムアバター はビデオから作成され、よりリアルで詳細な表現になります。API を使用してプレミアムアバターを生成するには、次の手順に従います。

署名済み URL をリクエストする:

まず、アップロードするビデオのファイル拡張子 (例: .mp4) を指定して、署名済み URL 生成エンドポイントから署名済み URL と対応するビデオファイル名をリクエストします。応答では、サイレントビデオ用とスピーキングビデオ用の 2 つの署名済み URL が提供され、直接アップロードできます。さらに、応答には両方のビデオのファイル名が含まれます。プレミアムアバターを生成するには、次のステップでこれを送信する必要があります。

=== "リクエスト"

    ```bash
    curl --request POST  \
        --url 'https://api.immersive-fox.com/v1/avatar_generation/premium_avatar_presigned_urls/'  \
        --header 'X-Api-Key: <your-api-key>' \
        --header 'Content-Type: application/json'  \
        --header 'Content-Type: multipart/form-data' \
        -F 'speaking_video_extention=.mp4' \
        -F 'silent_video_extention=.mp4'
    ```

=== 「レスポンス」

    ```json
    {
    "silent_video_data": {
        "presigned_url": "https://premium-avatar-videos.s3.amazonaws.com/silent_videos/31_6f72a1900fd64969ab9f8df465f9e92c.mp4?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA6E6ARAOX65ONAQYP%2F20241002%2Feu-central-1%2Fs3%2Faws4_request&X-Amz-Date=20241002T221000Z&X-Amz-Expires=1800&X-Amz-SignedHeaders=host&X-Amz-Signature=72058a2c206ba63726eeda2e88266575c046fa0625f9af1c366b4b9bf921b3ef",
        "file_name": "31_6f72a1900fd64969ab9f8df465f9e92c.mp4"
    },
    "speaking_video_data": {
        "presigned_url": "https://premium-avatar-videos.s3.amazonaws.com/speaking_videos/31_1e4eb799a3b84639a11c929a6729a1be.mp4?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA6E6ARAOX65ONAQYP%2F20241002%2Feu-central-1%2Fs3%2Faws4_request&X-Amz-Date=20241002T221000Z&X-Amz-Expires=1800&X-Amz-SignedHeaders=host&X-Amz-Signature=58e84ccd7d702b64b3400479f27b417f551317ca96afce3e923ac18d9db28bce",
        "file_name": "31_1e4eb799a3b84639a11c929a6729a1be.mp4"
    }
    }
    ```

署名済み URL を使用してビデオをアップロードする:

プレミアムアバターを生成するには、話すビデオをアップロードする必要がありますが、サイレントビデオはアバターの品質を向上させるためのオプションです。両方のビデオが、提供されているガイドラインに従っていることを確認してください。前の手順で取得した 'presigned_url' で PUT メソッドを使用します。これは 30 分間有効です。ビデオファイルは、この時間枠内にバイナリデータとして URL に直接アップロードする必要があります。

=== "リクエスト"

    ```bash
    curl --request PUT  \
        --url 'https://premium-avatar-videos.s3.amazonaws.com/speaking_videos/{file_name}?<presigned_url_parameters>'  \
        --header 'X-Api-Key: <your-api-key>' \
        --header 'Content-Type: video/mp4'  \
        --data-binary '@speaking_video.mp4'
    ```

=== 「レスポンス」

    ```json
    {
    }
    ```

--- === 「リクエスト」

    ```bash
    curl --request PUT  \
        --url 'https://premium-avatar-videos.s3.amazonaws.com/silent_videos/{file_name}?<presigned_url_parameters>'  \
        --header 'X-Api-Key: <your-api-key>' \
        --header 'Content-Type: video/mp4'  \
        --data-binary '@silent_video.mp4'
    ```

=== 「レスポンス」

    ```json
    {
    }
    ```

アバター作成リクエストを送信:

動画をアップロードした後、署名済み URL リクエストから取得した 'file_name' を使用してプレミアムアバターを生成します。レスポンスには、新しく作成されたプレミアムアバターの 'id' が含まれます。これは、後続の一括動画リクエストで使用されます。さらに、レスポンスには、アバターのプレビューである 'thumbnail' と、'generation time'、'name'、'gender' などの詳細情報、およびその他の関連情報が提供されます。アバターステータス api を使用して、アバターのステータスを確認します。

=== "リクエスト"

    ```bash
    curl --request POST  \
        --url 'https://api.immersive-fox.com/v1/avatar_generation/create_premium_avatar/'  \
        --header 'X-Api-Key: <your-api-key>' \
        --header 'Content-Type: application/json'  \
        --header 'Content-Type: form-data' \
        -F 'avatar_name=John' \
        -F 'gender=Male' \
        -F 'remove_background=false' \
        -F 'silent_video_name=31_6f72a1900fd64969ab9f8df465f9e92c.mp4'  \
        -F 'speaking_video_name=31_1e4eb799a3b84639a11c929a6729a1be.mp4'
    ```

=== 「レスポンス」

    ```bash
    {
        "id": 840,
        "thumbnail": "https://storage.googleapis.com/my_bucket_name/avatar_thumbnail/my_thumbnail.png",
        "name": "John",
        "gender": "Male",
        "user": 31,
        "remove_background": true,
        "based_on": "Video",
        "has_hand_wave": false
        "generation_time": 24
    }
    ```

アバター作成

クイック スタート

インスタント アバターを作成する

プレミアム アバターの作成

クイックスタート

インスタントアバターを作成する

プレミアムアバターの作成