Start a Metronome from a composer command

POST/v1/metronomes/{metronomeId}/triggers/thread-command

Resolve an active published thread-command trigger and queue its workflow directly without creating an origin Thread.

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
commandstringYesActive command configured on the workflow's thread-event trigger.
triggerCommandstringNoDeprecated alias for `command`.
trigger_commandstringNoDeprecated alias for `command`.
promptstringNoOptional user instructions supplied after selecting the workflow.
inputsobjectNoOptional composer context passed to the workflow trigger input.
inputobjectNoDeprecated alias for `inputs`.
idempotencyKeystringNo

What the API returns

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

202Metronome thread-command run queuedapplication/json
FieldTypeRequiredDescription
objectstringNo
dataobjectNo
data.runobjectNo
data.run.idstringNoUnique identifier.
data.run.metronomeIdstringNo
data.run.userIdstringNoUser ID.
data.run.organizationIdstringNo
data.run.createdByUserIdstringNo
data.run.triggerTypestringNo
data.run.versionIdstringNo
data.run.snapshotIdstringNoSnapshot ID.
data.run.runKindworkflow | node_test | slice_testNo
data.run.invocationSourcestringNo
data.run.executionSelectionobjectNo
data.run.effectModeexecute | previewNo
data.run.initiatedByUserIdstringNo
data.run.requestFingerprintstringNo
data.run.triggerEventIdstringNo
data.run.idempotencyKeystringNo
data.run.statusqueued | running | waiting_approval | paused | completed | failed | cancelledNoCurrent lifecycle status.
data.run.inputobjectNo
data.run.outputobjectNo
data.run.errorstringNo
data.run.startedAtstringNoISO 8601 timestamp.
data.run.queuedAtstringNo
data.run.nextAttemptAtstringNo
data.run.lockedAtstringNo
data.run.lockedBystringNo
data.run.attemptCountintegerNo
data.run.maxAttemptsintegerNo
data.run.timeoutMsintegerNo
data.run.attachedProjectIdstringNo
data.run.attachedTicketIdstringNo
data.run.completedAtstringNoISO 8601 timestamp.
data.run.createdAtstringNoISO 8601 timestamp.
data.run.updatedAtstringNoISO 8601 timestamp.
data.run.approvalsobject[]No
data.run.approvals[].idstringYesUnique identifier.
data.run.approvals[].runIdstringYes
data.run.approvals[].metronomeIdstringYes
data.run.approvals[].nodeIdstringYes
data.run.approvals[].approverUserIdstringYes
data.run.approvals[].organizationIdstringNo
data.run.approvals[].createdByUserIdstringNo
data.run.approvals[].statuspending | approved | rejected | cancelledYesCurrent lifecycle status.
data.run.approvals[].messagestringYesMessage text.
data.run.approvals[].decisionByUserIdstringNo
data.run.approvals[].decidedAtstringNo
data.run.approvals[].createdAtstringNoISO 8601 timestamp.
data.run.approvals[].updatedAtstringNoISO 8601 timestamp.
data.triggerEventIdstringNo
400Invalid workflow command or execution plan
None.
404Metronome not found
None.
409Workflow or command is no longer active
None.
Start a Metronome from a composer command
Loading...
Response 202
Loading...
See the ACP quickstart and SDK flow