Skip to main content
POST
Process File Base64

Authorizations

x-api-key
string
header
required

Headers

x-api-key
string
default:""

Body

application/json
file
File · object
required

File object containing base64 encoded text data and its content type.

entity_detection
Entity Detection · object

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.

pdf_options
Pdf Options · object

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

audio_options
Audio Options · object

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

Response

Successful Response

processed_file
string
required

the base64 encoded file content of the redacted file.

processed_text
string
required

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.

entities
FileEntityItem · object[]
required

A list of all entities found in the provided file.

entities_present
boolean
required

Returns True if the list of detected entities is not empty.