Skip to main content

Python client for the stablebrowse browser agent API

Project description

stablebrowse (Python)

Python client for the stablebrowse browser agent API.

Install

From PyPI (once published):

pip install stablebrowse

From source (for local development):

cd sdks/python
pip install -e .

Requires Python 3.9+. Depends on httpx.

Quick start

from stablebrowse import Stablebrowse

# Bearer token comes from either the constructor or the
# STABLEBROWSE_API_KEY environment variable.
client = Stablebrowse(api_key="sb_live_...")

# (Optional) upload per-end-user social-media credentials.
client.end_users("alice").credentials.set(
    twitter_auth_token="...",
    twitter_ct0="...",
)

# Sync-feeling submit. Polls internally until the task terminates.
result = client.tasks.run(
    end_user_id="alice",
    task="find the top AI tweets today",
)
print(result.result)

Async primitives

If you want to drive the poll loop yourself — for example, to push progress into your own queue, or to run many submissions in parallel with your own scheduler — use the raw methods:

submission = client.tasks.submit(end_user_id="alice", task="...")
while True:
    task = client.tasks.get(submission.task_id)
    if task.is_terminal:
        break
    time.sleep(2)

Multi-turn conversations

Pass the session_id you got from the first call to continue a conversation:

first = client.tasks.run(end_user_id="alice", task="who's trending on X?")
follow = client.tasks.run(
    end_user_id="alice",
    task="what about in music specifically?",
    session_id=first.session_id,
)

The server builds previousContext from the last completed turn so the agent has the earlier answer when it reasons about the follow-up.

End users and credentials

Each business scopes end-users by opaque identifier — "alice" inside your business is independent of any other business's "alice":

alice = client.end_users("alice")

alice.credentials.set(
    tiktok_session_id="...",
    tiktok_csrf_token="...",
)

status = alice.credentials.get()
assert status.platforms["tiktok"] is True

# Remove all creds
alice.credentials.delete()

# Or a specific subset
alice.credentials.delete(fields=["twitter_auth_token", "twitter_ct0"])

Field names are snake_case in Python and get translated to camelCase on the wire automatically.

API key management

Create and revoke keys in the dashboard under Settings → API Keys. Key lifecycle is dashboard-only by design — a leaked key can't mint more.

Errors

Every exception derives from StablebrowseError:

  • TaskFailedrun() saw the task finish with status=failed. The failed Task is on .task.
  • TaskTimeout — the poll deadline expired before the task terminated. The still-running Task is on .task so you can keep polling.
  • StablebrowseError — every other HTTP or transport error. .status_code and .body are populated when the server returned structured JSON.

Configuration

The constructor reads a couple of env vars if you don't pass them:

  • STABLEBROWSE_API_KEY — bearer token
  • STABLEBROWSE_BASE_URL — override the API base, useful for pointing at beta or a local gateway

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

stablebrowse-0.2.0.tar.gz (8.7 kB view details)

Uploaded Source

Built Distribution

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

stablebrowse-0.2.0-py3-none-any.whl (8.8 kB view details)

Uploaded Python 3

File details

Details for the file stablebrowse-0.2.0.tar.gz.

File metadata

  • Download URL: stablebrowse-0.2.0.tar.gz
  • Upload date:
  • Size: 8.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.15

File hashes

Hashes for stablebrowse-0.2.0.tar.gz
Algorithm Hash digest
SHA256 0bc4034246b615be9e8c7bda8433c34b7e632e06080266a8fe9d85ff038ae4a1
MD5 9a21e926f9ee95e05f28e24f482fbcca
BLAKE2b-256 9475a3f73ff378fb57a13ba85fa0649af58b8fcebdf9952f040c62749e33fcff

See more details on using hashes here.

File details

Details for the file stablebrowse-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: stablebrowse-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 8.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.15

File hashes

Hashes for stablebrowse-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 4a90678fdfb27214743e86499d1d31313b3fa7533fd451193a5098b2d76be8f6
MD5 a08a23bd80268c325216aad9b35497d4
BLAKE2b-256 0c1e6d27715d8cc0c91760a79ce085e71518a1029521dc245c369d3da611b7b7

See more details on using hashes here.

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