> ## Documentation Index > Fetch the complete documentation index at: https://docs.getsupervisor.ai/llms.txt > Use this file to discover all available pages before exploring further. # Crear una API Key > Genera una nueva API Key asociada al usuario autenticado y al workspace activo. La respuesta incluye el valor completo de la llave **solo una vez**, por lo que debe almacenarse de manera segura inmediatamente. ## OpenAPI ````yaml /openapi/public-api.yaml post /v1/api-keys openapi: 3.1.0 info: title: Agents Studio API version: 1.0.0 description: > API del backend de Agents Studio. Expone servicios multi-tenant para gestionar agentes (texto y voz), catálogo de herramientas, habilitación de workspaces y operaciones de telefonía. Todos los endpoints requieren autenticación Bearer y respetan los contratos documentados en `docs/modules`. license: name: Proprietary url: https://getsupervisor.ai/legal/terms servers: - url: https://api-prod.studio.getsupervisor.ai description: Producción - url: https://sandbox.agents.studio.getsupervisor.ai description: Sandbox security: - BearerAuth: [] tags: - name: Agents description: > Gestión general de agentes y sus metadatos. Scopes requeridos: `agents:read` para consultas y `agents:write` para creación, actualización y operaciones sobre teléfonos. - name: Agent Versions description: Versionado y mantenimiento de versiones publicadas de los agentes. - name: Agent Schedules description: >- Configuración de horarios regulares y excepciones puntuales para controlar la disponibilidad de los agentes. - name: Agent Knowledge description: Uploads y sincronización de knowledge bases asociadas al agente. - name: Agent Tags description: Gestión de etiquetas asociadas a agentes. - name: Campaigns description: > Gestión de campañas masivas basadas en CSV para ejecutar agentes de forma batch. Scopes requeridos: `campaigns:read` para consultas y `campaigns:write` para creación. - name: Calls description: | Consultas de llamadas (Speech Analytics) disponibles para el workspace. Scopes requeridos: `calls:read`. - name: Knowledge description: Gestión de recursos de conocimiento asociados a tools. - name: Agent Instructions description: > Operaciones sobre instrucciones (prompt) gestionadas por los usuarios finales para guiar y corregir el comportamiento del agente. Las instrucciones se aplican a la versión activa del agente, se mantienen como texto libre sin formato (1 a 500 caracteres) y su prioridad se controla mediante el campo `order`. Scopes requeridos: `agent-instructions:read` para consultas y `agent-instructions:write` para creación o edición. - name: Voices description: Catálogo consolidado de voces provenientes de proveedores externos. - name: Catalogs description: > Gestión centralizada de catálogos (idiomas, tonos, voces, etiquetas) con alcance global o específico por workspace. Scopes requeridos: `catalogs:read` para consultas y `catalogs:write` para creación y modificaciones. - name: Agent Phones description: Conexión y desconexión de teléfonos asignados a agentes. - name: API Keys description: Gestión de credenciales de acceso programático y sus permisos. - name: Agent Blueprints description: > Gestión del blueprint (personalidad) asociado a cada versión de agente. Scopes requeridos: `agent-blueprints:read` para lectura y `agent-blueprints:write` para cambios en blueprint. - name: Agent Stages description: > Autoría de stages del blueprint del agente, abarcando orden, prompts y validaciones previas a la publicación. Scopes requeridos: `stages:read` para consultas y `stages:write` para creación y edición. La validación se ejecuta automáticamente en cada mutación y la sincronización con proveedores sucede mediante jobs internos tras los cambios. - name: Stage Triggers description: > Gestión detallada de triggers que conectan stages dentro del blueprint y definen las transiciones conversacionales. Scopes requeridos: `stage-triggers:*` (o políticas equivalentes bajo `stages:*`). - name: Workspaces description: Gestión multi-tenant y habilitación de credenciales por workspace. - name: Tools description: > Catálogo y ejecución de tools disponibles para los agentes. Scopes requeridos: `tools:read` para listar y `tools:execute` para ejecutar tools. - name: Webhooks description: > Gestión de webhooks por workspace para suscribirse a eventos del dominio y recibir notificaciones HTTP. Scopes requeridos: `webhooks:read` para consultas y `webhooks:write` para crear, actualizar o eliminar webhooks y suscripciones. paths: /v1/api-keys: post: tags: - API Keys summary: Crear una API Key description: > Genera una nueva API Key asociada al usuario autenticado y al workspace activo. La respuesta incluye el valor completo de la llave **solo una vez**, por lo que debe almacenarse de manera segura inmediatamente. operationId: createApiKey parameters: - $ref: '#/components/parameters/XWorkspaceId' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateApiKeyRequest' examples: sandbox: summary: Crear API Key para entorno sandbox con scopes restringidos value: name: QA Sandbox description: Suite de tests automáticos environment: sandbox scopes: - agents:read - api-keys:read responses: '201': description: API Key creada con éxito content: application/json: schema: $ref: '#/components/schemas/CreateApiKeyResponse' examples: created: summary: Respuesta con la llave generada value: id: d6ef8c66-3c3d-4a87-9edf-9ec5fa929a9c name: Backend Integration description: Servicio interno para métricas environment: production scopes: - agents:read - workspaces:read keyPreview: sk_live_d6ef...29a9 createdAt: '2025-10-15T15:22:00.000Z' updatedAt: '2025-10-15T15:22:00.000Z' lastUsedAt: null key: sk_live_d6ef8c66-3c3d-4a87-9edf-9ec5fa929a9c '400': description: Solicitud inválida (campos fuera de rango o scopes vacíos) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: code: INVALID_API_KEY message: El arreglo scopes debe contener al menos un valor components: parameters: XWorkspaceId: name: x-workspace-id in: header required: true description: Identificador del workspace multi-tenant. schema: type: string format: uuid schemas: CreateApiKeyRequest: type: object properties: name: type: string minLength: 1 maxLength: 120 description: type: - string - 'null' maxLength: 255 environment: type: string enum: - production - sandbox - staging - development scopes: type: array items: type: string maxLength: 64 minItems: 1 required: - name additionalProperties: false CreateApiKeyResponse: allOf: - $ref: '#/components/schemas/ApiKeySummary' - type: object required: - key properties: key: type: string description: >- Valor completo de la API Key. Solo se entrega una vez y debe almacenarse de forma segura. ErrorResponse: type: object properties: code: type: string description: Código principal del error (alto nivel). message: type: string description: Mensaje legible para humanos. details: type: object description: > Información adicional específica del error. Cuando aplique, `details.subcode` provee un identificador estable para que el frontend decida qué UI mostrar. properties: subcode: type: string description: >- Identificador específico del error (p.ej. `WORKSPACE_NOT_PROVISIONED`). workspaceId: type: string format: uuid description: Identificador de workspace relacionado cuando aplica. additionalProperties: true required: - code - message ApiKeySummary: type: object required: - id - name - scopes - environment - keyPreview - createdAt - updatedAt properties: id: type: string format: uuid name: type: string description: type: - string - 'null' maxLength: 255 scopes: type: array description: Lista de scopes autorizados para esta credencial. items: type: string minItems: 1 environment: type: string enum: - production - sandbox - staging - development keyPreview: type: string description: >- Prefijo y sufijo visibles de la API Key (el valor completo no se expone después de la creación). createdAt: type: string format: date-time updatedAt: type: string format: date-time lastUsedAt: type: - string - 'null' format: date-time description: Fecha/hora del último uso registrado. revokedAt: type: - string - 'null' format: date-time description: Fecha/hora en que se revocó la credencial (si aplica). securitySchemes: BearerAuth: type: http scheme: bearer bearerFormat: JWT ````