Skip to main content
POST
/
api
/
velma-2-pii-phi-redaction-batch
Transcribe and redact PII/PHI from an audio file
curl --request POST \
  --url https://platform.modulate.ai/api/velma-2-pii-phi-redaction-batch \
  --header 'Content-Type: multipart/form-data' \
  --header 'X-API-Key: <api-key>' \
  --form upload_file='@example-file' \
  --form speaker_diarization=true \
  --form start_redaction_padding_ms=100 \
  --form end_redaction_padding_ms=0
{
  "metadata": {
    "text": "Hello, my name is <pii:name></pii:name>.",
    "duration_ms": 5000,
    "utterances": [
      {
        "utterance_uuid": "e5f6a7b8-c9d0-1234-efab-345678901234",
        "text": "Hello, my name is <pii:name></pii:name>.",
        "start_ms": 0,
        "duration_ms": 3000,
        "speaker": 1,
        "language": "en"
      }
    ],
    "redaction_ranges": [
      [
        1600,
        2400
      ]
    ]
  },
  "audio": "(binary MP3 data)"
}

Authorizations

​
X-API-Key
string
header
required

API key used for authentication and usage tracking.

Body

multipart/form-data
​
upload_file
file
required

Audio file to transcribe and redact. Supported formats: AAC, AIFF, FLAC, MP3, MP4, MOV, OGG, Opus, WAV, WebM. Maximum file size: 100MB. Empty files are rejected.

​
speaker_diarization
boolean
default:true

Speaker diarization identifies different speakers in the audio. When enabled, each utterance includes a speaker identifier (e.g., 1, 2).

​
start_redaction_padding_ms
integer
default:100

Additional silence in milliseconds to prepend before each redacted audio range. Extends the silenced region earlier in time to provide a buffer before PII/PHI content.

Required range: x >= 0
​
end_redaction_padding_ms
integer
default:0

Additional silence in milliseconds to append after each redacted audio range. Extends the silenced region later in time to provide a buffer after PII/PHI content.

Required range: x >= 0

Response

Redaction completed successfully

​
metadata
object
​
audio
file

Redacted MP3 audio file with PII/PHI ranges silenced.