Developer Guide

Envelark Platform Documentation

The Envelark Version 1 REST API provides comprehensive programmatic access for core messaging, thread synchronization, transactional template dispatch, HMAC webhook processing, and embeddable inbox components.

Architecture & Protocol

  • Protocol: REST over HTTPS.
  • Format: All request bodies and responses are standard UTF-8 JSON.
  • Authentication: Bearer API key header (Authorization: Bearer YOUR_API_KEY) or custom headers X-Envelark-Api-Key: YOUR_API_KEY / X-Api-Key: YOUR_API_KEY. Keys use the production prefix elv_live_ (the legacy env_live_ prefix alias is also accepted).
  • Idempotency: Safe mutation retry supported via Idempotency-Token header.
  • Rate Limit: 120 requests per 60-second window enforced per client.

Quick Start: Health & Runtime Status

Verify platform connectivity without requiring authentication using the public health endpoint (note: if an Authorization or API key header is sent with the request, the API middleware still validates the key and returns 401 Unauthorized if invalid):

curl -X GET https://envelark.com/api/v1/health

Example JSON Response (HTTP 200 OK):

{
  "status": "healthy"
}

Core Platform Endpoints

GET /api/v1/mailboxes
Scope: mail.read

Returns all hosted, shared, and connected IMAP mailboxes accessible to the authenticated workspace.

GET /api/v1/threads?view=inbox
Scope: mail.read

Lists email threads with full pagination, attachment counts, unread status, and smart category filters.

POST /api/v1/send
Scope: mail.write

Dispatches transactional emails using SaaS templates (password reset, receipts, OTPs) with dynamic brand styling.

POST /api/v1/elept/share
Scope: files.write

Generates persistent Elept Rooms and authenticated cloud share links for oversized files and documents.