Skip to main content
GET
Get Agent Thread

Permissions

Requires Agents and workflows API and Use agents and workflows permissions. If these permissions are not available to select, contact support@harvey.ai.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

thread_id
integer
required

The unique identifier of the agent thread.

Response

The thread, with its answer once it has finished

A thread and the agent run it holds.

id
integer

The unique identifier of the agent thread.

status
enum<string>

Lifecycle state of a thread. COMPLETED, ERRORED and CANCELLED are terminal.

Available options:
PENDING,
IN_PROGRESS,
COMPLETED,
ERRORED,
CANCELLED
agent_id
string<uuid> | null

The agent this thread ran. Null until the agent begins executing.

client_matter_id
string<uuid> | null

The client matter this thread is attributed to, as a UUID, even if you supplied a name. Null when none was supplied.

harvey_url
string<uri>

Link to the thread in the Harvey web app, for handing the work to a person.

created_at
string<date-time>

When the thread was created.

output
object | null

What the agent produced. Null until status is terminal, and on a thread that produced no answer.

error
string | null

Why the thread did not complete. Null unless status is ERRORED or CANCELLED.

files
object[]

The documents you attached, each with the processing status recorded for it. Generated files live under output.files instead.