Authentication

Configure your Paubox API credentials for the Python SDK.

Obtain your credentials

The Email API client requires two values:

• API key: a secret token that authenticates your requests
• API host: the full endpoint URL for your account, which includes your username

Both are available in the Paubox dashboard under API Credentials.

Environment variables (recommended)

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

PAUBOX_API_KEY=YOUR_API_KEY
PAUBOX_HOST=https://api.paubox.net/v1/YOUR_USERNAME

Replace YOUR_USERNAME with your Paubox API endpoint username. The SDK reads these automatically; no constructor arguments needed:

from paubox import PauboxApiClient

client = PauboxApiClient()

Constructor parameters

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

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

The SDK sets the Authorization header automatically on every request:

Authorization: Token token=YOUR_API_KEY

Forms client

PauboxFormsClient requires no credentials:

from paubox import PauboxFormsClient

forms_client = PauboxFormsClient()

Security notes

• Never hard-code credentials in source files.
• The SDK does not log API keys or request bodies.