Skip to main content
POST
Live Search

Authorizations

x-api-key
string
header
required

Headers

X-Assist-Token
string
Idempotency-Key
string

Body

application/json
clientMessageId
string
required

A unique ID for this message. Reuse it only when retrying the same request.

Required string length: 1 - 200
Pattern: ^[A-Za-z0-9][A-Za-z0-9_.:-]*$
message
string
required

What you want to find, do, or discuss.

Required string length: 1 - 20000
type
string
default:turn
Allowed value: "turn"
threadId
string

Omit to start a thread; pass the returned threadId to continue.

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

Omit to start a conversation; return this ID on follow-ups.

Pattern: ^asst_[a-f0-9-]{36}$
mode
string
deprecated
Allowed value: "live_search"
context
object
memoryAgentId
string

Read memory for an account agent you belong to. Does not change the acting identity. Cannot be combined with userId or user_memory.

Required string length: 1 - 200
Pattern: ^[A-Za-z0-9][A-Za-z0-9_.:-]*$
userId
string

Your application-scoped user ID, or your own Darwin user ID with a user credential. Reuses memory previously supplied for this user; never grants account access.

Required string length: 1 - 200
Pattern: ^[A-Za-z0-9][A-Za-z0-9_.:-]*$
user_memory
string

Markdown preferences to personalize this request. Read a .md file and pass its text, not a path or URL. With userId, saves these preferences for later requests; empty text clears them.

Maximum string length: 4000
applicationId
string

Optional attribution check. Must match the application attached to your API credential; inferred when omitted.

Required string length: 1 - 200
Pattern: ^[A-Za-z0-9][A-Za-z0-9_.:-]*$

Response

Conversation state. Acceptance is not proof of completed work.

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
Pattern: ^asst_[a-f0-9-]{36}$
conversation
object
conversationToken
string

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

Last modified on November 1, 2026