GET
/
v1
/
avatars
/
list
List avatars
curl --request GET \
  --url https://os.gan.ai/v1/avatars/list \
  --header 'ganos-api-key: <api-key>'
{
  "total_avatars": 123,
  "avatars_list": [
    {
      "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.

Query Parameters

​
title
string | null
​
status
enum<string>[] | null
​
skip
integer
default:0
​
limit
integer
default:10
​
start_datetime
string<date-time> | null

ISO 8601 formatted timestamp filter for retrieving avatars.

​
end_datetime
string<date-time> | null

ISO 8601 formatted timestamp filter for retrieving avatars.

Response

200
application/json

Successful Response

The response is of type object.