Skip to main content
POST
/
v1
/
avatars
/
create_video
Create Avatar Video
curl --request POST \
  --url https://os.gan.ai/v1/avatars/create_video \
  --header 'Content-Type: application/json' \
  --header 'ganos-api-key: <api-key>' \
  --data '
{
  "avatar_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "title": "<string>",
  "text": "<string>",
  "audio_url": "<string>"
}
'
{
  "avatar_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "inference_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "draft",
  "avatar_title": "<string>",
  "title": "<string>",
  "video": "<string>",
  "input_text": "<string>",
  "thumbnail": "<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
​
avatar_id
string<uuid>
required
​
title
string | null
​
text
string | null

The text from which the avatar inference video needs to be generated.

​
audio_url
string | null

Publicly accessible and downloadable audio url.

Response

Successful Response

​
avatar_id
string<uuid>
required
​
inference_id
string<uuid>
required

Unique identifier for the generated video from avatar(inference).

​
status
enum<string>
required
Available options:
draft,
processing,
failed,
succeeded,
deleted
​
avatar_title
string | null
​
title
string | null
​
video
string | null

Cloudfront url of the generated inference video.

​
input_text
string | null
​
thumbnail
string | null

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

​
created_at
string<date-time> | null

ISO 8601 formatted timestamp.