> ## Documentation Index
> Fetch the complete documentation index at: https://docs.niadra.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Cache de prompt dos agentes

> Tokens, acerto do cache do provedor e economia estimada, por agente, fornecedor ou modelo.



## OpenAPI

````yaml openapi/pt/cell.json GET /v1/usage/prompt-cache
openapi: 3.1.0
info:
  title: API de dados da Niadra
  version: '1'
  description: >-
    Escrita, contexto, histórico, objetos, identidade, privacidade e governança
    de um espaço. Cada espaço tem um endereço estável, com o espaço e a região
    no nome.
servers:
  - url: https://{space}.{region}.api.niadra.com
    variables:
      space:
        default: acme-prod
        description: O espaço, que vem na chave de fonte.
      region:
        default: us-east-2
        description: A região do espaço, que também vem na chave.
security: []
paths:
  /v1/usage/prompt-cache:
    get:
      tags:
        - usage
      summary: Cache de prompt dos agentes
      description: >-
        O cache de prompt dos agentes: tokens, acertos do cache e a economia
        estimada, pelo uso que o SDK leu de cada chamada ao modelo (15.3).


        **Autenticação.** Token de pessoa do Console com o papel `analysis`,
        `vendor` (ou admin), ou chave de fonte com o escopo `admin`.
      operationId: prompt_cache_v1_usage_prompt_cache_get
      parameters:
        - in: query
          name: since
          required: false
          schema:
            anyOf:
              - format: date
                type: string
              - type: 'null'
            title: Since
        - in: query
          name: until
          required: false
          schema:
            anyOf:
              - format: date
                type: string
              - type: 'null'
            title: Until
        - in: query
          name: group_by
          required: false
          schema:
            anyOf:
              - items:
                  type: string
                type: array
              - type: 'null'
            title: Group By
        - in: query
          name: source_id
          required: false
          schema:
            anyOf:
              - format: uuid
                type: string
              - type: 'null'
            title: Source Id
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PromptCacheReport'
          description: Resposta de sucesso.
        '422':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
          description: O pedido não bate com o contrato.
      security:
        - sourceKey: []
        - personToken: []
components:
  schemas:
    PromptCacheReport:
      additionalProperties: false
      description: >-
        `GET /v1/usage/prompt-cache`: o cache de prompt dos agentes, pelo que os
        provedores informaram (15.3).
      properties:
        buckets:
          items:
            $ref: '#/components/schemas/PromptCacheBucket'
          title: Buckets
          type: array
        estimate:
          default: true
          description: >-
            Sempre verdadeiro: a economia é uma estimativa, nunca o que um
            provedor cobrou.
          title: Estimate
          type: boolean
        group_by:
          items:
            type: string
          title: Group By
          type: array
        prices:
          description: O preço de cada modelo que a estimativa usou.
          items:
            $ref: '#/components/schemas/ModelPriceOut'
          title: Prices
          type: array
        prices_as_of:
          description: Quando a tabela da Niadra foi tirada das listas de preços públicas.
          title: Prices As Of
          type: string
        since:
          format: date
          title: Since
          type: string
        until:
          format: date
          title: Until
          type: string
      required:
        - since
        - until
        - group_by
        - buckets
        - prices
        - prices_as_of
      title: PromptCacheReport
      type: object
    Problem:
      additionalProperties: false
      description: >-
        Detalhes do problema no formato da RFC 9457; `code` vem do catálogo de
        erros versionado.
      properties:
        code:
          title: Code
          type: string
        detail:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          title: Detail
        request_id:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          title: Request Id
        status:
          title: Status
          type: integer
        title:
          title: Title
          type: string
        type:
          default: about:blank
          title: Type
          type: string
      required:
        - title
        - status
        - code
      title: Problem
      type: object
    PromptCacheBucket:
      additionalProperties: false
      properties:
        cache_write_tokens:
          description: Tokens de entrada gravados no cache.
          title: Cache Write Tokens
          type: integer
        cached_tokens:
          description: Tokens de entrada que o provedor leu do cache de prompt.
          title: Cached Tokens
          type: integer
        calls:
          description: Turnos do agente cuja chamada ao modelo informou o uso.
          title: Calls
          type: integer
        day:
          anyOf:
            - format: date
              type: string
            - type: 'null'
          title: Day
        estimated_savings_micros:
          anyOf:
            - type: integer
            - type: 'null'
          description: >-
            Uma estimativa, em milionésimos de dólar: tokens do cache pelo preço
            de entrada menos o preço de cache, descontado o adicional de
            gravação, pelo preço do modelo de cada chamada. Nulo quando nenhuma
            chamada do grupo tem preço.
          title: Estimated Savings Micros
        hit_rate:
          anyOf:
            - type: number
            - type: 'null'
          description: '`cached_tokens` sobre `prompt_tokens`; nulo sem tokens.'
          title: Hit Rate
        model:
          anyOf:
            - type: string
            - type: 'null'
          title: Model
        prompt_tokens:
          description: Todos os tokens de entrada dessas chamadas, os do cache inclusive.
          title: Prompt Tokens
          type: integer
        provider:
          anyOf:
            - type: string
            - type: 'null'
          title: Provider
        source_id:
          anyOf:
            - format: uuid
              type: string
            - type: 'null'
          title: Source Id
        unpriced_calls:
          default: 0
          description: >-
            Chamadas de modelos sem preço em nenhuma das tabelas: ficam fora da
            estimativa.
          title: Unpriced Calls
          type: integer
        vendor:
          anyOf:
            - type: string
            - type: 'null'
          description: Vem da configuração da fonte; `""` quando não tem.
          title: Vendor
      required:
        - calls
        - prompt_tokens
        - cached_tokens
        - cache_write_tokens
      title: PromptCacheBucket
      type: object
    ModelPriceOut:
      additionalProperties: false
      properties:
        cache_write:
          title: Cache Write
          type: number
        cached_input:
          title: Cached Input
          type: number
        input:
          description: Dólares por milhão de tokens de entrada.
          title: Input
          type: number
        model:
          title: Model
          type: string
        provider:
          title: Provider
          type: string
        table:
          description: >-
            `product`: a tabela de preços públicos da Niadra; `space`: as
            configurações do espaço.
          enum:
            - product
            - space
          title: Table
          type: string
      required:
        - provider
        - model
        - input
        - cached_input
        - cache_write
        - table
      title: ModelPriceOut
      type: object
  securitySchemes:
    sourceKey:
      type: http
      scheme: bearer
      description: nia_sk_...
    personToken:
      type: http
      scheme: bearer
      bearerFormat: JWT

````