Skip to main content
POST
Run an Act turn

Authorizations

overlay_session
string
cookie
required

Signed httpOnly browser session cookie.

Body

application/json
accessToken
string
Minimum string length: 1
userId
string
Minimum string length: 1
conversationId
string
conversationClientId
string
Minimum string length: 1
scope
enum<string>
Available options:
personal,
workspace
askModelIds
string[]
messages
any[]
prompt
string
systemPrompt
string
turnId
string
modelId
string
Required string length: 1 - 160
indexedFileNames
string[]
indexedAttachments
any
attachmentNames
string[]
replyContextForModel
string
historyBaseModelId
string
mode
enum<string>
Available options:
chat,
automate
personalChatMode
enum<string>

Deprecated compatibility field. Accepted but ignored; personal chat execution is selected by backend capability.

Available options:
chat,
work
automationMode
boolean
automationExecution
boolean
automationId
string
automationName
string
Maximum string length: 200
mediaToolIntent
enum<string> | null
Available options:
image,
video
requestedToolIds
any
memoryEnabled
boolean
notebookNoteId
string

The note open in the Notebook editor. The turn runs as a normal personal chat with that note as its subject and note editing tools available.

Required string length: 1 - 64
actAbortTimeoutMs
number
Required range: x > 0
harnessBudget
object
mentions
object[]
reasoning
enum<string>
Available options:
provider-default,
none,
minimal,
low,
medium,
high,
xhigh
liveTransport
enum<string>

The client reads the live reply from Convex. An admitted durable run then answers right after admission with its run identity and source metadata instead of relaying the reply over this response.

Available options:
convex

Response

Successful response. Stable response schemas are documented in workflow guides when available.

Response shape is route-specific and may be backed by @overlay/app-core contracts.