Skip to navigation

Flows · Authoring · Write the step graph, or edit title and description

View as Markdown

Updates a workflow. The step graph is written here, as extra.diagram.

Read resource: workflow://diagram-grammar before writing a diagram. It carries the block and connection grammar, variable references, a worked example, and the publish failures worth knowing. The grammar is not guessable from this schema.

The essentials, so a diagram can be sanity-checked without leaving this tool:

  • Blocks are start, end, and <action_slug>_<index> (e.g. call_agent_ai_v2_0). data.reference is the slug without the index.
  • Connections join o/<source_id>/main to i/<target_id>/main.
  • Step config goes in data.config.formData.inputParameters.
  • ${workflow.input.<name>} reads an input; ${<block_id>.output.<path>} reads an earlier step.
  • Declaring an input takes two places: extra.inputs and a dataSchema on the start block. Only one leaves the input invisible when the workflow is run.
  • You author diagram. conductor is compiled from it at publish and overwritten, so writing it achieves nothing.

Sending extra replaces it wholesale — include the complete diagram, not just what changed. version and skip_credit_usage are ignored here; publishing manages the version.

Saved changes are not live. The workflow must be published again before new runs use them.

Authentication

AuthorizationApi-Key

Header authentication of the form Api-Key <token>

OR
AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

workflow_idintegerRequired

Numeric workflow-definition ID. Not a run ID.

Request

This endpoint expects an object.
titlestringOptional
descriptionstringOptional
extramap from strings to anyOptional

Carries inputs and diagram. Replaces the stored value wholesale — send the complete diagram.

Response

Saved. has_unpublished_changes is now true.

Errors

400
Bad Request Error
404
Not Found Error