Responses are generated using AI and may contain mistakes.
Bland is getting a major upgrade. We're working on updating our docs as users transition in the coming weeks. Reach out to support@bland.ai with questions.
{ "data": null, "errors": [ { "error": "CONFLICT", "message": "Check run is not in a cancellable state" } ]}
{ "data": null, "errors": [ { "error": "NOT_FOUND", "message": "Check run not found" } ]}
Overview
Marks a PENDING or RUNNING run CANCELLED and stops its scoring work. A cancelled run never produces a final verdict, and cancelling frees the environment so a new run can be started with Start Check Run. Returns 409 CONFLICT when the run is already PASSED, FAILED, ERROR, or CANCELLED. Cancelling never changes an environment pointer.Requires an admin, owner, operator, or prompter role. This endpoint takes no body.
Headers
string
required
Your API key for authentication.
Path Parameters
string
required
The agent’s unique identifier.
string
required
The check run’s unique identifier.
Response
object
The cancelled run, with status set to CANCELLED and completed_at set to the cancellation time.
Show check run object
string
Unique identifier for the check run.
string
The agent the run belongs to.
string
The environment whose checks were run: staging or production.
string
The candidate version the run was scoring.
string | null
The candidate’s published version number, or null if it has never been published.
string | null
The candidate’s saved name, or null if it has none.
string
Always CANCELLED on success.
array
Display names of the judges frozen into the run when it started.
integer
Number of scenarios the run was driving conversations from.
integer
Conversations generated per scenario.
boolean | null
null for a cancelled run.
array | null
null for a cancelled run. See Get Check Run for the verdict object.
string | null
ID of the generated conversation set, if generation had started.
string | null
ID of the scoring run, if scoring had started.
string | null
null unless the run had already hit an error.
string | null
ID of the user who started the run. With an API key, this is the user the key belongs to. null when no user was recorded.
string
ISO 8601 timestamp the run was created.
string | null
When scoring began, or null if the run was cancelled while PENDING.
string | null
The cancellation time.
null | array
null on success, or a list of error objects if the request failed.