> ## 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.

# Is Idle • AI Agent SDK

> is_idle: API reference for ScaleToZeroPolicy.is_idle

# is\_idle

Method

> This is a method of the [**ScaleToZeroPolicy**](https://praison.ai/docs/sdk/reference/praisonaiagents/classes/ScaleToZeroPolicy.md) class in the [**protocols**](https://praison.ai/docs/sdk/reference/praisonaiagents/modules/protocols.md) module.

## Signature

```python theme={"theme":{"light":"vitesse-light","dark":"vitesse-dark"}}
def is_idle() -> IdleDecision
```

### Returns

**Returns** `IdleDecision`

The result of the operation.

## Uses

* `IdleDecision`

## Source

> [card] [View on GitHub](https://github.com/MervinPraison/PraisonAI/blob/main/src/praisonai-agents/praisonaiagents/gateway/protocols.py#L4240)
>
> `praisonaiagents/gateway/protocols.py` at line 4240


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