Asira
Ir al panel

Bienvenido a la API de Asira

La API pública v1 deja que tus sistemas hablen con Asira, el panel de agentes de IA de Sygnal: ingresar leads desde tu CRM o landing, consultarlos, y reaccionar a lo que pasa en el pipeline mediante webhooks. Todo queda acotado a tu workspace por la API key con la que autenticas.

Una sola verdadToda la API autentica con el header X-API-Key (formato sygk_live_…). No hay tokens en la URL ni en el body. Ver Autenticación.

Lo esencial

Autenticación

Cómo crear, usar y revocar tu API key. Formato, rate limit y errores.

Referencia de la API

Todos los endpoints, generados desde el código: nunca escritos a mano.

Webhook de leads

Ingesta de leads por webhook con token por workspace y ruteo automático.

Webhooks por etapa

Recibe un POST en tu endpoint cada vez que un lead cambia de estado.

Convenciones

La API sigue un contrato uniforme en todos sus endpoints:

  • URL base: https://TU-DOMINIO/api/public/v1 (reemplaza TU-DOMINIO por el dominio real de tu instancia).
  • Autenticación: header X-API-Key: sygk_live_… en cada request.
  • Rutas con {id} (nunca :id) para los parámetros de ruta.
  • Errores con envelope uniforme: { "error": { "code": "...", "message": "..." } }.
  • Listados paginados con limit / offset y un flag has_more.
  • Español en descripciones y mensajes.

Inicio rápido

  1. Crea tu API key

    En el panel, anda a Configuración → API y crea una key. Se muestra una sola vez: cópiala y guárdala en un lugar seguro (variable de entorno, secret manager). Detalle en Autenticación.

  2. Ingresa tu primer lead

    Con la key en el header X-API-Key, haz un POST /leads:

    curl -X POST https://TU-DOMINIO/api/public/v1/leads \
  -H "Content-Type: application/json" \
  -H "X-API-Key: sygk_live_tu_api_key" \
  -d '{
    "name": "Tony Stark",
    "phone": "+56912345678",
    "email": "tony@stark.com",
    "source": "landing_web"
  }'

    El lead entra al workspace de la key, se rutea por tus pre-procesadores hacia el agente correspondiente y arranca la conversación.

  3. Reacciona a lo que pasa

    Configura un webhook por etapa para recibir un POST en tu endpoint cada vez que un lead cambia de estado en el pipeline.

La key es un secretoTrata la sygk_live_… como una contraseña: nunca la subas a git, no la incrustes en el front, no la pegues en logs. En el servidor solo vive su hash.