An agent's run health over a time range

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

An agent's run health over a time range.

Runs started in the range, bucketed by start time: run count, succeeded and failed (failed or timed out) runs, tokens and priced cost from the runs' cost events, median run duration and 95th percentile queue wait. totals adds runs per hour, success rate of finished runs, tokens per run and cost per hour.

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

agentIdstring (uuid)Required
rangestringOptionalone of: "1h", "6h", "1d", "7d", "30d"

Responses

200SuccessThe request worked; the body holds the result.
400Bad requestThe request is malformed or failed validation. details names each field that failed.
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