Get one Optimization Campaign with attempts and events
GET
/v1/optimization-campaigns/{campaignId}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 |
|---|---|---|---|---|
| campaignId | path | string | Yes | Durable Optimization Campaign ID |
Query parameters
None.
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.
200Durable campaign stateapplication/json
| Field | Type | Required | Description |
|---|---|---|---|
| campaign | object | Yes | — |
| campaign.id | string | Yes | Unique identifier. |
| campaign.userId | string | No | User ID. |
| campaign.organizationId | string | No | — |
| campaign.createdByUserId | string | No | — |
| campaign.projectId | string | No | Project ID. |
| campaign.name | string | Yes | Human-readable name. |
| campaign.contract | object | Yes | — |
| campaign.contract.schemaVersion | computer_agents_optimization_campaign_v1 | Yes | — |
| campaign.contract.name | string | Yes | Human-readable name. |
| campaign.contract.projectId | string | No | Project ID. |
| campaign.contract.objective | object | Yes | — |
| campaign.contract.objective.statement | string | Yes | — |
| campaign.contract.objective.metric | average_score | pass_rate | Yes | — |
| campaign.contract.objective.target | number | Yes | — |
| campaign.contract.objective.minimumImprovement | number | Yes | — |
| campaign.contract.objective.maximumRegression | number | Yes | — |
| campaign.contract.target | object | Yes | — |
| campaign.contract.target.kind | function | metronome | Yes | — |
| campaign.contract.target.resourceKey | string | Yes | — |
| campaign.contract.target.resourceId | string | Yes | — |
| campaign.contract.target.baseVersionId | string | Yes | — |
| campaign.contract.target.baseFingerprint | string | Yes | — |
| campaign.contract.producer | object | Yes | — |
| campaign.contract.producer.kind | agent | Yes | — |
| campaign.contract.producer.adapterId | string | Yes | — |
| campaign.contract.producer.agentId | string | Yes | Agent ID. |
| campaign.contract.producer.agentVersionId | string | Yes | — |
| campaign.contract.producer.environmentId | string | Yes | Computer ID. |
| campaign.contract.evidence | object | Yes | — |
| campaign.contract.evidence.evaluationId | string | Yes | — |
| campaign.contract.evidence.evaluationVersionId | string | Yes | — |
| campaign.contract.evidence.baselineEvaluationRunId | string | Yes | — |
| campaign.contract.evidence.testPlanId | string | Yes | — |
| campaign.contract.evidence.testPlanVersionId | string | Yes | — |
| campaign.contract.evidence.assurancePolicyId | string | Yes | — |
| campaign.contract.evidence.assurancePolicyVersionId | string | Yes | — |
| campaign.contract.evidence.environmentId | string | No | Computer ID. |
| campaign.contract.limits | object | Yes | — |
| campaign.contract.limits.maximumAttempts | integer | Yes | — |
| campaign.contract.limits.plateauAttempts | integer | Yes | — |
| campaign.contract.limits.maximumTotalCostUsd | number | Yes | — |
| campaign.contract.limits.maximumDurationMinutes | integer | Yes | — |
| campaign.contract.limits.maximumTransientRetries | integer | Yes | — |
| campaign.contract.publication | object | Yes | — |
| campaign.contract.publication.mode | manual | auto_on_target | Yes | — |
| campaign.contract.publication.deployAfterPromotion | boolean | Yes | — |
| campaign.contract.idempotencyKey | string | Yes | — |
| campaign.contractFingerprint | string | Yes | — |
| campaign.objectiveFingerprint | string | Yes | — |
| campaign.targetKind | function | metronome | Yes | — |
| campaign.targetResourceId | string | Yes | — |
| campaign.baseVersionId | string | Yes | — |
| campaign.baseFingerprint | string | Yes | — |
| campaign.baselineEvaluationRunId | string | Yes | — |
| campaign.baselineScore | number | Yes | — |
| campaign.baselinePassRate | number | Yes | — |
| campaign.status | draft | queued | producing | evaluating | awaiting_assurance | ready_to_promote | releasing | completed | plateaued | failed | cancelled | Yes | Current lifecycle status. |
| campaign.attemptCount | integer | Yes | — |
| campaign.bestCandidateId | string | No | — |
| campaign.bestCandidateVersionId | string | No | — |
| campaign.bestScore | number | No | — |
| campaign.costUsd | number | Yes | — |
| campaign.idempotencyKey | string | Yes | — |
| campaign.startedAt | string | No | ISO 8601 timestamp. |
| campaign.completedAt | string | No | ISO 8601 timestamp. |
| campaign.cancelledAt | string | No | — |
| campaign.createdAt | string | Yes | ISO 8601 timestamp. |
| campaign.updatedAt | string | Yes | ISO 8601 timestamp. |
| campaign.attempts | object[] | No | — |
| campaign.attempts[].id | string | Yes | Unique identifier. |
| campaign.attempts[].campaignId | string | Yes | — |
| campaign.attempts[].attemptNumber | integer | Yes | — |
| campaign.attempts[].status | queued | producing | evaluating | awaiting_assurance | accepted | promoted | rejected | failed | cancelled | Yes | Current lifecycle status. |
| campaign.attempts[].producerRequest | object | Yes | — |
| campaign.attempts[].producerRequest.schemaVersion | computer_agents_optimization_campaign_producer_request_v1 | Yes | — |
| campaign.attempts[].producerRequest.campaignId | string | Yes | — |
| campaign.attempts[].producerRequest.attemptId | string | Yes | — |
| campaign.attempts[].producerRequest.attemptNumber | integer | Yes | — |
| campaign.attempts[].producerRequest.target | object | Yes | — |
| campaign.attempts[].producerRequest.target.kind | function | metronome | Yes | — |
| campaign.attempts[].producerRequest.target.resourceKey | string | Yes | — |
| campaign.attempts[].producerRequest.target.resourceId | string | Yes | — |
| campaign.attempts[].producerRequest.target.baseVersionId | string | Yes | — |
| campaign.attempts[].producerRequest.target.baseFingerprint | string | Yes | — |
| campaign.attempts[].producerRequest.objective | object | Yes | — |
| campaign.attempts[].producerRequest.objective.statement | string | Yes | — |
| campaign.attempts[].producerRequest.objective.metric | average_score | pass_rate | Yes | — |
| campaign.attempts[].producerRequest.objective.target | number | Yes | — |
| campaign.attempts[].producerRequest.objective.minimumImprovement | number | Yes | — |
| campaign.attempts[].producerRequest.objective.maximumRegression | number | Yes | — |
| campaign.attempts[].producerRequest.objectiveFingerprint | string | Yes | — |
| campaign.attempts[].producerRequest.producer | object | Yes | — |
| campaign.attempts[].producerRequest.producer.kind | agent | Yes | — |
| campaign.attempts[].producerRequest.producer.adapterId | string | Yes | — |
| campaign.attempts[].producerRequest.producer.agentId | string | Yes | Agent ID. |
| campaign.attempts[].producerRequest.producer.agentVersionId | string | Yes | — |
| campaign.attempts[].producerRequest.producer.environmentId | string | Yes | Computer ID. |
| campaign.attempts[].producerRequest.constraints | object | Yes | — |
| campaign.attempts[].producerRequest.constraints.candidateMustRemainSaved | true | Yes | — |
| campaign.attempts[].producerRequest.constraints.networkAccess | false | Yes | — |
| campaign.attempts[].producerRequest.constraints.secretsAccess | false | Yes | — |
| campaign.attempts[].producerRequest.constraints.maximumSourceSnapshotBytes | integer | Yes | — |
| campaign.attempts[].producerRequest.constraints.maximumCandidateResponseBytes | integer | Yes | — |
| campaign.attempts[].candidateId | string | No | — |
| campaign.attempts[].candidateVersionId | string | No | — |
| campaign.attempts[].candidateFingerprint | string | No | — |
| campaign.attempts[].testRunId | string | No | — |
| campaign.attempts[].evaluationRunId | string | No | — |
| campaign.attempts[].assuranceRunId | string | No | — |
| campaign.attempts[].acceptanceFingerprint | string | No | — |
| campaign.attempts[].score | number | No | — |
| campaign.attempts[].passRate | number | No | — |
| campaign.attempts[].improvement | number | No | — |
| campaign.attempts[].costUsd | number | Yes | — |
| campaign.attempts[].error | string | No | — |
| campaign.attempts[].startedAt | string | No | ISO 8601 timestamp. |
| campaign.attempts[].completedAt | string | No | ISO 8601 timestamp. |
| campaign.attempts[].createdAt | string | Yes | ISO 8601 timestamp. |
| campaign.attempts[].updatedAt | string | Yes | ISO 8601 timestamp. |
| campaign.events | object[] | No | — |
| campaign.events[].id | string | Yes | Unique identifier. |
| campaign.events[].type | string | Yes | — |
| campaign.events[].actorUserId | string | Yes | — |
| campaign.events[].payload | object | Yes | — |
| campaign.events[].createdAt | string | Yes | ISO 8601 timestamp. |
404Campaign not found
None.
Get one Optimization Campaign with attempts and events
Loading...
Response 200
Loading...