Saltar al contenido principal

Consultar agente

Obtiene la configuración completa de un agente a partir de su slug.

Endpoint

GET /v1/agents/:slug

Parámetros de ruta

ParámetroTipoDescripción
slugstringSlug único del agente. Obtenlo desde Listar agentes o desde tu dashboard de Fonema.

Ejemplo de solicitud

curl -X GET "https://api.fonema.ai/v1/agents/agente-de-ventas-ab12cd34" \
-H "Authorization: Bearer TU_API_KEY_AQUI"

Respuesta

{
"name": "Agente de Ventas",
"slug": "agente-de-ventas-ab12cd34",
"greeting": "¡Hola, gracias por llamar!",
"prompt": "Eres un asistente de ventas servicial.",
"textPrompt": "...",
"voiceId": "TU_VOICE_ID",
"sipDialTarget": null,
"numberOfAttempt": 3,
"allowReturnCall": true,
"recallLogic": { "totalCalls": 3 },
"workingHours": {},
"localizations": {},
"dtmf": false,
"transferCallDestinations": [],
"knowledgeBaseFiles": [],
"tools": [
{
"id": 12,
"name": "lookup_order",
"type": "API_CALL",
"description": "Busca un pedido por su ID",
"variables": [
{ "orderId": { "type": "string", "description": "El ID del pedido" } }
],
"content": {
"functionName": "lookup_order",
"url": "https://example.com/api/orders"
}
}
],
"config": {
"transcriberLanguage": "es-419",
"silenceTimeoutSeconds": 30,
"maxDurationSeconds": 600,
"endOfCallWebhook": "https://example.com/webhooks/end-of-call"
}
}

Campos de la respuesta

CampoTipoDescripción
namestringNombre del agente.
slugstringIdentificador único del agente.
greetingstringMensaje de apertura que dice el agente al iniciar la llamada.
promptstringPrompt del sistema que define el comportamiento del agente.
textPromptstringPrompt usado para conversaciones de texto/chat.
voiceIdstringIdentificador de la voz que usa el agente.
sipDialTargetstring | nullDestino SIP, si está configurado.
numberOfAttemptintegerNúmero de intentos de llamada configurados (proviene de recallLogic).
allowReturnCallbooleanSi el agente permite llamadas de retorno.
recallLogicobjectConfiguración de reintentos/rellamadas.
workingHoursobjectConfiguración de horario de atención.
localizationsobjectConfiguración de localización.
dtmfbooleanSi está habilitada la entrada por DTMF (teclado).
transferCallDestinationsarrayDestinos de transferencia de llamada configurados.
knowledgeBaseFilesarrayIDs de los archivos de base de conocimiento adjuntos.
toolsarrayHerramientas/skills disponibles para el agente.
configobjectConfiguración adicional del agente (idioma del transcriptor, tiempos de espera, webhooks, etc.).
nota

Las credenciales sensibles de las herramientas (apiKey, token, credentialId) nunca se incluyen en la respuesta de tools.

Errores

EstadoDescripción
404El agente no existe o no es accesible con esta API Key.