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

# Extract Audio

> Extract transcripts and metadata from audio files or URLs.

# Extract Audio API Documentation

## Description

This endpoint extracts structured data from audio files based on a user-defined prompt. It supports input via URL or base64-encoded audio content and uses Large Language Models (LLMs) to interpret and extract relevant information from the audio.

## Endpoint

```
POST https://app.dumplingai.com/api/v1/extract-audio
```

## Headers

* **Content-Type:** `application/json`
* **Authorization:** Bearer `<API_KEY>` (required)

## Request Body

```json theme={null}
{
  "inputMethod": "string", // Required. Either "url" or "base64".
  "audio": "string", // Required. URL or base64-encoded audio content.
  "prompt": "string", // Required. The prompt describing the data to extract.
  "jsonMode": boolean // Optional. Whether to return the result in JSON format. Default: false.
}
```

## Responses

### Success (200)

Returns the extracted data based on the provided prompt, along with additional information.

```json theme={null}
{
  "results": "string", // Extracted data based on the prompt
  "prompt": "string", // The original prompt used for extraction
  "audioDuration": number, // Duration of the audio in seconds
  "creditUsage": number // Total credits used for this request
}
```

* **Content-Type:** application/json
* **X-RateLimit-Limit:** The rate limit for the user.
* **X-RateLimit-Remaining:** The remaining number of requests for the user.

### Bad Request (400)

Returned if the request is invalid or the audio file exceeds size or duration limits.

```json theme={null}
{
  "error": "Error message describing the issue"
}
```

### Unauthorized (401)

Returned if the API key is invalid or missing.

```json theme={null}
{
  "error": "Invalid or missing Authorization header"
}
```

### Internal Server Error (500)

Returned if there's an error during the audio extraction process.

```json theme={null}
{
  "error": "Failed to extract audio data: [error details]"
}
```

## Example Request

```bash theme={null}
curl -X POST https://app.dumplingai.com/api/v1/extract-audio \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_KEY" \
-d '{
  "inputMethod": "url",
  "audio": "https://example.com/sample-audio.mp3",
  "prompt": "Summarize the main points discussed in this audio.",
  "jsonMode": false
}'
```

## Notes

* The maximum file size for an audio file is 100MB.
* The maximum audio duration is 9.5 hours (34,200 seconds).
* Supported audio formats: wav, mp3, aiff, aac, ogg, flac
* Credit usage:
  * Base cost: 100 credits
  * Additional 20 credits per minute of audio duration (rounded up)
* The total credit usage is returned in the response as `creditUsage`.
* If using the URL method, ensure the audio file is publicly accessible.
* The `jsonMode` parameter determines whether the output is formatted as JSON (true) or plain text (false).
* The endpoint uses the Gemini 1.5 Flash model for audio analysis and data extraction.
* Temporary files are created during processing and are deleted after use.
* You can get a list of supported audio formats by calling:

```
GET /api/v1/extract-audio
```

## Rate Limiting

Rate limit headers (`X-RateLimit-Limit` and `X-RateLimit-Remaining`) are included in the response to indicate the user's current rate limit status.

## Error Handling

* If the required parameters (`audio` or `prompt`) are missing, a 400 Bad Request error is returned.
* If the audio file size exceeds 100MB, a 400 Bad Request error is returned.
* If the audio duration exceeds 9.5 hours, a 400 Bad Request error is returned.
* If there's an error during extraction, a 500 Internal Server Error is returned with details about the failure.

## Security and Privacy

* Uploaded audio files are temporarily stored and then deleted after processing.
* Audio metadata (including duration) is checked using a separate Python service before processing.


## OpenAPI

````yaml POST /api/v1/extract-audio
openapi: 3.0.3
info:
  title: DumplingAI API
  version: 1.0.0
  description: >
    REST API for DumplingAI's content intelligence and automation platform.

    All endpoints are grouped under `/api/v1`; most are secured via Bearer API
    keys unless an operation explicitly sets `security: []`.
servers:
  - url: https://app.dumplingai.com
    description: Production
security:
  - bearerAuth: []
tags:
  - name: YouTube
    description: Access metadata, search results, and transcripts from YouTube.
  - name: TikTok
    description: Retrieve TikTok profile, video, follower, and transcript data.
  - name: LinkedIn
    description: Programmatically fetch LinkedIn company and profile data.
  - name: Search
    description: Search-orientated endpoints spanning web, news, maps, and autocomplete.
  - name: Google
    description: Integrations with Google business listings and location data.
  - name: Scraping
    description: Webpage capture, crawling, and structured content extraction utilities.
  - name: Documents
    description: Document processing, conversion, and metadata utilities.
  - name: AI
    description: DumplingAI agent and knowledge base endpoints.
  - name: Developer Tools
    description: Utilities for executing sandboxed code via API.
paths:
  /api/v1/extract-audio:
    post:
      tags:
        - Documents
      summary: Extract audio metadata
      description: Extract transcripts and metadata from audio files or URLs.
      operationId: extractAudio
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExtractAudioRequest'
            examples:
              default:
                value:
                  inputMethod: url
                  audio: https://example.com/podcast.mp3
                  prompt: Provide a summary and list the key action items discussed.
                  jsonMode: false
      responses:
        '200':
          description: Audio extraction results returned.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExtractAudioResponse'
        '400':
          description: Invalid request payload.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Missing or invalid API key.
        '500':
          description: Unexpected server error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    ExtractAudioRequest:
      type: object
      required:
        - inputMethod
        - audio
        - prompt
      properties:
        inputMethod:
          $ref: '#/components/schemas/FileInputMethod'
        audio:
          type: string
          description: Audio URL or base64-encoded audio content to analyze.
        prompt:
          type: string
          description: Instructions describing the insights to extract from the audio.
        jsonMode:
          type: boolean
          description: When true, requests the model to respond with JSON-formatted output.
          default: false
        requestSource:
          $ref: '#/components/schemas/RequestSource'
      additionalProperties: false
    ExtractAudioResponse:
      type: object
      required:
        - results
        - prompt
        - audioDuration
        - creditUsage
      properties:
        results:
          type: string
          description: Model output returned from the extraction prompt.
        prompt:
          type: string
        audioDuration:
          type: number
          format: float
          description: Duration of the processed audio in seconds.
        creditUsage:
          type: integer
          description: Credits consumed while processing the request.
      additionalProperties: false
    ErrorResponse:
      type: object
      properties:
        error:
          type: string
          description: Human-readable description of what went wrong.
      required:
        - error
    FileInputMethod:
      type: string
      description: >-
        Indicates whether binary content is supplied via URL or base64-encoded
        string.
      enum:
        - url
        - base64
    RequestSource:
      type: string
      description: Optional identifier describing where the API request originated.
      enum:
        - API
        - WEB
        - MAKE_DOT_COM
        - ZAPIER
        - N8N
        - PLAYGROUND
        - DEFAULT_AUTOMATION
        - AGENT_PREVIEW
        - AGENT_LIVE
        - AUTOPILOT
        - STUDIO
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key

````