# HeimPulse API

> Programmatic access to HeimPulse: manage monitored services, create and resolve incidents, and
> list available check regions. Authenticate every request with an org-scoped API key
> (`Authorization: Bearer hpk_...`), minted from the dashboard's Settings > API keys page.

## Docs

- [Getting started](https://docs.heimpulse.com/guides/getting-started/): authenticate and make your first call
- [Authentication and scopes](https://docs.heimpulse.com/guides/authentication/): key format, read_only vs read_write, what a key can't do
- [Rate limits and errors](https://docs.heimpulse.com/guides/rate-limits-and-errors/): 20-burst/5-per-second-per-key limit, the error response shape
- [Incidents](https://docs.heimpulse.com/guides/incidents/): the real create/update field shape (documented as opaque JSON in the spec itself)
- [API keys vs. webhooks](https://docs.heimpulse.com/guides/api-keys-vs-webhooks/): two different, complementary mechanisms

## API

- [OpenAPI spec](https://docs.heimpulse.com/openapi.json): machine-readable, generated straight from the real /v1 handlers - never hand-written
- [API reference](https://docs.heimpulse.com/reference.html): interactive reference UI (Scalar)

## Optional

- [llms-full.txt](https://docs.heimpulse.com/llms-full.txt): every guide's full text, plus the endpoint list, concatenated into one file