apyhub
SECURITY & PRIVACY · SMART GENERATION

AI Text Anonymization API

Hosted on ApyHub

What it does

Text Anonymizer removes personal or sensitive details from plain text and returns an anonymized response object. Send a text string in the request body, optionally set language, and choose requested_service to use either apyhub or azure. If you use Azure directly, you can also pass custom azure credentials such as key, region, endpoint, account_id, or access_token.

Use it when you need to process support tickets, chat logs, notes, or other free-form text before storing or sharing them. It fits privacy workflows where names, phone numbers, and similar identifiers should be hidden before data leaves a trusted boundary.

The response returns a data object with either an azure payload or an apyhub payload, depending on the service you request. That makes it suitable for pipelines that need a privacy-preserving text step without changing the rest of the document flow.

Text Anonymizer is a good fit for compliance, redaction, and internal analytics where you want the content to remain useful while reducing exposure of sensitive information.

Provider (requested_service)Atoms
Azure500
ApyHub2000
POST
Anonymize text content
http://localhost:8080/apyhub/anonymize-text
QUICKSTARTGUIDE

Quickstart

Send the text you want anonymized in a JSON body.

curl -X POST "http://localhost:8080/apyhub/anonymize-text" \
  -H "apy-token: $APY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "text": "My name is John Doe and my phone number is 555-0199.",
    "language":"en",
    "requested_service":"apyhub"
  }'

What you'll get back

Returns a JSON object with a data object field. That data object may include azure and/or apyhub response objects, depending on which service handled the request.

{
  "data": {
    "apyhub": {}
  }
}
TRY ITLIVE · 500 ATOMS
Loading your default key…
The full key is used to call the gateway and stays in this tab — never sent to orbit or saved.
body*
azure
Custom credentials for Azure services.
Azure subscription key.
Azure service region.
Azure endpoint URL.
Azure account ID.
OAuth access token for Azure service.

About this endpoint

What it does

Anonymizes text content by sending a text string in the request body and returning a JSON object with a data object. The data object may include either an azure response object, an apyhub response object, or both, depending on the backend used.

Request Body

ParameterTypeMandatoryDescription
textStringYesThe text to anonymize.
azureObjectNoCustom credentials for Azure services. Contains the optional fields key, region, endpoint, account_id, and access_token.
azure.keyStringYes (if azure is selected in requested_service)Azure subscription key.
azure.regionStringNoAzure service region.
azure.endpointStringYes (if azure is selected in requested_service)Azure endpoint URL.
azure.account_idStringNoAzure account ID.
azure.access_tokenStringYes (if azure is selected in requested_service)OAuth access token for Azure service.
languageStringYesLanguage code for the input text.
requested_serviceENUMNoWhich service to use. Allowed values: azure, apyhub. Default: apyhub.

Response

Returns a JSON object with a data object field. The data object may contain an azure object and/or an apyhub object, depending on the service used.

ParameterTypeMandatoryDescription
dataObjectNoResponse payload. May include azure and/or apyhub objects.
data.azureObjectNoResponse object from Microsoft Azure Cognitive Services.
data.apyhubObjectNoResponse object from ApyHub language tools.

Body

Name
Type
Description
bodyREQUIRED
object
▣ COMMON ERRORS

Errors any endpoint can return

400bad_request

Required parameter missing or malformed body.

401unauthorized

API key missing, revoked, or not authorized for this service.

429rate_limited

Your plan's per-second rate exceeded. Retry with exponential backoff.

503upstream_busy

Backend temporarily unavailable. Try again in a few seconds.