# API reference

Source: https://getuptimely.com/docs/api-reference

> The interactive reference for every /v1 operation, generated from the same schemas the API validates with.

This reference is generated from Uptimely's committed OpenAPI 3.1 document —
the exact schemas the server enforces, so it cannot drift from the API.

* Base URL: `https://app.getuptimely.com/v1`
* Auth: `Authorization: Bearer <project API key>` — created under
  **Settings → API Keys → Public API keys**
* Machine-readable spec: [/docs/api/openapi.json](/api/openapi.json)
* Error vocabulary: [problem+json codes](/api/problems/validation-failed)
  with a docs page per code

Pick an operation from the sidebar. Each page shows the request and response
schemas, per-field constraints, and ready-to-paste code samples.

New to the API? Start with the [API overview](/api) for authentication,
rate limits, idempotency and the TypeScript SDK.
