Skip to navigation
Simulation Runs

Cancel Simulation Run Item

Cancels the specified run item.

Authentication

AuthorizationBearer

Authenticate server-side requests with a private Vapi API key. Create or copy a key from the Vapi Dashboard and send it in the Authorization header as Bearer <token>. Keep private API keys out of client-side code and public repositories.

Path parameters

idstringRequired
The unique identifier of the simulation run.
itemIdstringRequired
The unique identifier of the run item.

Response

idstringformat: "uuid"
This is the unique identifier for the simulation run item.
orgIdstringformat: "uuid"
This is the unique identifier for the organization.
simulationIdstringformat: "uuid"
This is the ID of the simulation this run belongs to.
statusenum
The run item's current status.
queuedAtdatetime

This is the ISO 8601 date-time string of when the run was queued.

createdAtdatetime

This is the ISO 8601 date-time string of when the run item was created.

updatedAtdatetime

This is the ISO 8601 date-time string of when the run item was last updated.

startedAtdatetimeOptional

This is the ISO 8601 date-time string of when the run started.

completedAtdatetimeOptional

This is the ISO 8601 date-time string of when the run completed.

failedAtdatetimeOptional

This is the ISO 8601 date-time string of when the run failed.

canceledAtdatetimeOptional

This is the ISO 8601 date-time string of when the run was canceled.

failureReasonstringOptional<=2000 characters
Why the run item failed, when applicable.
callIdstringOptionalformat: "uuid"
The ID of the call that ran this item.
runIdstringOptionalformat: "uuid"

This is the ID of the parent run (batch/group).

hookslist of objectsOptional
Hooks configured for this simulation run item
iterationNumberdoubleOptionalDefaults to 1
Which iteration of the simulation this item represents.
sessionIdstringOptionalformat: "uuid"

This is the session ID for chat-based simulations (webchat transport).

scenarioIdstringOptionalformat: "uuid"
The ID of the scenario used for this run item.
personalityIdstringOptionalformat: "uuid"
The ID of the personality used for this run item.
metadataobjectOptional
This is the metadata containing snapshots and call data.
resultsobjectOptional
The evaluation results for this run item.
improvementSuggestionsobjectOptional

AI-generated suggestions for improving the assistant or squad’s system prompt, tools, and scenarios after a failed run.

configurationsobjectOptional
This is the configuration for how this simulation run executes.