VolundOS
Referência da APIChat embutido

Consumo por pessoa da aplicação

O consumo de cada pessoa de uma aplicação: as do chat embutido e as indicadas com `user` nos runs da API, que são as mesmas pessoas. Cada linha traz o id que a aplicação mandou (`user`), o nome, as conversas, os turnos, os tokens, o custo em dólares, o último uso e a quebra por agente. `total` soma todas as pessoas do recorte, antes da página. A aplicação tem de ser da organização da chave; de outra organização, ou inexistente, a resposta é 404 `app_not_found`. Quem emitiu a chave precisa da leitura de consumo da Governança ou de administrar as aplicações (senão, 403 `forbidden`). Dado de todos os agentes, então a chave restrita a agentes é recusada (`agent_not_allowed`). Exige o escopo app_users:read.

Atualizado em 04 de novembro de 2026
GET
/v1/apps/{appId}/usage

Authorization

chaveDeApi
AuthorizationBearer <token>

Chave de API da organização, criada nas configurações. Envie-a em Authorization: Bearer <sua chave>.

In: header

Path Parameters

appId*string

Id da aplicação (Configurações > Aplicações).

Formatuuid

Query Parameters

periodo?string

O mesmo de GET /v1/governance/consumption: 24h, 7d, 30d (padrão), 90d, um mês (2026-10) ou um intervalo (2026-09-15..2026-10-10), no fuso da organização.

user?string

Só esta pessoa (o id que a aplicação manda em user).

Lengthlength <= 200
limit?integer

Pessoas por página, de 1 a 500.

Range1 <= value <= 500
Default100
offset?integer

Quantas pessoas pular.

Range0 <= value
Default0

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/apps/497f6eca-6276-4993-bfeb-53cbbbba6f08/usage"
{  "app": {    "id": "string",    "name": "string"  },  "period": {    "periodo": "string",    "since": "2019-08-24T14:15:22Z",    "until": "2019-08-24T14:15:22Z"  },  "users": [    {      "user": "string",      "name": "string",      "conversations": 0,      "turns": 0,      "tokens": {        "input": 0,        "output": 0      },      "cost_usd": 0,      "last_used_at": "2019-08-24T14:15:22Z",      "agents": [        {          "agent_id": "string",          "name": "string",          "conversations": 0,          "turns": 0,          "tokens": {            "input": 0,            "output": 0          },          "cost_usd": 0        }      ]    }  ],  "total": {    "users": 0,    "conversations": 0,    "turns": 0,    "tokens": {      "input": 0,      "output": 0    },    "cost_usd": 0  },  "limit": 0,  "offset": 0}