Skip to main content
POST
Create an initiative

Authorizations

Authorization
string
header
required

OrgX API key, sent as Authorization: Bearer oxk_...

Headers

Idempotency-Key
string
required

Workspace-scoped retry key for safe mutation replay.

Required string length: 1 - 200
Pattern: ^[A-Za-z0-9][A-Za-z0-9._:/-]{0,199}$

Body

application/json
proposal_id
string<uuid>
required
proposal_digest
string
required

Must equal the stored proposal digest — commit exactly what you reviewed

Pattern: ^sha256:[0-9a-f]{64}$
workspace_id
string<uuid>
initiative_id
string<uuid>

Optional client-supplied id; defaults to a deterministic id derived from workspace and Idempotency-Key

overrides
object

Non-structural adjustments; structural edits require a new plan or proposal

expected_aggregate_version
integer

Response

Original result returned after a safe retry

data
object
required
meta
object
required