Consumo

[GET] Retrieve Usage

Retorna a quantidade de agentes utilizada e a quantidade de créditos disponíveis na conta

curl --location 'https://api.zaia.app/v1.1/api/retrieve-usage' \
--header 'Authorization: Bearer <your api key goes here>'

Headers (Cabeçalhos)

Chave	Tipo	Exemplo	Obrigatório
Authorization	String	Bearer <sua chave aqui>	✓

Usage

Chave	Tipo	Exemplo
agents	Limits	40
externalGenerativeMessages	Limits
generativeMessages	Limits

Limits

Chave	Tipo	Exemplo
balance	Number	32
count	Number	8
limit	Number	40

Responses

🟢 200 -> OK

{
    "usage": {
        "agents": {
            "balance": 32,
            "count": 8,
            "limit": 40
        },
        "externalGenerativeMessages": {
            "balance": 19902,
            "count": 8,
            "limit": 20000
        },
        "generativeMessages": {
            "balance": 9902,
            "count": 98,
            "limit": 10000
        }
    }
}

🔴 403 → Unauthorized

"Forbidden."

🔴 404 → Not Found

"Agent not found."