Saltar al contenido principal

Listar agentes

Devuelve los agentes a los que tu API Key tiene acceso. Una clave con alcance Todos los agentes devuelve todos los agentes de tu empresa; una clave con alcance Agentes específicos devuelve únicamente los agentes vinculados a esa clave.

Endpoint

GET /v1/agents

Parámetros de consulta

ParámetroTipoPor defectoDescripción
pageinteger1Número de página a obtener (empezando en 1). Valores menores a 1 se ajustan a 1.
limitinteger20Cantidad de agentes por página. Máximo 100.

Ejemplo de solicitud

curl -X GET "https://api.fonema.ai/v1/agents?page=1&limit=20" \
-H "Authorization: Bearer TU_API_KEY_AQUI"

Respuesta

{
"offset": 0,
"total": 42,
"limit": 20,
"currentPage": 1,
"totalPages": 3,
"agents": [
{ "name": "Agente de Ventas", "slug": "agente-de-ventas-ab12cd34" },
{ "name": "Agente de Soporte", "slug": "agente-de-soporte-ef56gh78" }
]
}

Campos de la respuesta

CampoTipoDescripción
totalintegerNúmero total de agentes accesibles por esta clave.
limitintegerTamaño de página usado en esta respuesta.
offsetintegerCantidad de agentes omitidos antes de esta página.
currentPageintegerPágina devuelta.
totalPagesintegerNúmero total de páginas disponibles.
agentsarrayLista de agentes. Cada elemento contiene el name y el slug del agente.
tip

Usa el slug que se devuelve aquí como identificador en las solicitudes de Consultar agente y Editar agente.