Skip to main content
POST
/
plaud
/
files
/
{id}
/
transsumm
Start transcribe + summarize
curl --request POST \
  --url https://{deployment}/api/v1/plaud/files/{id}/transsumm \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "language": "auto",
  "diarization": true,
  "llm": "auto",
  "summ_type": "AUTO-SELECT"
}
'
{
  "status": 123,
  "msg": "<string>",
  "request_id": "<string>",
  "auto_save": true,
  "ppc_status": 123,
  "err_code": "<string>",
  "err_msg": "<string>",
  "data_extra": {}
}

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

Task accepted (async)

Immediate response from the async transsumm trigger. A successful call returns status=0 with msg="task processing"; extra fields are captured loosely for forward-compat.

​
status
integer
​
msg
string
​
request_id
string
​
auto_save
boolean
​
ppc_status
integer
​
err_code
string
​
err_msg
string
​
data_extra
object