Authentication

Obtain your credentials

The Email API client requires two values:

Your API key is available in the Paubox dashboard under API Credentials.

Set these in your shell or a .env file loaded by your application:

PAUBOX_API_KEY=YOUR_API_KEY
PAUBOX_HOST=https://api.paubox.com/v1

The SDK reads these automatically; no constructor arguments needed:

from paubox import PauboxApiClient

client = PauboxApiClient()

Pass credentials directly if you prefer not to use environment variables:

client = PauboxApiClient(
    api_key = 'YOUR_API_KEY',
    host    = 'https://api.paubox.com/v1'
)

The SDK sets the Authorization header automatically on every request:

Authorization: Token token=YOUR_API_KEY

PauboxFormsClient requires no credentials:

from paubox import PauboxFormsClient

forms_client = PauboxFormsClient()

⌘I