> ## 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 consumo por agente > Obtiene un listado paginado del consumo agregado por agente para el workspace activo. Los resultados están ordenados por cantidad total consumida (descendente) e incluyen el porcentaje de participación de cada agente sobre el total. ## OpenAPI ````yaml /openapi/public-api.yaml get /v1/usage/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: 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: Health description: > Sonda de disponibilidad del servicio. No requiere autenticación ni `X-Workspace-Id`. paths: /v1/usage/agents: get: tags: - Usage summary: Listar consumo por agente description: > Obtiene un listado paginado del consumo agregado por agente para el workspace activo. Los resultados están ordenados por cantidad total consumida (descendente) e incluyen el porcentaje de participación de cada agente sobre el total. operationId: listUsageAgents parameters: - $ref: '#/components/parameters/XWorkspaceId' - $ref: '#/components/parameters/PageParam' - $ref: '#/components/parameters/LimitParam' - $ref: '#/components/parameters/UsageResourceQuery' - $ref: '#/components/parameters/UsageFromQuery' - $ref: '#/components/parameters/UsageToQuery' responses: '200': description: Listado paginado de consumo por agente content: application/json: schema: $ref: '#/components/schemas/UsageAgentsResponse' examples: default: summary: Consumo de dos agentes value: data: - agentId: 5769e110-7267-4cf7-a3ca-2d06e8fffbb3 agentName: Agente Ventas status: active totalQuantity: 820 totalEvents: 45 percentOfTotal: 65.6 lastActivity: '2026-03-15T18:30:00.000Z' - agentId: e3a1b2c4-d5f6-7890-abcd-ef1234567890 agentName: Agente Soporte status: active totalQuantity: 430 totalEvents: 22 percentOfTotal: 34.4 lastActivity: '2026-03-15T12:10:00.000Z' meta: total: 2 page: 1 limit: 20 hasNext: false hasPrevious: false '400': description: Parámetros de consulta inválidos content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: code: BAD_REQUEST message: Invalid query parameter components: parameters: XWorkspaceId: name: x-workspace-id in: header required: true description: Identificador del workspace multi-tenant. 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 UsageResourceQuery: name: resource in: query required: false description: Tipo de recurso a consultar. Por defecto "minutes". schema: type: string default: minutes UsageFromQuery: name: from in: query required: false description: Fecha inicio del rango de consulta (formato YYYY-MM-DD). schema: type: string format: date UsageToQuery: name: to in: query required: false description: Fecha fin del rango de consulta (formato YYYY-MM-DD). schema: type: string format: date schemas: UsageAgentsResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/UsageAgentRow' meta: $ref: '#/components/schemas/UsageAgentsMeta' 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 UsageAgentRow: type: object description: Consumo agregado de un agente individual. properties: agentId: type: string format: uuid agentName: type: - string - 'null' description: Nombre del agente (null si fue eliminado). status: type: - string - 'null' description: Estado actual del agente (null si fue eliminado). enum: - inactive - training - active - archived - building - failed - null totalQuantity: type: integer description: Cantidad total consumida por el agente. totalEvents: type: integer description: Número total de eventos de consumo registrados. percentOfTotal: type: number format: double description: Porcentaje de participación sobre el total (0-100). lastActivity: type: string format: date-time description: Fecha de la última actividad de consumo del agente. required: - agentId - agentName - status - totalQuantity - totalEvents - percentOfTotal - lastActivity additionalProperties: false UsageAgentsMeta: type: object properties: total: type: integer page: type: integer limit: type: integer hasNext: type: boolean hasPrevious: type: boolean aggregations: $ref: '#/components/schemas/UsageAgentsAggregations' required: - total - page - limit - hasNext - hasPrevious - aggregations additionalProperties: false UsageAgentsAggregations: type: object description: Datos agregados del consumo global y plan contratado. properties: totalUsage: type: integer description: Sumatoria total del consumo de todos los agentes filtrados. planLimit: type: - integer - 'null' description: >- Límite contratado del recurso filtrado. Null si no hay suscripción activa. required: - totalUsage - planLimit additionalProperties: false securitySchemes: BearerAuth: type: http scheme: bearer bearerFormat: JWT ````