Skip to main content
GET
/
plaud
/
doctor
Health check
curl --request GET \
  --url https://{deployment}/api/v1/plaud/doctor \
  --header 'X-API-KEY: <api-key>'
{
  "ok": true,
  "api_domain": "<string>",
  "checks": {},
  "user": {},
  "devices": [
    {}
  ],
  "user_error": "<string>",
  "device_error": "<string>",
  "hint": "<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.

Response

Doctor report

Live connectivity probe result.

​
ok
boolean

True only when every check passed.

​
api_domain
string

The Plaud API host the probe used.

​
checks
object
​
user
object

Present when the user check passed.

​
devices
object[]

Present when the device check passed.

​
user_error
string
​
device_error
string
​
hint
string

Actionable hint (present on 401).