Skip to main content
POST
audio.redaction.create

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string
required

Required: this capability has an external effect.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
policies
enum<string>[]
required

Personal-data categories to remove from text and audio.

Required array length: 1 - 60 elements

Kind of personal detail to remove.

Available options:
accountNumber,
bankingInformation,
bloodType,
creditCardCvv,
creditCardExpiration,
creditCardNumber,
date,
dateInterval,
dateOfBirth,
driversLicense,
drug,
duration,
emailAddress,
event,
filename,
gender,
genderSexuality,
healthcareNumber,
injury,
ipAddress,
language,
location,
locationAddress,
locationAddressStreet,
locationCity,
locationCoordinate,
locationCountry,
locationState,
locationZip,
maritalStatus,
medicalCondition,
medicalProcess,
moneyAmount,
nationality,
numberSequence,
occupation,
organization,
organizationMedicalFacility,
passportNumber,
password,
personAge,
personName,
phoneNumber,
physicalAttribute,
politicalAffiliation,
religion,
sexuality,
statistics,
time,
url,
usSocialSecurityNumber,
username,
vehicleId,
zodiacSign
audioUrl
string

Public HTTPS audio URL; send this or fileId.

fileId
string

Id of an uploaded file holding the audio to transcribe, in place of a public link.

Pattern: ^file_[0-9A-HJKMNP-TV-Z]{26}$
language
string

Two-letter language; detected when omitted.

Pattern: ^[a-z]{2}$
staticTerms
string[]

Additional literal terms to remove.

Maximum array length: 100

Exact additional term to remove.

Required string length: 1 - 200
substitution
enum<string>
default:entityName

Replace personal details with their category or a hash mark.

Available options:
entityName,
hash
audioMethod
enum<string>
default:silence

Sound replacing redacted audio.

Available options:
beep,
silence
audioFormat
enum<string>
default:mp3

Redacted audio format.

Available options:
mp3,
wav
profanity
boolean
default:false

Also remove profanity; explicitly costs more.

includeUnredacted
boolean
default:false

Explicitly include original personal speech text in the result.

Response

Job started; poll GET /v1/jobs/{id}

job_id
string
required
status
enum<string>
required
Available options:
running
held_micro
integer
required

The credit set aside for the job (its estimate), micro-USD; 0 when it takes none. Not a price: what the job is charged reads on GET /v1/jobs/{id} once it is settled.