> ## Documentation Index
> Fetch the complete documentation index at: https://docs.getlimina.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Bleep

> Bleep an audio given the timestamps to bleep.



## OpenAPI

````yaml /openapi/privateai_3.8.2.json post /v3/bleep
openapi: 3.1.0
info:
  title: API Reference
  description: Private AI API Reference
  termsOfService: https://www.private-ai.com/terms-of-use/
  contact:
    url: https://www.private-ai.com/contact/
    email: info@private-ai.com
  version: 3.8.2
servers:
  - url: https://api.private-ai.com/deid
    description: Private AI Community API
  - url: https://api.private-ai.com/cloud
    description: Private AI Cloud API
  - url: http://localhost:8080
    description: Local Server
security: []
paths:
  /v3/bleep:
    post:
      summary: Bleep
      description: Bleep an audio given the timestamps to bleep.
      operationId: bleep_v3_bleep_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BleepRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BleepResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    BleepRequest:
      properties:
        file:
          allOf:
            - $ref: '#/components/schemas/FileData'
          description: >-
            File object containing base64 encoded text data and its content
            type.
        timestamps:
          items:
            $ref: '#/components/schemas/PIITimestamp'
          type: array
          title: Timestamps
        bleep_frequency:
          type: integer
          title: Bleep Frequency
          description: >-
            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.
          default: 600
        bleep_gain:
          type: number
          title: Bleep Gain
          description: >-
            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.
          default: -3
      type: object
      required:
        - file
        - timestamps
      title: BleepRequest
    BleepResponse:
      properties:
        bleeped_file:
          type: string
          title: Bleeped File
          description: the base64 encoded file content of the redacted file.
      type: object
      required:
        - bleeped_file
      title: BleepResponse
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    FileData:
      properties:
        data:
          type: string
          title: Data
          description: Base64 encoded ASCII text data.
        content_type:
          type: string
          title: Content Type
          description: Content type of the data.
      type: object
      required:
        - data
        - content_type
      title: FileData
    PIITimestamp:
      properties:
        start:
          type: number
          title: Start
        end:
          type: number
          title: End
      type: object
      required:
        - start
        - end
      title: PIITimestamp
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError

````