Sessions

Create running browser session to use remotely.

Last updated 1 month ago

GetSession

get

Retrieves detailed information about a specific browser session, including its status, settings, and remaining lease time.

Authorizations

Path parameters

modestringrequired

sessionUUIDstringrequiredExample: dcf639f1-1ecb-4208-8ef2-02d7a02b0997

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.tasknet.co/{mode}/v1/sessions/{sessionUUID}' \
  --header 'X-Api-Key: YOUR_API_KEY'

200

{
  "sessionUUID": "576626a7-2953-4790-8bc5-28a2e247ac03",
  "fingerprintUUID": "576626a7-2953-4790-8bc5-28a2e247ac03",
  "currentLeaseTime": 5,
  "isVncEnabled": true,
  "createdAt": "2025-02-04T11:06:29.731Z",
  "updatedAt": "2025-02-04T11:06:29.731Z",
  "driver": "puppeteer",
  "status": "running",
  "vncMode": "rw"
}

Session details

EndSession

delete

Terminates a browser session immediately, releasing all associated resources and ending the lease.

Authorizations

Path parameters

modestringrequired

sessionUUIDstringrequiredExample: dcf639f1-1ecb-4208-8ef2-02d7a02b0997

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'https://api.tasknet.co/{mode}/v1/sessions/{sessionUUID}' \
  --header 'X-Api-Key: YOUR_API_KEY'

200

{}

Session terminated successfully

ListSessions

get

Retrieves a list of all active browser sessions in your environment, including their status, VNC settings, and lease times.

Authorizations

Path parameters

modestringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.tasknet.co/{mode}/v1/sessions' \
  --header 'X-Api-Key: YOUR_API_KEY'

200

{
  "sessions": [
    {
      "sessionUUID": "576626a7-2953-4790-8bc5-28a2e247ac03",
      "fingerprintUUID": "576626a7-2953-4790-8bc5-28a2e247ac03",
      "currentLeaseTime": 5,
      "isVncEnabled": true,
      "createdAt": "2025-02-04T11:06:29.731Z",
      "updatedAt": "2025-02-04T11:06:29.731Z",
      "driver": "puppeteer",
      "status": "running",
      "vncMode": "rw"
    }
  ]
}

List of active browser sessions

CreateSessionWithoutFingerprint

post

Creates a new browser session using a specified fingerprint (OPTIONAL). Configure VNC access, lease time, and other session parameters.

Authorizations

Path parameters

modestringrequired

Header parameters

X-Fingerprint-SecretstringoptionalExample: {{fingerprintSecret}}

X-Environment-IdstringoptionalExample: {{env_uuid}}

X-Environment-SecretstringoptionalExample: {{env_secret}}

Body

fingerprintUUIDstring · uuidoptionalExample: 576626a7-2953-4790-8bc5-28a2e247ac03

leaseTimeinteger · min: 1 · max: 60required

Duration of the session lease in minutes

Example: 5

isVncEnabledbooleanrequired

Whether VNC access is enabled for this session

vncModestring · enumrequired

VNC access mode (read-write or read-only)

Available options:

driverstring · enumrequired

Browser automation driver type

Available options:

showMousebooleanoptional

Whether to show mouse movements

Default: false

isProxyEnabledbooleanoptional

Whether to enable proxy for this session

Default: false

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.tasknet.co/{mode}/v1/sessions' \
  --header 'X-Api-Key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "fingerprintUUID": "576626a7-2953-4790-8bc5-28a2e247ac03",
    "leaseTime": 5,
    "isVncEnabled": true,
    "vncMode": "rw",
    "driver": "puppeteer",
    "showMouse": true,
    "isProxyEnabled": true
  }'

200

{
  "sessionUUID": "576626a7-2953-4790-8bc5-28a2e247ac03",
  "fingerprintUUID": "576626a7-2953-4790-8bc5-28a2e247ac03",
  "currentLeaseTime": 5,
  "isVncEnabled": true,
  "createdAt": "2025-02-04T11:06:29.731Z",
  "updatedAt": "2025-02-04T11:06:29.731Z",
  "driver": "puppeteer",
  "status": "running",
  "vncMode": "rw"
}

Session created successfully

UpdateSession

patch

Updates the settings of an active browser session. Currently supports extending the lease time.

Authorizations

Path parameters

modestringrequired

sessionUUIDstringrequiredExample: dcf639f1-1ecb-4208-8ef2-02d7a02b0997

Body

newLeaseTimeintegerrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PATCH \
  --url 'https://api.tasknet.co/{mode}/v1/sessions/{sessionUUID}' \
  --header 'X-Api-Key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "newLeaseTime": 1
  }'

200

{}

Session lease time updated successfully