Run Metronome

POST/v1/metronomes/{metronomeId}/runs

Queue a workflow execution for the saved Metronome definition.

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

What the API returns

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

201Metronome run queuedapplication/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.
Run Metronome
Loading...
Response 201
Loading...
See the ACP quickstart and SDK flow