Skip to main content
PUT
Create or update the declared intent for a workflow version

Authorizations

Authorization
string
header
required

OAuth 2.0 authentication.

Path Parameters

workflow_id
string<uuid>
required

Workflow ID to write intent for.

Query Parameters

workflow_version_id
string<uuid>

The workflow version the intent describes. Intent belongs to one immutable version, not to the workflow as a whole. When omitted, the workflow's current published version is used, and the response reports which version was written. A version that belongs to a different workflow returns 404, as does a workflow with nothing published: there is no version to attach the text to.

Body

application/json
intent
string
required

What this version of the workflow is for, in the owner's own terms: the outcome it exists to produce, the trigger it responds to, and any constraint that must hold. Plain prose, not code.

Required string length: 1 - 8000

Response

OK

workflow_id
string<uuid>
required

The workflow the intent belongs to.

workflow_version_id
string<uuid> | null
required

The workflow version this read or write targeted, so a caller that omitted the parameter learns which version answered. null only on a read of a workflow that has nothing published yet.

intent
string | null
required

The intent recorded against this version, or null when this version has none. Intent is never carried over from another version: text recorded against one version never answers a read of another.

updated_at
string<date-time> | null

When the intent was last written; null when never captured.

Last modified on September 16, 2026