Services
Every service available to you, keyed by the service code: whether it accepts orders
(status), its state (available, maintenance, disabled) with a message for the
user, the type (tts, dubbing, image, …), capabilities (templates, voice library,
dubbing, voice cloning), the voice providers for GET /voices?provider=… and
/voices/{provider}/clones, and the health block of the status page. Use it instead of
a hard-coded list of services: a new service appears here by itself.
Required key permission: any of templates.read, orders.read, voices.read.
Parameters
Values go straight into the request line, and the URL is built for you. Below are each parameter’s type, whether it is required, and its allowed values.
Possible responses
200Success. The payload is in data.
Success. The payload is in data.
{
"success": true,
"message": "Services retrieved.",
"data": {
"elevenlabs": {
"code": "elevenlabs",
"name": "ElevenLabs",
"type": "tts",
"order": 1,
"access": "public",
"status": true,
"state": "available",
"message": null,
"maintenance": {
"enabled": false,
"since": null,
"message": null
},
"capabilities": {
"templates": true,
"voice_library": true,
"voice_filters": true,
"voice_clone": false,
"dubbing": true
},
"task_types": [
"tts"
],
"voice_provider": "elevenlabs",
"clone_provider": null,
"dubbing_service": "elevenlabs_dub",
"health": {
"status": "operational",
"stability_index": 98,
"latency_seconds": 4.1,
"latency_unit": "chunk",
"error_level": "normal",
"queue": {
"state": "few",
"approx": null,
"wait_seconds": 30,
"load": "low"
}
}
},
"cartesia": {
"code": "cartesia",
"name": "Cartesia",
"type": "tts",
"order": 3,
"access": "public",
"status": false,
"state": "maintenance",
"message": "The service is under maintenance.",
"maintenance": {
"enabled": true,
"since": "2026-11-07T10:15:00+03:00",
"message": "The service is under maintenance."
},
"capabilities": {
"templates": true,
"voice_library": true,
"voice_filters": true,
"voice_clone": true,
"dubbing": true
},
"task_types": [
"tts"
],
"voice_provider": "cartesia",
"clone_provider": "cartesia",
"dubbing_service": "cartesia_dub",
"health": {
"status": "maintenance",
"stability_index": null,
"latency_seconds": null,
"latency_unit": "chunk",
"error_level": "normal",
"queue": {
"state": "none",
"approx": null,
"wait_seconds": null,
"load": "low"
}
}
}
}
}Success flag. Branch on the HTTP status code instead: any 2xx response carries true here, while an error comes back in a different shape that need not contain this field at all.
A human-readable note in the account language. Fine to show to a user; do not parse it — the wording changes without notice and is not an error code.
datarequiredThe response payload.
object
The response payload.
401The key is missing, unknown, disabled or expired.
The key is missing, unknown, disabled or expired.
{
"success": false,
"message": "API key is missing. Provide it in the X-API-KEY header.",
"data": null
}Always false in error responses.
Error text in the key's language (set through the X-Locale header).
Always null when the request is rejected before processing.
403The key lacks the required permission, or the object belongs to another user.
The key lacks the required permission, or the object belongs to another user.
{
"success": false,
"message": "This API key does not have permission to perform this action."
}Always false in error responses.
Error text in the key's language (set through the X-Locale header).
Nearby
The same in words
This page for AI
API version 1.0.0