> ## 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 las bases de conocimiento del workspace > Devuelve las bases vivas del workspace, paginadas y ordenadas por fecha de creación. **Los conteos salen de nuestra fila, no del proveedor**, y eso es el diseño: el listado del proveedor devuelve la cuenta entera sin filtrar por cliente. Pueden ir por detrás de lo que el proveedor tiene mientras una base termina de indexar; el detalle sí va en vivo. **`documents` viene vacío**: traerlos costaría una llamada al proveedor por cada elemento de la página. ## OpenAPI ````yaml /openapi/public-api.yaml get /v1/knowledge-bases 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: 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: 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: Catalogs description: > Gestión centralizada de catálogos (idiomas, estilos de mensaje, tonos, etiquetas, voces y eventos de webhook) con alcance global o específico por workspace. Las voces del workspace se consultan aquí, con `GET /v1/catalogs/items?type=voice`. Scopes requeridos: `catalogs:read` para consultas y `catalogs:write` para creación y modificaciones. - name: Catalog Templates description: > Catálogo de plantillas de agente publicadas. Sirve para descubrir qué plantillas hay disponibles y con qué `agentVersionId` clonarlas mediante `POST /v1/agents/from-template`. Scopes requeridos: `catalogs:read`. - 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: Blueprint Stages description: > Autoría de stages de un blueprint del agente, abarcando orden, prompts y validaciones previas a la publicación. Todas las rutas cuelgan del blueprint (`/v1/agents/{agentId}/blueprints/{blueprintId}/stages`), así que hay que resolver primero el `blueprintId` con `GET /v1/agents/{agentId}/blueprints`. Scopes requeridos: `blueprint-stages:read` para consultas y `blueprint-stages:write` para creación y edición. La validación del grafo se ejecuta automáticamente en cada mutación y la sincronización con el proveedor 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:read` y `stage-triggers:write`. - 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. - name: SIP Trunks description: > Provisionamiento y gestión de SIP trunks para conectar agentes de voz con carriers PSTN (Twilio, ccc2.uno, etc.) via Kamailio. Genera credenciales digest automaticamente. Scopes requeridos: `sip:read` para consultas y `sip:write` para creación, actualización y eliminación. - name: Documents description: > Gestión de documentos asociados al workspace. Permite obtener URLs presignadas para subir archivos que luego se referencian al crear o personalizar agentes. Scopes requeridos: `documents:write`. - name: Message Templates description: > Gestión de message templates de WhatsApp (Kapso). Permite crear, listar y eliminar templates, así como consultar el estado de la conexión con el número de teléfono configurado. Scopes requeridos: `agents:read` para consultas y `agents:write` para creación y eliminación. - name: Billing description: | Consulta del balance de consumo del workspace sobre el plan contratado. Scopes requeridos: `billing:read`. - name: Usage description: | Consultas de consumo de recursos agregado por agente. Scopes requeridos: `usage:read`. - name: Uploads description: > Subida de archivos por URL prefirmada: la API reserva el sitio y devuelve la URL, y el cliente sube contra el almacén sin que los bytes pasen por aquí. Toda escritura exige `uploads:write`, y la firma exige **además** el scope que decide el namespace de la ruta: `agent-briefs` y `avatars` exigen `agents:write`, y `knowledge-sources` exige `knowledge-bases:write`. Cada namespace declara además qué acepta. `avatars` sólo admite PNG, JPEG y WEBP —y **no** SVG: se sirven en línea, y un SVG es texto ejecutable—, con un archivo por lote y 1 MiB como máximo. - name: Health description: > Sonda de disponibilidad del servicio. No requiere autenticación ni `X-Workspace-Id`. - name: Knowledge Bases description: > Bases de conocimiento del workspace: el material que el agente consulta durante la conversación. El prefijo nombra el recurso y no la tool que lo implementa, así que renombrar la tool `knowledge` no mueve estas rutas. Las sirve un plugin instalable, y eso tiene una consecuencia visible: si la tool no está abierta para el workspace, **todas** responden `404` —no `403`—. Una feature que no está disponible para un cliente no existe para él. Scopes requeridos: `knowledge-bases:read` para consultas y `knowledge-bases:write` para el alta, la baja y el mantenimiento de sus documentos. paths: /v1/knowledge-bases: get: tags: - Knowledge Bases summary: Listar las bases de conocimiento del workspace description: > Devuelve las bases vivas del workspace, paginadas y ordenadas por fecha de creación. **Los conteos salen de nuestra fila, no del proveedor**, y eso es el diseño: el listado del proveedor devuelve la cuenta entera sin filtrar por cliente. Pueden ir por detrás de lo que el proveedor tiene mientras una base termina de indexar; el detalle sí va en vivo. **`documents` viene vacío**: traerlos costaría una llamada al proveedor por cada elemento de la página. operationId: listKnowledgeBases parameters: - $ref: '#/components/parameters/XWorkspaceId' - name: page in: query required: false schema: type: integer minimum: 1 default: 1 - name: limit in: query required: false description: > Máximo 100. El techo no es decorativo: cada base pedida en detalle cuesta una llamada al proveedor, y sin él una página enorme sería la forma barata de cargarlo. schema: type: integer minimum: 1 maximum: 100 default: 20 responses: '200': description: Bases de conocimiento del workspace content: application/json: schema: $ref: '#/components/schemas/KnowledgeBaseList' examples: default: summary: Una base indexada y otra en curso value: data: - id: 9d0a1b2c-3d4e-4f50-8a6b-7c8d9e0f1a2b name: Manual de garantías description: Lo que el agente cita cuando preguntan por la garantía status: ready agentCount: 2 documentCount: 3 totalSizeBytes: 481203 documents: [] errorMessages: [] createdAt: '2026-09-01T10:00:00.000Z' updatedAt: '2026-09-01T10:04:12.000Z' - id: 1f2e3d4c-5b6a-4798-8d0e-1f2a3b4c5d6e name: Catálogo 2026 description: '' status: syncing agentCount: 2 documentCount: 0 totalSizeBytes: 0 documents: [] errorMessages: [] createdAt: '2026-09-01T11:30:00.000Z' updatedAt: '2026-09-01T11:30:02.000Z' meta: total: 2 page: 1 limit: 20 hasNext: false hasPrevious: false '403': description: | La llave no tiene el scope `knowledge-bases:read`. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: > La tool `knowledge` no está abierta para este workspace. Es `404` y no `403` a propósito: la feature no existe para él, y decir «desactivada» delataría que existe para otros. 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 schemas: KnowledgeBaseList: type: object properties: data: type: array items: $ref: '#/components/schemas/KnowledgeBase' meta: $ref: '#/components/schemas/PaginationMeta' required: - data - meta 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 KnowledgeBase: type: object properties: id: type: string format: uuid description: > Identificador de la base en Agents Studio. La referencia interna del proveedor no se publica. name: type: string description: type: string status: type: string enum: - queued - syncing - ready - error description: > `queued`: dada de alta, todavía no existe en el proveedor. `syncing`: el proveedor la está indexando. `ready`: el agente ya puede consultarla. `error`: el indexado falló, y `errorMessages` dice por qué. documentCount: type: integer totalSizeBytes: type: integer agentCount: type: integer description: > Cuántos **agentes** del workspace consultan esta base. Cuenta agentes, no conexiones: un agente con dos conexiones a la misma base suma uno. Cero significa que ninguno la consulta, y por tanto que retirarla no cambia el comportamiento de nadie. documents: type: array description: > **Vacío en el listado a propósito.** Los documentos los tiene el proveedor y traerlos costaría una llamada por elemento de la página. Vienen en el detalle. items: $ref: '#/components/schemas/KnowledgeBaseDocument' errorMessages: type: array description: Vacío salvo que `status` sea `error`. items: type: string createdAt: type: string format: date-time updatedAt: type: string format: date-time required: - id - name - description - status - agentCount - documentCount - totalSizeBytes - documents - errorMessages - 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 KnowledgeBaseDocument: type: object properties: id: type: string description: Identificador del documento dentro de la base. name: type: string description: Nombre del archivo tal como se subió. sizeBytes: type: integer description: Tamaño del archivo en bytes. url: type: string nullable: true description: > Enlace de descarga, cuando el proveedor lo emite. `null` si no hay uno disponible. required: - id - name - sizeBytes - url securitySchemes: BearerAuth: type: http scheme: bearer bearerFormat: JWT ````