ai-newsletter 1.0.0

Official Python SDK for the Signal AI / AI Newsletter public REST API.

ai-newsletter (Python)

Official Python SDK for the Signal AI public REST API.

Install

pip install ai-newsletter

Quick start

from ai_newsletter import AiNewsletter

with AiNewsletter(api_key="sk_live_…") as client:  # or sk_test_…
    client.subscribers.create(newsletter_id="d5…", email="[e-mail]")

    job = client.sends.create(
        newsletter_id="d5…",
        type="transactional",
        to="[e-mail]",
        subject="Welcome!",
        html="<p>Hi Jane</p>",
    )

    stats = client.analytics.for_newsletter("d5…")
    print(stats["open_rate"])

Pagination

for sub in client.subscribers.iterate(newsletter_id="d5…"):
    print(sub["email"])

Retries & timeouts

Retries (with exponential backoff and jitter) are automatic for 408 / 425 / 429 / 5xx and network errors. Retry-After is honoured.

client = AiNewsletter(api_key="…", max_retries=5, timeout=60.0)

Errors

from ai_newsletter import AiNewsletterError

try:
    client.subscribers.create(...)
except AiNewsletterError as e:
    print(e.status, e.code, str(e), e.retry_after)

Verify webhooks

from ai_newsletter import verify_webhook_signature

if not verify_webhook_signature(raw_body, request.headers["X-Webhook-Signature"], SECRET):
    abort(401)

Test mode

Pass an sk_test_ key — all traffic targets the sandbox tables. client.is_test reports the mode.

License

MIT