> ## 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.

# Avatar Videos with Photo Avatars

> Use custom photo avatars created from your own photos

## Introduction

Create personalized avatar videos using custom photo avatars generated from your own portrait photos. Perfect for branded content, personal messaging, or using specific talent.

### Key Features

<CardGroup cols={2}>
  <Card title="Your Own Face" icon="user">
    Use your own photo to create custom avatars
  </Card>

  <Card title="Brand Consistency" icon="palette">
    Maintain consistent personal or brand presence
  </Card>

  <Card title="Multi-Language" icon="language">
    Same face across 40+ languages
  </Card>

  <Card title="Professional Quality" icon="star">
    High-quality avatar generation from photos
  </Card>
</CardGroup>

<Info>
  **Prerequisites:** You must first create a photo avatar before using it in videos. See \[Create Photo Avatar]\(/api-reference/v2/API Documentation/CreatePhotoAvatar) guide.
</Info>

***

## Quick Start

### Related API Endpoints

| Endpoint                         | Purpose                        | Documentation                                                  |
| -------------------------------- | ------------------------------ | -------------------------------------------------------------- |
| `GET /avatars/photo_avatars`     | Get your photo avatars         | [API Reference](/api-reference/v2/Avatar/PhotoAvatarsGet)      |
| `POST /create_video_from_avatar` | Create video with photo avatar | [API Reference](/api-reference/v2/Video/CreateVideoFromAvatar) |
| `GET /avatar_video/{id}`         | Check video status             | [API Reference](/api-reference/v2/Video/AvatarVideoGet)        |

### Key Parameters

| Parameter            | Type    | Required | Description                                         |
| -------------------- | ------- | -------- | --------------------------------------------------- |
| `avatar.avatar_id`   | integer | ✅        | Your photo avatar ID                                |
| `avatar.avatar_type` | integer | ✅        | **Must be `1`** for photo avatars                   |
| `voice.type`         | string  | ✅        | "script" for text-to-speech                         |
| `voice.voice_id`     | string  | ✅        | Voice ID for text-to-speech                         |
| `voice.script`       | string  | ✅        | Text for avatar to speak                            |
| `aspect_ratio`       | string  | ✅        | portrait/landscape/square                           |
| `screen_style`       | integer | ✅        | 1=Full screen, 2=Split screen, 3=Picture in picture |

<Warning>
  **Important:** Set `avatar.avatar_type: 1` to use photo avatars. Using `0` will use public avatars instead.
</Warning>

***

## Code Examples

### Step 1: Create Video with Photo Avatar

Get your photo avatar ID first:

```bash theme={null}
curl --request GET \
  --url 'https://api.jogg.ai/v2/avatars/photo_avatars' \
  --header 'x-api-key: YOUR_API_KEY'
```

**Response:**

```json theme={null}
{
  "code": 0,
  "msg": "Success",
  "data": {
    "avatars": [
      {
        "id": 123,
        "name": "My Custom Avatar",
        "status": 1,
        "cover_url": "https://res.jogg.ai/avatars/cover_123.jpg"
      }
    ]
  }
}
```

Then create video with the photo avatar:

```bash theme={null}
curl --request POST \
  --url 'https://api.jogg.ai/v2/create_video_from_avatar' \
  --header 'x-api-key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "avatar": {
      "avatar_id": 123,
      "avatar_type": 1
    },
    "voice": {
      "type": "script",
      "voice_id": "en-US-ChristopherNeural",
      "script": "Hello! This is my custom photo avatar speaking."
    },
    "aspect_ratio": "portrait",
    "screen_style": 1,
    "caption": true
  }'
```

**Response:**

```json theme={null}
{
  "code": 0,
  "msg": "Success",
  "data": {
    "video_id": "video_123456"
  }
}
```

<Check>
  Ensure photo avatar `status` is `1` (completed) before creating videos. Status `0` means still processing.
</Check>

### Step 2: Check Video Status

Poll to check if video is ready:

```bash theme={null}
curl --request GET \
  --url 'https://api.jogg.ai/v2/avatar_video/video_123456' \
  --header 'x-api-key: YOUR_API_KEY'
```

**Response (Processing):**

```json theme={null}
{
  "code": 0,
  "msg": "Success",
  "data": {
    "video_id": "video_123456",
    "status": "processing",
    "created_at": 1732806631
  }
}
```

**Response (Completed):**

```json theme={null}
{
  "code": 0,
  "msg": "Success",
  "data": {
    "video_id": "video_123456",
    "status": "completed",
    "video_url": "https://res.jogg.ai/videos/video_123456.mp4",
    "cover_url": "https://res.jogg.ai/covers/cover_123456.jpg",
    "created_at": 1732806631
  }
}
```

<Tip>
  Instead of polling, use \[Webhooks]\(/api-reference/v2/API Documentation/WebhookIntegration) to get notified instantly when videos are ready!
</Tip>

***

## Use Case Examples

<AccordionGroup>
  <Accordion title="Personal Branding">
    Use your own face in videos:

    * Create photo avatar from your photo
    * Generate branded video content
    * Consistent personal presence across platforms
    * Scale your personal brand without being on camera
  </Accordion>

  <Accordion title="Company Spokesperson">
    Feature company executives or talent:

    * Create avatar from CEO or spokesperson photo
    * Generate company announcements and updates
    * Consistent company voice and appearance
    * Reduce production time and costs
  </Accordion>

  <Accordion title="Multi-Language Content">
    Speak in languages you don't know:

    * Create avatar from your photo once
    * Generate videos in 40+ languages
    * Maintain your face across all languages
    * Reach global audiences authentically
  </Accordion>

  <Accordion title="Influencer Content">
    Scale your content creation:

    * Use your photo avatar for multiple videos
    * Create content in different languages
    * Maintain your personal brand
    * Save time on video production
  </Accordion>
</AccordionGroup>

***

## Tips for Best Results

<Tip>
  **Photo Avatar Quality:**

  * Use high-quality source photos (1920x1080 or higher)
  * Ensure good lighting in source photo
  * Face should be clearly visible
  * Check avatar status is `1` (completed) before use
  * Test with short script first
</Tip>

**Script Recommendations:**

* Keep scripts natural and conversational
* Avoid very long scripts (\< 2 minutes)
* Test pronunciation of special terms
* Use appropriate voice for avatar personality

## Related Documentation

<CardGroup cols={2}>
  <Card title="Create Photo Avatar" icon="camera" href="/api-reference/v2/API Documentation/CreatePhotoAvatar">
    Generate photo avatars from your photos
  </Card>

  <Card title="Get Photo Avatars" icon="users" href="/api-reference/v2/Avatar/PhotoAvatarsGet">
    List your photo avatars
  </Card>

  <Card title="Get Avatar Video" icon="video" href="/api-reference/v2/Video/AvatarVideoGet">
    Check video generation status
  </Card>

  <Card title="Get Voices" icon="microphone" href="/api-reference/v2/Voice/GetVoices">
    Browse available voices
  </Card>
</CardGroup>