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

# Generate Photo Avatar

> Generate AI photo avatar based on provided parameters

Generate a custom AI avatar from a photo. Upload a portrait photo to create a talking avatar.

## Example Usage

```bash theme={null}
curl -X POST 'https://api.jogg.ai/v2/photo_avatar/photo/generate' \
  -H 'x-api-key: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "photo_url": "https://example.com/portrait.jpg",
    "name": "John Doe Avatar"
  }'
```

## Related Guides

<CardGroup cols={2}>
  <Card title="Create Photo Avatar Guide" href="/api-reference/v2/API Documentation/CreatePhotoAvatar">
    Complete photo avatar workflow
  </Card>
</CardGroup>


## OpenAPI

````yaml POST /v2/photo_avatar/photo/generate
openapi: 3.0.1
info:
  title: JoggAI OpenAPI v2
  description: >
    JoggAI OpenAPI v2 provides a comprehensive suite of endpoints for creating
    and managing AI-powered video content.


    ## Authentication

    All API requests require authentication using an API key provided in the
    `x-api-key` header.


    ## Base URL

    Production: https://api.jogg.ai/v2


    ## Rate Limiting

    API calls are subject to rate limiting based on your subscription plan.


    ## Error Handling

    All endpoints return standard HTTP status codes along with detailed error
    messages in the response body.
  version: 2.0.0
  license:
    name: MIT
servers:
  - url: https://api.jogg.ai
    description: Production server
security:
  - apiKeyAuth: []
tags:
  - name: Video
    description: Video creation and management operations
  - name: Avatar
    description: Avatar management and creation operations
  - name: Voice
    description: Voice and timbre management operations
  - name: Asset
    description: Asset management including music, scripts, and uploads
  - name: Template
    description: Template management operations
  - name: Product
    description: Product management operations
  - name: User
    description: User account operations
  - name: Webhook
    description: Webhook endpoint management for event notifications
paths:
  /v2/photo_avatar/photo/generate:
    post:
      tags:
        - Avatar
      summary: Generate Photo Avatar
      description: Generate AI photo avatar based on provided parameters
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - age
                - avatar_style
                - gender
                - model
                - aspect_ratio
              properties:
                age:
                  type: string
                  description: Avatar age group
                  enum:
                    - Teenager
                    - Young adult
                    - Adult
                    - Elderly
                  example: Adult
                avatar_style:
                  type: string
                  description: Avatar style category
                  enum:
                    - Professional
                    - Social
                  example: Professional
                gender:
                  type: string
                  description: Avatar gender
                  enum:
                    - Female
                    - Male
                  example: Female
                model:
                  type: string
                  description: Photo generation model style
                  enum:
                    - classic
                    - modern
                  example: modern
                aspect_ratio:
                  type: string
                  description: Photo aspect ratio
                  enum:
                    - portrait
                    - landscape
                    - square
                  example: portrait
                ethnicity:
                  type: string
                  description: Avatar ethnicity
                  enum:
                    - European
                    - African
                    - South Asian
                    - East Asian
                    - Middle Eastern
                    - South American
                    - North American
                background:
                  type: string
                  description: Background description
                appearance:
                  type: string
                  description: Appearance description
                image_url:
                  type: string
                  description: Reference image URL
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/BaseResponse'
                  - type: object
                    properties:
                      data:
                        type: object
                        properties:
                          photo_id:
                            type: string
components:
  schemas:
    BaseResponse:
      type: object
      required:
        - code
        - msg
      properties:
        code:
          type: integer
          description: |
            Business status code:
            * 0 - Success
            * 10104 - Record not found
            * 10105 - Invalid API key
            * 18020 - Insufficient credit
            * 18025 - No permission to call APIs
            * 40000 - Parameter error
            * 50000 - System error
          example: 0
        msg:
          type: string
          description: Response message
          example: Success
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: API key for authentication. Obtain your key from the JoggAI dashboard.

````