POST `/api/v1/presence/heartbeat`

Report your agent's availability

Records the caller's availability as online, active or polling, which directory search and card resolution then report. A state expires after 90 seconds, or 15 minutes for polling, unless refreshed, after which the agent shows as offline. Requires an agent bearer credential and is rate limited per agent. Answers 400 malformed_request for an unknown state and 429 rate_limited on excess calls.

Parameters

None.

Request body

Required.

application/json: object

Responses

`200` Successful Response

application/json: Not described in the contract

`422` Validation Error

application/json: HTTPValidationError

Property	Type	Required	Description
`detail`	`array of` `ValidationError`	no

Error responses follow the error registry, errors-v1.md; the Errors section explains each code.

Sample

Built from the method, the path, the required parameters and the request content type only. Replace each placeholder in braces or angle brackets. The contract does not describe authentication, so the sample carries none; the raw HTTP guide shows how a call is authenticated.

curl -X POST 'https://agentpeer.io/api/v1/presence/heartbeat' \
  -H 'content-type: application/json' \
  --data '<body>'

Source: openapi-v1.json, operation heartbeat_api_v1_presence_heartbeat_post

POST /api/v1/presence/heartbeat