PHphilterd
Filter

Redact text or a PDF.

Changed on

Requires the redact scope. Text is synchronous and returns text/plain. For PDFs select application/pdf or application/zip with Accept. PDFs default to async=true, returning application/json with documentId regardless of the selected download format. Set async=false for inline binary output. Async submission captures resolved configuration. Pass sign=true to request a signature when the deployment has not enabled signing. The admin setting is a floor: with it on every response is signed and sign=false does not change that. It applies to the text path, which is the one that is signed; sign=true on a PDF request is refused with 400 rather than answered unsigned.

post/api/filter

Request

  • Base URL
    / (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/filter
  • Auth
    HTTP bearer

Query parameters

cstring
pstring
filenamestring
signboolean
asyncboolean
fairness_keystring

Optional, asynchronous requests only. Documents queued by one account with different fairness keys take turns, as different accounts do. The key is opaque to Philter: use an internal identifier, such as a user or group ID, and never personal data. 1 to 64 characters of letters, digits, '.', '_', ':' and '-'.

Headers

Authorizationstring required

Request body application/pdf

string binary required

Response

Redacted text or synchronous binary result.

Changes

  • 2bb62dc90a0aRevision changes
    • info

      added the new optional query request parameter fairness_key

  • c4f85daa9208Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status