Skip to main content
PATCH
Edit an idle 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.

Headers

If-Match
string
required

Current ETag from the resource's GET response. An outdated value returns 412 with the current etag; omitting it returns 428.

Path Parameters

workspace_id
string
required

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

draft_id
string
required

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

Body

application/json

One complete idle drawer mutation, protected by If-Match.

authoring_model_ref
string

Explicit selection for future messages.

config_ops
object[]

Supported add/replace/remove configuration operations.

Maximum array length: 64

One JSON Patch operation on the setup: add, replace or remove.

instance_name
string

Instance slug selected independently of the recipe and display title.

instruction_edits
object[]

Non-overlapping instruction edits.

Maximum array length: 32
runtime_model_ref
string

Runtime model reference in the native Definition.

title
string

Human display title; 1..100 characters.

Response

Updated private draft

Creator-visible mutable draft and its latest immutable candidate.

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.