Skip to main content
GET
/
plaud
/
files
/
{id}
/
fetch
Get recording bundle
curl --request GET \
  --url https://{deployment}/api/v1/plaud/files/{id}/fetch \
  --header 'X-API-KEY: <api-key>'
{
  "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>"
  ]
}

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,summary — share 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.