Skip to main content
POST
Process Files Uri

Authorizations

x-api-key
string
header
required

Headers

x-api-key
string
default:""

Body

application/json
uri
string
required

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).

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.

project_id
string

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

Maximum string length: 32
Pattern: ^[a-zA-Z0-9\-_\:]*$

Response

Successful Response

result_uri
string
required

URI of the processed file in the output directory (e.g. /Users/sam/files/file.redacted.pdf).

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.

languages_detected
Languages Detected · object
required

A dictionary containing ISO 639-1 language labels and the likelihood of their detection in the request payload.