Skip to main content
GET
/
v1
/
voices
Listar voces disponibles para el workspace
curl --request GET \
  --url https://agents.studio.getsupervisor.ai/v1/voices \
  --header 'Authorization: Bearer <token>' \
  --header 'x-workspace-id: <x-workspace-id>'
{
  "data": [
    {
      "id": "<string>",
      "name": "<string>",
      "locale": "<string>",
      "provider": "<string>",
      "providerVoiceId": "<string>",
      "gender": "female",
      "tags": [
        "<string>"
      ],
      "previewUrl": "<string>"
    }
  ],
  "meta": {
    "total": 123,
    "page": 123,
    "limit": 123,
    "hasNext": true,
    "hasPrevious": true
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
x-workspace-id
string<uuid>
required

Identificador del workspace multi-tenant.

Query Parameters

​
agentId
string<uuid>

Filtra voces compatibles con el agente indicado.

​
agentVersionId
string<uuid>

Filtra voces compatibles con una versión específica del agente.

​
gender
enum<string>
Available options:
female,
male,
neutral
​
locale
string

Locale ISO (ej. es-MX).

​
page
integer
default:1

Número de página (>= 1). Por defecto es 1.

Required range: x >= 1
​
limit
integer
default:20

Tamaño de página (1..100). Por defecto 20.

Required range: 1 <= x <= 100
​
sort
string

Lista separada por comas de campos a ordenar. Usa prefijo '-' para orden descendente.

Example:

"createdAt,-id"

​
fields
string

Lista separada por comas de campos a retornar (sparse fieldset).

Example:

"id,externalId,status"

​
include
string

Lista separada por comas de relaciones a cargar.

Example:

"messages,sender"

​
q
string

Búsqueda de texto global sobre campos soportados del recurso.

Example:

"soporte"

​
filter
string

Expresión de filtros combinados generada con el API Query Builder. Utiliza funciones como and(...), or(...), eq(...), like(...), etc. Consulta docs/api-query-builder.md para la gramática completa y ejemplos adicionales.

Expresión string compatible con el API Query Builder. Soporta composición de funciones (and, or) y operadores (eq, like, between, etc.) para filtrar resultados.

Example:

"and(eq(status,\"active\"),like(name,\"%ventas%\"))"

Response

Catálogo de voces disponibles

​
data
object[]
required
​
meta
object
required