BRbrowserbase

List Sessions

Changed on
get/v1/sessions

Request

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

Query parameters

status'PENDING' | 'RUNNING' | 'ERROR' | 'TIMED_OUT' | 'COMPLETED'
qstring

Query sessions by user metadata. See Querying Sessions by User Metadata for the schema of this query.

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.

Changes

  • 3cb839210d89Revision changes
    • warning

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

    • info

      added the new enum value PENDING to the query request parameter status

  • a2379f6bf614Revision changes
    • breaking

      the / response's property type changed from no type to string for status

    • breaking

      the / response's property type changed from no type to string for status

    • breaking

      the / response's property type changed from no type to string for status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      added the new ap-southeast-1 enum value to the / response property for the response status

    • warning

      added the new eu-central-1 enum value to the / response property for the response status

    • warning

      added the new us-east-1 enum value to the / response property for the response status

    • warning

      added the new us-west-2 enum value to the / response property for the response status

    • info

      removed from the / response property allOf list for the response status

    • info

      removed from the / response property allOf list for the response status

    • info

      removed from the / response property allOf list for the response status