Skip to main content
PATCH
Edit an idle private draft

Authorizations

Authorization
string
header
required

Obtain a token via the CLI auth flow (POST /v1/auth/sessions) or GitHub OAuth

Headers

If-Match
string
required

Current strong tag from the resource's GET. A stale tag returns 412 with the current etag; an absent one returns 428.

Path Parameters

workspace_id
string
required

UUIDv7 of the workspace.

draft_id
string
required

UUIDv7 of the draft.

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

Decimal standing cancellation watermark.

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
null | object

Latest accepted setup, absent before the first candidate.

closed_at
integer<int64> | null

Closing time in Unix milliseconds.

expires_at
integer<int64> | null

Private retention deadline in Unix milliseconds.

linked_fleet_id
string | null

Related fleet, when this draft targets or created one.

publication
null | object

Explicit publication receipt, never synthesized by Save.

review
object | null

Complete effective setup, immutable requirements and live readiness.