paperclip_invoke_heartbeat
Trigger an immediate heartbeat run for a specified agent to process urgent tasks without waiting for the next scheduled heartbeat.
Instructions
Manually trigger an on-demand heartbeat run for an agent.
Args:
agentId: string — Agent UUID (example: "agt_abc123")
Returns: Returns the created heartbeat run record: runId, agentId, status, startedAt.
Examples:
Use when: waking an agent to process an urgent task without waiting for its next scheduled heartbeat
Don't use when: the agent has heartbeat disabled or wakeOnDemand:false — update config with paperclip_update_agent first
Error Handling:
401: authentication failed → check PAPERCLIP_API_KEY
404: agent not found → verify ID with paperclip_list_agents
409: agent is already running a heartbeat → wait for it to finish
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| agentId | Yes | Agent UUID |