AWawork-io
agentThreads

Gets an agent thread.

Changed on

Returns details of the specified agent conversation. Use the thread id returned when creating a conversation. Retrieve its messages separately with GET /agents/threads/{threadId}/messages. Returns not found if the thread is missing or is not visible to the user.

<Check title="Required Permissions" icon="key">Any authenticated user.</Check>

get/agents/threads/{threadId}

Request

  • Base URL
    https://api.awork.com/api/v1
  • URL
    https://api.awork.com/api/v1/agents/threads/{threadId}
  • Auth
    HTTP bearer

Path parameters

threadIdstring uuid required

The id of the thread to retrieve.

Response

OK

idstring uuid

The id of the entity.

createdOnstring date-time

The date this entity was created.

createdBystring uuid

The id of the user who created this entity.

updatedBystring uuid

The id of the user who last modified this entity.

updatedOnstring date-time

The parent timestamp used to order thread queue snapshots, with subsecond precision.

typestring nullable

The thread type.

titlestring nullable

The thread title.

statusstring nullable

The thread status.

isReadOnlyboolean

Whether the requester may only read this thread.

isSharedboolean

Whether this directly shareable thread currently has active shares.

agentIdstring uuid nullable

The agent used for the initial execution.

agentNameSnapshotstring nullable

The immutable initial agent name.

executionOwnerUserIdstring uuid nullable

The user whose permissions applied to the initial execution.

executionTriggeredByUserIdstring uuid nullable

The user who triggered the initial execution.

executionTypestring nullable

The initial execution type.

executionSourceIdstring uuid nullable

The entity that caused the initial execution.

modelProviderstring nullable

The model provider.

modelNamestring nullable

The provider model name.

parentThreadIdstring uuid nullable

The parent thread id.

projectIdstring uuid nullable

The associated project id.

taskIdstring uuid nullable

The associated task id.

clientIdstring uuid nullable

The associated client id.

documentIdstring uuid nullable

The associated document id.

startedOnstring date-time nullable

When execution started.

completedOnstring date-time nullable

When execution completed.

lastActivityOnstring date-time nullable

The latest activity timestamp.

lastActivityBystring uuid nullable

The user responsible for the latest user-message activity.

failureReasonstring nullable

The failure reason.

lastSequenceinteger

The latest persisted event sequence.

latestThreadUpdateSequenceinteger

The latest event sequence that creates a thread update.

hasUpdateboolean

Whether the requester has an unseen update.

isArchivedboolean

Whether the requester archived the thread.

archivedOnstring date-time nullable

When the requester archived the thread.

isPinnedboolean

Whether the requester pinned the thread.

pinnedOrdernumber double nullable

The requester's pinned order.

listStateUpdatedOnstring date-time nullable

When the requester's archive or pin state last changed.

isAwaitingActionboolean

Whether the thread awaits user action.

contextWindowUsageRationumber double nullable

The context-window usage ratio on detail responses.

ratingstring nullable

The personal-thread rating on detail responses.

Changes

  • 81151fac7e79Revision changes
    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

  • ab257be657b1Revision changes
    • info

      added the optional property to the response with the status