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)                 # "391847"
# 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="US") 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)

num.wait_for_otp(timeout=60)

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

Returns: OtpResult(otp_code, from_number, 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 (CA, AU, DE, FR coming soon)

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.3.1.tar.gz (21.9 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.3.1-py3-none-any.whl (7.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: agentsim_sdk-0.3.1.tar.gz
  • Upload date:
  • Size: 21.9 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.3.1.tar.gz
Algorithm Hash digest
SHA256 5c875dece614c2f600133d7a18d82edcf1f1b66ca905dbdfdbcd1dfb0a230616
MD5 c63a482b63aae1067a0b26551e80cdd1
BLAKE2b-256 6b241d0c0f5ae5f3992edbcb7a480f1355750ea794e4b4719e44c341703c2de6

See more details on using hashes here.

Provenance

The following attestation bundles were made for agentsim_sdk-0.3.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.3.1-py3-none-any.whl.

File metadata

  • Download URL: agentsim_sdk-0.3.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.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 3d46504d2245f31c83c7d76d6e752c01279181a6b238bf285ea034be83b48d2d
MD5 8c4f808126d3b1830ee1590104694f59
BLAKE2b-256 dc3c332ed8fafc0dca5c7d0ab15d09d7d616c2ee4655d56e308b891432a87231

See more details on using hashes here.

Provenance

The following attestation bundles were made for agentsim_sdk-0.3.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