Full catalogue

The

Catalogue section
of the API documentation provides endpoints for retrieving information about available actors, voices, templates, and music tracks. To use these endpoints, you must send a GET request to the corresponding endpoint with the necessary authorization and content-type headers included. The response will contain a JSON object with a
results key
, which holds a list of objects containing information about the available objects.

The available options for the

filter
parameter are:

ACTOR
VOICE
TEMPLATE
MUSIC

The take and skip parameters are optional and can be used to limit the number of results returned and to paginate through the available objects.

HTTP Request

GET https://api.oxolo.com/v1/api/catalogue?filter=ACTOR

curl -X 'GET' 
'https://api.oxolo.com/v1/api/catalogue?filter=ACTOR&take=10&skip=0' 
-H 'accept: application/json' 
-H 'authorization: YOUR_API_KEY'

{
  "results": {
      "0dcc9cc1-db74-4188-a2f1-d7a9634b9530": {
          "actor_name": "Amy",
          "..."
      }
  }
}