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

# Create Avatar Videos Using Photo Avatars

> How to create avatar video with Photo avatars.

## Introduction

Using the JoggAI API, you can create videos with Photo Avatars. In this tutorial, we'll guide you through making a video using your customized Photo Avatar and cloned Voice.

### **Core Concept: Asynchronous Processing Flow**

Before you begin, it is crucial to understand that **creating an avatar video is an asynchronous operation**. This means you will not receive the final video file immediately after calling the API.

The entire process is as follows:

1. **Submit Task:** Your application sends a `POST` request to [Jogg.ai](http://Jogg.ai), containing the video script, selected avatar, and all other necessary information.
2. **Receive Confirmation:** The [Jogg.ai](http://Jogg.ai) server validates your request. If it's valid, it will immediately return a `200 Accepted` response, which includes a unique `project_id`. This ID is your credential for tracking this task.
3. **Background Processing:** Your video creation task enters our processing queue. The server will render the video in the background based on the current workload. This process can take anywhere from a few seconds to several minutes.
4. **Retrieve Result:** Once the video processing is complete, you can obtain the result in one of two ways:
   * **Webhook (Recommended):** We will send a `POST` notification to your pre-configured `webhook_url`, containing the video status and the final video playback address. This is the most efficient and reliable method.
   * **Polling (Alternative):** You can use the `project_id` to periodically call the `GET /project/{project_id}` endpoint to check the task status.

## Quick Start

### Create Talking Avatar Video

> First, create your Photo Avatar on the [Create photo Avatar page](https://app.jogg.ai/avatar). Then, use the `My Photo Avatars` List endpoint to obtain your Avatar ID, and the `My Voices List` endpoint to retrieve your Voice for video creation.

Please refer to the [Create Talking Avatar Videos](/api-reference/v1/Create-Avatar-Videos/CreateAvatarVideo) for more details and refer to the next section for obtaining the avatar\_id and voice\_id.

## Here is a code example

Request Example：

```bash theme={null}
curl --location --request POST 'https://api.jogg.ai/v1/create_video_from_talking_avatar' \
--header 'x-api-key: <your-api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "script": "Hi, welcome to JoggAI and create longer videos with Talking Avatars in minutes!",
    "aspect_ratio": 0,
    "screen_style": 1,
    "avatar_id": 127,
    "avatar_type": 0,
    "voice_id": "en-US-ChristopherNeural",
    "caption": true,
	"video_name":"my_video"   
}'
```

Response example:

```json theme={null}
{
    "rid": "d43b3a5999e31b7e7a62ee5ef84d411d",
    "code": 0,
    "msg": "success",
    "data": {
        "project_id": "<project-id>"   
    }
}
```

### Get Avatars and Voices List

If you want to change the Avatar or voice, you can obtain the `avatar_id` from My Photo Avatars List and the `voice_id` from My Voices List to make replacements.

#### My Photo Avatars List

Please refer to the [Get Photo Avatar List](/api-reference/v1/Avatar/GetPhotoAvatar) for more details.

```bash theme={null}
curl --request GET \
  --url https://api.jogg.ai/v1/avatars/photo_avatars \
  --header 'accept: application/json' \
  --header 'x-api-key: <api-key>'
```

Response example:

```json theme={null}
{
    "rid": "d43b3a5999e31b7e7a62ee5ef84d411d",
    "code": 0,
    "msg": "success",
    "data": {
        "avatars": [
            {
                "avatar_id": 81,
                "name": "Amanda outdoors",
                "cover_url": "<avatar-cover-url>",
                "status": 1
            }
        ]
    }
}
```

#### My Voices List

Please refer to the [Get My Voice](/api-reference/v1/Voice/GetMyVoice) for more details.

```bash theme={null}
curl --request GET \
  --url https://api.jogg.ai/v1/voices/custom \
  --header 'x-api-key: <api-key>'
```

Response example:

```json theme={null}
{
    "rid": "d43b3a5999e31b7e7a62ee5ef84d411d",
    "code": 0,
    "msg": "success",
    "data": {
        "voices": [
            {
                "name": "Emily",
                "voice_id": "en-US-ChristopherNeural",
                "audio_url": "<voice-audio-url>",
                "language": "english"
            }
        ]
    }
}
```

### Get the generated video

Use the project\_id obtained from the "Generate Video from Product Information" step to retrieve details about the video generation, including status and duration. Access the generated video using the video\_url.

Please refer to the[ GetGeneratedVideo](/api-reference/v1/GetGeneratedVideo/GetGeneratedVideo) for the full options of enums.

```bash theme={null}
curl --location --request GET 'https://api.jogg.ai/v1/project?project_id=fa6228c0f52c4f3986e88f7ffa5d2864' \
--header 'x-api-key: <your-api-key>' \
```

Response example:

```json theme={null}
{
    "rid": "d43b3a5999e31b7e7a62ee5ef84d411d",
    "code": 0,
    "msg": "success",
    "data": {
        "id": "fa6228c0f52c4f3986e88f7ffa5d2864",
        "title": "welcome to jogg.ai",
        "video_url": "https://res.jogg.ai/video.webm",
        "cover_url": "https://res.jogg.ai/cover.png",
        "video_duration": 6,
        "status_code": 4,
        "status_desc": "success",
        "created_at": 1732806631
    }
}
```