Skip to main content

API

AI Smart Redact exposes two HTTP APIs that target different integration models.

  • Manager API — the lower-level interface. Exposes file management, detection, and redaction as separate endpoints, leaving the surrounding workflow (queueing, status tracking, access control) to the integrator. Use the Manager API to embed AI Smart Redact directly into an existing backend.
  • Orchestrator API — the higher-level interface. Each upload becomes a managed job that runs detection automatically, waits for review, runs redaction, and stores the redacted PDF for download. Authentication, request queueing, and access control are built in. Use the Orchestrator API for end-to-end workflows that benefit from these conveniences.

For a component diagram showing how these APIs connect to the Worker, databases, and file storage, refer to Architecture.