curl --request GET \
--url https://{deployment}/api/v1/plaud/files/{id}/fetch \
--header 'X-API-KEY: <api-key>'import requests
url = "https://{deployment}/api/v1/plaud/files/{id}/fetch"
headers = {"X-API-KEY": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-KEY': '<api-key>'}};
fetch('https://{deployment}/api/v1/plaud/files/{id}/fetch', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{deployment}/api/v1/plaud/files/{id}/fetch",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-KEY: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://{deployment}/api/v1/plaud/files/{id}/fetch"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-KEY", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://{deployment}/api/v1/plaud/files/{id}/fetch")
.header("X-API-KEY", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://{deployment}/api/v1/plaud/files/{id}/fetch")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-KEY"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"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>",
"source": "inline",
"markdown": "<string>",
"images": [
{
"path": "<string>",
"url": "<string>"
}
]
},
"share": {
"private": {},
"public": {}
},
"audio_url": "<string>",
"errors": [
"<string>"
],
"not_ready": [
"<string>"
]
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}Get recording bundle
Backend-for-frontend: returns the file plus any combination of transcript, summary, share state, and audio URL in a single call. Pro license required.
curl --request GET \
--url https://{deployment}/api/v1/plaud/files/{id}/fetch \
--header 'X-API-KEY: <api-key>'import requests
url = "https://{deployment}/api/v1/plaud/files/{id}/fetch"
headers = {"X-API-KEY": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-KEY': '<api-key>'}};
fetch('https://{deployment}/api/v1/plaud/files/{id}/fetch', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{deployment}/api/v1/plaud/files/{id}/fetch",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-KEY: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://{deployment}/api/v1/plaud/files/{id}/fetch"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-KEY", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://{deployment}/api/v1/plaud/files/{id}/fetch")
.header("X-API-KEY", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://{deployment}/api/v1/plaud/files/{id}/fetch")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-KEY"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"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>",
"source": "inline",
"markdown": "<string>",
"images": [
{
"path": "<string>",
"url": "<string>"
}
]
},
"share": {
"private": {},
"public": {}
},
"audio_url": "<string>",
"errors": [
"<string>"
],
"not_ready": [
"<string>"
]
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}Authorizations
Your deployment's API key (MMK_API_KEY). Your Plaud account credentials are stored server-side — you do not send them.
Path Parameters
Plaud recording (file) ID.
Query Parameters
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.
Rendering applied to the bundled transcript's text. Defaults to text.
text, markdown, srt, vtt, json, plain 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.
Inner file-detail object — the data of FileDetailResponse and the file of a bundle.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Private/public share state — present only when include=share.
Show child attributes
Show child attributes
Per-attachment failures (non-strict mode).
Requested attachments that are not generated yet.
Was this page helpful?

