Status

Inspect the database, sender identity, and available capabilities.

2 endpoints · API 0.5.1-rc.3

Read the usage guide ↗

Read sender identity and capabilities

#

Operation ID: getSender

relayToken↗

GET/v1/sender

Request

No parameters or request body.

Responses

200Current sender status.

Content type application/json

Sender ↗

401, 500Error responses

401

Missing or invalid bearer token.

500

The request failed.

Content type application/json

APIError ↗

Headers on every response

X-Request-IDstringRequired

Request correlation identifier.

Read service, database, and sender status

#

Operation ID: getStatus

relayToken↗

GET/v1/status

Reports readiness and sender permissions without running AppleScript or requesting permissions. A database that is not ready is represented in the 200 response, not as an HTTP failure.

Request

No parameters or request body.

Responses

200Service, database, and sender status.

Content type application/json

ServiceStatus ↗

401, 500Error responses

401

Missing or invalid bearer token.

500

The request failed.

Content type application/json

APIError ↗

Headers on every response

X-Request-IDstringRequired

Request correlation identifier.