Docs

Authentication

Every write endpoint requires Authorization: Bearer. Keys are hashed at rest and rejected in the query string. Coding agents must not ask a human to paste a key — run relaypdf setup (or relaypdf login) and wait for browser approval.

Every POST /v1/* write operation requires Authorization: Bearer pdf_live_… (or a local development key). GET /health is public. GET /v1/files/:id is a time-limited public download and does not use a key.

Header

Send the raw key. Do not put it in the URL.

• Query-string keys are rejected
• Only a SHA-256 hash is stored; the plaintext is shown once at creation
• Revoke unused keys on /dashboard/keys

Authorization

Authorization: Bearer pdf_live_...

Create a key

Dashboard → API keys. For agents and CI, run relaypdf setup (or relaypdf login) and approve the device in the browser instead of pasting a secret into chat.

CLI

npx @relaypdf/cli setup

Where credentials live

The CLI writes ~/.config/relaypdf/credentials.json with mode 0600 and never prints the key. setup can also write RELAYPDF_API_KEY into an env file.

Docs hub →Node.js SDK →Playground →