Check the connection

The health check an AI agent calls first (the notix_ping tool).

GEThttps://app.usenotix.dev/api/v1/ping

Full access and sending access keys can call this. Key permissions lists the extra rules some calls have.

The health check an AI agent calls first (the notix_ping tool). Returns the plan, the verified domains this key can send from, this key's limits, how many MCP tools it is offered and a next step. Reads only; every working key may call it: full access, send only, read only and live AI.

Headers

Authorizationstringrequired

Bearer followed by your API key.

curl -X GET "https://app.usenotix.dev/api/v1/ping" \
  -H "Authorization: Bearer $NOTIX_API_KEY"
Response200
{
  "ok": true,
  "plan": "free",
  "key": {
    "id": 1,
    "name": "Acme",
    "permission": "SENDING",
    "paused": true
  },
  "senders": {
    "verifiedDomains": [
      "string"
    ]
  },
  "limits": {
    "requestsPerSecond": 1,
    "requestsPerMinute": 1,
    "dailySendCap": 1,
    "monthlySendCap": 1,
    "smsDailyCap": 1,
    "approval": {
      "policy": "string",
      "overRecipients": 1
    }
  },
  "tools": 1,
  "nextStep": "string"
}
Open in ClaudeOpen in ChatGPT