Skip to main content
POST
/
v1
/
profiles
/
{id}
/
start
Start Profile
curl --request POST \
  --url https://api.bctrl.ai/v1/profiles/{id}/start \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "humanize": true,
  "proxy": {
    "type": "<string>",
    "host": "<string>",
    "port": 123,
    "username": "<string>",
    "password": "<string>"
  },
  "storage": "<string>"
}
'
{
  "profileId": "<string>",
  "sessionId": "<string>",
  "status": "<string>",
  "waited": true
}
​
id
string
required
Profile ID.
​
humanize
boolean
Override humanize setting for this session.
​
proxy
object
Override proxy for this session.
​
storage
string
Storage workspace name.
The browser process launches but no driver is attached yet. Use the Connect endpoint to attach a driver.

​
Examples

import { Bctrl } from '@bctrl/sdk';
const bctrl = new Bctrl({ apiKey: process.env.BCTRL_API_KEY! });

// Named-browser API
await bctrl.browser('my-browser').start();

// Raw profiles API
const result = await bctrl.profiles.start('prof_abc123');
console.log(result.sessionId);

​
Response

​
profileId
string
required
Profile ID.
​
sessionId
string
required
Created session ID.
​
status
string
required
started or already_running.
​
waited
boolean
required
Whether it waited for a previous session to stop.