Delete run

deleteRun(command: RunsDeleteRunCommand!): Acknowledgement!

Requires project.runs.admin; API keys also need delete scope.

Arguments

ArgumentTypeRequired
commandRunsDeleteRunCommand!Yes

Input fields

command

RunsDeleteRunCommand

FieldTypeRequiredDescription
runIdID!YesRun to delete. Must be completed, failed or cancelled, with execution stopped, no direct children, and no active parent; otherwise deletion returns 409. Conversation-owned runs also require admin access on the conversation. Run-scoped credentials cannot delete runs. Deleting a run also deletes its events and owned input requests; referenced artifact files are retained.

Response

Returns Acknowledgement!. Open the type for its fields and nested types.

FieldTypeDescription
okBoolean!Always true.

Types marked with ! cannot be null. Lists use [Type] notation. The type index lists all published input and response types.

Example

graphql
mutation DeleteRun($command: RunsDeleteRunCommand!) {
  deleteRun(command: $command) {
    ok
  }
}
json
{
  "command": {
    "runId": "11111111-1111-4111-8111-111111111111"
  }
}