GET VC Models

Fetch Voice Model

GET /v1/models

Returns a paginated list of voice models.

Headers

Name	Value
x-api-key	<token>

Query Parameters

Name	Type	Description
order	string	asc (default) or desc
page	integer	Page offset (default 1)
perPage	integer	Page size (default 10)

Response

200: OK

{
    "data": [
        {
            "modelId": "123x456",
            "status": "SUCCESS",
            "modelName": "John",
            "jobStartTime": "2024-01-01 20:15:50.428000 +00:00",
            "jobEndTime": null,
            "demoSong": null
        },
        ...
    ],
    "meta": {
        "currentPage": 1,
        "firstPage": 1,
        "firstPageUrl": "/?page=1",
        "lastPage": 3,
        "lastPageUrl": "/?page=2",
        "nextPageUrl": "/?page=3",
        "perPage": 10,
        "previousPageUrl": null,
        "total": 30,
    }
}

403: Forbidden

{"message": "Forbidden"}

429: Rate Limit

{"error": "Rate limit exceeded."}

---

Fetch Voice Model by ID

GET /v1/models/{modelId}

Returns a single voice model by id.

Headers

Name	Value
x-api-key	<token>

Response

200: OK

{
  "modelId": "123x456",
  "status": "SUCCESS",
  "modelName": "John",
  "jobStartTime": "2024-01-01 20:15:50.428000 +00:00",
  "jobEndTime": null,
  "demoSong": null
}

403: Forbidden

{"message": "Forbidden"}

429: Rate Limit

{"error": "Rate limit exceeded."}