BRbrowserbase

Get a Session

Changed on
get/v1/sessions/{id}

Request

  • Base URL
    https://api.browserbase.com
  • Auth
    API key in header X-BB-API-Key

Path parameters

idstring required

Response

The request has succeeded.

idstring required
createdAtstring date-time required
updatedAtstring date-time required
projectIdstring required

The Project ID linked to the Session.

startedAtstring date-time required
endedAtstring date-time
expiresAtstring date-time required
status'PENDING' | 'RUNNING' | 'ERROR' | 'TIMED_OUT' | 'COMPLETED' required
proxyBytesinteger required

Bytes used via the Proxy

keepAliveboolean required

Indicates if the Session was created to be kept alive upon disconnections

contextIdstring

Optional. The Context linked to the Session.

region'us-west-2' | 'us-east-1' | 'eu-central-1' | 'ap-southeast-1' required

The region where the Session is running.

userMetadataobject

Arbitrary user metadata to attach to the session. To learn more about user metadata, see User Metadata.

connectUrlstring uri

WebSocket URL to connect to the Session.

seleniumRemoteUrlstring uri

HTTP URL to connect to the Session.

signingKeystring

Signing key to use when connecting to the Session via HTTP.

Changes

  • 3cb839210d89Revision changes
    • warning

      added the new PENDING enum value to the //// response property for the response status

  • 215bc4361122Revision changes
    • breaking

      the response's body type changed from object to no type for status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • info

      added subschema #2 to the response body allOf list for the response status