Record a Metronome test run

POST/v1/metronomes/{metronomeId}/test-run

Create a dry-run execution record for the workflow graph.

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
NameLocationTypeRequiredDescription
metronomeIdpathstringYesMetronome workflow ID
Query parameters
None.

Body schema

Content type: application/json · Optional

FieldTypeRequiredDescription
inputobjectNo
inputsobjectNo
definitionobjectNo
definition.nodesobject[]No
definition.nodes[].idstringNoUnique identifier.
definition.nodes[].typestringNo
definition.nodes[].positionobjectNo
definition.nodes[].dataobjectNo
definition.nodes[].data.kindtrigger | condition | action | code | imagine | function | database | metronome | loop | approval | 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

What the API returns

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

201Metronome test run recordedapplication/json
FieldTypeRequiredDescription
dataobjectNo
data.idstringNoUnique identifier.
data.metronomeIdstringNo
data.userIdstringNoUser ID.
data.triggerTypestringNo
data.statusqueued | running | waiting_approval | completed | failed | cancelledNoCurrent lifecycle status.
data.inputobjectNo
data.outputobjectNo
data.errorstringNo
data.startedAtstringNoISO 8601 timestamp.
data.completedAtstringNoISO 8601 timestamp.
data.createdAtstringNoISO 8601 timestamp.
data.updatedAtstringNoISO 8601 timestamp.
Record a Metronome test run
Loading...
Response 201
Loading...
See the ACP quickstart and SDK flow