API Reference

Create Photo Avatar

post
https://api.heygen.com/v2/photo_avatar/photo/generate

Generates a personalized AI avatar based on text prompts, and attribute inputs.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

Name to assign to the generated avatar.

string
enum
required

Age group for the avatar's appearance.

Allowed:
string
enum
required

Gender identity of the avatar.

Allowed:
string
enum
required

Ethnic background for facial and skin tone characteristics.

string
enum
required

Image orientation for the generated avatar.

Allowed:
string
enum
required

Framing or body coverage in the avatar.

Allowed:
string
enum
required

Visual or artistic style of the generated avatar.

Allowed:
string
required

Text prompt describing the avatar's appearance, such as clothing, mood, lightning, etc. Maximum 1000 characters.

string

URL to notify when video rendering is complete, useful when your callback endpoint is dynamic and each video requires a separate callback. Using a webhook endpoint is still the recommended approach, as it provides more customization options such as secrets, event filtering, and more. If both webhook and callback_url are used, events will be sent to both endpoints.

string

Custom ID for callback purposes. Returned in the status/webhook payload for tracking.

Response

Updated 3 months ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 3 months ago