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
| Parameter | Type | Mandatory | Description |
|---|---|---|---|
| text | String | Yes | The text to anonymize. |
| azure | Object | No | Custom credentials for Azure services. Contains the optional fields key, region, endpoint, account_id, and access_token. |
| azure.key | String | Yes (if azure is selected in requested_service) | Azure subscription key. |
| azure.region | String | No | Azure service region. |
| azure.endpoint | String | Yes (if azure is selected in requested_service) | Azure endpoint URL. |
| azure.account_id | String | No | Azure account ID. |
| azure.access_token | String | Yes (if azure is selected in requested_service) | OAuth access token for Azure service. |
| language | String | Yes | Language code for the input text. |
| requested_service | ENUM | No | Which 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.
| Parameter | Type | Mandatory | Description |
|---|---|---|---|
| data | Object | No | Response payload. May include azure and/or apyhub objects. |
| data.azure | Object | No | Response object from Microsoft Azure Cognitive Services. |
| data.apyhub | Object | No | Response object from ApyHub language tools. |