Developer docs

Account and demo

Check an API key with GET /v1/me, and try redaction with no key: the keyless demo redacts the first page of your own PDF, JPEG or PNG and returns what it found.

Account and demo endpoints

Check an API key, and try the redaction engine without one.

GET /v1/me

Validate an API key and return basic account info. Call it at startup or before a large batch, so a bad key fails fast instead of after an upload.

curl -sS "https://www.redact-pdf.ai/v1/me" \
  -H "X-API-Key: YOUR_API_KEY"
{
  "user_id": "user_123",
  "email": "you@example.com"
}
  • 200: the key is valid
  • 401: missing or invalid key

Keyless demo

These endpoints need no API key. They are rate limited per IP address.

GET /v1/demo

Describes a real redaction of a built-in sample document full of synthetic personal data: the categories found, an example of each, and a link to the redacted PDF. No upload, and no user data involved. A quick connectivity check.

curl -sS "https://www.redact-pdf.ai/v1/demo"

GET /v1/demo/sample.pdf

The redacted sample as a PDF.

POST /v1/demo/redact

Redacts the first page of your own PDF, JPEG or PNG (5 MB max) and returns what was found on it by category, plus a link to the redacted page, valid for 14 days. The original is deleted after processing.

curl -sS -X POST "https://www.redact-pdf.ai/v1/demo/redact" \
  -F "file=@contract.pdf"

Optional form fields, as on POST /v1/jobs: pii_categories, pii_included_terms, pii_excluded_terms and mode (redact or pseudonymize; in pseudonymize mode the response lists the tags drawn on the page).

StatusMeaning
200First page redacted
400Unsupported file type, unknown or empty pii_categories, or a first page that can't be read
413File over 5 MB
429Demo rate limit for your IP address
503Temporarily unavailable; retry after the Retry-After seconds

For whole documents, create an API key and use POST /v1/jobs. A free account gets its first document (up to 5 pages) redacted in full, with no card.

Related pages