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

# Heartbeat • AI Agent SDK

> Heartbeat: Standalone heartbeat coordinator.

# Heartbeat

> Defined in the [**heartbeat**](https://praison.ai/docs/sdk/reference/praisonaiagents/modules/heartbeat.md) module.

AI Agent

Standalone heartbeat coordinator.

Runs an Agent on a schedule and delivers results via callback.
Does NOT add any params to the Agent class.

Usage::

```python theme={"theme":{"light":"vitesse-light","dark":"vitesse-dark"}}
from praisonaiagents import Agent, Heartbeat

agent = Agent(instructions="Monitor server health")
hb = Heartbeat(agent, schedule="hourly")
hb.start()
```

## Constructor

**agent** `Any` *required*

No description available.

**schedule** `str` (default: 'hourly')

No description available.

**prompt** `Optional[str]`

No description available.

**on\_result** `Optional[Callable]`

No description available.

**on\_error** `Union[str, Callable]` (default: 'retry')

No description available.

**max\_retries** `int` (default: 3)

No description available.

## Methods

> [card] [start()](https://praison.ai/docs/sdk/reference/praisonaiagents/functions/Heartbeat-start.md)
>
> Start the heartbeat loop.

> [card] [stop()](https://praison.ai/docs/sdk/reference/praisonaiagents/functions/Heartbeat-stop.md)
>
> Stop the heartbeat loop.

> [card] [is\_running()](https://praison.ai/docs/sdk/reference/praisonaiagents/functions/Heartbeat-is_running.md)
>
> Instance method.

## Source

> [card] [View on GitHub](https://github.com/MervinPraison/PraisonAI/blob/main/src/praisonai-agents/praisonaiagents/agent/heartbeat.py#L45)
>
> `praisonaiagents/agent/heartbeat.py` at line 45


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