SDK clients
Choose a published client, authenticate with your team API key, and call /api/v1 with envelope handling where the SDK supports it.
Loading article…
Integrators should use a published client for /api/v1 instead of hand-rolling HTTP. Each client is generated from the same OpenAPI spec as this API reference and targets https://api.emailguard.co.
Current client version: 1.0.0 (all published packages share this semver). The public API exposes 20 operations — listed below and in the sidebar.
See API key scopes for scope names. Keys use Authorization: Bearer gsk_live_... or X-API-Key.
| Client | Guide |
|---|---|
| TypeScript (npm) | TypeScript SDK |
| Go module | Go SDK |
| Python (PyPI) | Python SDK |
| PHP (Composer) | PHP SDK |
| Ruby (RubyGems) | Ruby SDK |
| MCP (AI assistants) | MCP integration |
Language-specific guides include install commands, quickstart code pulled from the same generator as API reference tabs, and links to every route.
Most clients accept the same runtime credentials:
| Variable | Required | Description |
|---|---|---|
EMAILGUARD_API_KEY | Yes | Team-scoped live key (egsk_live_...) |
API_KEY is accepted as an alias in most clients.
Successful JSON responses look like:
{
"code": "SUCCESS",
"data": { "..." : "..." },
"message": "OK"
}The TypeScript SDK and MCP server unwrap data for you. Go, Python, PHP, and Ruby generators return raw HTTP bodies — read data when code is SUCCESS. Each SDK guide explains the pattern for that language.
Endpoints grouped by OpenAPI tag (each links to interactive docs with SDK samples):
Custom tool routes (/api/v1/tools/*) appear when your deployment registers them in the public spec.
All clients share the same per-minute limits and monthly API quota. See API rate limiting for 429 handling, Retry-After, and quota headers.
Use the sidebar for every route, request body, and schema. On each endpoint page, switch language tabs (TypeScript, Python, Go, or Other for PHP/Ruby/cURL) for copy-paste samples generated from your deployment’s OpenAPI document.