Manager API

The Manager API is the lower-level interface to AI Smart Redact. It exposes file management, detection, and redaction as separate endpoints, without an enclosing workflow layer. The alternative is the Orchestrator API, which wraps these operations in a higher-level Jobs interface with built-in authentication, request queueing, and result tracking. Use the Manager API directly to integrate AI Smart Redact into an existing backend that handles these concerns itself.

Authentication

The Manager API doesn’t enforce per-request authentication. It’s intended to run inside a trusted environment, typically behind a reverse proxy or a private network. When integrating directly with the Manager instead of going through the Orchestrator, you’re responsible for placing the service behind appropriate authentication and authorization.

API versioning

All Manager API endpoints are prefixed with /v1.

Error responses

When a request fails, the response body is an ApiErrorResponse. Per-endpoint pages list the status codes each endpoint returns; the body shape is the same in all cases.

Field	Type	Description
type	string	URI identifier for the error type.
title	string	Short summary of the error.
status	integer	HTTP status code.
traceId	string	Correlation ID for the request, useful for support and log lookup.
detail	string	Description of the error.
errors	object of string arrays	Field-level validation errors, keyed by field name.

Reference pages

📄️ Files

Manager API endpoints for uploading, downloading, listing, and deleting files in AI Smart Redact.

📄️ Detection

Manager API endpoints for running sensitive-entity detection on a PDF and retrieving the result.

📄️ Redaction

Manager API endpoints for redacting sensitive entities from a PDF and retrieving the redacted result.