> ## Documentation Index > Fetch the complete documentation index at: https://docs.weve.cx/llms.txt > Use this file to discover all available pages before exploring further. # Uso de IA do club > O orçamento do mês e o gasto por finalidade e por agente. ## OpenAPI ````yaml GET /v1/clubs/{clubId}/ai-usage openapi: 3.0.3 info: title: weve API description: > Contrato entre a API Go e o dashboard. **Este arquivo é a fonte de verdade**: os tipos e a interface de servidor em Go, e o client TypeScript, são todos gerados daqui (`make openapi`). Handler que divergir da interface não compila. A superfície interna (`/internal/*`) fica de fora de propósito: é acesso de máquina, protegido por segredo dedicado, e não é contrato de cliente. version: 0.2.0 servers: - url: https://api.weve.cx description: produção - url: http://localhost:8080 description: desenvolvimento security: [] tags: - name: health - name: session - name: account - name: clubs - name: members - name: webhooks - name: outgoing-webhooks - name: sales-platforms - name: catalog - name: content - name: classroom - name: community - name: mentorships - name: agents - name: lives - name: students - name: auth - name: campaigns - name: workflows - name: email paths: /v1/clubs/{clubId}/ai-usage: parameters: - $ref: '#/components/parameters/OrgId' get: tags: - agents summary: O uso de IA do club description: | O orçamento do mês corrente (fuso de São Paulo) e o gasto de um período, por finalidade e por agente. Os valores são em MICRODÓLARES — inteiros, para somar sem erro de arredondamento: 1.000.000 é um dólar. Sem `from`, o período começa no primeiro dia do mês corrente; sem `to`, termina agora. operationId: getAIUsage parameters: - name: from in: query required: false schema: type: string format: date-time - name: to in: query required: false schema: type: string format: date-time responses: '200': description: O uso content: application/json: schema: $ref: '#/components/schemas/AIUsageReport' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '422': $ref: '#/components/responses/UnprocessableEntity' '500': $ref: '#/components/responses/InternalError' security: - userSession: [] components: parameters: OrgId: name: clubId in: path required: true description: > Id público da organização — o mesmo que `GET /v1/me` devolve em `organization_id`. Na URL o recurso se chama **club**; no contrato e no domínio, organization. A divergência é deliberada: `clubs` é a palavra do produto, e a URL é o que as pessoas leem. É o identificador do provedor de autenticação, e é assim de propósito: o cliente precisa nomear a organização ao pedir o token, e o token é o que prova o escopo. Um id só nosso obrigaria a traduzir um no outro antes de ter um token — e a tradução exigiria uma chamada escopada, que é justamente a que ainda não dá para fazer. O uuid interno da organização não aparece no contrato: ele é o que as chaves estrangeiras do domínio referenciam, e continua sendo nosso. schema: type: string format: uuid schemas: AIUsageReport: type: object required: - from - to - budget - by_purpose - by_agent properties: from: type: string format: date-time to: type: string format: date-time budget: type: object required: - monthly_budget_micros - spent_this_month_micros - remaining_micros description: O orçamento do MÊS CORRENTE, independente do período pedido. properties: monthly_budget_micros: type: integer format: int64 spent_this_month_micros: type: integer format: int64 remaining_micros: type: integer format: int64 by_purpose: type: array items: type: object required: - purpose - calls - cost_micros properties: purpose: $ref: '#/components/schemas/AIUsagePurpose' calls: type: integer format: int64 cost_micros: type: integer format: int64 by_agent: type: array items: type: object required: - messages - students - input_tokens - output_tokens - cost_micros properties: agent_id: type: string format: uuid description: Ausente é o uso de um agente que não existe mais. agent_name: type: string messages: type: integer format: int64 students: type: integer format: int64 input_tokens: type: integer format: int64 output_tokens: type: integer format: int64 cost_micros: type: integer format: int64 AIUsagePurpose: type: string enum: - agent_message - knowledge_extraction x-enum-varnames: - AIUsageAgentMessage - AIUsageKnowledgeExtraction ErrorEnvelope: type: object description: >- Envelope único de erro da API. O `code` é o contrato com o cliente — a `message` é diagnóstico, e pode mudar. required: - error properties: error: type: object required: - code properties: code: type: string message: type: string responses: Unauthorized: description: Sessão ausente, expirada ou revogada content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' Forbidden: description: > A sessão é válida, mas não age nesta organização. É a mesma resposta para uma organização que não existe — distinguir as duas deixaria enumerar organizações alheias. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' UnprocessableEntity: description: Campos obrigatórios ausentes ou inválidos content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' InternalError: description: >- Falha inesperada. O corpo nunca traz o erro real — ele fica no log e no rastreamento. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' securitySchemes: userSession: type: http scheme: bearer description: | Token OPACO de sessão de quem administra, emitido por `/v1/auth/admin/sign-in` e verificado contra a nossa tabela — o mesmo desenho do `studentSession`, para a outra identidade. É o esquema de quem ADMINISTRA — o dashboard. O aluno do classroom usa o `studentSession`; uma rota consumida pelos dois declara os dois esquemas, e o middleware aceita qualquer um deles. As duas credenciais são opacas e chegam pelo mesmo cabeçalho: quem as separa é a tabela em que cada uma existe. O dashboard o guarda em cookie httpOnly, que o BFF troca pelo `Authorization` a cada chamada. ```` ## Related topics - [Caixa de comentários do club](/api-reference/comments/managed-list.md) - [Limites de uso](/essentials/rate-limits.md) - [Agentes](/essentials/agents.md) - [Acesso ao classroom](/api-reference/clubs/classroom-session.md) - [Renomeia, move ou arquiva](/api-reference/media/update.md)