Skip to main content
POST
/
v1
/
profiles
Create Profile
curl --request POST \
  --url https://api.bctrl.ai/v1/profiles \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "config": {
    "proxy": {
      "type": "<string>",
      "host": "<string>",
      "port": 123,
      "username": "<string>",
      "password": "<string>"
    },
    "humanize": true
  }
}
'
{
  "id": "<string>",
  "kind": "<string>",
  "name": "<string>",
  "status": "<string>",
  "humanize": true,
  "hasProxy": true,
  "createdAt": "<string>"
}
​
name
string
Profile name (auto-generated if omitted).
​
config
object
Profile configuration.

​
Examples

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

// Named-browser API
await bctrl.browser('my-browser').create({
  proxy: { type: 'http', host: 'proxy.example.com', port: 8080 },
  humanize: true,
});

// Raw profiles API
const profile = await bctrl.profiles.create({ name: 'my-browser' });

​
Response

​
id
string
required
Profile ID.
​
kind
string
required
Profile kind.
​
name
string
required
Profile name.
​
status
string
required
Profile status.
​
humanize
boolean
required
Default humanize setting.
​
hasProxy
boolean
required
Whether a proxy is configured.
​
createdAt
string
required
Creation timestamp.
Response Example
{
  "id": "prof_abc123",
  "name": "my-browser",
  "status": "stopped"
}