On this page
Get a test run
Read a test run’s state, progress, verdict, summary and cost.
Operation ID: test_runs.get.
Request
GET /api/v1/test-runs/{test_run_id}
- TypeScript SDK:
client.test_runs.get(path arguments usepath). - MCP tool:
sdk_client_callwithoperationId: "test_runs.get"(path arguments useinput.path). Legacy alias:test_runs_get. Connect to your authenticated/mcpendpoint with an API key for the same environment. - Minimum API key role: viewer.
- Idempotency: No idempotency header required.
Read resource IDs from earlier responses and use a key for the same environment.
Request example
Set each path variable to an ID returned by an earlier API request.
Set CUMULUS_BASE_URL to your workspace API URL and CUMULUS_API_KEY to a key for that environment. Example values are synthetic.
cURL
curl --fail-with-body -sS "${CUMULUS_BASE_URL%/}/api/v1/test-runs/${TEST_RUN_ID}" \
-H "Authorization: Bearer $CUMULUS_API_KEY"
TypeScript
import { Cumulus } from "@cumulus/sdk";
const baseUrl = process.env.CUMULUS_BASE_URL;
const apiKey = process.env.CUMULUS_API_KEY;
if (!baseUrl || !apiKey) throw new Error("Set CUMULUS_BASE_URL and CUMULUS_API_KEY");
const client = new Cumulus({ baseUrl, apiKey });
const response = await client.test_runs.get({
"path": {
"test_run_id": "<test_run_id>"
}
});
Input schema
Path, query and header parameters
test_run_id
path parameter · Required.
Type: string (uuid). pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$.
JSON request body
This operation has no JSON request body.
Complete OpenAPI schema
{
"parameters": [
{
"name": "test_run_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$"
}
}
],
"requestBody": null
}
Responses
HTTP 200
Get a test run: state, verdict, progress, summary and cost
application/json
| Field | Type or values | Required | Description and limits |
|---|---|---|---|
owner_id | string | Required | minLength: 1. |
environment | string | Required | minLength: 1. |
tenant_id | string (uuid) | Required | pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$. |
test_run_id | string (uuid) | Required | Identifier of the test run whose progress or results you are reading. pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$. |
agent_id | string | Required | Agent identifier in the environment selected by your API key. minLength: 1. maxLength: 256. pattern: ^[A-Za-z0-9][A-Za-z0-9_.:-]*$. |
publication | object | Required | — |
publication.agent_id | string | Required | Agent identifier in the environment selected by your API key. minLength: 1. maxLength: 256. pattern: ^[A-Za-z0-9][A-Za-z0-9_.:-]*$. |
publication.version | integer | Required | At least 0. At most 2147483647. |
publication.digest | string | Required | pattern: ^sha256:[a-f0-9]{64}$. |
purpose | "manual" · "publish_gate" · "schedule" · "release" | Required | — |
suites | array of object | Required | minItems: 1. maxItems: 10. |
suites[].suite_id | string (uuid) | Required | Identifier of the test suite. pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$. |
suites[].revision | integer | Required | Greater than 0. At most 2147483647. |
suites[].digest | string | Required | pattern: ^sha256:[a-f0-9]{64}$. |
state | "queued" · "running" · "completed" · "cancelled" | Required | — |
verdict | "passed" · "failed" · "errored" or null | Required | — |
progress | object | Required | — |
progress.trials | integer | Required | At least 0. At most 9007199254740991. |
progress.admitted | integer | Required | At least 0. At most 9007199254740991. |
progress.settled | integer | Required | At least 0. At most 9007199254740991. |
summary | object or null | Required | — |
summary.cases | integer | Required in a non-null parent | At least 0. At most 9007199254740991. |
summary.passed | integer | Required in a non-null parent | At least 0. At most 9007199254740991. |
summary.flaky_passed | integer | Required in a non-null parent | At least 0. At most 9007199254740991. |
summary.failed | integer | Required in a non-null parent | At least 0. At most 9007199254740991. |
summary.errored | integer | Required in a non-null parent | At least 0. At most 9007199254740991. |
summary.invalid | integer | Required in a non-null parent | At least 0. At most 9007199254740991. |
summary.trials | integer | Required in a non-null parent | At least 0. At most 9007199254740991. |
summary.regressed | integer | Required in a non-null parent | At least 0. At most 9007199254740991. |
summary.fixed | integer | Required in a non-null parent | At least 0. At most 9007199254740991. |
summary.guard_events | integer | Required in a non-null parent | At least 0. At most 9007199254740991. |
baseline_test_run_id | string (uuid) or null | Required | pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$. |
judge_model | object or null | Required | — |
| judge_model · combined section 1 | object | — | Fields for this schema branch. |
judge_model.model_id | string | Required in a non-null parent | minLength: 1. pattern: \S. |
judge_model.provider | string | Required in a non-null parent | minLength: 1. pattern: \S. |
judge_model.tier | "frontier" · "cumulus-served" · "customer-gpu" | Required in a non-null parent | — |
cost | object | Required | — |
cost.estimated_usd | number | Required | At least 0. |
cost.measured_usd | number or null | Required | At least 0. |
created_by | object | Required | — |
| created_by · variant 1 | object | — | Fields for this schema branch. |
created_by.owner_id | string | Required | minLength: 1. |
created_by.environment | string | Required | minLength: 1. |
created_by.kind | "user" | Required | — |
created_by.id | string (uuid) | Required | pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$. |
| created_by · variant 2 | object | — | Fields for this schema branch. |
created_by.owner_id | string | Required | minLength: 1. |
created_by.environment | string | Required | minLength: 1. |
created_by.kind | "api_key" | Required | — |
created_by.id | string (uuid) | Required | pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$. |
| created_by · variant 3 | object | — | Fields for this schema branch. |
created_by.owner_id | string | Required | minLength: 1. |
created_by.environment | string | Required | minLength: 1. |
created_by.kind | "system" | Required | — |
created_by.id | string | Required | minLength: 1. maxLength: 256. |
created_at | string (date-time) | Required | pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:.\d+)?(?:Z))$. |
finished_at | string (date-time) or null | Required | pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:.\d+)?(?:Z))$. |
Error responses
| HTTP | Description |
|---|---|
| 4XX | Typed error (ApiError) |
| 5XX | Typed error (ApiError) |
Errors use the shared error envelope. Inspect error.code, retryable, outcome and details before retrying.
Complete OpenAPI schema
{
"200": {
"description": "Get a test run: state, verdict, progress, summary and cost",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TestRun"
}
}
}
},
"4XX": {
"description": "Typed error (ApiError)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"5XX": {
"description": "Typed error (ApiError)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
}
Referenced schemas
Expand the complete OpenAPI definitions for integrations that generate their own clients.
Complete OpenAPI schema
{
"components": {
"schemas": {
"TestRun": {
"type": "object",
"properties": {
"owner_id": {
"type": "string",
"minLength": 1
},
"environment": {
"type": "string",
"minLength": 1
},
"tenant_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$"
},
"test_run_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$"
},
"agent_id": {
"type": "string",
"minLength": 1,
"maxLength": 256,
"pattern": "^[A-Za-z0-9][A-Za-z0-9_.:-]*$"
},
"publication": {
"$ref": "#/components/schemas/PublicationRef"
},
"purpose": {
"type": "string",
"enum": [
"manual",
"publish_gate",
"schedule",
"release"
]
},
"suites": {
"minItems": 1,
"maxItems": 10,
"type": "array",
"items": {
"type": "object",
"properties": {
"suite_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$"
},
"revision": {
"type": "integer",
"minimum": 0,
"exclusiveMinimum": true,
"maximum": 2147483647
},
"digest": {
"type": "string",
"pattern": "^sha256:[a-f0-9]{64}$"
}
},
"required": [
"suite_id",
"revision",
"digest"
],
"additionalProperties": false
}
},
"state": {
"type": "string",
"enum": [
"queued",
"running",
"completed",
"cancelled"
]
},
"verdict": {
"nullable": true,
"type": "string",
"enum": [
"passed",
"failed",
"errored"
]
},
"progress": {
"type": "object",
"properties": {
"trials": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"admitted": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"settled": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"trials",
"admitted",
"settled"
],
"additionalProperties": false
},
"summary": {
"nullable": true,
"type": "object",
"properties": {
"cases": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"passed": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"flaky_passed": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"failed": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"errored": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"invalid": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"trials": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"regressed": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"fixed": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"guard_events": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"cases",
"passed",
"flaky_passed",
"failed",
"errored",
"invalid",
"trials",
"regressed",
"fixed",
"guard_events"
],
"additionalProperties": false
},
"baseline_test_run_id": {
"nullable": true,
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$"
},
"judge_model": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/ModelIdentity"
}
]
},
"cost": {
"type": "object",
"properties": {
"estimated_usd": {
"type": "number",
"minimum": 0
},
"measured_usd": {
"nullable": true,
"type": "number",
"minimum": 0
}
},
"required": [
"estimated_usd",
"measured_usd"
],
"additionalProperties": false
},
"created_by": {
"$ref": "#/components/schemas/PrincipalRef"
},
"created_at": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
},
"finished_at": {
"nullable": true,
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
}
},
"required": [
"owner_id",
"environment",
"tenant_id",
"test_run_id",
"agent_id",
"publication",
"purpose",
"suites",
"state",
"verdict",
"progress",
"summary",
"baseline_test_run_id",
"judge_model",
"cost",
"created_by",
"created_at",
"finished_at"
],
"additionalProperties": false
},
"PublicationRef": {
"type": "object",
"properties": {
"agent_id": {
"type": "string",
"minLength": 1,
"maxLength": 256,
"pattern": "^[A-Za-z0-9][A-Za-z0-9_.:-]*$"
},
"version": {
"type": "integer",
"minimum": 0,
"maximum": 2147483647
},
"digest": {
"type": "string",
"pattern": "^sha256:[a-f0-9]{64}$"
}
},
"required": [
"agent_id",
"version",
"digest"
],
"additionalProperties": false
},
"ModelIdentity": {
"type": "object",
"properties": {
"model_id": {
"type": "string",
"minLength": 1,
"pattern": "\\S"
},
"provider": {
"type": "string",
"minLength": 1,
"pattern": "\\S"
},
"tier": {
"type": "string",
"enum": [
"frontier",
"cumulus-served",
"customer-gpu"
]
}
},
"required": [
"model_id",
"provider",
"tier"
],
"additionalProperties": false
},
"PrincipalRef": {
"oneOf": [
{
"type": "object",
"properties": {
"owner_id": {
"type": "string",
"minLength": 1
},
"environment": {
"type": "string",
"minLength": 1
},
"kind": {
"type": "string",
"enum": [
"user"
]
},
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$"
}
},
"required": [
"owner_id",
"environment",
"kind",
"id"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"owner_id": {
"type": "string",
"minLength": 1
},
"environment": {
"type": "string",
"minLength": 1
},
"kind": {
"type": "string",
"enum": [
"api_key"
]
},
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$"
}
},
"required": [
"owner_id",
"environment",
"kind",
"id"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"owner_id": {
"type": "string",
"minLength": 1
},
"environment": {
"type": "string",
"minLength": 1
},
"kind": {
"type": "string",
"enum": [
"system"
]
},
"id": {
"type": "string",
"minLength": 1,
"maxLength": 256
}
},
"required": [
"owner_id",
"environment",
"kind",
"id"
],
"additionalProperties": false
}
]
},
"ApiError": {
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string",
"enum": [
"unauthenticated",
"forbidden",
"not_found",
"conflict",
"invalid_request",
"idempotency_conflict",
"policy_denied",
"capability_unavailable",
"provider_unavailable",
"knowledge_unavailable",
"publication_invalid",
"run_not_active",
"rate_limited",
"outcome_unknown",
"internal"
]
},
"message": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"outcome": {
"type": "string",
"enum": [
"none",
"unknown"
]
},
"details": {
"type": "object",
"additionalProperties": {}
}
},
"required": [
"code",
"message",
"retryable",
"outcome"
],
"additionalProperties": false
}
},
"required": [
"error"
],
"additionalProperties": false
}
}
}
}
Errors and recovery
See API error handling and Troubleshooting.