> ## 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 un agente y su versión inicial

> Registra un nuevo agente junto con su primera versión de configuración. Ideal para habilitar
rápidamente nuevos casos de uso (soporte, ventas, cobranza) manteniendo trazabilidad multi-tenant.




## OpenAPI

````yaml /openapi/public-api.yaml post /v1/agents
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/agents:
    post:
      tags:
        - Agents
      summary: Crear un agente y su versión inicial
      description: >
        Registra un nuevo agente junto con su primera versión de configuración.
        Ideal para habilitar

        rápidamente nuevos casos de uso (soporte, ventas, cobranza) manteniendo
        trazabilidad multi-tenant.
      operationId: createAgent
      parameters:
        - $ref: '#/components/parameters/XWorkspaceId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateAgentRequest'
            examples:
              voiceAgent:
                summary: Crear agente de voz en español
                value:
                  name: Soporte Voz Latam
                  agentType: voice
                  description: Flujo automatizado para atención postventa
                  debounceDelayMs: 1200
                  metadata:
                    projectCode: CX-OPS-001
      responses:
        '201':
          description: Agente creado
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AgentDetail'
              examples:
                created:
                  summary: Respuesta con la versión inicial del agente
                  value:
                    agentId: 5769e110-7267-4cf7-a3ca-2d06e8fffbb3
                    workspaceId: a44bb95e-9f01-4d19-8b62-1f6f2b8e8363
                    name: Soporte Voz Latam
                    agentType: voice
                    status: inactive
                    versionId: b8f60a6d-4c3a-4b9f-8cf3-56ad71d2f2bf
                    knowledgeBaseIds: []
                    tools: []
                    createdAt: '2025-10-08T12:34:56.000Z'
                    updatedAt: '2025-10-08T12:34:56.000Z'
                    metadata:
                      projectCode: CX-OPS-001
        '400':
          description: Payload inválido
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                code: INVALID_AGENT
                message: El campo languageCode es obligatorio
        '404':
          description: Referencias de catálogo inexistentes
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                code: CATALOG_NOT_FOUND
                message: ToneId 5ceba0dd-0dd4-47a7-94aa-3ee2eda82780 no existe
        '409':
          description: Conflicto por agente duplicado
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                code: AGENT_DUPLICATED
                message: Ya existe un agente con ese nombre en el workspace
components:
  parameters:
    XWorkspaceId:
      name: x-workspace-id
      in: header
      required: true
      description: Identificador del workspace multi-tenant.
      schema:
        type: string
        format: uuid
  schemas:
    CreateAgentRequest:
      type: object
      description: >-
        Campos necesarios para registrar un nuevo agente. El usuario propietario
        se resuelve automáticamente a partir del token Bearer activo.
      properties:
        name:
          type: string
          minLength: 1
        description:
          type:
            - string
            - 'null'
        agentType:
          type: string
          enum:
            - chat
            - voice
        status:
          type:
            - string
            - 'null'
          enum:
            - inactive
            - training
            - active
        avatarUrl:
          type:
            - string
            - 'null'
          format: uri
        debounceDelayMs:
          type:
            - integer
            - 'null'
          minimum: 0
          description: Delay opcional antes de enviar respuestas (milisegundos).
        metadata:
          type: object
          additionalProperties: true
          description: >-
            Campo libre para adjuntar atributos operativos adicionales (p.ej.
            códigos de proyecto).
      required:
        - name
        - agentType
      additionalProperties: false
    AgentDetail:
      type: object
      properties:
        agentId:
          type: string
          format: uuid
        name:
          type: string
        agentType:
          type: string
          enum:
            - chat
            - voice
        workspaceId:
          type: string
          format: uuid
        versionId:
          type: string
          format: uuid
        status:
          type: string
          enum:
            - inactive
            - training
            - active
            - archived
        description:
          type:
            - string
            - 'null'
        avatarUrl:
          type:
            - string
            - 'null'
          format: uri
          description: URL pública opcional utilizada para representar al agente.
        debounceDelayMs:
          type:
            - integer
            - 'null'
          minimum: 0
          description: Delay opcional antes de enviar respuestas (milisegundos).
        toneId:
          type:
            - string
            - 'null'
          format: uuid
        messageStyleId:
          type:
            - string
            - 'null'
          format: uuid
        ownerUserId:
          type:
            - string
            - 'null'
          format: uuid
        knowledgeBaseIds:
          type: array
          description: Identificadores de knowledge bases asociadas.
          items:
            type: string
            format: uuid
        tags:
          type: array
          description: >-
            Tags de negocio asignados al agente. Se administran mediante
            `/v1/agents/{agentId}/tags`.
          items:
            type: string
            format: uuid
        tools:
          type: array
          description: Tools habilitadas para el agente.
          items:
            type: object
            properties:
              identifier:
                type: string
              displayName:
                type: string
              enabled:
                type: boolean
            required:
              - identifier
              - displayName
              - enabled
        voiceConfig:
          type:
            - object
            - 'null'
          description: Configuración de voz activa cuando el agente es de tipo voice.
          properties:
            voiceId:
              type: string
            webhookUrl:
              type: string
              format: uri
            llmId:
              type:
                - string
                - 'null'
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
        totalCalls:
          type: integer
          minimum: 0
          description: Total de llamadas realizadas por el agente.
        totalOperationalDays:
          type: integer
          minimum: 0
          description: Total de días operativos desde la creación del agente.
        goalAchievedPercentage:
          type: number
          minimum: 0
          maximum: 100
          description: Porcentaje de llamadas donde el objetivo fue alcanzado.
        metadata:
          type: object
          additionalProperties: true
      required:
        - agentId
        - name
        - agentType
        - workspaceId
        - status
        - createdAt
        - updatedAt
        - totalCalls
        - totalOperationalDays
        - goalAchievedPercentage
    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
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````