> ## Documentation Index > Fetch the complete documentation index at: https://docs.mka1.com/llms.txt > Use this file to discover all available pages before exploring further. # Obter uso de arquivos > Recupere bytes de arquivos criados por período a partir de eventos de criação de arquivos duráveis. Isso não reflete o armazenamento retido atual, os buckets continuam contados após a exclusão de arquivos, e os resultados agrupados são colapsados pelas dimensões de saída solicitadas em vez de uma linha por UserContext. ## OpenAPI ````yaml https://apigw.mka1.com/speakeasy.json?language=pt-BR get /api/v1/llm/usage/files openapi: 3.1.1 info: title: MKA1 API version: 1.1.0 description: >- A API MKA1 é uma API RESTful que fornece acesso à plataforma MKA1. Aprenda como começar a usar a API e o SDK TypeScript [aqui](https://mka1.apidocumentation.com/guides/getting-started). license: name: Proprietário servers: - url: https://apigw.mka1.com description: MKA1 API Gateway - url: / description: Relative server URL (configurable via SDK constructor) security: [] tags: - name: Resource Authorization description: >- Gerencie permissões para recursos LLM. Crie recursos, conceda/revoque permissões e exclua recursos. Apenas os proprietários dos recursos podem conceder, revogar ou excluir permissões. x-displayName: Autorização de Recurso - name: Embeddings description: >- Endpoints da API de incorporação de texto para gerar representações vetoriais de texto. Crie incorporações semânticas para busca, clustering e correspondência de similaridade usando vários modelos de incorporação. x-displayName: Incorporações - name: Feedback description: >- API de feedback do usuário para avaliar e comentar sobre as conclusões de chat. Coleta de classificações de positivo/negativo e feedback detalhado para melhorar as respostas do modelo e acompanhar a satisfação do usuário. x-displayName: Feedback - name: Images description: >- Pontos de extremidade da API de geração de imagens para criar imagens a partir de descrições de texto. Gere imagens com controle sobre tamanho, qualidade e estilo. x-displayName: Imagens - name: MCP Vault description: >- API do cofre MCP para armazenar configurações de servidor MCP de propriedade do usuário e credenciais criptografadas. Os agentes referenciam IDs de cofre para que os segredos sejam resolvidos apenas no momento da execução da ferramenta. x-displayName: Cofre MCP - name: Speech description: >- Pontos de extremidade da API de fala para processamento de áudio. Converta texto em fala com som natural (TTS) ou transcreva fala em texto (STT) em diferentes idiomas. x-displayName: Discurso - name: Usage description: >- API de rastreamento de uso e análise para monitoramento do consumo de tokens, contagem de solicitações e análise de custos. Veja estatísticas detalhadas por usuário, modelo e período de tempo. x-displayName: Uso - name: Extract description: >- API de extração de dados estruturados para extrair informações de arquivos. Defina esquemas JSON para extrair dados estruturados de imagens, PDFs e documentos. Suporta modelos de esquema reutilizáveis. x-displayName: Extração - name: Text Classification description: >- API de classificação de texto para categorizar textos em rótulos predefinidos. Use modelos de IA para classificar o conteúdo textual para análise de sentimento, categorização de tópicos e moderação de conteúdo. x-displayName: Classificação de Texto - name: Responses description: >- API de respostas com agentes para criar agentes de IA com uso autônomo de ferramentas. Crie assistentes conversacionais que podem usar pesquisa na web, operações de arquivos, geração de imagens, execução de código, simulação de uso de computador e integrações MCP. Suporta processamento em segundo plano, streaming e monitoramento de status em tempo real. x-displayName: Respostas - name: Files description: >- API de gerenciamento de arquivos para upload, armazenamento e gerenciamento de arquivos com expiração automática e integração com S3. Faça upload de arquivos que podem ser usados com Assistentes, Armazenamentos Vetoriais e outras funcionalidades. Os arquivos são armazenados no S3 com metadados rastreados no PostgreSQL. Suporta limpeza automática de arquivos expirados. x-displayName: Arquivos - name: Vector Stores description: >- API de armazenamento de vetores para armazenar e pesquisar documentos usando embeddings. Crie armazenamentos de vetores, faça upload de arquivos com divisão automática e geração de embeddings, e realize pesquisas semânticas. Os arquivos são processados de forma assíncrona usando fluxos de trabalho Temporais para durabilidade. Suporta limpeza automática de armazenamentos expirados e LanceDB para armazenamento eficiente de vetores. x-displayName: Armazenamentos de Vetores - name: Conversations description: >- API de gerenciamento de conversas para armazenar e recuperar o estado da conversa durante chamadas à API de Resposta. Crie conversas, adicione itens (mensagens do usuário, mensagens do assistente, mensagens do sistema) e mantenha o histórico da conversa. Suporta rastreamento de metadados e gerenciamento de estado de diálogo em múltiplas interações. x-displayName: Conversa - name: Guardrails description: >- API de diretrizes de segurança de IA para configurar moderação de conteúdo e políticas de segurança. Configure listas de palavras proibidas, detecção de injeção de prompts e prevenção de vazamento de prompts do sistema. As diretrizes aplicam-se a todas as solicitações de uma conta e podem ser testadas antes da implementação. x-displayName: Guarda-corpos - name: Models description: >- API de listagem de modelos para descobrir modelos disponíveis. Retorna IDs de modelos, propriedade e metadados de todos os modelos registrados no gateway. x-displayName: Modelos - name: Skills description: >- API de habilidades para gerenciar pacotes versionados de instruções e arquivos seguindo o padrão de Habilidades do Agente. Crie, versionar e baixe pacotes de habilidades reutilizáveis que incluam manifestos SKILL.md para ambientes de agentes. x-displayName: Habilidades - name: Chat Completions description: >- **Obsoleto: Use a API de Respostas (`/api/v1/llm/responses`) em vez disso.** Endpoints de conclusão de chat com suporte para streaming, chamadas de ferramentas e múltiplos provedores. x-deprecated: true x-displayName: Conclusões de Bate-Papo - name: Batches x-displayName: Lotes - name: Evals x-displayName: Avaliações - name: Fine-Tuning x-displayName: Ajuste Fino - name: Memory Stores x-displayName: Armazenamentos de Memória - name: Prompts x-displayName: Sugestões - name: Tables description: Gerenciar esquemas de tabelas, operações de dados, pesquisa e índices. x-displayName: Tabelas - name: Text Store description: >- Gerencie armazenamentos de texto com busca híbrida (vetorial + texto completo) e conjuntos de texto agrupados. x-displayName: Loja de Texto - name: GraphRAG description: >- Construa e consulte gráficos de conhecimento leves respaldados por Redis e LanceDB. x-displayName: GraphRAG - name: API Key x-displayName: Chave da API - name: Sessions description: Crie, inspecione, acesse e encerre sessões de sandbox. x-displayName: Sessões - name: Browser description: >- Conecte-se às sessões do navegador através do proxy da porta do gateway. As sessões do navegador expõem um endpoint do Chrome DevTools Protocol na porta 9222. x-displayName: Navegador - name: Execution description: >- Executar comandos shell e código dentro de uma sessão de sandbox existente. x-displayName: Execução - name: Workspace description: >- Inspecione o manifesto do espaço de trabalho, transfira arquivos ou arquivos compactados e baixe artefatos gerados. x-displayName: Espaço de trabalho - name: Sandbox Usage x-displayName: Uso do Sandbox - name: Agents description: Crie e gerencie definições de agentes reutilizáveis. x-displayName: Agentes - name: Agent Versions description: >- Inspecione o histórico de configuração de um agente e reverta para uma versão anterior. x-displayName: Versões do Agente - name: Agent Runs description: Execute agentes salvos e inspecione os resultados da execução persistidos. x-displayName: Executa Agente - name: Agent Schedules description: Crie e gerencie execuções de agentes salvos agendadas ou recorrentes. x-displayName: Agendas de Agentes - name: schema-5_other x-displayName: outro paths: /api/v1/llm/usage/files: get: tags: - Usage summary: Obter uso de arquivos description: >- Recupere bytes de arquivos criados por período a partir de eventos de criação de arquivos duráveis. Isso não reflete o armazenamento retido atual, os buckets continuam contados após a exclusão de arquivos, e os resultados agrupados são colapsados pelas dimensões de saída solicitadas em vez de uma linha por UserContext. operationId: getFilesUsage parameters: - name: start_time in: query required: true schema: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: Hora de início (segundos Unix), inclusiva examples: - 1704067200 allowEmptyValue: true example: 1704067200 - name: end_time in: query required: false schema: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: Hora de término (segundos Unix), exclusivo examples: - 1704153600 allowEmptyValue: true example: 1704153600 - name: bucket_width in: query required: false schema: $ref: '#/components/schemas/BucketWidth' description: Largura de cada intervalo de tempo (1m, 1h, 1d) examples: - 1d allowEmptyValue: true example: 1d - name: limit in: query required: false schema: type: integer minimum: 1 maximum: 1440 description: Número de buckets a retornar examples: - 30 allowEmptyValue: true example: 30 - name: page in: query required: false schema: type: string description: Cursor de paginação examples: - cursor_abc123 allowEmptyValue: true example: cursor_abc123 - name: user_ids in: query required: false schema: anyOf: - type: array items: type: string - type: string description: >- Filtrar por IDs de usuários da plataforma (o mesmo grupo de dimensão group_by=user_id relatórios) examples: - - user_123 - user_456 allowEmptyValue: true example: - user_123 - user_456 - name: external_user_ids in: query required: false schema: anyOf: - type: array items: type: string - type: string description: >- Filtrar por IDs de usuários finais delegados (externalUserId, ou seja, subs X-On-Behalf-Of) examples: - - sub_123 allowEmptyValue: true example: - sub_123 - name: all_orgs in: query required: false schema: type: string description: >- Uso agregado em todas as organizações (apenas administradores de cluster) allowEmptyValue: true - name: org_ids in: query required: false schema: anyOf: - type: array items: type: string - type: string description: >- Filtrar por IDs de organização (apenas administradores de cluster, implica escopo de cluster) examples: - - org_123 allowEmptyValue: true - name: group_by in: query required: false schema: anyOf: - type: array items: $ref: '#/components/schemas/FilesGroupBy' - $ref: '#/components/schemas/FilesGroupBy' description: Agrupar por campos especificados allowEmptyValue: true example: - user_id - name: X-On-Behalf-Of in: header required: false schema: type: string description: Optional external end-user identifier forwarded by the API gateway. responses: '200': description: OK content: application/json: schema: type: object properties: object: const: page data: type: array items: type: object properties: object: const: bucket start_time: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: Unix timestamp of bucket start (inclusive) end_time: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: Unix timestamp of bucket end (exclusive) results: type: array items: anyOf: - {} - type: 'null' description: Array of usage results for this time bucket required: - object - start_time - end_time - results has_more: type: boolean description: Whether there are more pages next_page: anyOf: - type: string - type: 'null' description: Cursor for next page, null if no more pages required: - object - data - has_more - next_page example: object: page data: - object: bucket start_time: 1704067200 end_time: 1704153600 results: - object: organization.usage.files.result usage_bytes: 2048000 num_files: 4 user_id: user_123 api_key_id: null org_id: null has_more: false next_page: null security: - bearerAuth: [] x-codeSamples: - lang: python label: Python (SDK) source: |- from meetkai_mka1 import SDK with SDK( bearer_auth="", ) as sdk: res = sdk.llm.usage.files(start_time=1704067200, end_time=1704153600, bucket_width="1d", limit=30, page="cursor_abc123", user_ids=[ "user_123", "user_456", ], external_user_ids=[ "sub_123", ], org_ids=[ "org_123", ], group_by=[ "user_id", ]) # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SDK } from "@meetkai/mka1"; const sdk = new SDK({ bearerAuth: "", }); async function run() { const result = await sdk.llm.usage.files({ startTime: 1704067200, endTime: 1704153600, limit: 30, page: "cursor_abc123", userIds: [ "user_123", "user_456", ], externalUserIds: [ "sub_123", ], orgIds: [ "org_123", ], groupBy: [ "user_id", ], }); console.log(result); } run(); - lang: csharp label: CSharp (SDK) source: |- using MeetKai.MKA1; using MeetKai.MKA1.Types.Components; using MeetKai.MKA1.Types.Requests; using System.Collections.Generic; var sdk = new SDK(bearerAuth: ""); GetFilesUsageRequest req = new GetFilesUsageRequest() { StartTime = 1704067200, EndTime = 1704153600, Limit = 30, Page = "cursor_abc123", UserIds = GetFilesUsageUserIds.CreateArrayOfStr( new List() { "user_123", "user_456", } ), ExternalUserIds = GetFilesUsageExternalUserIds.CreateArrayOfStr( new List() { "sub_123", } ), OrgIds = GetFilesUsageOrgIds.CreateArrayOfStr( new List() { "org_123", } ), GroupBy = GetFilesUsageGroupBy.CreateArrayOfFilesGroupBy( new List() { FilesGroupBy.UserId, } ), }; var res = await sdk.Llm.Usage.FilesAsync(req); // handle response components: schemas: BucketWidth: enum: - 1m - 1h - 1d default: 1d FilesGroupBy: enum: - user_id - api_key_id - org_id securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: API Key description: >- Gateway auth: send `Authorization: Bearer `. For multi-user server-side integrations, you can also send `X-On-Behalf-Of: `. ````