We use analytics and minimal tracking across our websites to help improve performance and user experience. Our privacy policy.
curl --request POST \
--url https://api.private-ai.com/deid/v3/process/files/base64 \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"file": {
"data": "JVBERi0xLjQKJdPr6eEKMSAwIG9iago8PC9UaXRsZSAoc2FtcGxlKQovUHJvZHVj...",
"content_type": "application/pdf or image/jpeg"
},
"entity_detection": {
"accuracy": "high",
"return_entity": true
},
"pdf_options": {
"density": 150,
"max_resolution": 2000
},
"audio_options": {
"bleep_start_padding": 0,
"bleep_end_padding": 0
}
}
'{
"processed_file": "<string>",
"processed_text": "<string>",
"entities": [
{
"processed_text": "<string>",
"text": "<string>",
"location": {
"stt_idx": 123,
"end_idx": 123,
"stt_idx_processed": 123,
"end_idx_processed": 123
},
"best_label": "<string>",
"labels": {}
}
],
"entities_present": true,
"languages_detected": {}
}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/json, application/msword, application/pdf, application/vnd.ms-excel, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet, application/vnd.openxmlformats-officedocument.wordprocessingml.document, application/xml, message/rfc822, text/csv, text/plain, application/dicom, jpeg, jpeg, tiff, tiff, png, bmp, bmp, mp4, m4a, m4a, mp3, mp3, wav, wav, webm
curl --request POST \
--url https://api.private-ai.com/deid/v3/process/files/base64 \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"file": {
"data": "JVBERi0xLjQKJdPr6eEKMSAwIG9iago8PC9UaXRsZSAoc2FtcGxlKQovUHJvZHVj...",
"content_type": "application/pdf or image/jpeg"
},
"entity_detection": {
"accuracy": "high",
"return_entity": true
},
"pdf_options": {
"density": 150,
"max_resolution": 2000
},
"audio_options": {
"bleep_start_padding": 0,
"bleep_end_padding": 0
}
}
'{
"processed_file": "<string>",
"processed_text": "<string>",
"entities": [
{
"processed_text": "<string>",
"text": "<string>",
"location": {
"stt_idx": 123,
"end_idx": 123,
"stt_idx_processed": 123,
"end_idx_processed": 123
},
"best_label": "<string>",
"labels": {}
}
],
"entities_present": true,
"languages_detected": {}
}Authorizations
Headers
Body
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.
Show child attributes
Show child attributes
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.
Show child attributes
Show child attributes
Options to process PDF files, such as the rendering quality when each page is turned into an image.
Show child attributes
Show child attributes
Options to process audio files, such as the padding to add while redacting audio segments.
Show child attributes
Show child attributes
Used to categorize requests for reporting purposes. Limited to alphanumeric characters or the following special characters :_-
32^[a-zA-Z0-9\-_\:]*$Response
Successful Response
the base64 encoded file content of the redacted file.
This field contains the redacted version of any text that was extracted from the input file. It corresponds to a redacted ASR transcript for audio files and any text found inside a document such as a PDF or image file.
A list of all entities found in the provided file.
Show child attributes
Show child attributes
Returns True if the list of detected entities is not empty.
A dictionary containing ISO 639-1 language labels and the likelihood of their detection in the request payload.
Show child attributes
Show child attributes