Queue an isolated Metronome node or slice test

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

Persist an immutable workflow snapshot and asynchronously execute only the selected node or connected slice.

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 · Required

FieldTypeRequiredDescription
selectionobjectYes
selection.typenode | sliceYes
selection.nodeIdstringNo
selection.nodeIdsstring[]No
selection.boundaryContextobjectNo
inputobjectNo
inputsobjectNo
fixtureobjectNo
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
definition.executionRecoveryPolicyobjectNo
definition.executionRecoveryPolicy.schemaVersioncomputer_agents_metronome_recovery_policy_v1Yes
definition.executionRecoveryPolicy.enforcementcheckpointedYes
definition.executionRecoveryPolicy.inDoubtDefaultpauseYes
definition.executionRecoveryPolicy.checkpointMaxBytesintegerYes
versionIdstringNo
idempotencyKeystringNo
maxAttemptsintegerNo
timeoutMsintegerNo
pinnedAgentVersionsobjectNo

What the API returns

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

202Metronome test run acceptedapplication/json
FieldTypeRequiredDescription
objectstringYes
dataobjectYes
data.idstringNoUnique identifier.
data.metronomeIdstringNo
data.userIdstringNoUser ID.
data.organizationIdstringNo
data.createdByUserIdstringNo
data.triggerTypestringNo
data.versionIdstringNo
data.snapshotIdstringNoSnapshot ID.
data.runKindworkflow | node_test | slice_testNo
data.invocationSourcestringNo
data.executionSelectionobjectNo
data.effectModeexecute | previewNo
data.initiatedByUserIdstringNo
data.requestFingerprintstringNo
data.triggerEventIdstringNo
data.idempotencyKeystringNo
data.statusqueued | running | waiting_approval | paused | completed | failed | cancelledNoCurrent lifecycle status.
data.inputobjectNo
data.outputobjectNo
data.errorstringNo
data.startedAtstringNoISO 8601 timestamp.
data.queuedAtstringNo
data.nextAttemptAtstringNo
data.lockedAtstringNo
data.lockedBystringNo
data.attemptCountintegerNo
data.maxAttemptsintegerNo
data.timeoutMsintegerNo
data.attachedProjectIdstringNo
data.attachedTicketIdstringNo
data.completedAtstringNoISO 8601 timestamp.
data.createdAtstringNoISO 8601 timestamp.
data.updatedAtstringNoISO 8601 timestamp.
previewobjectYes
preview.definitionSha256stringYes
preview.planobjectYes
preview.plan.schemaVersionintegerYes
preview.plan.selectionobjectYes
preview.plan.runKindworkflow | node_test | slice_testYes
preview.plan.startNodeIdstringYes
preview.plan.stopNodeIdsstring[]No
preview.plan.allowedNodeIdsstring[]No
preview.plan.allowedEdgeIdsstring[]No
preview.plan.boundaryContextobjectNo
preview.plan.effectsobject[]Yes
preview.plan.requiredBoundaryNodeIdsstring[]No
preview.plan.executablebooleanYes
preview.plan.digeststringYes
400Invalid or unsafe execution selection
None.
404Metronome not found
None.
409Immutable version or candidate binding conflict
None.
Queue an isolated Metronome node or slice test
Loading...
Response 202
Loading...
See the ACP quickstart and SDK flow