instantlyai 0.2.0

Python SDK for the Instantly.ai API

instantlyai

A typed, importable Python client for the Instantly.ai V2 API.

• A clean, resource-based client: client.campaigns.list(...), client.leads.create(...).
• Full end-to-end typing, generated from Instantly's OpenAPI spec -- real editor and type-checker support.
• Sync and async clients from a single codebase (Instantly / AsyncInstantly).
• Typed exceptions, auto-retry with backoff, and auto-paginating list methods.

Status: pre-1.0 (0.x). Minor version bumps may include breaking changes until 1.0.0 -- pin accordingly. See the changelog.

Install

pip install instantlyai

Quickstart

Set INSTANTLY_API_KEY in your environment, or pass api_key=... explicitly.

"""Quickstart: authenticate and list your campaigns.

Runnable as-is once ``INSTANTLY_API_KEY`` is set in the environment. Also
executed in CI (see ``tests/test_examples.py``) against a mocked API, so this
file can never drift from what actually works.
"""

from __future__ import annotations

import instantlyai


def main(client: instantlyai.Instantly) -> None:
    for campaign in client.campaigns.list(limit=10):
        print(campaign.id, campaign.name)


if __name__ == "__main__":
    with instantlyai.Instantly() as client:  # reads INSTANTLY_API_KEY from the environment
        main(client)

Async usage is the same shape, with AsyncInstantly and await/async for.

Docs

Full documentation, including the tutorial and API reference, lives at https://exprtec.github.io/instantlyai-python-sdk.

• Authenticate
• Run a campaign
• Handle rate limits
• Async usage

Contributing

See CONTRIBUTING.md.