Developer docs

Studio handoff

Hybrid API plus manual review workflow.

Studio Handoff

Studio handoff is the hybrid flow where API-created jobs are reviewed in the web Studio.

When to use it

Use Studio handoff if you need a human-in-the-loop step before delivery.

Typical cases:

  • legal document review
  • complex OCR layouts
  • strict compliance QA workflows

How to enable

Set retention=studio when creating the job.

curl -sS -X POST "https://api.redactpdf.ai/v1/jobs" \
  -H "X-API-Key: YOUR_API_KEY" \
  -F 'files=@/absolute/path/dossier.pdf;type=application/pdf' \
  -F 'retention=studio'

Current status

  • Retention mode is supported in the API contract.
  • Deep-link return payloads for direct Studio navigation are planned.

Recommended implementation pattern

  1. Submit jobs via API.
  2. Poll until documents reach terminal states.
  3. Route flagged or high-risk documents into Studio review.
  4. Publish approved redacted outputs to your downstream system.