创建浏览器会话

POST /browserbase/v1/sessions● 支持

Browserbase

请求参数

projectIdstring可选
The Project ID. Can be found in [Settings](https://www.browserbase.com/settings). Optional - if not provided, the project will be inferred from the API key.
extensionIdstring可选○ 未支持
不支持此配置。
browserSettingsobject可选
▸ 展开子字段（14）
- contextobject可选
  ▸ 展开子字段（2）
  - idstring必填
    The Context ID.
  - persistboolean可选
    Whether or not to persist the context after browsing. Defaults to `false`.
- extensionIdstring可选○ 未支持
  不支持此配置。
- viewportobject可选
  ▸ 展开子字段（2）
  - widthinteger可选
    The width of the browser.
  - heightinteger可选
    The height of the browser.
- blockAdsboolean可选◐ 部分支持
  接受但忽略；不会启用此能力。
- solveCaptchasboolean可选◐ 部分支持
  接受但忽略；不会启用此能力。
- recordSessionboolean可选◐ 部分支持
  接受但忽略；不会启用此能力。
- logSessionboolean可选◐ 部分支持
  接受但忽略；不会启用此能力。
- advancedStealthboolean可选○ 未支持
  不支持此配置。
- verifiedboolean可选○ 未支持
  不支持此配置。
- captchaImageSelectorstring可选
  Custom selector for captcha image. See [Custom Captcha Solving](/features/stealth-mode#custom-captcha-solving)
- captchaInputSelectorstring可选
  Custom selector for captcha input. See [Custom Captcha Solving](/features/stealth-mode#custom-captcha-solving)
- osstring可选○ 未支持
  不支持此配置。
  取值 windowsmaclinuxmobiletablet
- allowedDomainsarray可选○ 未支持
  默认 []
  不支持此配置。
- ignoreCertificateErrorsboolean可选○ 未支持
  不支持此配置。
timeoutinteger可选
Duration in seconds after which the session will automatically end. Defaults to the Project's `defaultTimeout`. Minimum 60 seconds, maximum 21600 seconds (6 hours).
keepAliveboolean可选
Set to true to keep the session alive even after disconnections. Available on the Hobby Plan and above.
proxiesunion可选◐ 部分支持
仅省略、false 或 [{type: 'none'}] 可用，其它代理配置返回 501。
proxySettingsobject可选
Supplementary proxy settings. Optional.
▸ 展开子字段（1）
- caCertificatesarray可选
  默认 []
  The TLS certificate IDs to trust. Optional.
regionstring可选◐ 部分支持
默认 "us-west-2"
接受但忽略；不会启用此能力。
取值 us-west-2us-east-1eu-central-1ap-southeast-1
userMetadataobject可选
Arbitrary user metadata to attach to the session. To learn more about user metadata, see [User Metadata](/features/sessions#user-metadata).

201

仅支持服务指南列出的能力；部分官方请求参数不可用。

错误含 statusCode、error、message；自有面另含 code。请求 ID 见 X-Request-Id。错误

连接与使用指南

代理、反检测、扩展和 Selenium 不可用。region 和 solveCaptchas 接受但忽略；不提供区域选择或验证码代解。

响应

HTTP 201

The request has succeeded and a new resource has been created as a result.

application/json

名称	类型	说明
id	string
createdAt	string
updatedAt	string
projectId	string	The Project ID linked to the Session.
startedAt	string
endedAt	string
expiresAt	string
status	string
proxyBytes	integer	Bytes used via the Proxy
keepAlive	boolean	Indicates if the Session was created to be kept alive upon disconnections
contextId	string	Optional. The Context linked to the Session.
region	string	The region where the Session is running.
userMetadata	object	Arbitrary user metadata to attach to the session. To learn more about user metadata, see User Metadata.
connectUrl	string	WebSocket URL to connect to the Session.
seleniumRemoteUrl	string	HTTP URL to connect to the Session.
signingKey	string	Signing key to use when connecting to the Session via HTTP.

创建浏览器会话

请求参数

返回

响应

HTTP 201