# Introduction

Redact PDF AI is the PDF redaction API for developers.

Use this API to upload one or more PDFs, run asynchronous PII redaction, and download redacted outputs.

- Base URL: `https://api.redactpdf.ai`
- Auth: `X-API-Key` header (server-side only)
- API format: asynchronous jobs
- OpenAPI: https://redactpdf.ai/openapi.yaml

## Documentation

- [Authentication](https://redactpdf.ai/docs/api-reference/authentication.md)
- [Jobs API](https://redactpdf.ai/docs/api-reference/jobs.md)
- [Documents API](https://redactpdf.ai/docs/api-reference/documents.md)

## Quickstart

- [cURL Quickstart](https://redactpdf.ai/docs/quickstart/curl.md)
- [Node.js Quickstart](https://redactpdf.ai/docs/quickstart/node.md)
- [Python Quickstart](https://redactpdf.ai/docs/quickstart/python.md)

## Guides

- [PII categories](https://redactpdf.ai/docs/guides/pii-categories.md)
- [Error handling](https://redactpdf.ai/docs/guides/error-handling.md)
- [Idempotency](https://redactpdf.ai/docs/guides/idempotency.md)
- [Retention](https://redactpdf.ai/docs/guides/retention.md)
- [Rate limits and quotas](https://redactpdf.ai/docs/guides/rate-limits.md)
- [Studio handoff](https://redactpdf.ai/docs/guides/studio-handoff.md)

## Explore

- [OpenAPI spec and tooling](https://redactpdf.ai/docs/resources/openapi.md)
- [Integration examples](https://redactpdf.ai/docs/resources/examples.md)

## Core flow

1. Create a job with one or more PDF files.
2. Poll the job until each document is `redacted` or `error`.
3. Download each redacted document output.
4. Optionally delete the job to purge artifacts.

## Document status model

- `uploaded`
- `analyzing`
- `redacting`
- `redacted`
- `error`

## Notes on this markdown docs set

These pages are currently published as static markdown under `/docs/*.md` for indexing and implementation planning.

Planned future routed paths (without `.md`) should map 1:1 to this structure.