> ## 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. # Listar instrucciones de una versión del agente ## OpenAPI ````yaml /openapi/public-api.yaml get /v1/agents/{agentId}/versions/{versionId}/instructions 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/{agentId}/versions/{versionId}/instructions: get: tags: - Agent Instructions summary: Listar instrucciones de una versión del agente operationId: listAgentVersionInstructions parameters: - $ref: '#/components/parameters/XWorkspaceId' - $ref: '#/components/parameters/AgentId' - $ref: '#/components/parameters/VersionId' - $ref: '#/components/parameters/PageParam' - $ref: '#/components/parameters/LimitParam' - $ref: '#/components/parameters/FilterParam' responses: '200': description: Lista ordenada de instrucciones content: application/json: schema: $ref: '#/components/schemas/InstructionListResponse' '404': description: Versión no encontrada content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' components: parameters: XWorkspaceId: name: x-workspace-id in: header required: true description: Identificador del workspace multi-tenant. schema: type: string format: uuid AgentId: name: agentId in: path required: true description: Identificador del agente schema: type: string format: uuid VersionId: name: versionId in: path required: true description: Identificador de la versión del agente schema: type: string format: uuid PageParam: name: page in: query required: false description: Número de página (>= 1). Por defecto es 1. schema: type: integer minimum: 1 default: 1 LimitParam: name: limit in: query required: false description: Tamaño de página (1..100). Por defecto 20. schema: type: integer minimum: 1 maximum: 100 default: 20 FilterParam: name: filter in: query required: false description: > Expresión de filtros combinados generada con el API Query Builder. Utiliza funciones como `and(...)`, `or(...)`, `eq(...)`, `like(...)`, etc. Consulta `docs/api-query-builder.md` para la gramática completa y ejemplos adicionales. schema: $ref: '#/components/schemas/QueryFilters' examples: estadoActivoConNombre: summary: Filtrar agentes activos cuyo nombre contiene "ventas" value: and(eq(status,"active"),like(name,"%ventas%")) schemas: InstructionListResponse: type: object required: - data properties: data: type: array default: [] items: $ref: '#/components/schemas/Instruction' meta: $ref: '#/components/schemas/PaginationMeta' 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 QueryFilters: type: string description: > Expresión string compatible con el API Query Builder. Soporta composición de funciones (`and`, `or`) y operadores (`eq`, `like`, `between`, etc.) para filtrar resultados. example: and(eq(status,"active"),like(name,"%ventas%")) Instruction: type: object properties: id: type: string format: uuid agentId: type: string format: uuid versionId: type: string format: uuid order: type: integer content: type: string minLength: 1 maxLength: 500 description: Texto libre que guía el comportamiento del agente. status: type: string enum: - active - inactive description: Controla si la instrucción está habilitada para el agente. createdAt: type: string format: date-time updatedAt: type: string format: date-time deletedAt: type: - string - 'null' format: date-time description: >- Timestamp de borrado suave. Nulo cuando la instrucción sigue disponible. required: - id - agentId - versionId - order - content - status - createdAt - updatedAt PaginationMeta: type: object properties: total: type: integer page: type: integer limit: type: integer hasNext: type: boolean hasPrevious: type: boolean description: Indica si existe una página previa a la actual. required: - total - page - limit - hasNext - hasPrevious securitySchemes: BearerAuth: type: http scheme: bearer bearerFormat: JWT ````