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

# cancelled • AI Agent SDK

> cancelled: Create a cancelled outcome.

# cancelled

<div className="flex items-center gap-2">
  <Badge color="purple">Method</Badge>
</div>

> This is a method of the [**AgentRunOutcome**](../classes/AgentRunOutcome) class in the [**run\_outcome**](../modules/run_outcome) module.

Create a cancelled outcome.

## Signature

```python theme={"theme":{"light":"vitesse-light","dark":"vitesse-dark"}}
def cancelled(error: str, elapsed_s: float, agent_name: Optional[str], run_id: Optional[str], context: Optional[Dict[str, Any]]) -> 'AgentRunOutcome'
```

## Parameters

<ParamField query="error" type="str" required={false} default="'Operation was cancelled'">
  No description available.
</ParamField>

<ParamField query="elapsed_s" type="float" required={false} default="0.0">
  No description available.
</ParamField>

<ParamField query="agent_name" type="Optional[str]" required={false}>
  No description available.
</ParamField>

<ParamField query="run_id" type="Optional[str]" required={false}>
  No description available.
</ParamField>

<ParamField query="context" type="Optional" required={false}>
  No description available.
</ParamField>

### Returns

<ResponseField name="Returns" type="'AgentRunOutcome'">
  The result of the operation.
</ResponseField>

## Uses

* `cls`

## Source

<Card title="View on GitHub" icon="github" href="https://github.com/MervinPraison/PraisonAI/blob/main/src/praisonai-agents/praisonaiagents/run_outcome.py#L235">
  `praisonaiagents/run_outcome.py` at line 235
</Card>