For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Returns thread metadata or period usage rows, including the thread Id, name, credits, and timestamps.
Required Permissions
The user must be an admin.
Authentication
AuthorizationBearer
Bearer authentication of the form Bearer <token>, where token is your auth token.
Query parameters
usageFromstringOptionalformat: "date-time"
The first included UTC calendar day for period usage rows.
usageTostringOptionalformat: "date-time"
The last included UTC calendar day for period usage rows.
usageGroupBystringOptionalDefaults to none
The report grouping when a usage period is provided.
usagePageSizeintegerOptional
Optional bounded bulk page size for period usage rows.
Response
OK
idstringOptionalformat: "uuid"
The thread identifier.
isDeletedbooleanOptional
Whether the thread was deleted and can no longer be opened.
typestring or nullOptional
The thread type.
titlestring or nullOptional
The contextual thread title. A private thread title is available only to its creator.
Contributors do not widen this: they exist only on project- or task-backed threads, whose titles are never masked.
createdBystringOptionalformat: "uuid"
The human creator identifier.
agentIdstring or nullOptionalformat: "uuid"
The associated Agent identifier.
agentNameSnapshotstring or nullOptional
The Agent display name captured for the initial run.
executionTypestring or nullOptional
The initial execution trigger type: direct, task-assignment, project-assignment, mention, schedule, automation, queue, delegation, or workflow.
projectIdstring or nullOptionalformat: "uuid"
The project context identifier.
taskIdstring or nullOptionalformat: "uuid"
The task context identifier.
clientIdstring or nullOptionalformat: "uuid"
The client context identifier.
statusstring or nullOptional
The current thread status.
creditsUsedlongOptional
Whole credits attributed to this thread. Period report rows use the overview’s quota factors;
unscoped metadata uses the stable display factor.
usageUserIdstring or nullOptionalformat: "uuid"
The responsible user when the report is grouped by user.
usageGroupKeystring or nullOptional
The selected reporting group for this row.
usageOnstring or nullOptionalformat: "date-time"
The latest usage timestamp in the selected period.
providerstring or nullOptional
The provider of the highest-cost model pair in this row’s scope, or null without usage.
modelstring or nullOptional
The highest-cost model in this row’s scope, or null without usage.
createdOnstring or nullOptionalformat: "date-time"
When the thread was created.
lastActivityOnstring or nullOptionalformat: "date-time"
When the thread last had user-visible activity.
updatedOnstring or nullOptionalformat: "date-time"
