Process Files Uri

Detect entities such as PII, PHI or PCI in the file located at the provided URI using Private AI's entity detection engine. After entity detection, a copy of the file with all entities removed is created and placed in the folder specified by PAI_OUTPUT_FILE_DIR on the local host.

This route is similar to /v3/process/files/base64, but relies on URIs instead of base64-encoded strings. As this route avoids the overhead of base64 encoding, it is more suitable for processing large files and large volumes of data.

This route supports the following content types: application/dicom, application/json, application/msword, application/pdf, application/, application/, application/vnd.openxmlformats-officedocument.presentationml.presentation, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet, application/vnd.openxmlformats-officedocument.wordprocessingml.document, application/xml, audio/m4a, audio/mp3, audio/mp4, audio/mp4a-latm, audio/mpeg, audio/wav, audio/webm, audio/x-wav, image/bmp, image/jpeg, image/jpg, image/png, image/tif, image/tiff, image/x-ms-bmp, message/rfc822, text/csv, text/plain

header Parameters
string (X-Api-Key)
Request Body schema: application/json
string (Uri)

URI of the file to be processed. It must be an accessible file path on the host machine (e.g. /Users/sam/files/file.pdf).

object (PIIDetectionParams)

This section contains a set of parameters to control the PII detection process. All fields have sensible default that can be changed for specific needs.

object (PDFOptions)

Options to process PDF files, such as the rendering quality when each page is turned into an image.

object (ImageOptions)

Options to process image files, such as the masking mode.

object (AudioOptions)

Options to process audio files, such as the padding to add while redacting audio segments.

string (Project Id) <= 60 characters ^[a-zA-Z0-9\-_\:]*$

Used to categorize requests for reporting purposes. Limited to alphanumeric characters or the following special characters :_-


Successful Response


Validation Error

Request samples
Response samples
  • "result_uri": "string",
  • "processed_text": "string",
  • "entities": [
  • "entities_present": true,
  • "languages_detected": {
© Copyright 2024 Private AI.