v34

latestOpenAPI 3.0.0raw.githubusercontent.com2026-07-215423105.7 KB

Create a Session

post/v1/sessions

projectIdstring

The Project ID. Can be found in Settings. Optional - if not provided, the project will be inferred from the API key.

extensionIdstring

The uploaded Extension ID. See Upload Extension.

timeoutinteger

Duration in seconds after which the session will automatically end. Defaults to the Project's defaultTimeout.

keepAliveboolean

Set to true to keep the session alive even after disconnections. Available on the Hobby Plan and above.

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

The region where the Session should run.

userMetadataobject

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

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

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 required

WebSocket URL to connect to the Session.

seleniumRemoteUrlstring uri required

HTTP URL to connect to the Session.

signingKeystring required

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