SDKs

    Official SDKs cover every API-key-authenticated endpoint documented here. Pick the language that fits your project - both share the same mental model and method names (translated snake_case ↔ camelCase).

    Install

    python
    pip install nopaque

    Quick start

    python
    from nopaque import Nopaque

client = Nopaque(api_key="nq_...")  # or set NOPAQUE_API_KEY

# Create a mapping job and wait for completion
job = client.mapping.create(
    name="Main IVR",
    phone_number="+441234567890",
    mapping_mode="dtmf",
)
client.mapping.start(job.id)
final = client.mapping.wait_for_complete(job.id)
print(final.status)

client.close()

    Client configuration

    All options are optional unless you aren't using the environment variable. Both SDKs read NOPAQUE_API_KEY and NOPAQUE_BASE_URL automatically.

    python
    Nopaque(
    api_key="nq_...",                       # or env NOPAQUE_API_KEY
    base_url="https://api.nopaque.co.uk",    # or env NOPAQUE_BASE_URL
    timeout=60.0,                            # seconds
    max_retries=3,                           # set to 0 to disable
    default_headers={"X-Source": "worker"},
)

    Authentication

    Both SDKs use the workspace API key in the x-api-key header. See Authentication for how to create a key and tier restrictions.

    Common patterns

    Source