Skip to content
LogoLogo

Read settled and pending credit usage for one custom Agent and period

Read settled and pending credit usage for one custom Agent and period

GET/api/v1/workspaces/{workspace_id}/agents/studio/definitions/{definition_id}/usage

Path Parameters

workspace_idRequired
string <uuid>
Example0198ac5e-f9b7-7000-8000-000000000001
definition_idRequired
string <uuid>
Example0198ac5e-f9b7-7000-8000-000000000001

Query Parameters

from
string <date-time>

Inclusive period start; defaults to one month before the request.

Example2026-08-15T12:00:00Z
to
string <date-time>

Exclusive period end; defaults to request time.

Example2026-08-15T12:00:00Z

Header Parameters

X-Assign-Realtime-Baseline
string

Upcoming browser-session canonical read. Set to '1' to capture the authorized response and a signed Workspace replay cursor in one snapshot. Apply every required retained read before acknowledging a socket checkpoint. Failed or incomplete reads return no cursor.

Values
1

Responses