API Reference
OpenAPI reference for the Wraps Platform API with interactive documentation.
Reference
API Reference
OpenAPI reference for the Wraps Platform API. Browse endpoints, auth, and the interactive spec.
Base URL
All API requests are made to:
Authentication
Authenticate using a Bearer token in the Authorization header. Two methods are supported:
API Key
Prefixed with wraps_. Best for server-to-server and SDK usage.
Create keys in the dashboard under Settings > API Keys.
Session Token
better-auth session token. Used by the dashboard and browser-based clients.
Endpoints
The API is organized into endpoint groups. See the interactive docs for full request/response schemas.
HealthPublic
Health check and API info
GET
Contacts
Create, update, delete, and list contacts
GETPOSTPATCHPUTDELETE
Batch
Batch email sending for broadcasts
POST
Events
Custom event ingestion for triggering workflows
POST
Workflows
API-triggered workflow execution
POST
Connections
AWS account connection management
GETPOSTDELETE
WebhooksPublic
Receive SES delivery events
POST
UnsubscribePublic
RFC 8058 one-click unsubscribe
GETPOST
ToolsPublic
Free email deliverability tools
GETPOST
SDK Usage
The @wraps.dev/client SDK provides a typed wrapper around the API.
OpenAPI Spec
The full OpenAPI 3.0.3 specification is auto-generated from route definitions. Use it with any OpenAPI-compatible tool.
Interactive Docs
Browse and test endpoints in the Swagger UI.
Open Swagger UIJSON Spec
Import into Postman, Insomnia, Scalar, or any OpenAPI tool.
Download OpenAPI JSONNext Steps
Rate Limits
Per-minute and daily limits by plan.
View Rate LimitsError Codes
Complete reference for CLI and SDK error codes.
View Error CodesPlatform SDK
Typed TypeScript wrapper for the API.
View SDK ReferenceEnvironment Variables
All env vars for CLI, SDKs, and CI/CD.
View Env Vars