Skip to main content
Version: 1.0.0

Zyphr API

Zyphr is a multi-channel notification platform that enables developers to send emails, push notifications, SMS, and in-app messages through a unified API.

Authentication​

All API requests require authentication using an API key. Include your API key in the X-API-Key header:

X-API-Key: zy_live_xxxxxxxxxxxx

API keys can be created in the Zyphr Dashboard. Use zy_test_* keys for testing and zy_live_* keys for production.

Rate Limiting​

The API implements rate limiting to ensure fair usage. Rate limit information is included in response headers:

  • X-RateLimit-Limit: Maximum requests per window
  • X-RateLimit-Remaining: Remaining requests in current window
  • X-RateLimit-Reset: Unix timestamp when the window resets

Account Sending Status​

Every authenticated response carries the account's current sending state so you can surface it in your own tooling without a separate call:

  • X-Account-Sending-Status: active, throttled, or frozen
  • X-Account-Sending-Status-Reason: human-readable reason (present only when the status is throttled or frozen)

This header is informational and non-blocking on non-send endpoints (reads, billing, and deliverability stay available). Send-capable endpoints additionally enforce the state: a frozen account receives 403 account_frozen and a throttled account receives 429 account_throttled, both with the reason in the error message.

Errors​

All errors follow a consistent format:

{
  "error": {
    "code": "error_code",
    "message": "Human readable message",
    "details": {}
  },
  "meta": {
    "request_id": "req_xxxx"
  }
}

Authentication​

API key via X-API-Key header (zy_live_* or zy_test_*). Alternatively, pass via Authorization: Bearer <api_key>.

Security Scheme Type:

apiKey

Header parameter name:

X-API-Key

Contact

Zyphr Support: support@zyphr.dev

URL: https://zyphr.dev