Developer docs

Authentication

How to authenticate with the Redact PDF AI API: send your key in the X-API-Key header from server-side code, rotate it safely and never expose it in a browser.

Authentication

All API requests require an API key sent in the X-API-Key header.

  • Header name: X-API-Key
  • Scope: server-to-server only
  • Base URL: https://www.redact-pdf.ai

Validate your key

Endpoint:

  • GET /v1/me

Example:

curl -sS -X GET "https://www.redact-pdf.ai/v1/me" \
  -H "X-API-Key: YOUR_API_KEY"

Example response:

{
  "user_id": "user_123",
  "email": "you@company.com"
}

Live and test keys

Create keys in Settings → API keys. Pick Live or Test when you create one.

Live (rdp_live_…)Test (rdp_test_…)
Pages processedthe whole documentthe first page only
Outputredacted PDFredacted PDF with a visible TEST watermark (the text version, table and entities of page 1 are not watermarked)
Quotapages counted against your plan or creditsnever counted
File size50 MB PDF, 10 MB image5 MB
Seesevery job of the accountonly sandbox jobs (created with any test key of the account)
Limitsrate limitrate limit, plus 100 sandbox files per rolling 24 hours (a retried request with the same X-Idempotency-Key counts once)

Everything else is the same API: POST /v1/jobs (and POST /v1/uploads/{upload_id}/jobs), detect_only, GET /v1/jobs/{job_id}, entities, downloads, links and webhooks answer exactly as they do for live jobs, so a test key exercises your whole integration. Jobs show "sandbox": true. Direct uploads (POST /v1/jobs/init) are refused for test keys: send the file to POST /v1/jobs.

A test key never sees a real document, so it is safe to put in CI. Both kinds share the account's per-minute rate limit. Each key's last use, and its documents and pages counted over the last 30 days, are shown in the dashboard. Sandbox outputs are never credit-gated, and stay watermarked if re-rendered in the Studio.

Unauthorized response

{
  "error": "Unauthorized",
  "code": "unauthorized",
  "request_id": "req_abc123"
}

Security recommendations

  • Keep API keys in server environment variables.
  • Use separate keys per environment (dev, staging, prod).
  • Rotate keys on a schedule and immediately after suspected leaks.
  • Never include API keys in browser JS, mobile apps, or public repos.

Related pages