Skip to main content
POST
/
plaud
/
files
/
{id}
/
transsumm
/
wait
Transcribe + summarize (wait)
curl --request POST \
  --url https://{deployment}/api/v1/plaud/files/{id}/transsumm/wait \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "language": "auto",
  "poll_interval_sec": 3,
  "timeout_sec": 300,
  "include": [
    "transcript",
    "summary"
  ]
}
'
{
  "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.

Body

application/json

All fields optional; an empty body uses Plaud defaults.

language
string

Transcript language; default auto.

timezone
integer

Signed UTC offset (hours). Default 0.

diarization
boolean

Speaker diarization. Default true.

llm
string

Summary model id (model_name from /summary/models). Default auto.

summ_type
string

Summary template. Default AUTO-SELECT.

is_reload
boolean

Force re-transcribe. Auto-detected when omitted (reloads if a transcript already exists).

check_quota
boolean

Pre-flight quota check. Default false on /transsumm, true on /transsumm/wait. Insufficient quota returns 402.

poll_interval_sec
integer

(wait only) Poll interval, clamped to 1–30s.

timeout_sec
integer

(wait only) Max wait, clamped to 10s–30m.

include
enum<string>[]

(wait only) Attachments to compose in the returned bundle.

Available options:
transcript,
summary,
share,
audio_url

Response

Completed 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.