> ## Documentation Index > Fetch the complete documentation index at: https://lightsage.com/docs/llms.txt > Use this file to discover all available pages before exploring further. # Cancel an eval run > Marks an active eval run as cancelled and prevents queued attempts from starting. Running sandbox attempts are stopped asynchronously. Requests already sent to an external provider cannot be recalled, but any later response does not change the run from cancelled. Repeating this request for an already-cancelled run is safe. ## OpenAPI ````yaml /openapi.json post /v2/eval-runs/{run_id}/cancel openapi: 3.1.0 info: title: Lightsage Public API description: Public API for Lightsage CLI and external integrations. version: 1.0.0 servers: - url: https://api.lightsage.com description: Production security: [] tags: - name: Status description: Check API availability and validate the calling API key. - name: Visibility description: >- Measure visibility, citations, competitors, and prompt performance across answer platforms. - name: Prompts description: Manage tracked prompts and topics, and inspect their stored runs. - name: Opportunities description: Review ranked opportunities computed from prompt visibility results. - name: Tasks description: Manage the persisted action queue and task lifecycle. - name: Site Audits description: Review website audit results and page-level findings. - name: Evals description: Define eval tasks, judges, subjects, and saved configurations. - name: Eval Templates description: >- Select reusable judges, targets, schedules, metadata, and runtime settings with `POST /v2/eval-templates`, then copy only those settings into prompt-specific evals with `POST /v2/evals/batch`. Templates never contain prompts and remain independent from evals created from them. - name: Eval Runs description: Start eval runs and inspect their lifecycle state. - name: Eval Results description: Review completed eval outcomes and diagnostic details. - name: Agent Preference description: >- Compare your company head-to-head with a tracked competitor. Create a comparison with `POST /v2/agent-preference/evals`, run it with `POST /v2/eval-runs`, then read which company agents recommended. - name: Agents description: List runnable coding-agent harness and model combinations. - name: Repositories description: Manage reusable Git repository workspaces. - name: Environments description: List reusable runtime environments without exposing secret values. - name: MCP Servers description: List reusable MCP server integrations without exposing credentials. - name: CLIs description: List reusable command-line interfaces without exposing setup commands. - name: Skills description: List reusable skills available to workflows and evals. paths: /v2/eval-runs/{run_id}/cancel: post: tags: - Eval Runs summary: Cancel an eval run description: >- Marks an active eval run as cancelled and prevents queued attempts from starting. Running sandbox attempts are stopped asynchronously. Requests already sent to an external provider cannot be recalled, but any later response does not change the run from cancelled. Repeating this request for an already-cancelled run is safe. operationId: v2_eval_runs_cancel parameters: - name: run_id in: path required: true schema: type: string title: Run Id responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/V2EvalRun' '404': description: >- Eval run not found. Use the run ID returned when you started the eval. content: application/json: schema: type: object properties: detail: type: string required: - detail example: detail: >- Eval run not found. Use the run ID returned when you started the eval. '409': description: The eval run has already completed or failed. content: application/json: schema: type: object properties: detail: type: string required: - detail example: detail: Eval run cannot be cancelled after it has completed or failed. '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' '503': description: Eval run cancellation is temporarily unavailable. content: application/json: schema: type: object properties: detail: type: string required: - detail example: detail: Eval run cancellation is temporarily unavailable. Try again. security: - LightsageApiKeyAuth: [] components: schemas: V2EvalRun: properties: id: type: string title: Id description: Run ID to use when polling eval-run status. job_id: type: string title: Job Id description: Alias of `id` for the durable parent job. eval_id: anyOf: - type: string - type: 'null' title: Eval Id description: Saved eval definition ID, including one created by a direct run. eval_name: anyOf: - type: string - type: 'null' title: Eval Name description: Display name captured for the eval when the run was created. configuration_id: anyOf: - type: string - type: 'null' title: Configuration Id persona: anyOf: - type: string - type: 'null' title: Persona description: Perspective applied to every attempt in this simulation. agent: items: type: string type: array title: Agent description: Runnable agents selected for this simulation. prompt_count: type: integer minimum: 1 title: Prompt Count description: Number of prompts included in the simulation. default: 1 runs: type: integer minimum: 1 title: Runs description: Independent attempts requested for every prompt-agent pair. default: 1 attempt_count: type: integer minimum: 1 title: Attempt Count description: Total concrete attempts after all fan-out dimensions. default: 1 status: type: string title: Status description: >- Terminal values: `completed`, `failed`, and `cancelled`. Recoverable interruptions are reported as `running` with stage `retrying`. stage: anyOf: - type: string - type: 'null' title: Stage dispatch_id: anyOf: - type: string - type: 'null' title: Dispatch Id progress: $ref: '#/components/schemas/PublicEvalRunProgress' estimated_cost: anyOf: - type: number - type: 'null' title: Estimated Cost error: anyOf: - type: string - type: 'null' title: Error created_at: anyOf: - type: string - type: 'null' title: Created At started_at: anyOf: - type: string - type: 'null' title: Started At completed_at: anyOf: - type: string - type: 'null' title: Completed At type: object required: - id - job_id - status title: V2EvalRun HTTPValidationError: properties: detail: items: $ref: '#/components/schemas/ValidationError' type: array title: Detail type: object title: HTTPValidationError PublicEvalRunProgress: properties: total: type: integer title: Total default: 0 queued: type: integer title: Queued default: 0 running: type: integer title: Running default: 0 completed: type: integer title: Completed default: 0 failed: type: integer title: Failed default: 0 cancelled: type: integer title: Cancelled default: 0 retrying: type: integer title: Retrying description: >- Recoverable child jobs waiting to be retried. These remain active and are excluded from `percent`. default: 0 interrupted: type: integer title: Interrupted description: Deprecated compatibility alias for `retrying`; use `retrying`. default: 0 deprecated: true percent: type: number title: Percent description: >- The percentage of child jobs in a final state (`completed`, `failed`, or `cancelled`). It can reach `100` while the parent job is still summarizing, so use `status` to detect completion. default: 0 type: object title: PublicEvalRunProgress ValidationError: properties: loc: items: anyOf: - type: string - type: integer type: array title: Location msg: type: string title: Message type: type: string title: Error Type input: title: Input ctx: type: object title: Context type: object required: - loc - msg - type title: ValidationError securitySchemes: LightsageApiKeyAuth: type: apiKey in: header name: X-Lightsage-Api-Key ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.