Skip to navigation
API ReferenceBrowsers

Send a request from the browser

View as Markdown

Send an HTTP request from the browser itself: it carries the browser’s cookies, proxy and TLS/HTTP2 fingerprint and is not subject to CORS. The response body is returned base64 encoded up to maxBytes (truncated is true beyond it). Human control blocks it; the Run’s Events record the URL without its query, the status and the byte count. An interrupted request returns unknown and must not be repeated automatically.

Authentication

AuthorizationBearer

Use Bearer <api-key>.

Path parameters

browserIdstringRequired

Headers

BCTRL-VersionenumOptional
Dated API version. Defaults to the release pinned when the API key was created.
Allowed values:
BCTRL-SpacestringOptional
Select one authorized Space by its opaque ID or unique name. Omission uses the operation default.
BCTRL-Subaccount-IdstringOptional
Optional effective subaccount context for organization API keys. Subaccount API keys are already scoped and cannot use this header to act as another subaccount.
Idempotency-KeystringOptional1-200 characters

Optional retry key for this billable operation. Reusing the same key with the same request replays its stable outcome; credential-bearing results may be freshly issued for the same principal. Reusing it with a different request returns 409.

Query parameters

spaceIdstring or "default"Optional

Request

This endpoint expects an object.
urlstringRequired<=8192 characters
bodystringOptional<=10485760 characters
bodyEncodingenumOptionalDefaults to utf8
Allowed values:
headersobjectOptionalDefaults to {}
maxBytesintegerOptional0-5242880Defaults to 1048576
methodenumOptionalDefaults to GET
timeoutMsintegerOptional1-60000Defaults to 30000

Response headers

BCTRL-Request-IdstringOptional
Current request identifier, also echoed in errors.
BCTRL-VersionstringOptional
Negotiated dated API version.
RateLimit-Limitinteger

Evaluated policy limit; zero when no finite policy was evaluated.

RateLimit-Remaininginteger

Remaining policy budget; zero when no finite policy was evaluated.

RateLimit-Resetinteger

Seconds until reset; zero when no finite policy was evaluated.

Response

OK
dataobject or null
eventIdstring
Unique runEvent identifier generated by BCTRL.
object"fetch.result"
statusenum
Allowed values:

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
429
Too Many Requests Error