System
Health, identity, search, devices, models, and the OpenAPI manifest.
These endpoints report status and identity. To read or change app settings, see the config reference.
Endpoints
| Method + path | Scope | Notes |
|---|---|---|
GET /health | none | No token required. Returns four blocks: status, version, webhooks:{events_dropped, deliveries_failed}, and license:{fail_open_total}. deliveries_failed counts webhook deliveries that exhausted every retry, so a permanently-broken endpoint is visible here. fail_open_total counts requests let through because license verification could not complete, so persistent fail-open activity is visible without polling logs. |
GET /v1/whoami | Read | Returns {token_id, scopes[], license_tier}. This is the standard first call an automation makes, right after /health. |
GET /v1/search?q= | Read | Returns {results:[{meeting_id,title,match_context,timestamp,audio_start_time?}]}. |
GET /v1/devices | Read | Returns {devices:[{name,device_type}]}. |
GET /v1/models | Read | Returns {models:[{name,size_mb,accuracy,speed,status,description,is_custom}]}. Read-only, no download or delete. |
GET /openapi.json | Read | The machine-readable OpenAPI 3.1 manifest for the whole API (it describes every route, so it needs the Read scope). |
Health check
GET /health needs no token and is the standard first call of any preflight. The response has four top-level blocks:
{
"status": "ok",
"version": "1.9.0",
"webhooks": {
"events_dropped": 0,
"deliveries_failed": 0
},
"license": {
"fail_open_total": 0
}
}license.fail_open_total is a diagnostic counter
It tracks requests let through while license verification could not complete. A rising count means license checks are failing open, not that anything is broken; treat it the same way as webhooks.deliveries_failed, worth watching, not worth alarming on a single nonzero value.
curl -s http://127.0.0.1:8420/healthmeetily-pro healthfrom meetily_agent import MeetilyClient
print(MeetilyClient().system.health())Identify the caller
GET /v1/whoami returns your token id, its scopes, and the license tier. Use it to confirm what a token can do before you rely on it.
curl -s http://127.0.0.1:8420/v1/whoami -H "Authorization: Bearer $MEETILY_PRO_TOKEN"meetily-pro whoami --jsonfrom meetily_agent import MeetilyClient
print(MeetilyClient().system.whoami())OpenAPI manifest
GET /openapi.json returns the OpenAPI 3.1 document for the whole API. It needs a Read-scoped token (the manifest describes every route). Point codegen or schema-validation tooling at it directly.
curl -s http://127.0.0.1:8420/openapi.json -H "Authorization: Bearer $MEETILY_PRO_TOKEN"No CLI or SDK wrapper
There is no meetily-pro command or Python method for this endpoint; call it directly with curl or an HTTP client.
Last updated on