Metadata-Version: 2.5
Name: website-traveler
Version: 1.0.0
Summary: Official Python SDK for the Website Traveler browser agent API
Project-URL: Homepage, https://website-exploring-agent.vercel.app
Project-URL: Documentation, https://website-exploring-agent.vercel.app/docs
Project-URL: Repository, https://github.com/Sudhanshu-Roy/website-exploring-agent
Author: Website Traveler
License-Expression: MIT
Keywords: agent,api,browser,playwright,sdk,traveler
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Internet :: WWW/HTTP
Requires-Python: >=3.10
Requires-Dist: httpx>=0.27.0
Description-Content-Type: text/markdown

# website-traveler

Official Python SDK for the [Website Traveler](https://website-exploring-agent.vercel.app) API — cloud browser agent, goal in → structured JSON out.

## Install

```bash
pip install website-traveler
```

## Quickstart

```python
import os
from website_traveler import Traveler

client = Traveler(api_key=os.environ["TRAVELER_API_KEY"])

run = client.run(
    "Extract the main heading",
    url="https://example.com",
)
print(run.status, run.result)
```

Environment variables (optional):

- `TRAVELER_API_KEY` — API key (`trv_...`)
- `TRAVELER_API_URL` — API base URL (defaults to the production Cloud Run URL)

## Async-style control

```python
run = client.create_run("Extract the heading", url="https://example.com")
final = client.wait(run.id, poll_interval=2, timeout=600)
print(final.result)
```

## Errors

- `AuthenticationError` — invalid API key (401)
- `PaymentRequiredError` — no active subscription (402)
- `APIError` — other HTTP errors
- `TimeoutError` — poll exceeded `timeout`
- `RunFailedError` — run finished with `error` / failed status (optional raise)

Get your key at the [dashboard](https://website-exploring-agent.vercel.app/dashboard).
