Create an evaluation run

POST/v1/evaluations/{evaluationId}/runs

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
evaluationIdpathstringYes
Query parameters
None.

Body schema

Content type: application/json · Required

FieldTypeRequiredDescription
idstringNoUnique identifier.
runIdstringNo
run_idstringNo
targetobjectNoThe platform resource evaluated by this run. Agent, Function, and Metronome targets require `id`. A service_topology requires `entrypoint` and one or more uniquely-keyed `resources`; the complete topology is pinned before dispatch and the entrypoint is invoked. Agent resources require immutable `versionId` values and a Metronome entrypoint so the runtime can enforce and attest their exact versions. A direct Agent target also requires `environmentId`; when `versionId` is omitted, the control plane pins the latest published Agent version or rejects the run before dispatch. An explicitly requested saved Function or Metronome `versionId` is eligible only when it belongs to a registered immutable Optimization Candidate; ordinary saved drafts are rejected. Saved Function candidates execute only through the networkless Evaluation sandbox and never through the live deployment. An unpublished saved Agent version additionally requires `candidateAuthority`, bound to the completed Agent Optimization job that owns that exact version.
target.kindagent | function | metronome | service_topologyYes
target.idstringNoUnique identifier.
target.targetIdstringNo
target.versionIdstringNo
target.candidateAuthorityobjectNoCanonical authority for evaluating an unpublished saved Agent version. The Evaluation service verifies that the completed Agent Optimization job owns the exact candidate version and carries a successful, evidence-bound publication decision before dispatch.
target.candidateAuthority.kindagent_optimization_jobYes
target.candidateAuthority.idstringYesUnique identifier.
target.environmentIdstringNoComputer ID.
target.invocationobjectNo
target.invocation.methodGET | POST | PUT | PATCH | DELETENo
target.invocation.pathstringNoWorkspace-relative file path.
target.invocation.timeoutMsintegerNo
target.entrypointstringNo
target.resourcesobject[]No
target.resources[].keystringYes
target.resources[].kindagent | function | metronomeYes
target.resources[].idstringYesUnique identifier.
target.resources[].versionIdstringNo
target.resources[].candidateAuthorityobjectNoCanonical authority for evaluating an unpublished saved Agent version. The Evaluation service verifies that the completed Agent Optimization job owns the exact candidate version and carries a successful, evidence-bound publication decision before dispatch.
target.resources[].candidateAuthority.kindagent_optimization_jobYes
target.resources[].candidateAuthority.idstringYesUnique identifier.
agentIdstringNoAgent ID.
environmentIdstringNoComputer ID.
computerIdstringNo
versionIdstringNo
labelstringNo
purposediagnostic | development | optimization | release | external_validationNo
metadataobjectNoFree-form metadata object.
runobjectNoExecution configuration metadata. Version and dataset binding fields are server-owned and cannot be overridden.

What the API returns

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

202Queued evaluation run
None.
Create an evaluation run
Loading...
Response 202
Loading...
See the ACP quickstart and SDK flow