Pause run

pauseRun(command: RunsPauseRunCommand!, idempotencyKey: String): RunsRun!

Requires project.runs.write.

Arguments

ArgumentTypeRequiredDescription
commandRunsPauseRunCommand!Yes
idempotencyKeyStringNoRetry key for this mutation (1-128 characters); overrides Idempotency-Key.

Input fields

command

RunsPauseRunCommand

FieldTypeRequiredDescription
runIdID!YesRun to pause. Conversation-owned runs also require editor access on the conversation. Requests a safe-boundary pause. A fresh pause request for a running agent without project-bound dispatch stop authority returns 409 RUN_NOT_PAUSABLE. An authorized retry of the identical request with the same idempotency key returns its stored result.

Response

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

FieldTypeDescription
idID!Unique run UUID.
runIdID!Public run ID that run events (metadata.run_id) and runtime tools name. Equals id for runs the server names; older runs keep their run_ ID.
statusString!Current execution state.
projectIdID!Project containing the run.
targetRunsRunTarget!Execution definition; its ID may be null only on historical runs.
inputJSONBusiness input supplied when the run was created.
outputJSONFinal business output; null until successful finalization.
errorRunsRunErrorFailure details, present only when the run failed.

All fields of RunsRun.

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

Example

graphql
mutation PauseRun($command: RunsPauseRunCommand!, $idempotencyKey: String) {
  pauseRun(command: $command, idempotencyKey: $idempotencyKey) {
    id
    projectId
    runId
    status
    createdAt
  }
}
json
{
  "command": {
    "runId": "11111111-1111-4111-8111-111111111111"
  }
}