Skip to main content
POST
Start a private setup chat

Authorizations

Authorization
string
header
required

Send a dashboard session token, an account API key (agt_t), or a command-line credential (afc_) as a Bearer token. Each endpoint lists accepted credential types.

Path Parameters

workspace_id
string
required

Workspace identifier (version 7 universally unique identifier, or UUID).

Body

application/json

Atomically create a private draft and optional first message.

authoring_model_ref
string
required

Copy an eligible ref from GET /v1/workspaces/{workspace_id}/models?purpose=authoring.

operation_id
string
required

Required retry identifier: a version 7 universally unique identifier (UUID).

Retry within 24 hours with the same operation_id and unchanged request. After that window, inspect existing resources before retrying.

source
object
required

Exact native source to capture.

message
string

Optional initial user text; 1..32768 UTF-8 bytes when present.

save
boolean

Defaults to false. When true, save the finalized setup after this message succeeds. Requires message. Closing the browser does not cancel the save.

Response

Created or exact replay

Atomic draft creation response.

authoring_model_ref
string
required

Explicit model for future messages.

cancelled_through
string
required

Highest cancelled message sequence, as a decimal string.

etag
string
required

Strong version for idle edits.

id
string
required

Private draft identity.

state
string
required

editing, saving or closed.

title
string
required

Human display title.

candidate
object | null

Latest accepted setup, absent before the first candidate.

closed_at
string<date-time> | null

Closing timestamp, such as 2026-10-24T05:00:00.000Z.

expires_at
string<date-time> | null

Private retention deadline, such as 2026-10-24T05:00:00.000Z.

linked_fleet_id
string | null

Related fleet, when this draft targets or created one.

publication
object | null

Explicit publication receipt, never synthesized by Save.

review
object | null

Complete effective setup, immutable requirements and live readiness.

accepted
object | null

Present only when creation accepted an initial message.