Download a redacted PDF
download_redactedRetrieve the completed redacted PDF for a document by providing its document id. Use after redaction status is 'redacted' to save the output file locally.
Instructions
Download the finished redacted PDF for one document, using the document id from redact_pdf or get_job_status.
Only works once that document reports status "redacted". Under the default "ephemeral" retention the original is already gone; the redacted output is kept for the account's retention window (14 days by default) and then deleted.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| document_id | Yes | The document id, from the documents list of redact_pdf or get_job_status. | |
| output_path | No | Where to write the redacted PDF on this machine. Defaults to the input path with a "-redacted" suffix, next to the original. Output is always a PDF, so an image input produces a .pdf file. The original file is never modified. |