Sessions

Get session details

Changed on

Retrieves details of a specific session by ID.

get/v1/sessions/{id}

Request

  • Base URL
    https://api.steel.dev
  • URL
    https://api.steel.dev/v1/sessions/{id}
  • Auth
    • API key in header steel-api-key
    • or none

Path parameters

idstring uuid required

Response

Represents the data structure for a browser session, including its configuration and status.

browserMode'stealth' | 'standard' | 'unknown' required

Browser mode used for this session.

createdAtstring date-time required

Timestamp when the session started

creditsUsedinteger required

Amount of credits consumed by the session

debugUrlstring required

URL for debugging the session

durationinteger required

Duration of the session in milliseconds

eventCountinteger required

Number of events processed in the session

fullscreenboolean

Launch the browser in fullscreen mode, covering the full screen with no Chrome UI.

headlessboolean

Indicates if the session is headless or headful

idstring uuid required

Unique identifier for the session

inactivityTimeoutinteger

Inactivity timeout in milliseconds, if one was set when the session was created

isSeleniumboolean

Indicates if Selenium is used in the session

persistProfileboolean

This flag will persist the profile for the session.

profileIdstring uuid

The ID of the profile associated with the session

projectIdstring uuid nullable

The project associated with the session

proxyBytesUsedinteger required

Amount of data transmitted through the proxy

proxySource'steel' | 'external' nullable required

Source of the proxy used for the session

regionstring

The region where the session was created.

releaseReason'user_requested' | 'timeout' | 'inactivity_timeout' | 'creation_timeout' | 'startup_failed' | 'browser_closed' | 'browser_crashed' nullable

Why the session reached a terminal state. Null while the session is live, or when the reason is unknown (e.g. sessions created before this was tracked). One of: user_requested (released via the API/SDK), timeout (hard timeout elapsed), inactivity_timeout (no activity for the configured window), creation_timeout (never started in time), startup_failed (could not be dispatched), browser_closed (the browser or agent closed itself — not a crash), browser_crashed (the browser crashed or its machine became unresponsive).

sessionViewerUrlstring required

URL to view session details

solveCaptchaboolean

Indicates if captcha solving is enabled

status'live' | 'released' | 'failed' required

Status of the session

timeoutinteger required

Session timeout duration in milliseconds

userAgentstring

User agent string used in the session

websocketUrlstring required

URL for the session's WebSocket connection

Changes

  • 8f7e74e04bd3Revision changes
    • info

      removed the ap-northeast enum value from the response property for the response status

    • info

      removed the ap-southeast enum value from the response property for the response status

    • info

      removed the eu-central enum value from the response property for the response status

    • info

      removed the eu-west enum value from the response property for the response status

    • info

      removed the fra enum value from the response property for the response status

    • info

      removed the iad enum value from the response property for the response status

    • info

      removed the lax enum value from the response property for the response status

    • info

      removed the nrt enum value from the response property for the response status

    • info

      removed the ord enum value from the response property for the response status

    • info

      removed the sa-east enum value from the response property for the response status

    • info

      removed the scl enum value from the response property for the response status

    • info

      removed the us-central enum value from the response property for the response status

    • info

      removed the us-east enum value from the response property for the response status

    • info

      removed the us-west enum value from the response property for the response status

    • info

      added the required property to the response with the status

  • 416b04cf01b1Revision changes
    • info

      added the optional property to the response with the status