Skip to main content
POST
Send a turn

Authorizations

Authorization
string
header
required

A workspace API key.

Headers

idempotency-key
string
required

Required stable id for this turn; reuse it after a timeout to receive the same answer.

Required string length: 1 - 255

Body

application/json
message
string
required

What the person asked.

Required string length: 1 - 4000
threadId
string

Continue this conversation (threadId from an earlier turn).

Required string length: 1 - 200
projectId
string

The project to work in. Implied by a project thread.

Required string length: 1 - 200
mode
enum<string>
default:review

review: edits come back as proposals to apply. agentic: free, reversible edits land at once, each with a turnId to revert.

Available options:
review,
agentic
assetIds
string[]

Project media uploaded for this turn.

Maximum array length: 8
Required string length: 1 - 200
mark
object

Mark-to-Fix: point the message at one frame; the message is the note on it.

Response

Success.

success
boolean
required
threadId
string
required
messageId
string
required
projectId
string | null
required
mode
enum<string>
required
Available options:
review,
agentic
reply
string
required
edits
object[]
required
proposals
object[]
required
refusals
string[]
required
approvals
object[]
required
warnings
string[]
required
billing
object | null
required
{key}
any