VolundOS
Referência da APIParceiro

Consumo de um cliente

O consumo da organização cliente no período, só agregado: custo em dólares, tokens, requisições, conversas, contagem de pessoas ativas (sem a identidade de sistema e sem visitantes do chat embutido), a quebra por cópia gerenciada (pelo agente de origem), o resto somado sem nome, por modelo e por aplicação. Nenhuma pessoa, conversa, título ou trecho. Exige o escopo partner:read.

Atualizado em 04 de novembro de 2026
GET
/v1/partner/clients/{slug}/consumption

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

slug*string

Slug (ou id) da organização cliente.

Query Parameters

periodo?string

Janela: 24h, 7d, 30d (padrão), 90d, um mês (AAAA-MM) ou um intervalo de dias (AAAA-MM-DD..AAAA-MM-DD, até 366 dias). Fuso America/Sao_Paulo. O mesmo formato de GET /v1/governance/consumption.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/partner/clients/string/consumption"
{  "client": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "slug": "string",    "name": "string",    "external_id": "string"  },  "period": {    "periodo": "string",    "since": "2019-08-24T14:15:22Z",    "until": "2019-08-24T14:15:22Z"  },  "totals": {},  "by_agent": [    {}  ],  "other_agents": {},  "by_model": [    {}  ],  "by_application": [    {}  ]}

Criar um cliente

Cria a organização cliente com a marca do parceiro, põe o dono já dentro (sem aceite: conta existente entra direto e recebe aviso por e-mail; conta nova nasce confirmada e recebe o link de primeiro acesso) e instala as cópias dos agentes pedidos. `agents` aceita id ou apelido de agente do parceiro publicado para os clientes. Com `external_id`, repetir a chamada devolve 200 com o cliente que já existe, em vez de criar outro. Exige o escopo partner:write.

Pessoas de um cliente

Os membros ativos da organização cliente, só com o necessário para o parceiro administrar quem ele pôs: id, nome, e-mail, cargo, perfil, data de entrada e por onde entrou (`join_source`: `partner` para quem o parceiro pôs). Sem consumo e sem conversas. A identidade de sistema fica de fora. Exige o escopo partner:read.