Authorization. Esta página explica cómo autenticar llamadas con una API key que usted
ya posee. Para generar, listar y revocar claves, consulte la Guía de API key.
Base URL
/v1. Por ejemplo, listar agentes es
GET https://api.nuvia.ai/v1/agents.
Dos formas de autenticar
La API acepta dos tipos de identidad en el mismo headerAuthorization: Bearer:
- API key de empresa: es lo que usa para integración programática. La clave está
vinculada a su empresa y a los scopes definidos en la creación; puede tener validez opcional
(
expiresAt). Es el método recomendado para servidores, scripts e integraciones. - JWT humano: el token de sesión emitido por el flujo de inicio de sesión de la aplicación
(
POST /v1/auth/login). Representa a un usuario humano, no una integración. No lo necesita para consumir la API vía API key. Los endpoints de inicio de sesión pertenecen a la plataforma y no aparecen en la Referencia de la API, que cubre la superficie consumible por API key.
Autenticando una solicitud
Incluya el headerAuthorization en cada llamada. El siguiente ejemplo lista los agentes de su
empresa (requiere el scope agents:read):
La API key es un token de acceso completo al scope concedido. Trátela como un secreto:
guárdela en una variable de entorno o en un gestor de secretos, nunca en el código fuente ni en
el control de versiones.
Multi-tenant y el header X-Company-Id
El tenant (empresa) de una API key de empresa se resuelve por el propio token. No necesita
indicarlo. El header X-Company-Id solo es obligatorio para claves globales de uso interno y se
ignora para API keys de empresa y para JWT humano. En resumen: integrando con una API key
de empresa, no envía X-Company-Id.
Errores de autenticación
Las respuestas de error de autenticación siguen el formato{ statusCode, message, error }.
401: no autenticado
Se retorna cuando el token está ausente, es inválido, expiró o fue revocado.message detalla la causa cuando es posible, por ejemplo "API key inválida",
"API key expirada", "API key revocada" o "API key no encontrada".
403: sin permiso
Se retorna cuando el token es válido, pero la API key no tiene el scope necesario para la acción, o el endpoint no está disponible para API keys.403 en una llamada que debería funcionar, verifique si la clave fue creada con el
scope exigido por el endpoint. Los scopes se definen en el momento de la creación de la clave.
Consulte la Guía de API key.
Próximos pasos
Guía de API key
Cómo generar, listar y revocar claves, y qué scopes existen.
Inicio rápido
Haga su primera llamada a la API en pocos minutos.