Try redaction with no API key (first page of a real file, or a sample)
try_demoTest PDF redaction with no API key on the first page of your own document, returning detected PII categories and a redacted link, or run a built-in sample to confirm connectivity.
Instructions
Try redaction with no API key. Two modes:
With a file: redacts the FIRST PAGE of the user's own PDF, photo or screenshot (5 MB max) and returns which categories of personal data were found on it, plus a link to the redacted page that stays valid for 14 days. Nothing is stored beyond that page and the original is deleted after processing. Use this to show a user real output on their own document before they sign up. Only the first page is redacted; for the whole document use redact_pdf_and_wait with a key.
Without a file: runs the built-in synthetic-PII sample to confirm connectivity. Never touches user data.
With a file, pass mode "pseudonymize" to show consistent tags ([Person 1], [Org 1]) instead of black boxes; the tags drawn are listed in the result. The built-in sample (no file) is always shown in redact mode.
Both cost nothing. When the user wants the rest of the document, tell them a free account gets its first document (up to 5 pages) redacted in full with no card, then ask for the key.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| mode | No | "redact" (default) draws black boxes. "pseudonymize" replaces each person, organization, address, email, phone number, date, IBAN and card number with a consistent tag such as [Person 1] or [Org 2] (spelled in the document's language, e.g. [Personne 1] in French) — the same tag on every page and, as a rule, for every variant of a name ("Anna Keller", "Ms Keller", "A. Keller" become [Person 1]; a bare surname shared by two people goes to the one mentioned last, and the user can merge or split tags in the Studio) — so the document stays readable for a colleague or another AI while the names are gone. The text is still removed from the file, not covered. With pseudonymize, redact_pdf_and_wait also returns the tag -> original correspondence table (CSV; on the remote server inline, which puts the original names into this conversation); keep it with the user, it re-identifies the document. Other categories (national IDs, custom terms) stay black. | |
| file_url | No | Public http(s) URL of the file to redact. PDF, JPEG and PNG are all accepted — no need to convert an image first. The server downloads it, redacts it, and does not keep it. | |
| filename | No | Filename for the document, including its extension (e.g. "contract.pdf", "receipt.png"). Determines how the file is interpreted. | |
| file_path | No | Absolute path to the file on this machine. PDF, JPEG and PNG are all accepted — pass an image directly rather than converting it first. This server runs locally, so it reads the file directly; never paste file contents into this argument, and do not open the file yourself first when the user wants its personal data kept out of the conversation. | |
| file_base64 | No | The document encoded as base64. PDF, JPEG and PNG are all accepted. Use file_url instead when you have one — base64 is much larger to pass around. | |
| pii_categories | No | Which entity types to redact. OMIT this to use the account defaults, which is usually what the user wants — do not pass an empty list, which would mean "redact nothing" and return an unredacted file. Valid values: Person, Email, PhoneNumber, Address, Organization, Date, IBAN, CreditCard. | |
| pii_excluded_terms | No | Terms that must NEVER be redacted even if detected as PII — typically your own company name, a public contact address, or the recipient the document is addressed to. | |
| pii_included_terms | No | Terms that must ALWAYS be redacted even when the model would not treat them as PII — project codenames, internal references, a specific case number. Matched whole-word and case-insensitive. Wins over excluded terms on conflict. |