GET
/
v1
/
avatars
/
avatar_details
Avatar Details
curl --request GET \
  --url https://os.gan.ai/v1/avatars/avatar_details \
  --header 'ganos-api-key: <api-key>'
{
  "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",
  "avatar_processing_results": [
    {
      "check_name": "<string>",
      "check_status": "SUCCESS",
      "message": "<string>"
    }
  ],
  "consent_verification_results": [
    {
      "check_name": "<string>",
      "check_status": "SUCCESS",
      "message": "<string>"
    }
  ]
}

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.

Query Parameters

​
avatar_id
string<uuid>
required

Response

Successful Response

​
avatar_id
string<uuid>
required
​
status
enum<string>
required
Available options:
consent_pending,
processing,
consent_failed,
failed,
published,
deleted
​
title
string | null
​
thumbnail
string | null

Cloudfront url of the thumbnail.

​
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.

​
avatar_processing_results
ProcessingResult · object[] | null
​
consent_verification_results
ProcessingResult · object[] | null