Validate Metronome definition

POST/v1/metronomes/validate

Validate an inline workflow definition for basic shape or publish readiness without saving it.

How to call this endpoint

Every ACP API request uses bearer authentication. The examples here show the actual request path, auth header, and body shape that the platform expects.

Path, query, and header parameters

These parameters control which ACP object the endpoint acts on and how the request is processed.

Path parameters
None.
Query parameters
None.

Body schema

Content type: application/json · Required

FieldTypeRequiredDescription
modeshape | publishNoShape validates graph structure only. Publish validates required triggers, branches, resources, loop safety, and reachable end paths.
definitionobjectNo
definition.nodesobject[]No
definition.nodes[].idstringNoUnique identifier.
definition.nodes[].typestringNo
definition.nodes[].positionobjectNo
definition.nodes[].dataobjectNo
definition.nodes[].data.kindtrigger | condition | action | imagine | function | database | ticket | metronome | loop | end | noteNo
definition.nodes[].data.subtypestringNo
definition.nodes[].data.labelstringNo
definition.nodes[].data.descriptionstringNoHuman-readable description.
definition.nodes[].data.configobjectNo
definition.edgesobject[]No
definition.edges[].idstringNoUnique identifier.
definition.edges[].sourcestringNo
definition.edges[].targetstringNo
definition.edges[].sourceHandlestringNo
definition.edges[].targetHandlestringNo
definition.edges[].labelstringNo
nodesobject[]No
nodes[].idstringNoUnique identifier.
nodes[].typestringNo
nodes[].positionobjectNo
nodes[].dataobjectNo
nodes[].data.kindtrigger | condition | action | imagine | function | database | ticket | metronome | loop | end | noteNo
nodes[].data.subtypestringNo
nodes[].data.labelstringNo
nodes[].data.descriptionstringNoHuman-readable description.
nodes[].data.configobjectNo
edgesobject[]No
edges[].idstringNoUnique identifier.
edges[].sourcestringNo
edges[].targetstringNo
edges[].sourceHandlestringNo
edges[].targetHandlestringNo
edges[].labelstringNo

What the API returns

Each response code below includes the documented payload shape for the ACP API.

200Metronome validation resultapplication/json
FieldTypeRequiredDescription
objectstringNo
dataobjectNo
data.okbooleanNo
data.modeshape | publishNo
data.metronomeIdstringNo
data.versionIdstringNo
data.versionNumberintegerNo
data.issuesobject[]No
data.issues[].codestringNo
data.issues[].messagestringNoMessage text.
data.issues[].nodeIdstringNo
data.issues[].edgeIdstringNo
data.issues[].severityerror | warningNo
Validate Metronome definition
Loading...
Response 200
Loading...
See the ACP quickstart and SDK flow