Skip to main content

AgentSIM Python SDK — autonomous OTP relay for AI agents

Project description

agentsim

Autonomous OTP relay for AI agents. AgentSIM provisions real carrier-routed phone numbers, receives inbound SMS, and delivers parsed OTP codes back to your agent — no human relay needed.

Install

uv add agentsim

Or with pip:

pip install agentsim

Quickstart

import agentsim

async with agentsim.provision(agent_id="checkout-bot", country="US") as num:
    await enter_phone_number(num.number)          # "+14155552671"
    otp = await num.wait_for_otp(timeout=60)
    await enter_otp(otp.otp_code)                 # "847291"
# number auto-released

Auth

Set AGENTSIM_API_KEY in your environment, or call agentsim.configure() at startup:

agentsim.configure(api_key="asm_live_xxx")

Get your API key at agentsim.dev/dashboard.

API

agentsim.provision(*, agent_id, country="US", ttl_seconds=3600, webhook_url=None)

Returns an async context manager. Provisions a number on enter, auto-releases on exit (even if the body raises).

async with agentsim.provision(agent_id="stripe-setup", country="DE") as num:
    print(num.number)   # E.164 phone number
    print(num.session_id)
    otp = await num.wait_for_otp(timeout=30)
    print(otp.otp_code, otp.confidence)

num.wait_for_otp(timeout=60)

Long-polls until an OTP arrives or timeout seconds elapse.

Returns: OtpResult(otp_code, confidence, method, received_at)

Raises: OtpTimeoutError if no OTP arrives within timeout seconds.

agentsim.provision_sync(...) / num.wait_for_otp_sync(timeout=60)

Synchronous variants for non-async codebases:

with agentsim.provision_sync(agent_id="x") as num:
    otp = num.wait_for_otp_sync(timeout=60)

Error Reference

Exception When
AuthenticationError Missing or invalid API key
PoolExhaustedError No numbers available in requested country
OtpTimeoutError No OTP arrived within timeout seconds
RateLimitError Too many requests — back off and retry
SessionNotFoundError Session expired or already released

Supported Countries

US, GB, DE, FR, NL, EE

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

agentsim_sdk-0.1.1.tar.gz (22.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

agentsim_sdk-0.1.1-py3-none-any.whl (7.9 kB view details)

Uploaded Python 3

File details

Details for the file agentsim_sdk-0.1.1.tar.gz.

File metadata

  • Download URL: agentsim_sdk-0.1.1.tar.gz
  • Upload date:
  • Size: 22.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for agentsim_sdk-0.1.1.tar.gz
Algorithm Hash digest
SHA256 baca1427988f4a89cb5f7fc83c4886be9de3b38b90d58e6d81a49e4535a1de1d
MD5 391316c9c3e0b1536dffdd75b86805b0
BLAKE2b-256 7e9d7d4fb73f490dab68d97c1b4cc55e2a3e828d58adf8d9edb7d9f075831803

See more details on using hashes here.

Provenance

The following attestation bundles were made for agentsim_sdk-0.1.1.tar.gz:

Publisher: publish-pypi.yml on Fato07/agentsim

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file agentsim_sdk-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: agentsim_sdk-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 7.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for agentsim_sdk-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 dc37caa38e2357717473e5a9a630a337832b078bd0e9a76807762727d1765840
MD5 f402b5ab5fd614a70d1f63b071745bb8
BLAKE2b-256 966860d8e1b2ef0c9cbe5a7e9c0d6bdcefde196ba91024211263d0da779651c5

See more details on using hashes here.

Provenance

The following attestation bundles were made for agentsim_sdk-0.1.1-py3-none-any.whl:

Publisher: publish-pypi.yml on Fato07/agentsim

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page