> ## 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 custo por modelo

> Agrega os gastos por modelo ao longo de um intervalo de tempo, precificados na moeda do cluster a partir do livro de preços do modelo. Escopo da organização: administradores da organização veem sua organização; administradores do cluster podem informar `org_id`. Inclui trabalho faturável sem uma linha de uso própria (respostas com store=false, chamadas de ferramentas de agente), para que os totais se reconciliem com o medidor de orçamento ao vivo.



## OpenAPI

````yaml https://apigw.mka1.com/speakeasy.json?language=pt-BR get /api/v1/llm/usage/costs
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: Budgets
    x-displayName: Orçamentos
  - 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/costs:
    get:
      tags:
        - Usage
      summary: Obter custo por modelo
      description: >-
        Agrega os gastos por modelo ao longo de um intervalo de tempo,
        precificados na moeda do cluster a partir do livro de preços do modelo.
        Escopo da organização: administradores da organização veem sua
        organização; administradores do cluster podem informar `org_id`. Inclui
        trabalho faturável sem uma linha de uso própria (respostas com
        store=false, chamadas de ferramentas de agente), para que os totais se
        reconciliem com o medidor de orçamento ao vivo.
      operationId: getCostsUsage
      parameters:
        - name: start_time
          in: query
          required: true
          schema:
            type: integer
            minimum: 0
            maximum: 9007199254740991
            description: Timestamp Unix, inclusivo
          allowEmptyValue: true
        - name: end_time
          in: query
          required: true
          schema:
            type: integer
            minimum: 0
            maximum: 9007199254740991
            description: Timestamp Unix, exclusivo
          allowEmptyValue: true
        - name: org_id
          in: query
          required: false
          schema:
            type: string
            description: >-
              Apenas para administradores de cluster: organização cujos custos
              devem ser relatados (padrão é a organização do chamador)
          allowEmptyValue: true
        - name: group_by
          in: query
          required: false
          schema:
            anyOf:
              - type: array
                items:
                  $ref: '#/components/schemas/CostsUsageGroupBy'
              - $ref: '#/components/schemas/CostsUsageGroupBy'
            description: >-
              Custo do grupo por modelo / api_key_id (chave do inquilino) /
              team_id (sub-inquilino dentro de uma organização) /
              external_user_id (usuário final fornecido pelo chamador,
              X-On-Behalf-Of, para chargeback de revenda) / org_id
          allowEmptyValue: true
        - 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:
                $ref: '#/components/schemas/UsageCostsResponse'
      security:
        - bearerAuth: []
      x-codeSamples:
        - lang: python
          label: Python (SDK)
          source: |-
            from meetkai_mka1 import SDK


            with SDK(
                bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
            ) as sdk:

                res = sdk.llm.usage.costs(start_time=612474, end_time=211313)

                # Handle response
                print(res)
        - lang: typescript
          label: Typescript (SDK)
          source: |-
            import { SDK } from "@meetkai/mka1";

            const sdk = new SDK({
              bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
            });

            async function run() {
              const result = await sdk.llm.usage.costs({
                startTime: 612474,
                endTime: 211313,
              });

              console.log(result);
            }

            run();
        - lang: csharp
          label: CSharp (SDK)
          source: |-
            using MeetKai.MKA1;
            using MeetKai.MKA1.Types.Components;
            using MeetKai.MKA1.Types.Requests;

            var sdk = new SDK(bearerAuth: "<YOUR_BEARER_TOKEN_HERE>");

            GetCostsUsageRequest req = new GetCostsUsageRequest() {
                StartTime = 612474,
                EndTime = 211313,
            };

            var res = await sdk.Llm.Usage.CostsAsync(req);

            // handle response
components:
  schemas:
    CostsUsageGroupBy:
      enum:
        - model
        - api_key_id
        - team_id
        - external_user_id
        - org_id
    UsageCostsResponse:
      type: object
      properties:
        object:
          const: usage.costs
        currency:
          anyOf:
            - type: string
            - type: 'null'
        start_time:
          type: integer
          minimum: -9007199254740991
          maximum: 9007199254740991
        end_time:
          type: integer
          minimum: -9007199254740991
          maximum: 9007199254740991
        group_by:
          type: array
          items:
            $ref: '#/components/schemas/CostsUsageGroupBy'
        data:
          type: array
          items:
            $ref: '#/components/schemas/CostGroupRow'
        total_cost:
          type: number
        total_cost_nano:
          type: string
          description: >-
            Custo total em unidades NANO inteiras (1e9 por unidade principal,
            NÃO centavos); use `total_cost` para o valor principal.
      required:
        - object
        - currency
        - start_time
        - end_time
        - group_by
        - data
        - total_cost
        - total_cost_nano
    CostGroupRow:
      type: object
      properties:
        model:
          anyOf:
            - type: string
            - type: 'null'
        api_key_id:
          anyOf:
            - type: string
            - type: 'null'
        team_id:
          anyOf:
            - type: string
            - type: 'null'
        external_user_id:
          anyOf:
            - type: string
            - type: 'null'
        org_id:
          anyOf:
            - type: string
            - type: 'null'
        cost:
          type: number
          description: Custo em unidades monetárias principais (por exemplo, dólares)
        cost_nano:
          type: string
          description: >-
            Custo em unidades NANO-inteiras — 1e9 por unidade monetária
            principal (NÃO centavos). Divida por 1e9 para o valor principal; use
            `custo` para o valor principal já pronto.
      required:
        - model
        - api_key_id
        - team_id
        - external_user_id
        - org_id
        - cost
        - cost_nano
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key
      description: >-
        Gateway auth: send `Authorization: Bearer <mka1-api-key>`. For
        multi-user server-side integrations, you can also send `X-On-Behalf-Of:
        <external-user-id>`.

````