> ## 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 Config • AI Agent SDK

> HeartbeatConfig: Configuration for Heartbeat scheduler.

# HeartbeatConfig

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

AI Agent

Configuration for Heartbeat scheduler.

Attributes:
schedule: Human-friendly schedule expression. Supports:

* Keywords: "hourly", "daily", "weekly"
* Intervals: "every 30m", "every 6h", "*/30m", "*/10s"
* Cron: "cron:0 7 \* \* \*"
* One-shot: "at:2026-03-01T09:00:00"
  prompt: Override prompt sent to agent each tick. None = use agent's default.
  on\_result: Callback receiving (result\_text: str). Default: log to stdout.
  on\_error: "retry" | "skip" | callable(error). Default: "retry".
  max\_retries: Max consecutive retries before skipping. Default: 3.

## Properties

**schedule** `str`

No description available.

**prompt** `Optional[str]`

No description available.

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

No description available.

**on\_error** `Union[str, Callable]`

No description available.

**max\_retries** `int`

No description available.

## Source

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

***

## Related Documentation

> [card] [Configuration Overview](https://praison.ai/docs/docs/configuration/index)

> [card] [Agent Config](https://praison.ai/docs/docs/configuration/agent-config)


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