Process Text POST
/api/process/text/deid/ Detect entities such as PII or PCI in the provided text strings using Blueguard API 's entity detection engine. After entity detection, any entities found can be redacted, masked or replaced with AI-generated synthetic entities.
Request
HEADER PARAMETERS
| Field | Type | Description |
|---|---|---|
| api_key | string (Api-Key) | API Key of the Company |
REQUEST BODY SCHEMA: application/json
| Field | Type | Description |
|---|---|---|
| mode | string | The processing mode ('mask', 'replace', 'redact'). |
| context_id | string | A unique identifier generated for every request. |
| policy_id | string | The policy identifier for the organization policy that defines the list of entities to detect |
| language | string | The language code for processing the text. Defaults to English 'en' |
| enable_details | boolean | Flag to enable or disable detailed processing information in the responses |
| inputs | List[InputText] | A list of objects containing the text to be processed. text (string): The text string to be processed. |
| enable_sensitive_scan | boolean | Flag to enable or disable sensitive scanning to identify sensitive words present in the given text. Organization that does not have custom terms to detect may turn this off to gain performance. |
| org_uuid | string | a string contains organization ID. |
| identify_credentials | boolean | Flag to enable or disable scanning to identify credentials present in the given text. credentials are keys such as AWS, GCP, Azure, SSH, Stripe etc. |
Responses
200 Successful Response
RESPONSE SCHEMA: application/json
| Field | Type | Description | |||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| success | boolean | Indicates the success status of the request. | |||||||||||||||||||||
| status | integer | The HTTP status code. | |||||||||||||||||||||
| context_id | string | A unique UUID generated for every deid request | |||||||||||||||||||||
| policy_id | string | policy id that tracks the policy to apply on this text processing | |||||||||||||||||||||
| output | List[dict] | A list of processed text strings corresponding to each input text. this list contains responses which are basically a python dictionary.
|
4XX Client Error
RESPONSE SCHEMA: application/json
| Field | Type | Description |
|---|---|---|
| success | boolean | Indicates the success status of the request. |
| status | integer | The HTTP status code. |
| details | string | A detailed message describing the error. |