Skip to main content
PATCH
Update Session
Send a new title or archived value. Archiving changes navigation only; it does not cancel operations or remove history. Only the session administrator can change this metadata.

Authorizations

x-api-key
string
header
required

Path Parameters

sessionId
string
required
Pattern: ^asst_[a-f0-9-]{36}$

Body

application/json
title
string
Required string length: 1 - 160
archived
boolean
brief
string
Maximum string length: 4000

Response

Accepted state.

conversationId
string
required
Pattern: ^asst_[a-f0-9-]{36}$
status
enum<string>
required
Available options:
planning,
ready,
running,
paused,
completed,
cancelled
goal
string
required
messages
object[]
required
revisions
object[]
required
Maximum array length: 32
latestRevisionId
string | null
required
Pattern: ^arev_[a-f0-9-]{36}$
quote
object | null
required
funding
object | null
required
run
object | null
required
previousRuns
object[]
required
Maximum array length: 32
createdAt
string<date-time>
required
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
updatedAt
string<date-time>
required
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
threadId
string

Deprecated alias for sessionId.

Pattern: ^asst_[a-f0-9-]{36}$
delivery
object
sessionId
string
Pattern: ^asst_[a-f0-9-]{36}$
threadBrief
string
Maximum string length: 4000
threadTitle
string
conversation
object
agents
object[]
conversationToken
string

Private guest token. Send as X-Assist-Token for subsequent requests.

Last modified on November 9, 2026