Skip to main content
POST
/
v1
/
photo_avatars
/
create
Create Photo Avatar
curl --request POST \
  --url https://os.gan.ai/v1/photo_avatars/create \
  --header 'Content-Type: application/json' \
  --header 'ganos-api-key: <api-key>' \
  --data '
{
  "base_image_url": "<string>",
  "title": "<string>",
  "webhook_data": {
    "webhook_url": "<string>"
  }
}
'
{
  "photo_avatar_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "draft",
  "title": "<string>",
  "base_image": "<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_image_url
string
required

Publicly accessible URL of the base face image.

​
title
string | null
​
webhook_data
AvatarWebhook · object

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

Response

Successful Response

​
photo_avatar_id
string<uuid>
required
​
status
enum<string>
required
Available options:
draft,
failed,
processing,
published,
deleted
​
title
string | null
​
base_image
string

Presigned URL of the processed base image.

​
created_at
string<date-time> | null

ISO 8601 formatted timestamp.