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

# Waveform

> Generate a visual waveform image from audio

<RequestExample>
  ```json Example Request theme={null}
  {
    "input": "https://example.com/audio.wav",
    "width": 1920,
    "height": 200,
    "color": "0x00ff00"
  }
  ```

  ```bash File Upload theme={null}
  curl -X POST https://api.ringbee.dev/v1/audio/waveform \
    -H "X-API-Key: YOUR_API_KEY" \
    -F "file=@audio.mp3" \
    -F "width=1920" \
    -F "height=200" \
    -F "color=0x00ff00"
  ```
</RequestExample>

| Param  | Type   | Description                              |
| ------ | ------ | ---------------------------------------- |
| width  | number | Waveform image width in pixels           |
| height | number | Waveform image height in pixels          |
| color  | string | Waveform color as hex (e.g., "0x00ff00") |


## OpenAPI

````yaml POST /v1/audio/waveform
openapi: 3.0.3
info:
  title: MediAPI
  description: >-
    Media processing API — video, audio, image, and document transformations via
    simple REST calls.
  version: 1.0.0
servers:
  - url: https://api.ringbee.dev
    description: Production
security:
  - apiKey: []
paths:
  /v1/audio/waveform:
    post:
      tags:
        - Audio
      summary: Waveform
      description: Generate a visual waveform image from audio
      operationId: audioWaveform
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - input
              properties:
                input:
                  type: string
                  description: Input file URL
                width:
                  type: number
                  description: Waveform image width in pixels
                height:
                  type: number
                  description: Waveform image height in pixels
                color:
                  type: string
                  description: Waveform color as hex (e.g., "0x00ff00")
                webhook_url:
                  type: string
                  description: URL to receive job completion notification
          multipart/form-data:
            schema:
              type: object
              required:
                - file
              properties:
                file:
                  type: string
                  format: binary
                  description: Upload file directly
                width:
                  type: number
                  description: Waveform image width in pixels
                height:
                  type: number
                  description: Waveform image height in pixels
                color:
                  type: string
                  description: Waveform color as hex (e.g., "0x00ff00")
                webhook_url:
                  type: string
                  description: URL to receive job completion notification
      responses:
        '202':
          description: Job accepted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JobResponse'
        '400':
          description: Invalid request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: Usage limit reached
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    JobResponse:
      type: object
      properties:
        id:
          type: string
          example: job_abc123
        status:
          type: string
          enum:
            - pending
            - processing
            - completed
            - failed
            - cancelled
          example: pending
    Error:
      type: object
      properties:
        error:
          type: string
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: X-API-Key

````