Skip to main content
GET
Get recording bundle

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.

Path Parameters

id
string
required

Plaud recording (file) ID.

Query Parameters

include
string
default:transcript,summary

Comma-separated attachments to compose. Accepted tokens: transcript, summary, share, audio_url (alias audio-url). When omitted, defaults to transcript,summaryshare and audio_url are only included when explicitly requested.

transcript_format
enum<string>

Rendering applied to the bundled transcript's text. Defaults to text.

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

Fail-fast on any sub-fetch error instead of collecting per-attachment errors.

Response

Composed file bundle

File detail plus opted-in attachments. file is the inner file-detail object (file.file_id, …), not a {status,data} envelope. transcript/summary/share/audio_url appear only when requested via include and the fetch succeeded.

file
object

Inner file-detail object — the data of FileDetailResponse and the file of a bundle.

transcript
object
summary
object
share
object

Private/public share state — present only when include=share.

audio_url
string
errors
string[]

Per-attachment failures (non-strict mode).

not_ready
string[]

Requested attachments that are not generated yet.