Process Files Base64

Detect entities such as PII, PHI or PCI in a base64-encoded file using Private AI's entity detection engine. After entity detection, a copy of the file with all entities removed is created and returned.

This route is similar to /v3/process/files/uri, but passes the file in the POST request itself. This route allows for simple setup and testing, as no folders or volumes need to be mounted to the container.

This route supports the following content types: application/dicom, application/json, application/msword, application/pdf, application/vnd.ms-excel, application/vnd.ms-powerpoint, 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

Request

header Parameters

x-api-key

string (X-Api-Key)

Default:

Request Body schema: application/json
required

required	object (File) 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 (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.
	any (Processed Text) Default: {"marker_language":"en","pattern":"[UNIQUE_NUMBERED_ENTITY_TYPE]","type":"MARKER"} This section allows the user to generate redacted (default) or masked text.
	Project Id (string) or Project Id (null) (Project Id) Used to categorize requests for reporting purposes. Limited to alphanumeric characters or the following special characters :_-

Responses

200

Successful Response

422

Validation Error

post/v3/process/files/base64

Request samples

Response samples

application/json

{"processed_file": "string",
"processed_text": "string",
"entities": [{"processed_text": "string",
"text": "string",
"location": {"stt_idx": 0,
"end_idx": 0,
"stt_idx_processed": 0,
"end_idx_processed": 0
},
"best_label": "string",
"labels": {"property1": 0,
"property2": 0
}
}
],
"entities_present": true,
"languages_detected": {"property1": 0,
"property2": 0
}
}