Agentes¶

Listado de los agentes de AI disponibles para tu organización. El agent_id que devuelve este endpoint es el que usas al lanzar una campaña.

La misma referencia, en otras dos formas

· Probar los endpoints — esta misma información, desplegable y con botón para ejecutar las consultas de lectura contra tu organización. · Ciclo de vida de una campaña — si buscabas el recorrido completo en orden en vez del contrato suelto.

Base URL: https://api.neuronstudio.ai

Autenticación: API Key (X-API-Key) o JWT (Authorization: Bearer).

Los agentes se crean y configuran del lado de Neuron — no se crean vía la API. Si necesitas un agente nuevo o un cambio de configuración, contacta a tu contacto de Neuron.

`GET /api/agents`¶

Lista los agentes asignados a tu organización. Se puede filtrar por tipo.

Atributo	Valor
URL completa	`https://api.neuronstudio.ai/api/agents`
Autenticación	API Key / JWT
Scope	lectura
Rate limit	—

Parámetros de query¶

Parámetro	Tipo	Requerido	Descripción
`type`	string	No	Filtra por `agent_type`: `collections`, `sdr`, `cx` o `interviewer`.

Ejemplo de request¶

API_BASE_URL="https://api.neuronstudio.ai"

curl -s "$API_BASE_URL/api/agents?type=collections" \
  -H "X-API-Key: nrn_live_0123456789abcdef0123456789abcdef"

Ejemplo de response (200)¶

{
  "success": true,
  "agents": [
    {
      "agent_id": "agent_abc",
      "agent_name": "Cobranza CDMX",
      "agent_type": "collections"
    },
    {
      "agent_id": "agent_def",
      "agent_name": "Prospección Norte",
      "agent_type": "sdr"
    }
  ]
}

Campo	Significado
`agent_id`	Identificador del agente. Es el valor que pasas como `agent_id` al iniciar o programar una campaña.
`agent_name`	Nombre legible del agente.
`agent_type`	Tipo del agente: `collections`, `sdr`, `cx` o `interviewer`.

Cómo se usa el `agent_id`¶

Al iniciar una campaña (POST /api/campaign/start), pasas el agent_id de este listado para elegir qué agente realiza las llamadas. Si omites agent_id, se usa el agente por defecto de tu organización.

curl -s -X POST "$API_BASE_URL/api/campaign/start" \
  -H "X-API-Key: nrn_live_0123456789abcdef0123456789abcdef" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Cobranza Enero",
    "csv_content": "to_number,lead_id,client_name,debt\n+525512345678,L001,Juan,5000",
    "agent_id": "agent_abc"
  }'

Códigos de error¶

Código	Cuándo ocurre
`401`	No autenticado.
`400`	`type` no es un tipo de agente válido.