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): 
GET /v1/agents?limit=1 HTTP/1.1
Host: api-prod.studio.getsupervisor.ai
X-API-Key: TU_API_KEY
X-Workspace-Id: TU_WORKSPACE_ID

​
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:readListar y consultar agentes del workspace.
agents:writeCrear/actualizar/eliminar agentes y gestionar su configuración operativa.
agent-versions:readListar y consultar versiones de un agente.
agent-versions:writeCrear, clonar, restaurar y publicar versiones de un agente.
agent-instructions:readLeer instrucciones (a nivel agente y por versión).
agent-instructions:writeCrear, actualizar o borrar instrucciones personalizadas.
agent-blueprints:readConsultar el blueprint (personalidad) de una versión de agente.
agent-blueprints:writeEditar blueprint: personalidad, reglas, audiencia, objetivos, etc.
blueprint-stages:readListar y consultar stages del blueprint.
blueprint-stages:writeCrear, actualizar o reordenar stages del blueprint.
stage-triggers:readConsultar triggers que conectan stages y sus condiciones.
stage-triggers:writeCrear, actualizar o eliminar triggers entre stages.
agent-schedules:readConsultar horario semanal y excepciones vigentes.
agent-schedules:writeCrear o modificar horarios y excepciones.
campaigns:readConsultar campañas y sus ejecuciones.
campaigns:writeCrear y disparar campañas batch.
calls:readConsultar llamadas (Speech Analytics) del workspace.
catalogs:readNavegar catálogos globales y por workspace (idiomas, tonos, voces, etc.).
catalogs:writeRegistrar o ajustar ítems de catálogo.
tools:readDescubrir tools disponibles, recursos y capacidades declaradas.
tools:connections:readListar conexiones configuradas entre agentes y tools.
tools:connections:writeCrear o actualizar conexiones entre agentes y tools.
tools:executeEjecutar acciones de una tool.
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 workspaces disponibles y sus metadatos.
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.