# Photo Avatar Details
Retrieves detailed information about an avatar or look using its ID.
**Note:**
* Scroll down to the **Response** section below and expand the status code(s) to view the detailed response schema.
* Refer to the **RESPONSE** section on the right and choose an example to see how the API response appears for each status code.
# OpenAPI definition
```json
{
"openapi": "3.1.0",
"info": {
"title": "heygen-api",
"version": "4.0.8"
},
"servers": [
{
"url": "https://api.heygen.com"
}
],
"components": {
"securitySchemes": {
"sec0": {
"type": "apiKey",
"name": "x-api-key",
"in": "header",
"x-default": ""
}
}
},
"security": [
{
"sec0": []
}
],
"paths": {
"/v2/photo_avatar/{id}": {
"get": {
"summary": "Photo avatar details",
"description": "Get the details of a photo avatar",
"operationId": "photo-avatar-details",
"parameters": [
{
"name": "id",
"in": "path",
"schema": {
"type": "string"
},
"required": true,
"description": "Unique identifier of the avatar/look. For avatars, this ID can be retrieved from Create Photo Avatar Group endpoint. For looks, this ID can be retrieved from Add Looks to Photo Avatar Group endpoint"
}
],
"responses": {
"200": {
"description": "Avatar/Look details retrieved successfully - Expand to view the detailed response schema.",
"content": {
"application/json": {
"examples": {
"Result": {
"value": {
"error": null,
"data": {
"id": "0d9ub062cf7d4d908622c9b3c85c8659",
"image_url": "https://files2.heygen.ai/avatar/v3/0d9ub062cf7d4d908622c9b3c85c8659/full/2.2/raw_preview_image.webp",
"created_at": 1760612934,
"name": "Claire",
"status": "completed",
"group_id": "59813b97eb29c494baey49b8e4d85652",
"is_motion": true,
"motion_preview_url": "https://files2.heygen.ai/avatar/v3/0d9ub062cf7d4d908622c9b3c85c8659/full/2.2/preview_video_target.mp4",
"business_type": "generated",
"upscale_availability": {
"available": false,
"reason": "The photo avatar look has already been upscaled"
},
"upscaled": true,
"background_sound_effect": {
"status": "COMPLETED",
"sound_effect_id": "46cyup4691004fdc82865fa77647203e",
"sound_effect_preview_url": "https://files2.heygen.ai/avatar/v3/0d2fb062cf7d4d908622c9b3c85c7519/46cfed4691004fdc82865fa77647203e/sound_effect_preview.mp4",
"file_meta": {
"id": "46cfed4691004fdc82865fa77647203e",
"size": 353219,
"duration": 22,
"status": 2,
"mime_type": "audio/mpeg",
"meta": {
"audios": {
"m4a": "https://resource2.heygen.ai/audio/46cyup4691004fdc82865fa77647203e/transcode.m4a",
"mp3": "https://resource2.heygen.ai/audio/46cyup4691004fdc82865fa77647203e/transcode.mp3",
"ogg": "https://resource2.heygen.ai/audio/46cyup4691004fdc82865fa77647203e/transcode.ogg",
"wav": "https://resource2.heygen.ai/audio/46cyup4691004fdc82865fa77647203e/transcode.wav"
},
"thumbnails": {}
},
"properties": null,
"created_ts": 1760537735
}
},
"default_voice_id": null,
"moderation_msg": null
}
}
}
},
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"description": "Displays error message when the request fails; null if the request is successful."
},
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique identifier of the avatar/look."
},
"image_url": {
"type": "string",
"description": "URL of the avatar/look's image."
},
"created_at": {
"type": "integer",
"description": "Unix timestamp when the avatar/look was created."
},
"name": {
"type": "string",
"description": "Name of the avatar/look. "
},
"status": {
"type": "string",
"description": "Processing status of the avatar/look (e.g., \"pending\", \"in_appeal\", \"moderation_rejected\")."
},
"group_id": {
"type": "string",
"description": "Unique identifier of the group the avatar/look belongs to."
},
"is_motion": {
"type": "boolean",
"description": "Whether the avatar/look is a motion (animated) avatar. "
},
"motion_preview_url": {
"type": "string",
"description": "URL of the motion avatar/look's preview. Returns null if not available. "
},
"business_type": {
"type": "string",
"description": "Indicates the origin of the avatar/look (e.g., \"generated\" or \"uploaded\")."
},
"upscale_availability": {
"type": "object",
"properties": {
"available": {
"type": "boolean",
"description": "Whether the avatar can be upscaled. "
},
"reason": {
"type": "string",
"description": "Reason why the avatar cannot be upscaled (if applicable). "
}
},
"description": "Information about the avatar's upscaling availability. "
},
"upscaled": {
"type": "boolean",
"description": "Whether the avatar has already been upscaled. "
},
"background_sound_effect": {
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "Processing status of the background sound effect (e.g., \"processing\", \"completed\")."
},
"sound_effect_id": {
"type": "string",
"description": "Unique identifier of the background sound effect applied to the avatar/look. "
},
"sound_effect_preview_url": {
"type": "string",
"description": "URL to preview the background sound effect as a short video clip. "
},
"file_meta": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique identifier of the sound effect. "
},
"size": {
"type": "integer",
"description": "Size of the sound effect file in bytes. "
},
"duration": {
"type": "integer",
"description": "Duration of the sound effect. "
},
"status": {
"type": "integer",
"description": "Numeric status code for the file processing state. "
},
"mime_type": {
"type": "string",
"description": "MIME type specifying the audio format. "
},
"meta": {
"type": "object",
"description": "URLs for transcoded audio formats and thumbnail data. ",
"properties": {
"audios": {
"type": "object",
"properties": {},
"description": "URLs of the sound effect in multiple audio formats (e.g., `m4a`, `mp3`, `ogg`, `wav`)"
},
"thumbnails": {
"type": "object",
"properties": {},
"description": "URL of the thumbnail image linked to the sound effect. "
}
}
},
"properties": {
"type": "object",
"description": "Additional metadata or file-specific properties. ",
"properties": {}
},
"created_ts": {
"type": "integer",
"description": "Unix timestamp when the sound effect was created. "
}
},
"description": "Metadata about the sound effect. "
}
},
"description": "Background sound effect applied to the avatar/look. Returns null if none. "
},
"default_voice_id": {
"type": "string",
"description": "Default voice ID assigned to the avatar/look. "
},
"moderation_msg": {
"type": "string",
"description": "Message describing the result of content moderation for the avatar. Provides the reason if the avatar is rejected, suspended, or pending review. Returns null if no moderation issues exist."
}
},
"description": "Contains detailed information about avatar/look. "
}
}
}
}
}
}
},
"deprecated": false
}
}
},
"x-readme": {
"headers": [],
"explorer-enabled": true,
"proxy-enabled": true
},
"x-readme-fauxas": true
}
```