Cancel task run
Cancel a running task run. Only valid when the run’s current status
is pending or running.
Authorizations
Most Arize AI endpoints require authentication. For those endpoints that require authentication, include your API key in the request header using the format
Path Parameters
The unique task run identifier (base64) A universally unique identifier (base64-encoded opaque string).
"RW50aXR5OjEyMzQ1"
Response
Returns a single task run object
A task run is an async job that executes the work defined on a task. Runs are
created by triggering an existing task (POST /v2/tasks/{task_id}/trigger).
For RUN_EXPERIMENT tasks, experiment_id is populated after the experiment
is provisioned; poll GET /v2/task-runs/{run_id} until status reaches a
terminal state.
The unique identifier for the task run.
The parent task identifier (base64).
Status of a task run.
- PENDING - The run has been created but not yet started.
- RUNNING - The run is currently in progress.
- COMPLETED - The run finished successfully.
- FAILED - The run encountered an error and stopped.
- CANCELLED - The run was cancelled before completion.
PENDING, RUNNING, COMPLETED, FAILED, CANCELLED When the run started processing.
When the run finished processing.
Start of the data window evaluated. Null for run_experiment runs.
End of the data window evaluated. Null for run_experiment runs.
Number of successfully evaluated items.
Number of items that errored during evaluation.
Number of items that were skipped.
When the run was created.
The unique identifier for the user who triggered the run.
Created experiment identifier (base64). Present only for RUN_EXPERIMENT
task runs; null for all other task types.
Human-readable explanation of why the run failed or was cancelled;
null for successful runs. For example, when all matching data already
has evaluation labels from a previous run, the task cancels with zero
successes, errors, and skipped items, and this field explains that the
task must be re-triggered with override_evaluations enabled to
re-evaluate it.