Cancel input request

cancelInputRequest(command: RunsCancelInputRequestCommand!, idempotencyKey: String): RunsInputRequest!

Arguments

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

Input fields

command

RunsCancelInputRequestCommand

FieldTypeRequiredDescription
inputRequestIdID!YesInput request to cancel. A fresh cancellation of an already-resolved request returns 409; only an open request can be cancelled. Requires project.runs.write on the run’s project and, for a request in a conversation, editor access on that conversation. An authorized retry of the identical request with the same idempotency key returns its stored result.

Response

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

FieldTypeDescription
inputRequestIdID!Unique input request ID.
projectIdID!Project inherited from the run.
runIdID!Run waiting for this input.
titleString!Question or decision shown to the responder.
fields[JSON!]!Fields the responder can fill in.
statusString!Current resolution state.
requestedResponderTypeString!Required responder role; the authenticated actor identifies who actually responded.
responseJSONSubmitted response, or null before submission or after cancellation or expiry.

All fields of RunsInputRequest.

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

Example

graphql
mutation CancelInputRequest($command: RunsCancelInputRequestCommand!, $idempotencyKey: String) {
  cancelInputRequest(command: $command, idempotencyKey: $idempotencyKey) {
    projectId
    runId
    status
    createdAt
    conversationId
  }
}
json
{
  "command": {
    "inputRequestId": "00000000-0000-4000-8000-000000000001"
  }
}