Run Metronome
POST
/v1/metronomes/{metronomeId}/runsQueue 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
| Name | Location | Type | Required | Description |
|---|---|---|---|---|
| metronomeId | path | string | Yes | Metronome workflow ID |
Query parameters
None.
Body schema
Content type: application/json · Optional
| Field | Type | Required | Description |
|---|---|---|---|
| input | object | No | — |
| inputs | object | No | — |
| idempotencyKey | string | No | — |
| maxAttempts | integer | No | — |
| timeoutMs | integer | No | — |
| attachedProjectId | string | No | — |
| attachedTicketId | string | No | — |
| pinnedAgentVersions | object | No | Exact Agent version IDs keyed by Agent ID. A successful run must invoke every pin. |
| queueWhenCapacityUnavailable | boolean | No | Convert the requested run into a durable auto-start Batch when runtime capacity is full. Defaults to true on local appliances and false on cloud deployments. |
What the API returns
Each response code below includes the documented payload shape for the ACP API.
201Metronome run queuedapplication/json
| Field | Type | Required | Description |
|---|---|---|---|
| data | object | No | — |
| data.id | string | No | Unique identifier. |
| data.metronomeId | string | No | — |
| data.userId | string | No | User ID. |
| data.organizationId | string | No | — |
| data.createdByUserId | string | No | — |
| data.triggerType | string | No | — |
| data.versionId | string | No | — |
| data.snapshotId | string | No | Snapshot ID. |
| data.runKind | workflow | node_test | slice_test | No | — |
| data.invocationSource | string | No | — |
| data.executionSelection | object | No | — |
| data.effectMode | execute | preview | No | — |
| data.initiatedByUserId | string | No | — |
| data.requestFingerprint | string | No | — |
| data.triggerEventId | string | No | — |
| data.idempotencyKey | string | No | — |
| data.status | queued | running | waiting_approval | paused | completed | failed | cancelled | No | Current lifecycle status. |
| data.input | object | No | — |
| data.output | object | No | — |
| data.error | string | No | — |
| data.startedAt | string | No | ISO 8601 timestamp. |
| data.queuedAt | string | No | — |
| data.nextAttemptAt | string | No | — |
| data.lockedAt | string | No | — |
| data.lockedBy | string | No | — |
| data.attemptCount | integer | No | — |
| data.maxAttempts | integer | No | — |
| data.timeoutMs | integer | No | — |
| data.attachedProjectId | string | No | — |
| data.attachedTicketId | string | No | — |
| data.completedAt | string | No | ISO 8601 timestamp. |
| data.createdAt | string | No | ISO 8601 timestamp. |
| data.updatedAt | string | No | ISO 8601 timestamp. |
202A paused native run was prepared and accepted by the capacity-aware Batch queueapplication/json
| Field | Type | Required | Description |
|---|---|---|---|
| data | object | Yes | — |
| data.id | string | No | Unique identifier. |
| data.metronomeId | string | No | — |
| data.userId | string | No | User ID. |
| data.organizationId | string | No | — |
| data.createdByUserId | string | No | — |
| data.triggerType | string | No | — |
| data.versionId | string | No | — |
| data.snapshotId | string | No | Snapshot ID. |
| data.runKind | workflow | node_test | slice_test | No | — |
| data.invocationSource | string | No | — |
| data.executionSelection | object | No | — |
| data.effectMode | execute | preview | No | — |
| data.initiatedByUserId | string | No | — |
| data.requestFingerprint | string | No | — |
| data.triggerEventId | string | No | — |
| data.idempotencyKey | string | No | — |
| data.status | queued | running | waiting_approval | paused | completed | failed | cancelled | No | Current lifecycle status. |
| data.input | object | No | — |
| data.output | object | No | — |
| data.error | string | No | — |
| data.startedAt | string | No | ISO 8601 timestamp. |
| data.queuedAt | string | No | — |
| data.nextAttemptAt | string | No | — |
| data.lockedAt | string | No | — |
| data.lockedBy | string | No | — |
| data.attemptCount | integer | No | — |
| data.maxAttempts | integer | No | — |
| data.timeoutMs | integer | No | — |
| data.attachedProjectId | string | No | — |
| data.attachedTicketId | string | No | — |
| data.completedAt | string | No | ISO 8601 timestamp. |
| data.createdAt | string | No | ISO 8601 timestamp. |
| data.updatedAt | string | No | ISO 8601 timestamp. |
| batchJob | object | Yes | — |
| batchJob.id | string | Yes | Unique identifier. |
| batchJob.userId | string | Yes | User ID. |
| batchJob.organizationId | string | No | — |
| batchJob.createdByUserId | string | No | — |
| batchJob.name | string | Yes | Human-readable name. |
| batchJob.description | string | Yes | Human-readable description. |
| batchJob.targetKind | thread_run | metronome_run | evaluation_run | agent_optimization | project_ticket_action | Yes | — |
| batchJob.targetResourceId | string | No | — |
| batchJob.targetVersionId | string | No | — |
| batchJob.definition | object | Yes | Native target definition. A Thread Batch may reference an existing thread with threadId (or targetResourceId), or create a new thread when released by providing message and optional agentId, environmentId/computerId, projectId, title, attachments, skills, reasoning effort, and cost boundaries. |
| batchJob.startPolicy | manual | stay_on_shelf | when_capacity_available | Yes | manual is a one-shot shelf job started explicitly; stay_on_shelf is also started explicitly but returns to the bottom of its shelf after every successful execution; when_capacity_available is automatically released by the scheduler when runtime capacity permits. |
| batchJob.status | held | queued | dispatching | running | succeeded | failed | cancelled | Yes | Current lifecycle status. |
| batchJob.queueLane | string | Yes | — |
| batchJob.priority | integer | Yes | — |
| batchJob.position | integer | Yes | — |
| batchJob.maxAttempts | integer | Yes | — |
| batchJob.attemptCount | integer | Yes | — |
| batchJob.executionGeneration | integer | Yes | — |
| batchJob.availableAt | string | Yes | — |
| batchJob.waitReason | string | No | — |
| batchJob.nativeResourceType | string | No | — |
| batchJob.nativeResourceId | string | No | — |
| batchJob.sourceProjectId | string | No | — |
| batchJob.sourceTicketId | string | No | — |
| batchJob.permissionSet | string | Yes | — |
| batchJob.idempotencyKey | string | No | — |
| batchJob.leaseOwner | string | No | — |
| batchJob.leaseExpiresAt | string | No | — |
| batchJob.heartbeatAt | string | No | — |
| batchJob.lastError | string | No | — |
| batchJob.metadata | object | Yes | Free-form metadata object. |
| batchJob.createdAt | string | Yes | ISO 8601 timestamp. |
| batchJob.updatedAt | string | Yes | ISO 8601 timestamp. |
| batchJob.queuedAt | string | No | — |
| batchJob.startedAt | string | No | ISO 8601 timestamp. |
| batchJob.completedAt | string | No | ISO 8601 timestamp. |
| queuedInBatch | boolean | Yes | — |