Sign in
Browser Sessions

Close a session

Close a session. Once closed, the session cannot be used again.

post/v1/browser_sessions/{browser_session_id}/close

Path parameters

browser_session_idstring required

The ID of the browser session to close. completed_at will be set when the browser session is closed. browser_session_id starts with pbs_

Example:pbs_123456

The ID of the browser session to close. completed_at will be set when the browser session is closed. browser_session_id starts with pbs_

Headers

x-api-keystring nullable

Skyvern API key for authentication. API key can be found at https://app.skyvern.com/settings.

Skyvern API key for authentication. API key can be found at https://app.skyvern.com/settings.

Response

Successfully closed browser session

{"stackTrail":"paths:/v1/browser_sessions/{browser_session_id}/close:post:responses:200:content:application/json:schema","oasType":"schema","type":"unknown"}

Changes

Changed in 3 of the 86 revisions of this API.6

  • 3c39ee1fef001See the full diff
    • ○

      added the non-success response with the status

      response-non-success-status-added

  • 3a3616091b664See the full diff
    • ○

      header request parameter x-api-key list-of-types was widened by adding types null

      request-parameter-list-of-types-widened

    • ○

      for the header request parameter x-api-key, the type was generalized from string to no type

      request-parameter-type-generalized

    • ○

      added the optional property // to the response with the status

      response-optional-property-added

    • ○

      added the optional property // to the response with the status

      response-optional-property-added

    This revision also has 10 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • a8899e7707c41See the full diff
    • ○

      endpoint added

      endpoint-added

    This revision also has 5 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog