Skip to main content
POST
/
browser
/
session
curl -X POST "https://api.smooth.sh/api/v1/browser/session" \
     -H "Content-Type: application/json" \
     -H "apikey: YOUR_API_KEY" \
     -d '{
       "session_id": "my-persistent-session"
     }'
{
  "profile_id": "<string>",
  "live_id": "<string>",
  "live_url": "<string>"
}

Authorizations

​
apikey
string
header
required

Body

application/json

Request model for creating a browser session.

​
profile_id
string | null

The profile ID to open in the browser. If None, a new profile will be created with a random name.

​
live_view
boolean

Whether to open a live browser instance using the specified profile.

​
device
enum<string>

The device type for the browser session. Note that mobile does not support navigation via the search bar, so a starting URL must be provided.

Available options:
desktop,
mobile
​
url
string<uri> | null

The starting URL to open in the browser session. If None, a blank page will be opened.

​
proxy_server
string | null

Proxy server address to route browser traffic through.

​
proxy_username
string | null

Username for proxy server authentication, if required.

​
proxy_password
string | null

Password for proxy server authentication, if required.

Response

Successful Response

Browser session response model.

​
profile_id
string
required

The ID of the browser profile associated with the opened browser session.

​
live_id
string

The unique identifier for the live browser session.

​
live_url
string

The live URL to interact with the browser session.