Catalogue item

The

Catalogue endpoint
returns detailed information about a specific
ACTOR
VOICE
TEMPLATE
or
MUSIC
object in the Oxolo catalogue. To use this endpoint, you must provide the identifier for the objectyou're interested in. The request should be sent as a
GET
request to the
/v1/api/catalogue/{CATALOGUE_IDENTIFIER}
endpoint, with the necessary authorization and content-type headers included.

If you're unsure about the available options for the CATALOGUE_IDENTIFIER, you can refer to the Catalogue section of the API documentation to retrieve information about actors, voices, templates, and music tracks.

HTTP Request

GET https://api.oxolo.com/v1/api/catalogue/{CATALOGUE_IDENTIFIER}

curl -X 'GET' 
'https://api.oxolo.com/v1/api/catalogue/{CATALOGUE_IDENTIFIER}' 
-H 'accept: application/json' 
-H 'authorization: YOUR_API_KEY'

{
  "results": {
    "0dcc9cc1-db74-4188-a2f1-d7a9634b9530": {
      "description": "walking and normal talk with hand gestures and casual outfit",
      "default_voice_uuid": "4acb10b9-9033-440a-9059-e935881efecf",
      "actor_name": "Amy",
      "default_voice_id": "sara",
      "gender": "female",
      "max_video_duration": "1:00",
      "variation_name": "Casual - walking with hand gestures"
    }
  }
}