POST
/
v1
/
avatars
/
create_avatar
Create Avatar
curl --request POST \
  --url https://os.gan.ai/v1/avatars/create_avatar \
  --header 'Content-Type: application/json' \
  --header 'ganos-api-key: <api-key>' \
  --data '{
  "title": "<string>",
  "base_video_url": "<string>",
  "webhook_data": {
    "webhook_url": "<string>"
  }
}'
{
  "avatar_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "title": "<string>",
  "thumbnail": "<string>",
  "status": "consent_pending",
  "base_video": "<string>",
  "avatar_webhook": {
    "webhook_url": "<string>"
  },
  "created_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
ganos-api-key
string
header
required

Use the API key generated from our website to programmatically interact with our endpoints. This key authorizes your requests, allowing you to access and utilize our services securely.

Body

application/json
​
base_video_url
string
required

Publicly accessible and downloadable video url with content type video/mp4 and the maximum size of 300 MB.

​
title
string | null
​
webhook_data
object | null

This endpoint allows you to register a webhook, which can be used to get the generation state of the avatar.

Response

Successful Response

​
avatar_id
string<uuid>
required

Unique identifier for the avatar

​
title
string | null
​
thumbnail
string | null

Represents the CloudFront URL of the thumbnail, initially null while being generated, and returns the URL once available

​
status
enum<string> | null
Available options:
consent_pending,
processing,
consent_failed,
failed,
published,
deleted
​
base_video
string | null

Cloudfront url of the base video.

​
avatar_webhook
object | null

This endpoint allows you to register a webhook, which can be used to get the generation state of the avatar.

​
created_at
string<date-time> | null

ISO 8601 formatted timestamp.