API Reference

Complete API endpoint documentation for the platform.

Base URL: http://localhost:8000

Email API

Send, receive, and manage emails

OTP & Contact API

One-time passwords and contact forms

Templates API

Create and manage email templates

Webhooks API

Real-time event notifications

Organizations API

Orgs, workspaces, projects, team management

Error Catalog

Complete error code reference

Standard Error Response

All API endpoints return errors in a consistent format:

Error Responsejson

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Human-readable error description",
    "details": {"field": "to_emails", "reason": "field required"},
    "request_id": "req_xyz"
  },
  "timestamp": "2026-07-13T12:00:00Z",
  "version": "v1"
}

HTTP Status Codes

Code	Description
200	Success
201	Created
400	Bad Request — invalid parameters
401	Unauthorized — missing or invalid API key
404	Not Found
409	Conflict — duplicate resource
422	Unprocessable Entity — validation error
429	Too Many Requests — rate limit exceeded
500	Internal Server Error

Rate Limiting

The platform applies rate limits per API key. Limits are configurable per product.

Limit	Default
Requests per second	10
Emails per hour	1000
OTP per minute	3 per email

Rate limit headers are returned in all responses:

X-RateLimit-Limit: 10
X-RateLimit-Remaining: 7
X-RateLimit-Reset: 1720800000