Browser sessions last 5 minutes and consume 1 credit ($0.01).
Setting up
Get your free API key and start running tasks in minutes.Get your free API key
Unlock your free welcome credits. No credit card required.
What are Sessions?
Sessions allow you to persist cookies and authentication across runs. Once a session is created, it can be utilized for running agent tasks that require user authentication.- Create a Session Open a new session. The system will return a session_id (a unique identifier for your session) and a live_url (an interactive browser window).
- Authenticate via the Live URL Use the provided live_url to log in to the target platform (e.g., your project management tool, social media account) as you normally would. This action securely stores your authentication cookies within the session.
- Execute Tasks with the Session ID When running an agent task, simply include the session_id. The agent will use the stored authentication from that session, allowing it to immediately access the platform as a logged-in user.
Open a browser session using the Python SDK
Open a browser session in 4 lines of code.If Python is not your language of choice, check out our API Reference.
Parameters
All parameters available when opening a browser session.The unique identifier for the browser session. If omitted, a random session ID will be generated and returned.This id will be used when running a task.Example:
my-test-session
Request a live URL to interact with the browser session. Default:
True
.Set it to True
if you want to manually interact with the browser to perform logins or other authentications.
Set it to False
if you want to simply create an empty browser profile for Smooth to interact with in future tasks.Response
Returns aBrowserSessionHandle
with the following attributes.
Returns ID of the session.
Returns a live URL where you can interact with the browser (requires
live_view=True
).Set interactive=True
to get an interactive view.Set embed=True
to get an embeddable view (ideal for iframes).