Skip to main content
POST
/
v3
/
bleep
Bleep
curl --request POST \
  --url https://api.private-ai.com/community/v3/bleep \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "file": {
    "data": "<string>",
    "content_type": "<string>"
  },
  "timestamps": [
    {
      "start": 123,
      "end": 123
    }
  ],
  "bleep_frequency": 600,
  "bleep_gain": -3
}
'
{
  "bleeped_file": "<string>"
}

Authorizations

​
x-api-key
string
header
required

Body

application/json
​
file
FileData · object
required

File object containing base64 encoded text data and its content type.

​
timestamps
PIITimestamp · object[]
required
​
bleep_frequency
integer
default:600

The bleep_frequency parameter configures the frequency of the sine wave used for the bleep sound in an audio segment. This setting allows users to adjust the pitch of the bleep, with higher values resulting in a higher pitch and vice versa. Ideal for customizing the bleep tone to suit various audio environments, it is expressed in Hertz (Hz) and should be chosen considering the balance and clarity needed in the audio. The default setting is 600 Hz, which represents a standard bleep tone.

​
bleep_gain
number
default:-3

The bleep_gain parameter sets the gain level, in decibels (dB), for the bleep sound within the audio segment. It controls the relative loudness of the bleep, allowing for precise volume adjustments. A value of 0.0 dB maintains the original amplitude of the bleep, positive values increase its loudness, and negative values decrease it.

Response

Successful Response

​
bleeped_file
string
required

the base64 encoded file content of the redacted file.