Personal Identifiable Information (PII) Redaction is an AI model that is used to automatically remove sensitive information that can be used to uniquely identify an individual from your transcript text.
When submitting files for transcription, include the
redact_pii parameter in your request body and set it to
true, as well as the required parameter
redact_pii_policies, listing all policies that should be redacted.
You can explore the full JSON response here:
Understanding the response
The JSON object above contains all information about the transcription. Depending on which Models are used to analyze the audio, the attributes of this object will vary. For example, in the quickstart above we did not enable Summarization, which is reflected by the
summarization: false key-value pair in the JSON above. Had we activated Summarization, then the
summary_model key values would contain the file summary (and additional details) rather than the current
To access the PII Redaction diarization information, we use the
The reference table below lists all relevant attributes along with their descriptions, where we've called the JSON response object
results. Object attributes are accessed via dot notation, and arbitrary array elements are denoted with
results.words[i].text refers to the
text attribute of the
i-th element of the
words array in the JSON
|boolean||Whether PII Redaction was enabled in the transcription request|
|boolean||Whether to return a redacted version of the audio file|
|string||The quality of the redacted PII audio file|
|array||An array of PII policies that were requested for redaction in the transcription request|
|boolean||What type of substitution is used to redact PII (see below for details)|
All policies supported by the model
With PII Redaction, the API can automatically remove Personally Identifiable Information (PII) such as phone numbers and social security numbers from the transcription text before it is returned. The redacted text replaces any sensitive information with "#" characters.
Below is a table that lists all the available PII Redaction policies and their descriptions:
In addition to the
redact_pii_policies parameter, users can also use the
redact_pii_sub parameter to further customize PII Redaction. This parameter allows users to specify the exact text substrings to be redacted, regardless of the PII policy being used.
Create a redacted audio file
In addition to redacting sensitive information from the transcription text, the API can also generate a version of the original audio file with the PII "beeped" out when it's being spoken. To do so, include the
redact_pii_audio parameter in your request when submitting files for transcription.
When the transcription is complete, you can retrieve a URL that points to your redacted audio file by making a request to the following API endpoint:
Webhooks allow you to receive real-time updates about the status of your PII redacted audio file.
webhook_url was provided in your request when submitting your audio file for transcription, we'll send a
POST request to the URL. Note if you're using webhooks along with PII audio redaction you'll receive two webhook calls. The first call is for the redacted audio. The second one comes a few seconds later and is for the completed transcript.
When you receive the request from AssemblyAI, it'll include the following headers.
accept-encoding: gzip, deflate
And the first request body includes the following parameters.
The status field indicates whether the PII Redaction was completed successfully or if there was an error. The
redacted_audio_urlfield contains a URL to the redacted audio file.
The second request body includes the following parameters.
transcript_idfield contains the ID of the completed transcription, and the
statusfield indicates whether the transcription was completed successfully or if there was an error.
The redacted audio URL is accessible for 30 minutes while the redacted audio file itself is available for 24 hours. If you don't access the original URL within 30 minutes, you can make another GET request to the
/v2/transcript/<transcript-id>/redacted-audioendpoint to get a new URL as long as it's within 24 hours.
redact_pii_policiesparameter is included in your request with the desired policy names. If you're still experiencing issues, please reach out to our support team for assistance.
webhook_urlparameter is included with a valid URL that can be reached by AssemblyAI's API. If you're using custom authentication headers, ensure that the
webhook_auth_header_valueparameters are included and are correct. If you're still having issues, please contact our support team for assistance.