Skip to main content
POST
Create antidetect browser

Authorizations

Authorization
string
header
required

Access token issued by gtm.service.id. Its access_identity claim carries team_sid, actor_sid and actor_type, and that team scope is authoritative.

Team-SID
string
header
required

Team scope for tokens that do not carry one. Ignored when the token already names a team.

Body

application/json

Request body of create_antidetect_browser.

vendor_provider
enum<string>

Default gologin (the only wired vendor).

Available options:
gologin,
multilogin,
adspower,
dolphin
vendor_profile_id
string | null

Bind an EXISTING vendor profile (BYO): the GoLogin profile id, 24 hex characters. NOT a profile URL, share link or LinkedIn slug. Omit to mint a fresh one. The profile must be shared with our GoLogin account, or the create is 422 vendor_profile_not_found; if the owning GoLogin account is over its plan the create is 402 vendor_profile_plan_limit and retrying will not help.

Pattern: ^[0-9a-f]{24}$
os
enum<string>

OS for a freshly-minted profile (default win).

Available options:
win,
mac,
lin,
android
antidetect_browser_proxy_sid
string

Assign an already-chosen pooled proxy. Resolve the sid yourself with search_antidetect_browser_proxies; never ask an end user for one.

Required string length: 18
Pattern: ^ab_px_
proxy_country_code
string

ISO country. Picks the least-loaded active proxy. The default way to pick a proxy.

Required string length: 2
custom_proxy_config
object

Custom proxy connection tuple (customer BYO path). Probed before it is written; 5G Proxy cannot ride it.

proxy_5g
boolean

Provision the browser on the 5G Proxy add-on: the dedicated 5G mobile route, sold for speed (faster command execution, fewer retries). Each flagged browser takes one add-on slot; with no headroom left the create is refused 402 insufficient_proxy_5g_slots.

Response

create success envelope.

success
enum<boolean>
required
Available options:
true
operation
enum<string>
required
Available options:
create
item
object
required
already_exists
boolean
required
meta
object
required