Skip to main content
GET
/
plaud
/
sync
Bundle multiple recordings
curl --request GET \
  --url https://{deployment}/api/v1/plaud/sync \
  --header 'X-API-KEY: <api-key>'
{
  "total": 123,
  "files": [
    {
      "file": {
        "file_id": "<string>",
        "file_name": "<string>",
        "duration": 123,
        "is_trash": true,
        "start_time": 123,
        "filetag_id_list": [
          "<string>"
        ],
        "is_trans": true,
        "is_summary": true
      },
      "transcript": {
        "file_id": "<string>",
        "content": "<unknown>",
        "text": "<string>",
        "format": "<string>"
      },
      "summary": {
        "file_id": "<string>",
        "markdown": "<string>",
        "images": [
          {
            "path": "<string>",
            "url": "<string>"
          }
        ]
      },
      "share": {
        "private": {},
        "public": {}
      },
      "audio_url": "<string>",
      "errors": [
        "<string>"
      ],
      "not_ready": [
        "<string>"
      ]
    }
  ],
  "fetched_at": "2023-11-07T05:31:56Z",
  "stats": {
    "bundle_errors": 123,
    "elapsed_ms": 123
  }
}

Authorizations

X-API-KEY
string
header
required

Your deployment's API key (MMK_API_KEY). Your Plaud account credentials are stored server-side — you do not send them.

Query Parameters

limit
integer
default:10

Max files (clamped to 1–20).

Required range: 1 <= x <= 20
skip
integer
default:0

Offset for pagination.

since
integer<int64>

Only include files with start_time >= this epoch-ms value.

include
string
default:transcript,summary

Comma-separated attachments to compose: transcript, summary, share, audio_url.

transcript_format
enum<string>

Rendering applied to each bundled transcript's text.

Available options:
text,
markdown,
srt,
vtt,
json,
plain
strict
boolean
default:false

Fail-fast on any sub-fetch error.

concurrency
integer
default:4

Max in-flight files (clamped to 1–8).

Required range: 1 <= x <= 8

Response

Aggregated bundles

total
integer
files
object[]
fetched_at
string<date-time>
stats
object