List Function optimization candidates
GET
/v1/optimization-candidates/functions/{resourceId}Returns immutable candidates plus the exact current published base and its canonical fingerprint.
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
| Name | Location | Type | Required | Description |
|---|---|---|---|---|
| limit | query | integer | No | — |
| offset | query | integer | No | — |
Body schema
This endpoint does not require a request body.
None.
What the API returns
Each response code below includes the documented payload shape for the ACP API.
200Function optimization candidatesapplication/json
| Field | Type | Required | Description |
|---|---|---|---|
| object | list | Yes | — |
| data | object[] | Yes | — |
| data[].id | string | Yes | Unique identifier. |
| data[].object | optimization_candidate | Yes | — |
| data[].targetKind | function | metronome | Yes | — |
| data[].targetResourceId | string | Yes | — |
| data[].baseVersionId | string | Yes | — |
| data[].baseFingerprint | string | Yes | — |
| data[].candidateVersionId | string | Yes | — |
| data[].candidateFingerprint | string | Yes | — |
| data[].objectiveFingerprint | string | Yes | — |
| data[].proposalFingerprint | string | Yes | — |
| data[].idempotencyKey | string | Yes | — |
| data[].status | materialized | validated | accepted | rejected | published | superseded | Yes | Current lifecycle status. |
| data[].proposal | object | Yes | — |
| data[].proposal.schemaVersion | computer_agents_optimization_candidate_v1 | Yes | — |
| data[].proposal.target | object | Yes | — |
| data[].proposal.target.kind | function | metronome | Yes | — |
| data[].proposal.target.resourceId | string | Yes | — |
| data[].proposal.target.baseVersionId | string | Yes | — |
| data[].proposal.target.baseFingerprint | string | Yes | — |
| data[].proposal.objectiveFingerprint | string | Yes | — |
| data[].proposal.candidate | object | Yes | — |
| data[].proposal.candidate.fingerprint | string | Yes | — |
| data[].proposal.candidate.label | string | Yes | — |
| data[].proposal.candidate.description | string | No | Human-readable description. |
| data[].proposal.candidate.snapshot | object | Yes | — |
| data[].proposal.candidate.snapshot.name | string | No | Human-readable name. |
| data[].proposal.candidate.snapshot.description | string | No | Human-readable description. |
| data[].proposal.candidate.snapshot.kind | function | Yes | — |
| data[].proposal.candidate.snapshot.sourceType | manual | computer | git | No | — |
| data[].proposal.candidate.snapshot.sourceEnvironmentId | string | No | — |
| data[].proposal.candidate.snapshot.sourcePath | string | No | Workspace-relative file path. |
| data[].proposal.candidate.snapshot.region | string | No | — |
| data[].proposal.candidate.snapshot.runtime | string | No | — |
| data[].proposal.candidate.snapshot.authMode | public | private | No | — |
| data[].proposal.candidate.snapshot.customDomain | string | No | — |
| data[].proposal.candidate.snapshot.metadata | object | No | Versionable Function metadata. Deployment identity and credentials are rejected. |
| data[].proposal.candidate.snapshot.sourceFiles | object[] | Yes | — |
| data[].proposal.candidate.snapshot.sourceFiles[].path | string | Yes | Safe relative versioned source path. |
| data[].proposal.candidate.snapshot.sourceFiles[].name | string | Yes | Human-readable name. |
| data[].proposal.candidate.snapshot.sourceFiles[].isFolder | boolean | Yes | — |
| data[].proposal.candidate.snapshot.sourceFiles[].size | integer | Yes | — |
| data[].proposal.candidate.snapshot.sourceFileContents | object | Yes | Complete contents for every non-folder sourceFiles entry. |
| data[].proposal.producer | object | Yes | — |
| data[].proposal.producer.kind | agent | human | deterministic | external | Yes | — |
| data[].proposal.producer.id | string | Yes | Unique identifier. |
| data[].proposal.producer.versionId | string | No | — |
| data[].proposal.producer.runId | string | No | — |
| data[].proposal.evidence | object | No | — |
| data[].proposal.evidence.evaluationRunIds | string[] | No | — |
| data[].proposal.evidence.testRunIds | string[] | No | — |
| data[].proposal.evidence.assuranceRunIds | string[] | No | — |
| data[].proposal.evidence.repairEpisodeId | string | No | — |
| data[].proposal.evidence.diagnosticFingerprint | string | No | — |
| data[].proposal.idempotencyKey | string | Yes | — |
| data[].producer | object | Yes | — |
| data[].producer.kind | agent | human | deterministic | external | Yes | — |
| data[].producer.id | string | Yes | Unique identifier. |
| data[].producer.versionId | string | No | — |
| data[].producer.runId | string | No | — |
| data[].evidence | object | Yes | — |
| data[].evidence.evaluationRunIds | string[] | No | — |
| data[].evidence.testRunIds | string[] | No | — |
| data[].evidence.assuranceRunIds | string[] | No | — |
| data[].evidence.repairEpisodeId | string | No | — |
| data[].evidence.diagnosticFingerprint | string | No | — |
| data[].organizationId | string | No | — |
| data[].createdByUserId | string | No | — |
| data[].createdAt | string | Yes | ISO 8601 timestamp. |
| data[].updatedAt | string | Yes | ISO 8601 timestamp. |
| candidates | object[] | Yes | — |
| candidates[].id | string | Yes | Unique identifier. |
| candidates[].object | optimization_candidate | Yes | — |
| candidates[].targetKind | function | metronome | Yes | — |
| candidates[].targetResourceId | string | Yes | — |
| candidates[].baseVersionId | string | Yes | — |
| candidates[].baseFingerprint | string | Yes | — |
| candidates[].candidateVersionId | string | Yes | — |
| candidates[].candidateFingerprint | string | Yes | — |
| candidates[].objectiveFingerprint | string | Yes | — |
| candidates[].proposalFingerprint | string | Yes | — |
| candidates[].idempotencyKey | string | Yes | — |
| candidates[].status | materialized | validated | accepted | rejected | published | superseded | Yes | Current lifecycle status. |
| candidates[].proposal | object | Yes | — |
| candidates[].proposal.schemaVersion | computer_agents_optimization_candidate_v1 | Yes | — |
| candidates[].proposal.target | object | Yes | — |
| candidates[].proposal.target.kind | function | metronome | Yes | — |
| candidates[].proposal.target.resourceId | string | Yes | — |
| candidates[].proposal.target.baseVersionId | string | Yes | — |
| candidates[].proposal.target.baseFingerprint | string | Yes | — |
| candidates[].proposal.objectiveFingerprint | string | Yes | — |
| candidates[].proposal.candidate | object | Yes | — |
| candidates[].proposal.candidate.fingerprint | string | Yes | — |
| candidates[].proposal.candidate.label | string | Yes | — |
| candidates[].proposal.candidate.description | string | No | Human-readable description. |
| candidates[].proposal.candidate.snapshot | object | Yes | — |
| candidates[].proposal.candidate.snapshot.name | string | No | Human-readable name. |
| candidates[].proposal.candidate.snapshot.description | string | No | Human-readable description. |
| candidates[].proposal.candidate.snapshot.kind | function | Yes | — |
| candidates[].proposal.candidate.snapshot.sourceType | manual | computer | git | No | — |
| candidates[].proposal.candidate.snapshot.sourceEnvironmentId | string | No | — |
| candidates[].proposal.candidate.snapshot.sourcePath | string | No | Workspace-relative file path. |
| candidates[].proposal.candidate.snapshot.region | string | No | — |
| candidates[].proposal.candidate.snapshot.runtime | string | No | — |
| candidates[].proposal.candidate.snapshot.authMode | public | private | No | — |
| candidates[].proposal.candidate.snapshot.customDomain | string | No | — |
| candidates[].proposal.candidate.snapshot.metadata | object | No | Versionable Function metadata. Deployment identity and credentials are rejected. |
| candidates[].proposal.candidate.snapshot.sourceFiles | object[] | Yes | — |
| candidates[].proposal.candidate.snapshot.sourceFiles[].path | string | Yes | Safe relative versioned source path. |
| candidates[].proposal.candidate.snapshot.sourceFiles[].name | string | Yes | Human-readable name. |
| candidates[].proposal.candidate.snapshot.sourceFiles[].isFolder | boolean | Yes | — |
| candidates[].proposal.candidate.snapshot.sourceFiles[].size | integer | Yes | — |
| candidates[].proposal.candidate.snapshot.sourceFileContents | object | Yes | Complete contents for every non-folder sourceFiles entry. |
| candidates[].proposal.producer | object | Yes | — |
| candidates[].proposal.producer.kind | agent | human | deterministic | external | Yes | — |
| candidates[].proposal.producer.id | string | Yes | Unique identifier. |
| candidates[].proposal.producer.versionId | string | No | — |
| candidates[].proposal.producer.runId | string | No | — |
| candidates[].proposal.evidence | object | No | — |
| candidates[].proposal.evidence.evaluationRunIds | string[] | No | — |
| candidates[].proposal.evidence.testRunIds | string[] | No | — |
| candidates[].proposal.evidence.assuranceRunIds | string[] | No | — |
| candidates[].proposal.evidence.repairEpisodeId | string | No | — |
| candidates[].proposal.evidence.diagnosticFingerprint | string | No | — |
| candidates[].proposal.idempotencyKey | string | Yes | — |
| candidates[].producer | object | Yes | — |
| candidates[].producer.kind | agent | human | deterministic | external | Yes | — |
| candidates[].producer.id | string | Yes | Unique identifier. |
| candidates[].producer.versionId | string | No | — |
| candidates[].producer.runId | string | No | — |
| candidates[].evidence | object | Yes | — |
| candidates[].evidence.evaluationRunIds | string[] | No | — |
| candidates[].evidence.testRunIds | string[] | No | — |
| candidates[].evidence.assuranceRunIds | string[] | No | — |
| candidates[].evidence.repairEpisodeId | string | No | — |
| candidates[].evidence.diagnosticFingerprint | string | No | — |
| candidates[].organizationId | string | No | — |
| candidates[].createdByUserId | string | No | — |
| candidates[].createdAt | string | Yes | ISO 8601 timestamp. |
| candidates[].updatedAt | string | Yes | ISO 8601 timestamp. |
| publishedBase | object | Yes | — |
| publishedBase.targetKind | function | metronome | Yes | — |
| publishedBase.resourceId | string | Yes | — |
| publishedBase.versionId | string | Yes | — |
| publishedBase.version | integer | Yes | — |
| publishedBase.fingerprint | string | Yes | — |
| publishedBase.snapshot | object | Yes | — |
| hasMore | boolean | Yes | — |
| limit | integer | Yes | — |
| offset | integer | Yes | — |
404Function not found in the active resource scope
None.
List Function optimization candidates
Loading...
Response 200
Loading...