Materialize a saved Metronome optimization candidate
POST
/v1/optimization-candidates/metronomes/{resourceId}Atomically creates a content-addressed immutable saved Metronome version and append-only candidate provenance. This operation never publishes or activates the workflow.
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 |
|---|---|---|---|---|
| resourceId | path | string | Yes | — |
Query parameters
None.
Body schema
Content type: application/json · Required
| Field | Type | Required | Description |
|---|---|---|---|
| proposal | object | Yes | — |
| proposal.schemaVersion | computer_agents_optimization_candidate_v1 | Yes | — |
| proposal.target | object | Yes | — |
| proposal.target.kind | function | metronome | Yes | — |
| proposal.target.resourceId | string | Yes | — |
| proposal.target.baseVersionId | string | Yes | — |
| proposal.target.baseFingerprint | string | Yes | — |
| proposal.objectiveFingerprint | string | Yes | — |
| proposal.candidate | object | Yes | — |
| proposal.candidate.fingerprint | string | Yes | — |
| proposal.candidate.label | string | Yes | — |
| proposal.candidate.description | string | No | Human-readable description. |
| proposal.candidate.snapshot | object | Yes | — |
| proposal.candidate.snapshot.name | string | No | Human-readable name. |
| proposal.candidate.snapshot.description | string | No | Human-readable description. |
| proposal.candidate.snapshot.kind | function | Yes | — |
| proposal.candidate.snapshot.sourceType | manual | computer | git | No | — |
| proposal.candidate.snapshot.sourceEnvironmentId | string | No | — |
| proposal.candidate.snapshot.sourcePath | string | No | Workspace-relative file path. |
| proposal.candidate.snapshot.region | string | No | — |
| proposal.candidate.snapshot.runtime | string | No | — |
| proposal.candidate.snapshot.authMode | public | private | No | — |
| proposal.candidate.snapshot.customDomain | string | No | — |
| proposal.candidate.snapshot.metadata | object | No | Versionable Function metadata. Deployment identity and credentials are rejected. |
| proposal.candidate.snapshot.sourceFiles | object[] | Yes | — |
| proposal.candidate.snapshot.sourceFiles[].path | string | Yes | Safe relative versioned source path. |
| proposal.candidate.snapshot.sourceFiles[].name | string | Yes | Human-readable name. |
| proposal.candidate.snapshot.sourceFiles[].isFolder | boolean | Yes | — |
| proposal.candidate.snapshot.sourceFiles[].size | integer | Yes | — |
| proposal.candidate.snapshot.sourceFileContents | object | Yes | Complete contents for every non-folder sourceFiles entry. |
| proposal.producer | object | Yes | — |
| proposal.producer.kind | agent | human | deterministic | external | Yes | — |
| proposal.producer.id | string | Yes | Unique identifier. |
| proposal.producer.versionId | string | No | — |
| proposal.producer.runId | string | No | — |
| proposal.evidence | object | No | — |
| proposal.evidence.evaluationRunIds | string[] | No | — |
| proposal.evidence.testRunIds | string[] | No | — |
| proposal.evidence.assuranceRunIds | string[] | No | — |
| proposal.evidence.repairEpisodeId | string | No | — |
| proposal.evidence.diagnosticFingerprint | string | No | — |
| proposal.idempotencyKey | string | Yes | — |
What the API returns
Each response code below includes the documented payload shape for the ACP API.
200Idempotent replay of an existing candidateapplication/json
| Field | Type | Required | Description |
|---|---|---|---|
| object | optimization_candidate.materialization | Yes | — |
| candidate | object | Yes | — |
| candidate.id | string | Yes | Unique identifier. |
| candidate.object | optimization_candidate | Yes | — |
| candidate.targetKind | function | metronome | Yes | — |
| candidate.targetResourceId | string | Yes | — |
| candidate.baseVersionId | string | Yes | — |
| candidate.baseFingerprint | string | Yes | — |
| candidate.candidateVersionId | string | Yes | — |
| candidate.candidateFingerprint | string | Yes | — |
| candidate.objectiveFingerprint | string | Yes | — |
| candidate.proposalFingerprint | string | Yes | — |
| candidate.idempotencyKey | string | Yes | — |
| candidate.status | materialized | validated | accepted | rejected | published | superseded | Yes | Current lifecycle status. |
| candidate.proposal | object | Yes | — |
| candidate.proposal.schemaVersion | computer_agents_optimization_candidate_v1 | Yes | — |
| candidate.proposal.target | object | Yes | — |
| candidate.proposal.target.kind | function | metronome | Yes | — |
| candidate.proposal.target.resourceId | string | Yes | — |
| candidate.proposal.target.baseVersionId | string | Yes | — |
| candidate.proposal.target.baseFingerprint | string | Yes | — |
| candidate.proposal.objectiveFingerprint | string | Yes | — |
| candidate.proposal.candidate | object | Yes | — |
| candidate.proposal.candidate.fingerprint | string | Yes | — |
| candidate.proposal.candidate.label | string | Yes | — |
| candidate.proposal.candidate.description | string | No | Human-readable description. |
| candidate.proposal.candidate.snapshot | object | Yes | — |
| candidate.proposal.candidate.snapshot.name | string | No | Human-readable name. |
| candidate.proposal.candidate.snapshot.description | string | No | Human-readable description. |
| candidate.proposal.candidate.snapshot.kind | function | Yes | — |
| candidate.proposal.candidate.snapshot.sourceType | manual | computer | git | No | — |
| candidate.proposal.candidate.snapshot.sourceEnvironmentId | string | No | — |
| candidate.proposal.candidate.snapshot.sourcePath | string | No | Workspace-relative file path. |
| candidate.proposal.candidate.snapshot.region | string | No | — |
| candidate.proposal.candidate.snapshot.runtime | string | No | — |
| candidate.proposal.candidate.snapshot.authMode | public | private | No | — |
| candidate.proposal.candidate.snapshot.customDomain | string | No | — |
| candidate.proposal.candidate.snapshot.metadata | object | No | Versionable Function metadata. Deployment identity and credentials are rejected. |
| candidate.proposal.candidate.snapshot.sourceFiles | object[] | Yes | — |
| candidate.proposal.candidate.snapshot.sourceFiles[].path | string | Yes | Safe relative versioned source path. |
| candidate.proposal.candidate.snapshot.sourceFiles[].name | string | Yes | Human-readable name. |
| candidate.proposal.candidate.snapshot.sourceFiles[].isFolder | boolean | Yes | — |
| candidate.proposal.candidate.snapshot.sourceFiles[].size | integer | Yes | — |
| candidate.proposal.candidate.snapshot.sourceFileContents | object | Yes | Complete contents for every non-folder sourceFiles entry. |
| candidate.proposal.producer | object | Yes | — |
| candidate.proposal.producer.kind | agent | human | deterministic | external | Yes | — |
| candidate.proposal.producer.id | string | Yes | Unique identifier. |
| candidate.proposal.producer.versionId | string | No | — |
| candidate.proposal.producer.runId | string | No | — |
| candidate.proposal.evidence | object | No | — |
| candidate.proposal.evidence.evaluationRunIds | string[] | No | — |
| candidate.proposal.evidence.testRunIds | string[] | No | — |
| candidate.proposal.evidence.assuranceRunIds | string[] | No | — |
| candidate.proposal.evidence.repairEpisodeId | string | No | — |
| candidate.proposal.evidence.diagnosticFingerprint | string | No | — |
| candidate.proposal.idempotencyKey | string | Yes | — |
| candidate.producer | object | Yes | — |
| candidate.producer.kind | agent | human | deterministic | external | Yes | — |
| candidate.producer.id | string | Yes | Unique identifier. |
| candidate.producer.versionId | string | No | — |
| candidate.producer.runId | string | No | — |
| candidate.evidence | object | Yes | — |
| candidate.evidence.evaluationRunIds | string[] | No | — |
| candidate.evidence.testRunIds | string[] | No | — |
| candidate.evidence.assuranceRunIds | string[] | No | — |
| candidate.evidence.repairEpisodeId | string | No | — |
| candidate.evidence.diagnosticFingerprint | string | No | — |
| candidate.organizationId | string | No | — |
| candidate.createdByUserId | string | No | — |
| candidate.createdAt | string | Yes | ISO 8601 timestamp. |
| candidate.updatedAt | string | Yes | ISO 8601 timestamp. |
| version | object | Yes | — |
| version.id | string | Yes | Unique identifier. |
| version.targetKind | function | metronome | Yes | — |
| version.resourceId | string | Yes | — |
| version.version | integer | Yes | — |
| version.label | string | Yes | — |
| version.description | string | Yes | Human-readable description. |
| version.status | saved | published | archived | Yes | Current lifecycle status. |
| version.snapshot | object | Yes | — |
| version.metadata | object | No | Free-form metadata object. |
| version.publishedAt | string | No | — |
| version.createdAt | string | Yes | ISO 8601 timestamp. |
| version.updatedAt | string | Yes | ISO 8601 timestamp. |
| alreadyMaterialized | boolean | Yes | — |
| publicationTriggered | false | Yes | — |
| deploymentTriggered | false | Yes | — |
201Metronome candidate materializedapplication/json
| Field | Type | Required | Description |
|---|---|---|---|
| object | optimization_candidate.materialization | Yes | — |
| candidate | object | Yes | — |
| candidate.id | string | Yes | Unique identifier. |
| candidate.object | optimization_candidate | Yes | — |
| candidate.targetKind | function | metronome | Yes | — |
| candidate.targetResourceId | string | Yes | — |
| candidate.baseVersionId | string | Yes | — |
| candidate.baseFingerprint | string | Yes | — |
| candidate.candidateVersionId | string | Yes | — |
| candidate.candidateFingerprint | string | Yes | — |
| candidate.objectiveFingerprint | string | Yes | — |
| candidate.proposalFingerprint | string | Yes | — |
| candidate.idempotencyKey | string | Yes | — |
| candidate.status | materialized | validated | accepted | rejected | published | superseded | Yes | Current lifecycle status. |
| candidate.proposal | object | Yes | — |
| candidate.proposal.schemaVersion | computer_agents_optimization_candidate_v1 | Yes | — |
| candidate.proposal.target | object | Yes | — |
| candidate.proposal.target.kind | function | metronome | Yes | — |
| candidate.proposal.target.resourceId | string | Yes | — |
| candidate.proposal.target.baseVersionId | string | Yes | — |
| candidate.proposal.target.baseFingerprint | string | Yes | — |
| candidate.proposal.objectiveFingerprint | string | Yes | — |
| candidate.proposal.candidate | object | Yes | — |
| candidate.proposal.candidate.fingerprint | string | Yes | — |
| candidate.proposal.candidate.label | string | Yes | — |
| candidate.proposal.candidate.description | string | No | Human-readable description. |
| candidate.proposal.candidate.snapshot | object | Yes | — |
| candidate.proposal.candidate.snapshot.name | string | No | Human-readable name. |
| candidate.proposal.candidate.snapshot.description | string | No | Human-readable description. |
| candidate.proposal.candidate.snapshot.kind | function | Yes | — |
| candidate.proposal.candidate.snapshot.sourceType | manual | computer | git | No | — |
| candidate.proposal.candidate.snapshot.sourceEnvironmentId | string | No | — |
| candidate.proposal.candidate.snapshot.sourcePath | string | No | Workspace-relative file path. |
| candidate.proposal.candidate.snapshot.region | string | No | — |
| candidate.proposal.candidate.snapshot.runtime | string | No | — |
| candidate.proposal.candidate.snapshot.authMode | public | private | No | — |
| candidate.proposal.candidate.snapshot.customDomain | string | No | — |
| candidate.proposal.candidate.snapshot.metadata | object | No | Versionable Function metadata. Deployment identity and credentials are rejected. |
| candidate.proposal.candidate.snapshot.sourceFiles | object[] | Yes | — |
| candidate.proposal.candidate.snapshot.sourceFiles[].path | string | Yes | Safe relative versioned source path. |
| candidate.proposal.candidate.snapshot.sourceFiles[].name | string | Yes | Human-readable name. |
| candidate.proposal.candidate.snapshot.sourceFiles[].isFolder | boolean | Yes | — |
| candidate.proposal.candidate.snapshot.sourceFiles[].size | integer | Yes | — |
| candidate.proposal.candidate.snapshot.sourceFileContents | object | Yes | Complete contents for every non-folder sourceFiles entry. |
| candidate.proposal.producer | object | Yes | — |
| candidate.proposal.producer.kind | agent | human | deterministic | external | Yes | — |
| candidate.proposal.producer.id | string | Yes | Unique identifier. |
| candidate.proposal.producer.versionId | string | No | — |
| candidate.proposal.producer.runId | string | No | — |
| candidate.proposal.evidence | object | No | — |
| candidate.proposal.evidence.evaluationRunIds | string[] | No | — |
| candidate.proposal.evidence.testRunIds | string[] | No | — |
| candidate.proposal.evidence.assuranceRunIds | string[] | No | — |
| candidate.proposal.evidence.repairEpisodeId | string | No | — |
| candidate.proposal.evidence.diagnosticFingerprint | string | No | — |
| candidate.proposal.idempotencyKey | string | Yes | — |
| candidate.producer | object | Yes | — |
| candidate.producer.kind | agent | human | deterministic | external | Yes | — |
| candidate.producer.id | string | Yes | Unique identifier. |
| candidate.producer.versionId | string | No | — |
| candidate.producer.runId | string | No | — |
| candidate.evidence | object | Yes | — |
| candidate.evidence.evaluationRunIds | string[] | No | — |
| candidate.evidence.testRunIds | string[] | No | — |
| candidate.evidence.assuranceRunIds | string[] | No | — |
| candidate.evidence.repairEpisodeId | string | No | — |
| candidate.evidence.diagnosticFingerprint | string | No | — |
| candidate.organizationId | string | No | — |
| candidate.createdByUserId | string | No | — |
| candidate.createdAt | string | Yes | ISO 8601 timestamp. |
| candidate.updatedAt | string | Yes | ISO 8601 timestamp. |
| version | object | Yes | — |
| version.id | string | Yes | Unique identifier. |
| version.targetKind | function | metronome | Yes | — |
| version.resourceId | string | Yes | — |
| version.version | integer | Yes | — |
| version.label | string | Yes | — |
| version.description | string | Yes | Human-readable description. |
| version.status | saved | published | archived | Yes | Current lifecycle status. |
| version.snapshot | object | Yes | — |
| version.metadata | object | No | Free-form metadata object. |
| version.publishedAt | string | No | — |
| version.createdAt | string | Yes | ISO 8601 timestamp. |
| version.updatedAt | string | Yes | ISO 8601 timestamp. |
| alreadyMaterialized | boolean | Yes | — |
| publicationTriggered | false | Yes | — |
| deploymentTriggered | false | Yes | — |
409Base drift or conflicting idempotency key
None.
422Candidate is unchanged or cannot target this resource
None.
Materialize a saved Metronome optimization candidate
Loading...
Response 200
Loading...