Sign in

v34

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

Update a Session

post/v1/sessions/{id}

Path parameters

idstring required

Request body

projectIdstring

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

status'REQUEST_RELEASE' required

Set to REQUEST_RELEASE to request that the session complete. Use before session's timeout to avoid additional charges.

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.