API v1 Reference › AgentThreads

Returns thread metadata for usage analytics.

GEThttps://api.awork.com/api/v1/agents/management/threads
GET https://api.awork.com/api/v1/agents/management/threads

Returns thread metadata or period usage rows, including the thread Id, name, credits, and timestamps.

Authentication

AuthorizationBearer

Send your token in the Authorization: Bearer <token> header. See Authentication for API keys and OAuth.

Query parameters

usageFromstringOptional
format: date-time

The first included UTC calendar day for period usage rows.

usageTostringOptional
format: date-time

The last included UTC calendar day for period usage rows.

usageGroupBystringOptional
Default: "none"

The report grouping when a usage period is provided.

usagePageSizeintegerOptional
format: int32

Optional bounded bulk page size for period usage rows.

Responses

200 OK

application/json

idstringOptional
format: 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.

createdBystringOptional
format: uuid

The human creator identifier.

agentIdstring or nullOptional
format: 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 nullOptional
format: uuid

The project context identifier.

taskIdstring or nullOptional
format: uuid

The task context identifier.

clientIdstring or nullOptional
format: uuid

The client context identifier.

statusstring or nullOptional

The current thread status.

creditsUsedintegerOptional
format: int64

Whole credits attributed to this thread. Period report rows use the overview's quota factors; unscoped metadata uses the stable display factor.

usageUserIdstring or nullOptional
format: uuid

The responsible user when the report is grouped by user.

usageGroupKeystring or nullOptional

The selected reporting group for this row.

usageOnstring or nullOptional
format: 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 nullOptional
format: date-time

When the thread was created.

lastActivityOnstring or nullOptional
format: date-time

When the thread last had user-visible activity.

updatedOnstring or nullOptional
format: date-time

When the thread was last updated.

400 Bad Request

application/json

codestringRequired
minLength: 1

The error code.

descriptionstringRequired
minLength: 1

The description of the error.

linkstringRequired
minLength: 1

The link to the API documentation page.

detailsarray of string or nullOptional

A list of details describing the error.

validationErrorsarray of object or nullOptional

If a validation error occurred, this contains the validation errors for each property.

Show 2 properties
propertystring or nullOptional

The name of the property that failed validation.

messagestring or nullOptional

The reason why this property failed validation.

traceIdstring or nullOptional

The request trace id for tracking the request.

Search documentation