Health check
curl --request GET \
--url https://{deployment}/api/v1/plaud/doctor \
--header 'X-API-KEY: <api-key>'import requests
url = "https://{deployment}/api/v1/plaud/doctor"
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/doctor', 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/doctor",
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/doctor"
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/doctor")
.header("X-API-KEY", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://{deployment}/api/v1/plaud/doctor")
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{
"ok": true,
"api_domain": "<string>",
"checks": {
"user_me": "ok",
"device_list": "ok"
},
"user": {},
"devices": [
{}
],
"user_error": "<string>",
"device_error": "<string>",
"hint": "<string>"
}{
"ok": true,
"api_domain": "<string>",
"checks": {
"user_me": "ok",
"device_list": "ok"
},
"user": {},
"devices": [
{}
],
"user_error": "<string>",
"device_error": "<string>",
"hint": "<string>"
}{
"ok": true,
"api_domain": "<string>",
"checks": {
"user_me": "ok",
"device_list": "ok"
},
"user": {},
"devices": [
{}
],
"user_error": "<string>",
"device_error": "<string>",
"hint": "<string>"
}System
Health check
Runs a live connectivity probe against Plaud (user profile + device list in parallel) and reports whether the stored credentials work. Returns 200 when both checks pass, 401 when Plaud rejected the token (reconnect), 502 on other upstream failures. Pro license required. A Basic key is rejected with 400 and you are not a magic meal kits PRO user.
GET
/
plaud
/
doctor
Health check
curl --request GET \
--url https://{deployment}/api/v1/plaud/doctor \
--header 'X-API-KEY: <api-key>'import requests
url = "https://{deployment}/api/v1/plaud/doctor"
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/doctor', 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/doctor",
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/doctor"
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/doctor")
.header("X-API-KEY", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://{deployment}/api/v1/plaud/doctor")
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{
"ok": true,
"api_domain": "<string>",
"checks": {
"user_me": "ok",
"device_list": "ok"
},
"user": {},
"devices": [
{}
],
"user_error": "<string>",
"device_error": "<string>",
"hint": "<string>"
}{
"ok": true,
"api_domain": "<string>",
"checks": {
"user_me": "ok",
"device_list": "ok"
},
"user": {},
"devices": [
{}
],
"user_error": "<string>",
"device_error": "<string>",
"hint": "<string>"
}{
"ok": true,
"api_domain": "<string>",
"checks": {
"user_me": "ok",
"device_list": "ok"
},
"user": {},
"devices": [
{}
],
"user_error": "<string>",
"device_error": "<string>",
"hint": "<string>"
}Authorizations
Your deployment's API key (MMK_API_KEY). Your Plaud account credentials are stored server-side — you do not send them.
Response
Doctor report
Live connectivity probe result.
True only when every check passed.
The Plaud API host the probe used.
Show child attributes
Show child attributes
Present when the user check passed.
Present when the device check passed.
Actionable hint (present on 401).
Was this page helpful?

