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

# Get Photo Avatar Status

> Check the status of photo avatar generation task by photo ID

Check the status of photo avatar generation task by photo ID.

## Example Usage

```bash theme={null}
curl --request GET \
  --url 'https://api.jogg.ai/v2/photo_avatar/photo?photo_id=photo_123' \
  --header 'x-api-key: YOUR_API_KEY'
```

## Related Guides

<CardGroup cols={2}>
  <Card title="Generate Photo Avatar" href="/api-reference/v2/Avatar/PhotoAvatarGenerate">
    Generate photo avatar
  </Card>

  <Card title="Add Motion" href="/api-reference/v2/Avatar/PhotoAvatarMotionAdd">
    Add motion to photo avatar
  </Card>
</CardGroup>


## OpenAPI

````yaml GET /v2/photo_avatar/photo
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:
    get:
      tags:
        - Avatar
      summary: Check Photo Generation Status
      description: Check the status of photo avatar generation task by photo ID
      parameters:
        - name: photo_id
          in: query
          required: true
          description: Photo ID from the generation task
          schema:
            type: string
            example: photo_123
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/BaseResponse'
                  - type: object
                    properties:
                      data:
                        type: object
                        properties:
                          photo_id:
                            type: string
                            description: Photo ID
                            example: photo_123
                          status:
                            type: string
                            description: Photo generation status
                            enum:
                              - in_progress
                              - success
                              - error
                            example: success
                          image_url_list:
                            type: array
                            description: List of generated image URLs
                            items:
                              type: string
                              format: uri
                            example:
                              - https://example.com/image1.jpg
                              - https://example.com/image2.jpg
                          image_key_list:
                            type: array
                            description: List of image keys
                            items:
                              type: string
                            example:
                              - key1
                              - key2
                          msg:
                            type: string
                            description: Status message
                            nullable: true
                            example: null
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.

````