API Codex
Text Anonymization API

Schemas


Error

  • errorstring

    Error message

TextAnonymizationRequest

  • textstring · required

    The text content to anonymize

  • entitiesstring[]

    List of entity types to anonymize (defaults to a predefined list if not provided)

    Enum values:
    REDACTED
    DATE
    TIME
    DATETIME
    EMAIL_ADDRESS
    URL
    IBAN_CODE
    CREDIT_CARD

UrlAnonymizationRequest

  • urlstring · required

    The URL of the webpage to anonymize

  • entitiesstring[]

    List of entity types to anonymize (defaults to a predefined list if not provided)

AnonymizationResponse

  • successboolean

    Whether the anonymization was successful

  • anonymized_atstring · date-time

    The timestamp when anonymization was performed

  • anonymized_textstring

    The anonymized text with sensitive information redacted

  • errorstring

    Error message if any occurred during processing (only present on partial success)