Files & Recordings Management

Plaud’s API provides powerful features for managing audio recordings, allowing you to access, organize, and process your audio files.

Table of Contents

File Operations

List All Files

Retrieve a list of all files with optional pagination:

curl -H "Authorization: <YOUR_API_KEY>" https://api.plaud.ai/files/

Response:

{
  "type": "list",
  "data": [
    {
      "id": "file-123",
      "name": "Weekly Meeting",
      "owner_id": "user-456",
      "duration": 3600,
      "ai_status": 2,
      "ai_result_list": [
        // AI processing results
      ]
    }
    // more files
  ],
  "next_token": "token-for-next-page"
}

Get File Details

Get detailed information about a specific file:

curl -H "Authorization: <YOUR_API_KEY>" https://api.plaud.ai/files/{file_id}

Create a File

Create a new file record in the system:

curl -X POST -H "Authorization: <YOUR_API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Board Meeting",
    "desc": "Monthly board meeting discussion",
    "start_time": 1617235200,
    "end_time": 1617242400,
    "duration": 7200,
    "device_id": "device-123"
  }' \
  https://api.plaud.ai/files/

Update File Information

Update an existing file’s metadata:

curl -X PATCH -H "Authorization: <YOUR_API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Board Meeting - April",
    "desc": "Updated description for April board meeting"
  }' \
  https://api.plaud.ai/files/{file_id}

Delete a File

Remove a file from the system:

curl -X DELETE -H "Authorization: <YOUR_API_KEY>" \
  https://api.plaud.ai/files/{file_id}

File Merging

Plaud’s API allows you to merge multiple audio files into a single file:

curl -X POST -H "Authorization: <YOUR_API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{
    "file_id_list": ["file-123", "file-456", "file-789"],
    "owner_id": "user-123"
  }' \
  https://api.plaud.ai/files/merge

AI Processing

Tracking AI Processing Status

Each file has an ai_status field that indicates the current processing status:

StatusValueDescription
Not processed0AI processing has not started
Processing1AI processing is currently in progress
Completed2AI processing has successfully completed
ErrorNegative valuesAn error occurred during processing

Accessing AI Results

The results of AI processing are available in the ai_result_list and ai_data fields of the file object:

Result TypeDescriptionLocation
TranscriptionsText conversion of speechai_data.transcript
Speaker identificationWho said whatai_data.speakers
SummariesMeeting summaryai_data.summary
Action itemsTasks identifiedai_data.action_items
TopicsMain discussion topicsai_data.topics

Presigned URLs

For secure access to audio files, the API provides presigned URLs:

  1. The file details will include a presigned_url field when available
  2. This URL provides temporary access to download the audio file
  3. Presigned URLs typically expire after a short period (usually 15 minutes)

Supported File Formats

Plaud’s API supports the following audio formats:

FormatExtensionDescription
Opus.opusHigh-quality compressed audio format
MP3.mp3Widely supported compressed audio
WAV.wavUncompressed audio format
M4A.m4aAAC-encoded audio format