Skip to main content
Las API Keys son por espacio de trabajo. Cada workspace tiene su propia clave y permisos asociados.

​
Obtener tu API Key

  1. Inicia sesión en Agents Studio.
  2. Ve a Ajustes (Settings) del espacio de trabajo actual.
  3. Abre la sección “API Keys”.
  4. Genera una nueva clave o copia una existente.
Sugerencias:
  • Asigna un nombre/nota a cada clave para identificar su uso (p. ej., “Producción - Backend”).
  • Mantén las claves en un gestor seguro de secretos.

​
Alcance y permisos

  • La clave sólo es válida para el workspace donde fue emitida.
  • Acceso restringido a los recursos de ese workspace (chatbots, llamadas, notificaciones, etc.).
  • Puedes revocar o rotar una clave sin afectar otras.

​
Uso en peticiones

Incluye tu clave en el header HTTP como API Key simple (compatible con n8n): 
X-API-Key: TU_API_KEY
Ejemplo de uso (HTTP): 
POST /webhook/7a6c6697-7dfc-47cf-adc5-c1df3ca559b0 HTTP/1.1
Host: api.workflows.getsupervisor.ai
Content-Type: application/json
X-API-Key: TU_API_KEY

{ "chatbotId": "...", "phone": "..." }

​
Rotación y buenas prácticas

  • Rotación periódica de claves (al menos trimestral).
  • Revoca claves no utilizadas o comprometidas.
  • Usa claves distintas por entorno (dev/staging/prod).

​
Scopes disponibles

Cada clave debe emitirse con el conjunto mínimo de scopes necesario. La siguiente tabla resume los permisos alineados a la Public API vigente.
ScopePermiso principal
agents:readConsultar agentes, versiones, instrucciones, teléfonos y blueprints asociados.
agents:writeCrear, actualizar o eliminar agentes, versiones, teléfonos y su configuración operativa.
agent-instructions:readLeer instrucciones tanto a nivel agente como por versión publicada.
agent-instructions:writeCrear, actualizar o borrar instrucciones personalizadas.
agent-blueprints:readConsultar blueprint y resúmenes sincronizados con proveedores externos.
agent-blueprints:writeEditar blueprint, personalidad y reglas de cada versión.
stages:readRevisar stages del blueprint, triggers vinculados y resultados de validación.
stages:writeCrear, actualizar o reordenar stages para preparar la publicación de versiones.
stage-triggers:readConsultar triggers conversacionales que conectan stages y revisar sus condiciones.
stage-triggers:writeCrear, actualizar o eliminar triggers que conectan stages dentro del blueprint.
agent-schedules:readConsultar horario semanal y excepciones vigentes.
agent-schedules:writeCrear o modificar horarios y excepciones.
catalogs:readNavegar catálogos globales y por workspace (idiomas, estilos, voces, etc.).
catalogs:writeRegistrar o ajustar ítems de catálogo.
tools:readDescubrir tools disponibles, recursos y capacidades declaradas.
tools:connections:writeCrear conexiones entre agentes y tools (p. ej. voice.calls).
tools:executeEjecutar acciones de una tool (startCall, reload, etc.).
webhooks:readListar webhooks y sus suscripciones activas.
webhooks:writeCrear, actualizar o eliminar webhooks y suscripciones.
api-keys:readListar credenciales existentes y revelar su valor.
api-keys:writeEmitir o revocar API Keys.
workspaces:readConsultar metadatos y estado de habilitación de un workspace.
Recomendaciones rápidas:
  • Define scopes por entorno y flujo de negocio (backoffice, automatizaciones, integraciones externas, etc.).
  • Evita entregar *:* o :write cuando tu integración sólo consulta información.
  • Valida en openapi/public-api.yaml si un endpoint exige scopes adicionales o específicos.