Skip to main content
PATCH
/
runs
/
{run_id}
curl --request PATCH \
  --url https://api.coval.dev/v1/runs/{run_id} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "tags": [
    "baseline",
    "production"
  ]
}
'
{
  "run": {
    "name": "runs/abc123xyz789",
    "run_id": "8EktrIgaVxn9LfxkIynagX",
    "status": "COMPLETED",
    "create_time": "2025-10-14T12:00:00Z",
    "display_name": "Nightly regression – checkout flow",
    "update_time": "2025-10-14T12:15:00Z",
    "agent_id": "gk3jK9mPq2xRt5vW8yZaBc",
    "persona_id": "hL4kL0nQr3ySt6vX9zAcDd",
    "test_set_id": "aB1cD2eF",
    "tags": [
      "regression",
      "v2.1"
    ],
    "progress": {
      "total_test_cases": 10,
      "completed_test_cases": 8,
      "failed_test_cases": 1,
      "in_progress_test_cases": 1
    },
    "results": {
      "output_ids": [
        "sim_output_abc123",
        "sim_output_def456"
      ],
      "metrics": {
        "availability": {
          "mean": 0.95,
          "min": 0.85,
          "max": 1
        }
      }
    },
    "metadata": {
      "campaign_id": "q4_2025",
      "environment": "production"
    },
    "error": "Agent connection timeout"
  }
}
{
"error": {
"code": "INVALID_ARGUMENT",
"message": "Request validation failed",
"details": [
{
"field": "iteration_count",
"description": "Value must be between 1 and 10"
}
]
}
}
{
"error": {
"code": "UNAUTHENTICATED",
"message": "Invalid or missing API key",
"details": [
{
"field": "X-API-Key",
"description": "API key is required in the X-API-Key header"
}
]
}
}
{
"error": {
"code": "PERMISSION_DENIED",
"message": "Access denied",
"details": [
{
"description": "Your organization does not have access to this resource"
}
]
}
}
{
"error": {
"code": "NOT_FOUND",
"message": "Run not found",
"details": [
{
"field": "run_id",
"description": "Run 'abc123xyz789' does not exist or is not accessible by your organization"
}
]
}
}
{
"error": {
"code": "INTERNAL",
"message": "Internal server error",
"details": [
{
"description": "An unexpected error occurred. Please contact support."
}
]
}
}

Authorizations

X-API-Key
string
header
required

API key for authentication

Path Parameters

run_id
string
required

Unique identifier for the run

Required string length: 22

Body

application/json
tags
string[]
required

Full replacement list of run tags. Duplicate tags are automatically removed. Leading/trailing whitespace is stripped. Provide an empty list to clear all tags.

Maximum array length: 20
Maximum string length: 200
Example:
["baseline", "production"]

Response

Run updated successfully

run
object
required