Cloud browser

Read a cloud browser session

The session view. Every call is the popup's heartbeat: a session that is not polled for 90 seconds before approval is ended and its browser released. The response is Cache-Control: no-store, because the view can carry the live view address, which anyone holding can drive.

get/browser-sessions/{sid}

Request

  • Base URL: https://api.customdomain.ai/v1
  • URL: https://api.customdomain.ai/v1/browser-sessions/{sid}
  • Auth: HTTP bearer

Path parameters

sidstring required

The cloud browser session id, bs_ and 32 hex characters.

Response

The session as the popup may see it.

idstring required
state'created' | 'awaiting_sign_in' | 'checking' | 'plan_ready' | 'applying' | 'verifying' | 'manual_assist' | 'done' | 'done_manual' | 'cancelled' | 'expired' | 'abandoned' | 'failed' required
providerstring required
provider_namestring
vendorstring

The browser hosting company.

domainstring required
sitestring

The provider's registrable domain, for example namecheap.com. The popup shows it beside a lock while the customer signs in.

interactiveboolean

True when the customer may type in the live view.

live_view_urlstring uri
live_view_originstring
deadlinestring date-time

The next timer that matters: the sign in window in awaiting_sign_in, the approval window in plan_ready, the apply window in applying, the hard cap otherwise.

notice'not_signed_in'

Present after a :signed-in that landed on the sign in page, until the customer presses the button again.

sign_in_frameinteger

In awaiting_sign_in only: the bottom edge of the provider's sign in card on the remote screen, in CSS pixels from the top and under sign_in_viewport's height, measured when the sign in page opened. The popup ends its frame just under it, so the links below the card stay out of sight. Sent only while the sign in tab still shows the page it was measured on and no human check or second window is on screen; once that changes it is gone for the rest of the session. Absent means show the whole screen.

signed_in_detectedboolean

In awaiting_sign_in only: the provider's sign in page gave way to its DNS panel page and the panel held across two polls, so the customer looks signed in. A hint: the popup then calls :signed-in, which checks the page itself. Absent means not detected.

checkboolean

In awaiting_sign_in only: the vendor reports the sign in tab with the title of a known human check page (Cloudflare's "Just a moment..."), so the popup asks the customer to tick the box. Only this boolean is sent, never the title. A page can fake its title, so it is a hint for the popup's words and nothing else: it never counts toward signed_in_detected, and nothing clicks or types because of it. Absent means no check page.

Changes

No recorded changes to this operation across all 1 revision of this API.