POST v1/browser/requests

For more information on browser requests, see here.

The following endpoint creates a browser request and either runs it synchronously or returns immediately with an ID so you can check it status later using this endpoint.

Create a new browser request

post

This endpoint loads the required URL in our browser and then performs the selected actions.

Authorizations

API Key

X-API-KeystringRequired

Body

application/json

proxy_locationstring · nullableOptional

The location of the proxy server that your request will be routed through, null means no proxy is used

Default: null

urlstringOptional

The url you want our browsers to visit on your behalf

asyncbooleanOptional

Whether the request should be processed asynchronously, synchronous requests can be maximum 60 seconds long.

Default: true

max_cache_ageinteger · int32 · nullableOptional

The maximum age of a cached result in seconds. 0 means the cache will never be used

Default: 0

Responses

200

The browser request response detailing the state and output of the request

application/json

idstring · nullableOptional

ID of the browser request

urlstring · nullableOptional

URL of the request

proxy_locationstring · nullableOptional

The proxy location of the request.

statestring · nullableOptional

The status of the request

credit_usageinteger · int32 · nullableOptional

The number of credits used by the request

errorstring · nullableOptional

The name of the error type

error_reasonstring · nullableOptional

More detail about the error

actual_urlstring · nullableOptional

The actual URL captured, after any redirects.

http_status_codeinteger · int32Optional

The http status code for the request.

from_cacheboolean · nullableOptional

If this request was served from the cached

started_atstring · date-timeOptional

The time in UTC when the request started.

completed_atstring · date-timeOptional

The time in UTC when the request finished.

running_timestring · timespanOptional

The running time of the request

page_load_timestring · timespanOptional

How long did the page take to fully render.

videostring · nullableOptional

Video url

408

The browser request timed out - an example error

application/json

post

/v1/browser/requests

HTTPcURLJavaScriptPython

POST /v1/browser/requests HTTP/1.1
Host: api.gaffa.dev
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 370

"{\"proxy_location\":null,\"url\":\"https://demo.gaffa.dev/simulate/table?loadTime=3&rowCount=20\",\"async\":false,\"max_cache_age\":0,\"settings\":{\"record_request\":false,\"actions\":[{\"type\":\"wait\",\"selector\":\"table\"},{\"type\":\"print\",\"size\":\"A4\",\"margin\":20}],\"time_limit\":60000,\"max_media_bandwidth\":null,\"output\":null,\"block_ads\":false}}"

Print HTML to PDFConvert an article to markdown

{"data":{"id":"brq_V2P6PqrZpycFtbc7mtXE4tsNbeg2N6","url":"https://demo.gaffa.dev/simulate/table?loadTime=3&rowCount=20","proxy_location":null,"state":"completed","credit_usage":1,"error":null,"error_reason":null,"actual_url":null,"http_status_code":200,"from_cache":false,"started_at":"2024-11-22T14:33:38.7762685+00:00","completed_at":"2024-11-22T14:33:42.7135779+00:00","running_time":null,"page_load_time":"00:00:00.1902889","actions":[{"id":"act_V2P6Q3fSHhBWAhf4BQJxj9oYbQF1V9","type":"wait","custom_id":null,"timestamp":"2024-11-22T14:33:38.9665719+00:00","output":null,"reference":null,"iterations":null,"actions":null,"error":null},{"id":"act_V2P6Q6BuQhoYDAVkQMVSKkkwmUrArb","type":"print","custom_id":null,"timestamp":"2024-11-22T14:33:42.3025888+00:00","output":"https://storage.gaffa.dev/brq/pdf/brq_V2P6PqrZpycFtbc7mtXE4tsNbeg2N6/....","reference":null,"iterations":null,"actions":null,"error":null}],"video":null},"error":null}