---
title: "Download a file"
method: POST
path: "/api/ManualRedaction/{manualRedactionProjectId}/files/{manualRedactionFileId}/download"
tags: ["Guided Redaction Management"]
---

# Download a file

`POST /api/ManualRedaction/{manualRedactionProjectId}/files/{manualRedactionFileId}/download`

Downloads the specified file from the manual redaction project. The downloaded file is redacted based on the provided output options. If no options provided, system defaults are used.

## Path parameters

- `manualRedactionProjectId` string, required
- `manualRedactionFileId` string, required

## Request body

- ManualRedactionOutputOptions — Output options for the generated PDF generated via a guided redaction, controlling reference codes, watermarks, and page numbers.
  - `pdfReferenceCodeWorkflowMode` 'Redact' | 'Review' — Defines the workflow mode for PDF reference code display in manual redaction projects. Determines whether the redacted text is replaced with a filled box or kept visible with a border.<p>Possible values:</p> <ul> <li><b>Redact</b>: Redact mode: Replace text with a filled box containing reference codes inside. The redacted text is completely hidden and replaced with a solid black or white box that displays the reference codes as centered text inside the box. This is the default mode for final deliverables where sensitive data must be completely hidden.</li> <li><b>Review</b>: Review mode: Keep original text visible with a red border and reference codes as annotations. The original text remains visible inside a red outlined border (no fill), and reference codes are placed on top of the border as annotation-style labels (similar to reviewer initials or markup). This mode is intended for internal review and quality assurance where reviewers need to verify the original text.</li> </ul>
  - `pdfReferenceCodeDisplayMode` 'BlackBoxWhiteText' | 'WhiteBoxBlackText' — Defines how reference codes are displayed in PDF redaction boxes for manual redaction projects. Reference codes associated with redacted entities will be rendered inside the redaction area with the specified styling.<p>Possible values:</p> <ul> <li><b>BlackBoxWhiteText</b>: Black box with white text. Redacted areas appear as black boxes with reference codes displayed in white text. This is the default mode and provides high contrast for readability.</li> <li><b>WhiteBoxBlackText</b>: White box with black text. Redacted areas appear as white boxes with reference codes displayed in black text. This mode provides a cleaner appearance similar to text highlighting.</li> </ul>
  - `includeReferenceCodes` boolean — Whether to include reference codes on the redacted PDF
  - `watermarkText` string, nullable — Optional watermark text to overlay on each page
  - `footerText` string, nullable — Optional footer text to stamp on the bottom-left corner of each page
  - `includePageNumbers` boolean — Whether to include page numbers on the redacted PDF
  - `mergeIntoSinglePdf` boolean — Whether to merge all project files into a single PDF instead of a ZIP archive

## Response `200`

Returns the redacted image

## Other responses

- `400` — Invalid input or malformed content
- `404` — Project or file not found
- `409` — File is still processing
- `500` — An unexpected error occurred during redaction processing

---

[API](https://skmtc.net/tonic/apis/textual-api.md) · [All operations](https://skmtc.net/tonic/apis/textual-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/tonic/textual-api/revisions/41da8739a690/schema)