REST first

Build on the sGPT deliverability platform

Access campaign orchestration, seed inbox telemetry, and compliance insights programmatically with secure, well-documented APIs.

Download OpenAPI spec Back to docs

Authentication

All endpoints require bearer tokens generated in the dashboard. Tokens are scoped to workspaces and respect role-based permissions.

Authorization: Bearer <workspace_token>

Rotate tokens every 90 days

Core endpoints

Each endpoint supports idempotency keys, granular error codes, and workspace-scoped rate limits.

POST/v1/workspaces/{workspaceId}/campaigns

Create a new campaign with audience, content, and scheduling metadata.

POST/v1/smtp/accounts/{accountId}/warmups

Trigger an adaptive warm-up sequence for the specified SMTP account.

GET/v1/inbox/placements

Retrieve deliverability scores and seed inbox placement snapshots.

POST/v1/tools/email-validator

Submit a batch of addresses for validation and verification scoring.

Example request

curl -X POST https://api.sgpt.dev/v1/workspaces/ws_123/campaigns \
  -H "Authorization: Bearer sk_live_..." \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Welcome Series",
    "from": "[email protected]",
    "subject": "Welcome to our platform",
    "recipients": ["[email protected]"],
    "schedule": "immediate"
  }'

Webhook events

Receive live notifications when campaigns send, deliver, bounce, or trigger compliance thresholds.

POST https://your-app.com/webhooks/sgpt

Webhooks deliver JSON payloads with signature headers. Validate with our SDKs or HMAC utilities.

HMAC SHA-256 signatures with timestamp replay protection.

Retry policy: backoff with jitter, max 10 attempts.

SDKs for Node, Python, and Go ship with typed helpers.

Official SDKs

Get started quickly with our official client libraries and comprehensive type definitions.

Node.js

TypeScript SDK with full type definitions and async/await support.

View on GitHub →

Python

Python SDK with Pydantic models and comprehensive error handling.

View on GitHub →

Go

Go SDK with context support and structured logging.

View on GitHub →

Need a guided integration?

Our developer relations team can review architecture, share best practices, and accelerate your launch.

Request scoped tokens for sandbox and production workspaces.

White-glove webhook configuration and monitoring.

Schedule integration call

Example request

curl -X POST https://api.sgpt.dev/v1/workspaces/ws_123/campaigns \
  -H "Authorization: Bearer sk_live_..." \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Welcome Series",
    "from": "[email protected]",
    "subject": "Welcome to our platform",
    "recipients": ["[email protected]"],
    "schedule": "immediate"
  }'