Skip to main content
POST
/
v1
/
profiles
/
{id}
/
connect
Connect to Profile
curl --request POST \
  --url https://api.bctrl.ai/v1/profiles/{id}/connect \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "driver": "<string>"
}
'
{
  "profileId": "<string>",
  "sessionId": "<string>",
  "hostId": "<string>",
  "driver": "<string>",
  "reused": true,
  "driverChanged": true
}
id
string
required
Profile ID.
driver
string
Optional driver to connect: playwright, puppeteer, stagehand, or selenium. Defaults to playwright when omitted.

Examples

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

const result = await bctrl.profiles.connect('prof_abc123');

Response

profileId
string
required
Profile ID.
sessionId
string
required
Session ID.
hostId
string
required
Host ID.
driver
string
required
Connected driver name.
reused
boolean
required
Whether an existing connection was reused.
driverChanged
boolean
required
Whether the driver was changed from a previous connection.