Skip to main content
Use the REST API when your platform owns orchestration over HTTP or when another language controls the workflow. The Python package is currently a stub. Python services should call the REST API directly until the Python SDK ships the TypeScript SDK surface.

Authentication

/health is public. Browser, file, download, recording, and execution endpoints require authentication.

Minimal lifecycle

The shell example uses jq to extract the browser ID from the create response. Browser lifecycle create and delete requests require an Idempotency-Key header. Create a browser:
Run an exact browser-code step against it:
Clean up:
The API reference covers status, advanced browser-code execution, files, downloads, dialogs, permissions, recordings, screenshots, PDFs, proxy fields, and cleanup.

Python over HTTP

When to prefer the SDK

Use the TypeScript SDK when your app is written in TypeScript and can call web.agent() directly. Use REST when the integration boundary is HTTP. Reference: API reference, TypeScript SDK reference, proxy reference, and policy reference.