Skip to main content
POST
/
v1beta
/
tasks
/
{id}
/
start-manual-session
Start a manual session
curl --request POST \
  --url https://api.example.com/v1beta/tasks/{id}/start-manual-session \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "use_proxy": false
}
'
{
  "session_id": "<string>",
  "iframe_url": "<string>"
}

Authorizations

​
Authorization
string
header
required

Enter your API key as the bearer token. Set header: Authorization to Bearer <api_key>

Path Parameters

​
id
string<uuid>
required

The ID of the task to perform manually.

Body

application/json
​
use_proxy
boolean
default:false

If true, spawn the browser session using a proxy.

Response

Successful response

​
session_id
string
required

Opaque identifier for the spawned browser session.

​
iframe_url
string
required

URL to embed in an iframe to control the browser.