> ## Documentation Index
> Fetch the complete documentation index at: https://docs.revoengine.com/llms.txt
> Use this file to discover all available pages before exploring further.

# agent.cancelRun()

> Public low-code contract, signatures and examples for agent.cancelRun.

## `agent.cancelRun()`

Cancels a run, optionally recording a reason.

Notes:

* Unavailable with `readOnly: true` (throws an error).

### Signature

```ts theme={null}
static cancelRun(
      agentRunId: string,
      data?: AgentRunCancelInput,
    ): Promise<AgentRun>;
```

### Example

```ts theme={null}
const run = await agent.cancelRun(agentRunId, { reason: 'Operator stop' });
```

See [all agent methods](https://docs.revoengine.com/low-code/reference/agent.md) or [runtime basics](https://docs.revoengine.com/low-code/overview.md).


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.