sendmux-core

Shared runtime helpers for the Sendmux Python SDK packages.

Documentation

• Sendmux docs: sendmux.ai/docs
• Source repository: Sendmux/sendmux-sdk

Requirements

• Python 3.10 or newer.
• A surface package such as sendmux-sending, sendmux-mailbox, or sendmux-management for API operations.

Installation

pip install sendmux-core

Usage

Validate an API key prefix and prepare request headers before calling a surface package.

import os

from sendmux_core import conditional_headers, idempotency_headers, validate_api_key

validate_api_key(os.environ["SENDMUX_MAILBOX_API_KEY"], surface="mailbox")

headers = {
    **idempotency_headers("idem_123"),
    **conditional_headers(if_none_match='W/"etag"'),
}

Helpers

• validate_api_key checks smx_root_* prefixes for root clients, send-capable smx_mbx_* prefixes or owner-approved Sending-resource smx_agent_* tokens for Sending clients, and mailbox-compatible smx_mbx_* or smx_agent_* prefixes for Mailbox clients.
• configure_auth applies API-key bearer auth to generated client configuration objects. Surface factories also accept access_token as a bare token or callable; do not set both credential options.
• idempotency_headers and conditional_headers prepare request headers.
• iter_cursor_pages iterates cursor-paginated list responses.
• RetryOptions configures retry behaviour for generated clients. A single retry layer honours retryable: false, server retry delays and the total retry deadline.
• SendmuxApiError normalises API errors and request IDs.

Support

Open an issue in Sendmux/sendmux-sdk with the package name, version, and request ID from any API error.

Licence

MIT. See the licence file.