Skip to main content
PATCH
Update a thread

Authorizations

Authorization
string
header
required

Use JWT token for authentication

Path Parameters

threadId
string<uuid>
required

UUID of the thread to update

Body

application/json

Fields to update in the thread

status
enum<string>

Current status of the thread

Available options:
RUNNING,
PAUSED,
COMPLETED,
FAILED,
AWAITING_APPROVAL
metadata
object

Updated metadata for the thread

Response

Thread updated successfully

id
string<uuid>
required

Unique identifier for the thread

agentId
string<uuid>
required

Unique identifier for the associated agent

status
enum<string>
required

Current status of the thread

Available options:
RUNNING,
PAUSED,
COMPLETED,
FAILED,
AWAITING_APPROVAL
createdAt
string<date-time>
required

Timestamp when the thread was created

messages
object[]
required

Messages exchanged in the thread

updatedAt
string<date-time>

Timestamp when the thread was last updated

metadata
object

Custom metadata associated with the thread

cost
number<float>

Total cost accumulated by this thread