Get a test plan with versions and recent runs
GET
/v1/test-plans/{testPlanId}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 |
|---|---|---|---|---|
| testPlanId | path | string | Yes | — |
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.
200Test plan detailapplication/json
| Field | Type | Required | Description |
|---|---|---|---|
| testPlan | object | Yes | — |
| testPlan.id | string | Yes | Unique identifier. |
| testPlan.projectId | string | Yes | Project ID. |
| testPlan.name | string | Yes | Human-readable name. |
| testPlan.description | string | Yes | Human-readable description. |
| testPlan.status | draft | active | archived | Yes | Current lifecycle status. |
| testPlan.targetType | project | workflow | function | web_app | agent | repository | custom | Yes | — |
| testPlan.targetId | string | Yes | — |
| testPlan.defaultEnvironmentId | string | Yes | — |
| testPlan.definition | object | Yes | — |
| testPlan.definition.schemaVersion | computer_agents_test_plan_v1 | Yes | — |
| testPlan.definition.setup | object | Yes | — |
| testPlan.definition.setup.command | string | Yes | — |
| testPlan.definition.setup.workingDirectory | string | Yes | — |
| testPlan.definition.setup.timeoutMs | integer | Yes | — |
| testPlan.definition.setup.env | object | Yes | — |
| testPlan.definition.setup.secretRefs | string[] | Yes | — |
| testPlan.definition.cases | object[] | Yes | — |
| testPlan.definition.cases[].id | string | Yes | Unique identifier. |
| testPlan.definition.cases[].name | string | Yes | Human-readable name. |
| testPlan.definition.cases[].description | string | Yes | Human-readable description. |
| testPlan.definition.cases[].kind | command | contract | integration | browser | agent | security | custom | Yes | — |
| testPlan.definition.cases[].command | string | Yes | — |
| testPlan.definition.cases[].workingDirectory | string | Yes | — |
| testPlan.definition.cases[].timeoutMs | integer | Yes | — |
| testPlan.definition.cases[].retries | integer | Yes | — |
| testPlan.definition.cases[].env | object | Yes | — |
| testPlan.definition.cases[].secretRefs | string[] | Yes | — |
| testPlan.definition.cases[].request | object | Yes | Kind-specific structured request. Secrets must be referenced through `secretRefs`. |
| testPlan.definition.cases[].assertions | object[] | Yes | — |
| testPlan.definition.cases[].agentId | string | Yes | Agent ID. |
| testPlan.definition.cases[].enabled | boolean | Yes | — |
| testPlan.definition.cases[].tags | string[] | Yes | — |
| testPlan.definition.teardown | object | Yes | — |
| testPlan.definition.teardown.command | string | Yes | — |
| testPlan.definition.teardown.workingDirectory | string | Yes | — |
| testPlan.definition.teardown.timeoutMs | integer | Yes | — |
| testPlan.definition.teardown.env | object | Yes | — |
| testPlan.definition.teardown.secretRefs | string[] | Yes | — |
| testPlan.definition.concurrency | integer | Yes | — |
| testPlan.definition.stopOnFailure | boolean | Yes | — |
| testPlan.definition.retryPolicy | object | Yes | — |
| testPlan.definition.retryPolicy.maxAttempts | integer | Yes | — |
| testPlan.definition.retryPolicy.backoffMs | integer | Yes | — |
| testPlan.definition.evidencePolicy | object | Yes | — |
| testPlan.definition.evidencePolicy.retainLogs | boolean | Yes | — |
| testPlan.definition.evidencePolicy.retainScreenshots | boolean | Yes | — |
| testPlan.definition.evidencePolicy.retainTraces | boolean | Yes | — |
| testPlan.definition.evidencePolicy.retainArtifacts | boolean | Yes | — |
| testPlan.definition.evidencePolicy.redactSecrets | boolean | Yes | — |
| testPlan.caseCount | integer | Yes | — |
| testPlan.planFingerprint | string | Yes | — |
| testPlan.publishedVersionId | string | Yes | — |
| testPlan.metadata | object | Yes | Free-form metadata object. |
| testPlan.createdAt | string | Yes | ISO 8601 timestamp. |
| testPlan.updatedAt | string | Yes | ISO 8601 timestamp. |
| testPlan.versions | object[] | No | — |
| testPlan.versions[].id | string | Yes | Unique identifier. |
| testPlan.versions[].testPlanId | string | Yes | — |
| testPlan.versions[].version | integer | Yes | — |
| testPlan.versions[].label | string | Yes | — |
| testPlan.versions[].description | string | Yes | Human-readable description. |
| testPlan.versions[].status | saved | published | Yes | Current lifecycle status. |
| testPlan.versions[].snapshot | object | Yes | — |
| testPlan.versions[].snapshot.name | string | Yes | Human-readable name. |
| testPlan.versions[].snapshot.description | string | Yes | Human-readable description. |
| testPlan.versions[].snapshot.status | draft | active | archived | Yes | Current lifecycle status. |
| testPlan.versions[].snapshot.projectId | string | Yes | Project ID. |
| testPlan.versions[].snapshot.targetType | project | workflow | function | web_app | agent | repository | custom | Yes | — |
| testPlan.versions[].snapshot.targetId | string | Yes | — |
| testPlan.versions[].snapshot.defaultEnvironmentId | string | Yes | — |
| testPlan.versions[].snapshot.definition | object | Yes | — |
| testPlan.versions[].snapshot.definition.schemaVersion | computer_agents_test_plan_v1 | Yes | — |
| testPlan.versions[].snapshot.definition.setup | object | Yes | — |
| testPlan.versions[].snapshot.definition.setup.command | string | Yes | — |
| testPlan.versions[].snapshot.definition.setup.workingDirectory | string | Yes | — |
| testPlan.versions[].snapshot.definition.setup.timeoutMs | integer | Yes | — |
| testPlan.versions[].snapshot.definition.setup.env | object | Yes | — |
| testPlan.versions[].snapshot.definition.setup.secretRefs | string[] | Yes | — |
| testPlan.versions[].snapshot.definition.cases | object[] | Yes | — |
| testPlan.versions[].snapshot.definition.cases[].id | string | Yes | Unique identifier. |
| testPlan.versions[].snapshot.definition.cases[].name | string | Yes | Human-readable name. |
| testPlan.versions[].snapshot.definition.cases[].description | string | Yes | Human-readable description. |
| testPlan.versions[].snapshot.definition.cases[].kind | command | contract | integration | browser | agent | security | custom | Yes | — |
| testPlan.versions[].snapshot.definition.cases[].command | string | Yes | — |
| testPlan.versions[].snapshot.definition.cases[].workingDirectory | string | Yes | — |
| testPlan.versions[].snapshot.definition.cases[].timeoutMs | integer | Yes | — |
| testPlan.versions[].snapshot.definition.cases[].retries | integer | Yes | — |
| testPlan.versions[].snapshot.definition.cases[].env | object | Yes | — |
| testPlan.versions[].snapshot.definition.cases[].secretRefs | string[] | Yes | — |
| testPlan.versions[].snapshot.definition.cases[].request | object | Yes | Kind-specific structured request. Secrets must be referenced through `secretRefs`. |
| testPlan.versions[].snapshot.definition.cases[].assertions | object[] | Yes | — |
| testPlan.versions[].snapshot.definition.cases[].agentId | string | Yes | Agent ID. |
| testPlan.versions[].snapshot.definition.cases[].enabled | boolean | Yes | — |
| testPlan.versions[].snapshot.definition.cases[].tags | string[] | Yes | — |
| testPlan.versions[].snapshot.definition.teardown | object | Yes | — |
| testPlan.versions[].snapshot.definition.teardown.command | string | Yes | — |
| testPlan.versions[].snapshot.definition.teardown.workingDirectory | string | Yes | — |
| testPlan.versions[].snapshot.definition.teardown.timeoutMs | integer | Yes | — |
| testPlan.versions[].snapshot.definition.teardown.env | object | Yes | — |
| testPlan.versions[].snapshot.definition.teardown.secretRefs | string[] | Yes | — |
| testPlan.versions[].snapshot.definition.concurrency | integer | Yes | — |
| testPlan.versions[].snapshot.definition.stopOnFailure | boolean | Yes | — |
| testPlan.versions[].snapshot.definition.retryPolicy | object | Yes | — |
| testPlan.versions[].snapshot.definition.retryPolicy.maxAttempts | integer | Yes | — |
| testPlan.versions[].snapshot.definition.retryPolicy.backoffMs | integer | Yes | — |
| testPlan.versions[].snapshot.definition.evidencePolicy | object | Yes | — |
| testPlan.versions[].snapshot.definition.evidencePolicy.retainLogs | boolean | Yes | — |
| testPlan.versions[].snapshot.definition.evidencePolicy.retainScreenshots | boolean | Yes | — |
| testPlan.versions[].snapshot.definition.evidencePolicy.retainTraces | boolean | Yes | — |
| testPlan.versions[].snapshot.definition.evidencePolicy.retainArtifacts | boolean | Yes | — |
| testPlan.versions[].snapshot.definition.evidencePolicy.redactSecrets | boolean | Yes | — |
| testPlan.versions[].snapshot.metadata | object | Yes | Functional extension metadata only; ownership and access-control fields are deliberately excluded. |
| testPlan.versions[].metadata | object | Yes | Free-form metadata object. |
| testPlan.versions[].publishedAt | string | Yes | — |
| testPlan.versions[].createdAt | string | Yes | ISO 8601 timestamp. |
| testPlan.versions[].updatedAt | string | Yes | ISO 8601 timestamp. |
| testPlan.runs | object[] | No | — |
| testPlan.runs[].id | string | Yes | Unique identifier. |
| testPlan.runs[].testPlanId | string | Yes | — |
| testPlan.runs[].versionId | string | Yes | — |
| testPlan.runs[].projectId | string | Yes | Project ID. |
| testPlan.runs[].taskId | string | Yes | — |
| testPlan.runs[].releaseId | string | Yes | — |
| testPlan.runs[].environmentId | string | Yes | Computer ID. |
| testPlan.runs[].agentId | string | Yes | Agent ID. |
| testPlan.runs[].triggerType | manual | mission_control | task | release | pull_request | schedule | api | Yes | — |
| testPlan.runs[].commitSha | string | Yes | — |
| testPlan.runs[].status | queued | running | passed | failed | completed_with_errors | cancelled | Yes | Current lifecycle status. |
| testPlan.runs[].totalCount | integer | Yes | — |
| testPlan.runs[].passedCount | integer | Yes | — |
| testPlan.runs[].failedCount | integer | Yes | — |
| testPlan.runs[].skippedCount | integer | Yes | — |
| testPlan.runs[].errorCount | integer | Yes | — |
| testPlan.runs[].durationMs | integer | Yes | — |
| testPlan.runs[].evidence | object | Yes | — |
| testPlan.runs[].evidence.schemaVersion | computer_agents_test_run_evidence_v2 | Yes | — |
| testPlan.runs[].evidence.runId | string | Yes | — |
| testPlan.runs[].evidence.planId | string | Yes | — |
| testPlan.runs[].evidence.planVersionId | string | Yes | — |
| testPlan.runs[].evidence.planFingerprint | string | Yes | — |
| testPlan.runs[].evidence.commitSha | string | Yes | — |
| testPlan.runs[].evidence.status | queued | running | passed | failed | completed_with_errors | cancelled | Yes | Current lifecycle status. |
| testPlan.runs[].evidence.expectedCaseIds | string[] | Yes | — |
| testPlan.runs[].evidence.counts | object | Yes | — |
| testPlan.runs[].evidence.counts.total | integer | Yes | — |
| testPlan.runs[].evidence.counts.passed | integer | Yes | — |
| testPlan.runs[].evidence.counts.failed | integer | Yes | — |
| testPlan.runs[].evidence.counts.skipped | integer | Yes | — |
| testPlan.runs[].evidence.counts.error | integer | Yes | — |
| testPlan.runs[].evidence.executionContext | object | Yes | — |
| testPlan.runs[].evidence.executionContext.environmentId | string | Yes | Computer ID. |
| testPlan.runs[].evidence.executionContext.agentId | string | Yes | Agent ID. |
| testPlan.runs[].evidence.executionContext.projectId | string | Yes | Project ID. |
| testPlan.runs[].evidence.executionContext.taskId | string | Yes | — |
| testPlan.runs[].evidence.executionContext.releaseId | string | Yes | — |
| testPlan.runs[].evidence.generatedAt | string | Yes | — |
| testPlan.runs[].evidence.resultSetFingerprint | string | Yes | — |
| testPlan.runs[].evidence.artifactSetFingerprint | string | Yes | — |
| testPlan.runs[].evidence.provenance | object | Yes | Self-reported provenance must be unverified with no attestation. Verified-worker provenance is accepted only when the server-verified attestation binds every canonical evidence identity and digest. |
| testPlan.runs[].evidence.provenance.schemaVersion | computer_agents_test_run_evidence_provenance_v1 | Yes | — |
| testPlan.runs[].evidence.provenance.source | computer_agents_thread | execution_worker | api_client | legacy_import | Yes | — |
| testPlan.runs[].evidence.provenance.trustLevel | self_reported | verified_worker | Yes | — |
| testPlan.runs[].evidence.provenance.verificationStatus | unverified | verified | Yes | — |
| testPlan.runs[].evidence.provenance.executor | object | Yes | — |
| testPlan.runs[].evidence.provenance.executor.kind | string | Yes | — |
| testPlan.runs[].evidence.provenance.executor.id | string | Yes | Unique identifier. |
| testPlan.runs[].evidence.provenance.attestation | object | Yes | — |
| testPlan.runs[].evidence.provenance.attestation.schemaVersion | computer_agents_test_execution_attestation_v1 | Yes | — |
| testPlan.runs[].evidence.provenance.attestation.attestationId | string | Yes | — |
| testPlan.runs[].evidence.provenance.attestation.workerId | string | Yes | — |
| testPlan.runs[].evidence.provenance.attestation.dispatchId | string | Yes | — |
| testPlan.runs[].evidence.provenance.attestation.workerAssertionId | string | Yes | — |
| testPlan.runs[].evidence.provenance.attestation.runId | string | Yes | — |
| testPlan.runs[].evidence.provenance.attestation.planId | string | Yes | — |
| testPlan.runs[].evidence.provenance.attestation.planVersionId | string | Yes | — |
| testPlan.runs[].evidence.provenance.attestation.planFingerprint | string | Yes | — |
| testPlan.runs[].evidence.provenance.attestation.commitSha | string | Yes | — |
| testPlan.runs[].evidence.provenance.attestation.environmentId | string | Yes | Computer ID. |
| testPlan.runs[].evidence.provenance.attestation.resultSetFingerprint | string | Yes | — |
| testPlan.runs[].evidence.provenance.attestation.artifactSetFingerprint | string | Yes | — |
| testPlan.runs[].evidence.provenance.attestation.issuedAt | string | Yes | — |
| testPlan.runs[].evidence.provenance.attestation.verifiedAt | string | Yes | — |
| testPlan.runs[].evidence.results | object[] | Yes | — |
| testPlan.runs[].evidence.results[].id | string | Yes | Unique identifier. |
| testPlan.runs[].evidence.results[].testRunId | string | Yes | — |
| testPlan.runs[].evidence.results[].caseId | string | Yes | — |
| testPlan.runs[].evidence.results[].name | string | Yes | Human-readable name. |
| testPlan.runs[].evidence.results[].kind | command | contract | integration | browser | agent | security | custom | Yes | — |
| testPlan.runs[].evidence.results[].status | queued | running | passed | failed | skipped | error | Yes | Current lifecycle status. |
| testPlan.runs[].evidence.results[].attempt | integer | Yes | — |
| testPlan.runs[].evidence.results[].durationMs | integer | Yes | — |
| testPlan.runs[].evidence.results[].exitCode | integer | Yes | — |
| testPlan.runs[].evidence.results[].summary | string | Yes | — |
| testPlan.runs[].evidence.results[].diagnostics | object | Yes | — |
| testPlan.runs[].evidence.results[].evidence | object | Yes | — |
| testPlan.runs[].evidence.results[].startedAt | string | Yes | ISO 8601 timestamp. |
| testPlan.runs[].evidence.results[].completedAt | string | Yes | ISO 8601 timestamp. |
| testPlan.runs[].evidence.results[].createdAt | string | Yes | ISO 8601 timestamp. |
| testPlan.runs[].evidence.results[].updatedAt | string | Yes | ISO 8601 timestamp. |
| testPlan.runs[].evidence.artifacts | object[] | Yes | — |
| testPlan.runs[].evidence.artifacts[].id | string | Yes | Unique identifier. |
| testPlan.runs[].evidence.artifacts[].testRunId | string | Yes | — |
| testPlan.runs[].evidence.artifacts[].testCaseResultId | string | Yes | — |
| testPlan.runs[].evidence.artifacts[].type | string | Yes | — |
| testPlan.runs[].evidence.artifacts[].name | string | Yes | Human-readable name. |
| testPlan.runs[].evidence.artifacts[].uri | string | Yes | — |
| testPlan.runs[].evidence.artifacts[].contentType | string | Yes | — |
| testPlan.runs[].evidence.artifacts[].sizeBytes | integer | Yes | — |
| testPlan.runs[].evidence.artifacts[].sha256 | string | Yes | — |
| testPlan.runs[].evidence.artifacts[].metadata | object | Yes | Free-form metadata object. |
| testPlan.runs[].evidence.artifacts[].createdAt | string | Yes | ISO 8601 timestamp. |
| testPlan.runs[].evidence.fingerprint | string | Yes | — |
| testPlan.runs[].metadata | object | Yes | Free-form metadata object. |
| testPlan.runs[].execution | object | Yes | — |
| testPlan.runs[].execution.owner | string | Yes | — |
| testPlan.runs[].execution.attempt | integer | Yes | — |
| testPlan.runs[].execution.leaseExpiresAt | string | Yes | — |
| testPlan.runs[].execution.heartbeatAt | string | Yes | — |
| testPlan.runs[].createdAt | string | Yes | ISO 8601 timestamp. |
| testPlan.runs[].updatedAt | string | Yes | ISO 8601 timestamp. |
| testPlan.runs[].startedAt | string | Yes | ISO 8601 timestamp. |
| testPlan.runs[].completedAt | string | Yes | ISO 8601 timestamp. |
| testPlan.runs[].results | object[] | No | — |
| testPlan.runs[].results[].id | string | Yes | Unique identifier. |
| testPlan.runs[].results[].testRunId | string | Yes | — |
| testPlan.runs[].results[].caseId | string | Yes | — |
| testPlan.runs[].results[].name | string | Yes | Human-readable name. |
| testPlan.runs[].results[].kind | command | contract | integration | browser | agent | security | custom | Yes | — |
| testPlan.runs[].results[].status | queued | running | passed | failed | skipped | error | Yes | Current lifecycle status. |
| testPlan.runs[].results[].attempt | integer | Yes | — |
| testPlan.runs[].results[].durationMs | integer | Yes | — |
| testPlan.runs[].results[].exitCode | integer | Yes | — |
| testPlan.runs[].results[].summary | string | Yes | — |
| testPlan.runs[].results[].diagnostics | object | Yes | — |
| testPlan.runs[].results[].evidence | object | Yes | — |
| testPlan.runs[].results[].startedAt | string | Yes | ISO 8601 timestamp. |
| testPlan.runs[].results[].completedAt | string | Yes | ISO 8601 timestamp. |
| testPlan.runs[].results[].createdAt | string | Yes | ISO 8601 timestamp. |
| testPlan.runs[].results[].updatedAt | string | Yes | ISO 8601 timestamp. |
| testPlan.runs[].artifacts | object[] | No | — |
| testPlan.runs[].artifacts[].id | string | Yes | Unique identifier. |
| testPlan.runs[].artifacts[].testRunId | string | Yes | — |
| testPlan.runs[].artifacts[].testCaseResultId | string | Yes | — |
| testPlan.runs[].artifacts[].type | string | Yes | — |
| testPlan.runs[].artifacts[].name | string | Yes | Human-readable name. |
| testPlan.runs[].artifacts[].uri | string | Yes | — |
| testPlan.runs[].artifacts[].contentType | string | Yes | — |
| testPlan.runs[].artifacts[].sizeBytes | integer | Yes | — |
| testPlan.runs[].artifacts[].sha256 | string | Yes | — |
| testPlan.runs[].artifacts[].metadata | object | Yes | Free-form metadata object. |
| testPlan.runs[].artifacts[].createdAt | string | Yes | ISO 8601 timestamp. |
404Test plan not found or unavailable to the caller
None.
Get a test plan with versions and recent runs
Loading...
Response 200
Loading...