v3

OpenAPI 3.1.02026-07-31350397683.8 KB

Scenario Builder

Get Workflow V2

Get one workflows_v2 by ID (organization must match).

get/v1/scenario/{workflow_id}

Path parameters

workflow_idstring uuid required

Headers

X-API-Keystring required

API key required to authenticate requests.

Response

Successful Response

idstring required

Workflow ID

organization_idstring nullable

Owning organization ID (set by middleware on create)

agent_idsinteger[]

Linked agent ids when the workflow is agent-scoped

namestring required

Name of the workflow

descriptionstring nullable

Description

definitionobject required

Stored React Flow graph (start / single / options nodes). Nodes and edges use top-level string id fields; edge id values are unique within the graph.

created_atstring date-time required

Creation timestamp

dh_sync_summaryobject nullable

Present on PUT responses when the definition was updated. Keys: updated, created, marked_stale, skipped, errors.

warningsstring[]

Non-blocking lint warnings emitted at save time (e.g. node text referencing an unknown {{trait_name}}). Empty when the definition is clean or no agents are linked.