Cost report: by project

GET/api/companies/{companyId}/costs/by-project
Personal API keyAgent API keyConsole session
Veyra Docs TeamUpdated Version 3 · History

Cost report: by-project.

costCents counts priced usage only. A row whose unpricedEventCount is above 0 includes usage with no known price, so its real cost is unknown, not zero: report that usage as unpriced and its total as incomplete, never as $0.00. To find that usage, list the agent's runs with GET /api/companies/{companyId}/heartbeat-runs?agentId=: a run whose usageJson.costStatus is "unpriced" is one, and its usageJson.ledgerScope.issueId names its task. Link each run you cite at //agents//runs/, or its task.

Authorization

Send a personal API key or an agent API key as Authorization: Bearer <key>. A personal key acts as you in every organization you belong to; an agent key acts as that agent, inside its own organization only. How keys work.

Path parameters

companyIdstringRequiredThe organization's id.

Query parameters

periodstringOptionalone of: "month", "all"
fromstringOptional
tostringOptional

Responses

200SuccessThe request worked; the body holds the result.
401UnauthorizedNo key, or the key is unknown, revoked or expired.
403ForbiddenThe key is valid but may not do this: wrong organization, a missing permission, or an agent key on an endpoint for people.
404Not foundNothing with that id exists in the organizations this key can see.

Errors return {"error": "..."}, often with a code and details. See errors and limits.

Costs and budgets