Validate Metronome workflow
POST
/v1/metronomes/{metronomeId}/validateValidate the current workflow, a saved version, or an inline definition for basic shape or publish readiness.
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 |
|---|---|---|---|
| mode | shape | publish | No | Shape validates graph structure only. Publish validates required triggers, branches, resources, loop safety, and reachable end paths. |
| definition | object | No | — |
| definition.executionPolicy | object | No | — |
| definition.executionPolicy.placement | local_only | Yes | Requires on-prem PostgreSQL, filesystem artifacts, local scraping, local deployable Functions and explicit local inference. Unsupported node kinds and external API Functions fail closed. This placement contract does not replace operator-enforced network egress policy. |
| definition.nodes | object[] | No | — |
| definition.nodes[].id | string | No | Unique identifier. |
| definition.nodes[].type | string | No | — |
| definition.nodes[].position | object | No | — |
| definition.nodes[].data | object | No | — |
| definition.nodes[].data.kind | trigger | condition | approval | action | code | imagine | function | firecrawl | table | database | ticket | metronome | inference | loop | end | note | No | — |
| definition.nodes[].data.subtype | string | No | — |
| definition.nodes[].data.label | string | No | — |
| definition.nodes[].data.description | string | No | Human-readable description. |
| definition.nodes[].data.config | object | No | Kind-specific node configuration, versioned with the workflow. Thread (action) nodes opt into validated runtime results with outputMode=json_schema and a jsonOutputSchema (object or serialized JSON Schema), or the mutually exclusive jsonOutputSchemaFromInput naming one top-level field in the explicitly selected input. An input schema is validated before execution, removed from business input and retained with its fingerprint in the result receipt. The schema requires an object root, is limited to 64 KiB / 12 levels, and supports type, properties, required, additionalProperties (boolean), items, enum, numeric, string-length and array-length bounds, description and title. Unsupported keywords fail publication. maxValidationRetries is 0–2 (default 2). resultMode is inline (default) or artifact; outputKey defaults to data. Requires a Claw worker advertising json_schema_v1. Validated data comes from a dedicated runtime receipt, never assistant text. Failure retains Thread, usage and validation evidence without publishing partial data. Legacy outputMode=structured/json retains summary-parsing semantics until migrated. |
| definition.edges | object[] | No | — |
| definition.edges[].id | string | No | Unique identifier. |
| definition.edges[].source | string | No | — |
| definition.edges[].target | string | No | — |
| definition.edges[].sourceHandle | string | No | — |
| definition.edges[].targetHandle | string | No | — |
| definition.edges[].label | string | No | — |
| definition.executionRecoveryPolicy | object | No | — |
| definition.executionRecoveryPolicy.schemaVersion | computer_agents_metronome_recovery_policy_v1 | Yes | — |
| definition.executionRecoveryPolicy.enforcement | checkpointed | Yes | — |
| definition.executionRecoveryPolicy.inDoubtDefault | pause | Yes | — |
| definition.executionRecoveryPolicy.checkpointMaxBytes | integer | Yes | — |
| nodes | object[] | No | — |
| nodes[].id | string | No | Unique identifier. |
| nodes[].type | string | No | — |
| nodes[].position | object | No | — |
| nodes[].data | object | No | — |
| nodes[].data.kind | trigger | condition | approval | action | code | imagine | function | firecrawl | table | database | ticket | metronome | inference | loop | end | note | No | — |
| nodes[].data.subtype | string | No | — |
| nodes[].data.label | string | No | — |
| nodes[].data.description | string | No | Human-readable description. |
| nodes[].data.config | object | No | Kind-specific node configuration, versioned with the workflow. Thread (action) nodes opt into validated runtime results with outputMode=json_schema and a jsonOutputSchema (object or serialized JSON Schema), or the mutually exclusive jsonOutputSchemaFromInput naming one top-level field in the explicitly selected input. An input schema is validated before execution, removed from business input and retained with its fingerprint in the result receipt. The schema requires an object root, is limited to 64 KiB / 12 levels, and supports type, properties, required, additionalProperties (boolean), items, enum, numeric, string-length and array-length bounds, description and title. Unsupported keywords fail publication. maxValidationRetries is 0–2 (default 2). resultMode is inline (default) or artifact; outputKey defaults to data. Requires a Claw worker advertising json_schema_v1. Validated data comes from a dedicated runtime receipt, never assistant text. Failure retains Thread, usage and validation evidence without publishing partial data. Legacy outputMode=structured/json retains summary-parsing semantics until migrated. |
| edges | object[] | No | — |
| edges[].id | string | No | Unique identifier. |
| edges[].source | string | No | — |
| edges[].target | string | No | — |
| edges[].sourceHandle | string | No | — |
| edges[].targetHandle | string | No | — |
| edges[].label | string | No | — |
| versionId | string | No | Validate a saved version instead of the current workflow definition. |
What the API returns
Each response code below includes the documented payload shape for the ACP API.
200Metronome validation resultapplication/json
| Field | Type | Required | Description |
|---|---|---|---|
| object | string | No | — |
| data | object | No | — |
| data.ok | boolean | No | — |
| data.mode | shape | publish | No | — |
| data.metronomeId | string | No | — |
| data.versionId | string | No | — |
| data.versionNumber | integer | No | — |
| data.issues | object[] | No | — |
| data.issues[].code | string | No | — |
| data.issues[].message | string | No | Message text. |
| data.issues[].nodeId | string | No | — |
| data.issues[].edgeId | string | No | — |
| data.issues[].severity | error | warning | No | — |
404Metronome or version not found
None.