v1

latestOpenAPI 3.1.02026-07-22115189303.8 KB
Workflows

Retrieve workflow definition

Get the editor-oriented workflow payload for a specific workflow.

This endpoint returns everything needed to load the canvas:

  • Base workflow metadata
  • definition.nodes built from flow_steps
  • definition.edges built from flow_edges

Response details:

  • definition.nodes[].id is the workflow step identifier, not the database ID
  • definition.edges[].id is the persisted edge UUID
  • definition.nodes[].data.node_type is the canonical backend node type
  • definition.nodes[].data.config changes shape by node type
  • Config fields are returned in snake_case
  • Function and call-workflow references are returned as IDs in the Platform API; the Kapso CLI can export them as slugs for local source repos

Use this endpoint when building or syncing a visual workflow editor, exporting a workflow graph, or cloning an existing workflow definition.

get/workflows/{workflow_id}/definition

Response

Workflow definition retrieved successfully