Private Preview
Join Waitlist →

API Documentation

Current public status for integrations and API access

3 min readAuthor: Redactorr Support Team · [email protected]Last reviewed: May 2026

Outcome

Handle API and integration questions without inventing a public API contract or exposing private data.

Your progress

Mark each step as you complete it. This is saved only in this browser.

0 / 3 steps complete

Before you start

Treat this page as an integration boundary, not a published API reference.
Know the workflow goal before discussing endpoints, SDKs, webhooks, or automation.
Use scrubbed examples only; do not send credentials, documents, or raw payloads by default.

Visual frame

Review asset

API documentation boundary storyboard

Synthetic reference frame only. It makes the public API boundary visible without inventing endpoints, SDKs, webhooks, or rate limits.

ContractNot public
TodayWeb workflow
RequestScoped safely

Synthetic frame

API status

Use current product workflows unless a contract is provided.

Public RESTNo published contract
SDK packagesDo not infer
Web productSupported route
API guidance starts with the current supported surface.

Integration boundary frame

A reference frame for workflow goal, data boundary, redaction point, and consent-only examples.

BoundaryWhat the article can and cannot safely claim.
Next routeThe playbook or reference page that should handle the actual task.
Safe contextWhat support can receive without raw originals by default.

Guided steps

Follow the task, then check the result.

Read the boundary before acting

Start with what the article says is available, measured, preview-only, or not a product claim. Do not treat reference material as permission to send raw private content to support or external tools.

Article boundary note followed by the next task route.
Success check: You know whether this article is a task guide, a reference page, or a product-boundary note.

Frame the integration request safely

Describe the workflow you want to automate, the data categories involved, and where redaction must happen. Avoid assuming endpoint names, authentication schemes, rate limits, or SDK packages unless they are explicitly published.

Integration boundary frame
Success check: The integration request is framed as product discovery with safe context only.

Prepare safe support context if something disagrees

If the article and product screen do not match, describe the route, step, browser, and symptom. Do not paste raw original document text, secrets, restoration material, or private files by default.

Safe support bundle with route, symptom, and consent-only fields separated.
Success check: Any support description avoids raw private content unless you explicitly consent.

Branch questions

Completion check

You know whether this page is instructional, reference-only, or a product-boundary note.
You opened a task playbook when step-by-step guidance was needed.
Any support escalation avoids raw document text, secrets, files, and restoration material by default.

Support boundary

Support can use by default

  • Workflow goal and data category.
  • Desired source and destination system type.
  • Scrubbed example shape after consent.
  • Intent ID
  • Article slug
  • App route
  • Browser and viewport

Requires your consent

  • User-written description
  • Email address
  • Explicit attachment
  • Redacted sample
  • Support bundle previewed to the user

Not collected by default

  • Raw original document text
  • Full local file paths
  • Pasted private content
  • Unmasked screenshots
  • Replay capture

Safe support summary

Copy a scrubbed handoff.

Redactorr KB support summary

Article: /knowledge-base/api-docs
Selected issue: A user needs an integration path that is not publicly documented.
Playbook progress: 0/3 steps marked complete

Safe context to include:
- Workflow goal and data category.
- Desired source and destination system type.
- Scrubbed example shape after consent.
- Intent ID
- Article slug
- App route
- Browser and viewport

Requires explicit consent:
- User-written description
- Email address
- Explicit attachment
- Redacted sample
- Support bundle previewed to the user

Do not include by default:
- Raw original document text
- Full local file paths
- Pasted private content
- Unmasked screenshots
- Replay capture

User note:
- Describe the step and symptom without pasting raw document text, secrets, files, or restoration material.

Article details

API Documentation

This page is a product-boundary notice, not a public API reference.

Current Status

Redactorr's public, supported workflow is the web product. Detection and redaction run in the browser, and users review redacted output before it moves to optional workflows.

Do not copy older examples that mention public REST endpoints, SDK packages, webhook payloads, or rate-limit tables. Those drafts are not the current public source of truth.

What You Can Use Today

Web app Use the product interface for browser-local redaction, review, export, and supported workflows.

Knowledge base Use the playbooks for task guidance: first document, PDF review, Word documents, spreadsheets, log files, custom patterns, secure sharing, and AI-safe sharing.

Support routing When an integration request is blocked, contact support with the workflow goal, data category, and a scrubbed example. Do not send raw original document text or credentials.

Integration Requests

If your team needs automation, batch processing, or app-to-app integration, treat it as a scoped product request. A useful request includes:

  • What data type you need to process
  • Where the data starts
  • Where reviewed redacted output needs to go
  • Whether restoration material must be retained
  • What compliance, audit, or retention rules apply

Safe Boundary

The safe public claim is simple: redact before sending sensitive material onward. Public API, SDK, extension, and webhook claims should only be added after the product surface and release source of truth are ready.

Still stuck?

Copy a safe article handoff.

Start support with the article, the issue, and safe context. Raw document text, files, restoration material, and unredacted screenshots stay out unless you explicitly choose otherwise.

Support can start here
  • Article slug
  • Selected issue
  • Screen name
  • Action name
Redactorr support case

Source: Article playbook: api-docs
Route: /knowledge-base/api-docs
Selected issue: A user needs an integration path that is not publicly documented.

Safe context:
- Workflow goal and data category.
- Desired source and destination system type.
- Scrubbed example shape after consent.
- Article slug
- Selected issue
- Screen name or article section
- Action name
- Browser and viewport

Only include with explicit consent:
- User-written description
- Email address
- Explicit attachment
- Redacted sample
- Support bundle previewed to the user

Do not include by default:
- Raw original document text
- Full local file paths
- Pasted private content
- Unmasked screenshots
- Replay capture
- Hidden diagnostic uploads

User note:
- Describe what you tried and what happened. Do not paste raw document text, secrets, files, restoration material, or unredacted screenshots.

Support case builder

One case format, wherever you start.

This is the same support case shape used by diagnostics and article handoffs.

Safe to include
  • Workflow goal and data category.
  • Desired source and destination system type.
  • Scrubbed example shape after consent.
  • Article slug
  • Selected issue
  • Screen name or article section
Consent boundary

Private material belongs behind an explicit consent step, not in the initial case.

6 default exclusions

Before you copy0/4 ready
Open safe support guide