Skip to main content
POST
Redaction

Authorizations

X-API-Key
string
header
required

Cookies

wos-session
string
datalab_active_team
string

Body

multipart/form-data
file_url
string | null

Optional file URL (http/https). If provided, the server will download and process it.

preset
string | null
default:personal_information

A built-in spec: 'personal_information' removes a private individual's identifiers; 'financial_details' removes account identifiers and payment credentials, including business accounts; 'business_confidentiality' removes counterparties, commercial terms and explicitly non-public information; 'manuscript_anonymisation' prepares a manuscript for double-blind review. Combined with redaction_spec, the spec's fields replace the preset's.

redaction_spec
string | null

Optional JSON spec: {"goal": "...", "rules": [{"id", "label", "detail"}], "keep": [{"id", "label", "detail"}]}. "rules" says what to remove, "keep" what must stay.

page_range
string | null

Not supported for redaction. Omit this field; the whole document is reviewed (up to 60 pages).

skip_cache
boolean
default:false

Skip the cache and re-run the inference. Defaults to False.

processing_location
string | null

Optional residency region override (e.g. us, eu). When provided, use file_url or direct-upload; multipart uploads are rejected. When omitted, the request uses the team's configured residency and profile.

file
file | null

Input PDF, word document, powerpoint, or image file, uploaded as multipart form data. Images must be png, jpg, or webp format.

Response

Successful Response

request_id
string
required

The ID of the request. This ID can be used to check the status of the request.

request_check_url
string
required

The URL to check the status of the request and get results.

success
boolean
default:true

Whether the request was successful.

error
string | null

If the request was not successful, this will contain an error message.

versions

A dictionary of the versions of the libraries used in the request.

checkpoint_reused
boolean | null

True when this run automatically reused a checkpoint from a previous run of the same file, so the conversion step is not re-billed. Absent/None otherwise.