Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.blinkpdf.io/llms.txt

Use this file to discover all available pages before exploring further.

The /v1/health endpoint tells you whether the Blink PDF API is reachable and operational. It requires no authentication, returns a minimal JSON body, and never counts toward your rate limit or render quota. Use it for uptime monitoring, readiness probes in containerised deployments, or a quick sanity check before your integration goes live.
GET https://api.blinkpdf.io/v1/health

Authentication

No authentication is required for this endpoint. You do not need to include an Authorization header.

Response — 200 OK

status
string
The current status of the API. A value of "ok" means the service is available and accepting requests.

Example Response

{ "status": "ok" }

Example Request

curl https://api.blinkpdf.io/v1/health

Wire this endpoint into your monitoring or deployment pipeline. Because it requires no auth and costs nothing, you can poll it as frequently as you like to confirm the API is up before routing traffic to your integration.
GET /v1/health never counts toward your plan’s rate limit or render quota, regardless of how often you call it.