{ "opencollection": "1.0.0", "info": { "name": "Browserless Browser REST APIs API", "version": "2.49.0" }, "items": [ { "info": { "name": "Browser REST APIs", "type": "folder" }, "items": [ { "info": { "name": "/chrome/content", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/chrome/content", "params": [ { "name": "blockAds", "value": "", "type": "query" }, { "name": "launch", "value": "", "type": "query" }, { "name": "profile", "value": "", "type": "query" }, { "name": "timeout", "value": "", "type": "query" }, { "name": "token", "value": "", "type": "query" }, { "name": "trackingId", "value": "", "type": "query" } ], "body": { "type": "json", "data": "{}" } }, "docs": "A JSON-based API. Given a \"url\" or \"html\" field, runs and returns HTML content after the page has loaded and JavaScript has parsed." }, { "info": { "name": "/chrome/download", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/chrome/download", "params": [ { "name": "blockAds", "value": "", "type": "query" }, { "name": "launch", "value": "", "type": "query" }, { "name": "profile", "value": "", "type": "query" }, { "name": "timeout", "value": "", "type": "query" }, { "name": "token", "value": "", "type": "query" }, { "name": "trackingId", "value": "", "type": "query" } ], "body": { "type": "json", "data": "{}" } }, "docs": "A JSON or JavaScript content-type API for returning files Chrome has downloaded during\nthe execution of puppeteer code, which is ran inside context of the browser.\nBrowserless sets up a blank page, a fresh download directory, injects your puppeteer code, and then executes it.\nYou can load external libraries via the \"import\" syntax, and import ESM-style modules\nthat are written for execution inside of the browser. Once your script is finished, any\ndownloaded files from Chromium are returned back " }, { "info": { "name": "/chrome/function", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/chrome/function", "params": [ { "name": "blockAds", "value": "", "type": "query" }, { "name": "launch", "value": "", "type": "query" }, { "name": "profile", "value": "", "type": "query" }, { "name": "timeout", "value": "", "type": "query" }, { "name": "token", "value": "", "type": "query" }, { "name": "trackingId", "value": "", "type": "query" } ], "body": { "type": "json", "data": "{}" } }, "docs": "A JSON or JavaScript content-type API for running puppeteer code in the browser's context.\nBrowserless sets up a blank page, injects your puppeteer code, and runs it.\nYou can optionally load external libraries via the \"import\" module that are meant for browser usage.\nValues returned from the function are checked and an appropriate content-type and response is sent back\nto your HTTP call." }, { "info": { "name": "/json/new", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/json/new" }, "docs": "Returns a JSON payload that acts as a pass-through to the DevTools /json/new HTTP API in Chromium.\nBrowserless mocks this payload so that remote clients can connect to the underlying \"webSocketDebuggerUrl\"\nwhich will cause Browserless to start the browser and proxy that request into a blank page." }, { "info": { "name": "/json/protocol", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/json/protocol" }, "docs": "Returns Protocol JSON meta-data that Chrome and Chromium come with." }, { "info": { "name": "/json/version", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/json/version" }, "docs": "Returns a JSON payload that acts as a pass-through to the DevTools /json/version protocol in Chrome and Chromium." }, { "info": { "name": "/chrome/pdf", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/chrome/pdf", "params": [ { "name": "blockAds", "value": "", "type": "query" }, { "name": "launch", "value": "", "type": "query" }, { "name": "profile", "value": "", "type": "query" }, { "name": "timeout", "value": "", "type": "query" }, { "name": "token", "value": "", "type": "query" }, { "name": "trackingId", "value": "", "type": "query" } ], "body": { "type": "json", "data": "{}" } }, "docs": "A JSON-based API for getting a PDF binary from either a supplied\n\"url\" or \"html\" payload in your request. Many options exist for\ninjecting cookies, request interceptors, user-agents and waiting for\nselectors, timers and more." }, { "info": { "name": "/chrome/performance", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/chrome/performance", "params": [ { "name": "blockAds", "value": "", "type": "query" }, { "name": "launch", "value": "", "type": "query" }, { "name": "profile", "value": "", "type": "query" }, { "name": "timeout", "value": "", "type": "query" }, { "name": "token", "value": "", "type": "query" }, { "name": "trackingId", "value": "", "type": "query" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Run lighthouse performance audits with a supplied \"url\" in your JSON payload." }, { "info": { "name": "/chrome/scrape", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/chrome/scrape", "params": [ { "name": "blockAds", "value": "", "type": "query" }, { "name": "launch", "value": "", "type": "query" }, { "name": "profile", "value": "", "type": "query" }, { "name": "timeout", "value": "", "type": "query" }, { "name": "token", "value": "", "type": "query" }, { "name": "trackingId", "value": "", "type": "query" } ], "body": { "type": "json", "data": "{}" } }, "docs": "A JSON-based API that returns text, html, and meta-data from a given list of selectors.\nDebugging information is available by sending in the appropriate flags in the \"debugOpts\"\nproperty. Responds with an array of JSON objects." }, { "info": { "name": "/chrome/screenshot", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/chrome/screenshot", "params": [ { "name": "blockAds", "value": "", "type": "query" }, { "name": "launch", "value": "", "type": "query" }, { "name": "profile", "value": "", "type": "query" }, { "name": "timeout", "value": "", "type": "query" }, { "name": "token", "value": "", "type": "query" }, { "name": "trackingId", "value": "", "type": "query" } ], "body": { "type": "json", "data": "{}" } }, "docs": "A JSON-based API for getting a screenshot binary from either a supplied\n\"url\" or \"html\" payload in your request. Many options exist including\ncookies, user-agents, setting timers and network mocks." }, { "info": { "name": "/chromium/content", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/chromium/content", "params": [ { "name": "blockAds", "value": "", "type": "query" }, { "name": "launch", "value": "", "type": "query" }, { "name": "profile", "value": "", "type": "query" }, { "name": "timeout", "value": "", "type": "query" }, { "name": "token", "value": "", "type": "query" }, { "name": "trackingId", "value": "", "type": "query" } ], "body": { "type": "json", "data": "{}" } }, "docs": "A JSON-based API. Given a \"url\" or \"html\" field, runs and returns HTML content after the page has loaded and JavaScript has parsed.\n\n**Note:** This endpoint is also available at: `/content` for backwards compatibility." }, { "info": { "name": "/chromium/download", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/chromium/download", "params": [ { "name": "blockAds", "value": "", "type": "query" }, { "name": "launch", "value": "", "type": "query" }, { "name": "profile", "value": "", "type": "query" }, { "name": "timeout", "value": "", "type": "query" }, { "name": "token", "value": "", "type": "query" }, { "name": "trackingId", "value": "", "type": "query" } ], "body": { "type": "json", "data": "{}" } }, "docs": "A JSON or JavaScript content-type API for returning files Chrome has downloaded during\nthe execution of puppeteer code, which is ran inside context of the browser.\nBrowserless sets up a blank page, a fresh download directory, injects your puppeteer code, and then executes it.\nYou can load external libraries via the \"import\" syntax, and import ESM-style modules\nthat are written for execution inside of the browser. Once your script is finished, any\ndownloaded files from Chromium are returned back " }, { "info": { "name": "/chromium/function", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/chromium/function", "params": [ { "name": "blockAds", "value": "", "type": "query" }, { "name": "launch", "value": "", "type": "query" }, { "name": "profile", "value": "", "type": "query" }, { "name": "timeout", "value": "", "type": "query" }, { "name": "token", "value": "", "type": "query" }, { "name": "trackingId", "value": "", "type": "query" } ], "body": { "type": "json", "data": "{}" } }, "docs": "A JSON or JavaScript content-type API for running puppeteer code in the browser's context.\nBrowserless sets up a blank page, injects your puppeteer code, and runs it.\nYou can optionally load external libraries via the \"import\" module that are meant for browser usage.\nValues returned from the function are checked and an appropriate content-type and response is sent back\nto your HTTP call.\n\n**Note:** This endpoint is also available at: `/function` for backwards compatibility." }, { "info": { "name": "/chromium/performance", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/chromium/performance", "params": [ { "name": "blockAds", "value": "", "type": "query" }, { "name": "launch", "value": "", "type": "query" }, { "name": "profile", "value": "", "type": "query" }, { "name": "timeout", "value": "", "type": "query" }, { "name": "token", "value": "", "type": "query" }, { "name": "trackingId", "value": "", "type": "query" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Run lighthouse performance audits with a supplied \"url\" in your JSON payload.\n\n**Note:** This endpoint is also available at: `/performance` for backwards compatibility." }, { "info": { "name": "/chromium/scrape", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/chromium/scrape", "params": [ { "name": "blockAds", "value": "", "type": "query" }, { "name": "launch", "value": "", "type": "query" }, { "name": "profile", "value": "", "type": "query" }, { "name": "timeout", "value": "", "type": "query" }, { "name": "token", "value": "", "type": "query" }, { "name": "trackingId", "value": "", "type": "query" } ], "body": { "type": "json", "data": "{}" } }, "docs": "A JSON-based API that returns text, html, and meta-data from a given list of selectors.\nDebugging information is available by sending in the appropriate flags in the \"debugOpts\"\nproperty. Responds with an array of JSON objects.\n\n**Note:** This endpoint is also available at: `/scrape` for backwards compatibility." }, { "info": { "name": "/edge/content", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/edge/content", "params": [ { "name": "blockAds", "value": "", "type": "query" }, { "name": "launch", "value": "", "type": "query" }, { "name": "profile", "value": "", "type": "query" }, { "name": "timeout", "value": "", "type": "query" }, { "name": "token", "value": "", "type": "query" }, { "name": "trackingId", "value": "", "type": "query" } ], "body": { "type": "json", "data": "{}" } }, "docs": "A JSON-based API. Given a \"url\" or \"html\" field, runs and returns HTML content after the page has loaded and JavaScript has parsed." }, { "info": { "name": "/edge/download", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/edge/download", "params": [ { "name": "blockAds", "value": "", "type": "query" }, { "name": "launch", "value": "", "type": "query" }, { "name": "profile", "value": "", "type": "query" }, { "name": "timeout", "value": "", "type": "query" }, { "name": "token", "value": "", "type": "query" }, { "name": "trackingId", "value": "", "type": "query" } ], "body": { "type": "json", "data": "{}" } }, "docs": "A JSON or JavaScript content-type API for returning files Chrome has downloaded during\nthe execution of puppeteer code, which is ran inside context of the browser.\nBrowserless sets up a blank page, a fresh download directory, injects your puppeteer code, and then executes it.\nYou can load external libraries via the \"import\" syntax, and import ESM-style modules\nthat are written for execution inside of the browser. Once your script is finished, any\ndownloaded files from Chromium are returned back " }, { "info": { "name": "/edge/function", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/edge/function", "params": [ { "name": "blockAds", "value": "", "type": "query" }, { "name": "launch", "value": "", "type": "query" }, { "name": "profile", "value": "", "type": "query" }, { "name": "timeout", "value": "", "type": "query" }, { "name": "token", "value": "", "type": "query" }, { "name": "trackingId", "value": "", "type": "query" } ], "body": { "type": "json", "data": "{}" } }, "docs": "A JSON or JavaScript content-type API for running puppeteer code in the browser's context.\nBrowserless sets up a blank page, injects your puppeteer code, and runs it.\nYou can optionally load external libraries via the \"import\" module that are meant for browser usage.\nValues returned from the function are checked and an appropriate content-type and response is sent back\nto your HTTP call." }, { "info": { "name": "/edge/pdf", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/edge/pdf", "params": [ { "name": "blockAds", "value": "", "type": "query" }, { "name": "launch", "value": "", "type": "query" }, { "name": "profile", "value": "", "type": "query" }, { "name": "timeout", "value": "", "type": "query" }, { "name": "token", "value": "", "type": "query" }, { "name": "trackingId", "value": "", "type": "query" } ], "body": { "type": "json", "data": "{}" } }, "docs": "A JSON-based API for getting a PDF binary from either a supplied\n\"url\" or \"html\" payload in your request. Many options exist for\ninjecting cookies, request interceptors, user-agents and waiting for\nselectors, timers and more." }, { "info": { "name": "/edge/performance", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/edge/performance", "params": [ { "name": "blockAds", "value": "", "type": "query" }, { "name": "launch", "value": "", "type": "query" }, { "name": "profile", "value": "", "type": "query" }, { "name": "timeout", "value": "", "type": "query" }, { "name": "token", "value": "", "type": "query" }, { "name": "trackingId", "value": "", "type": "query" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Run lighthouse performance audits with a supplied \"url\" in your JSON payload." }, { "info": { "name": "/edge/scrape", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/edge/scrape", "params": [ { "name": "blockAds", "value": "", "type": "query" }, { "name": "launch", "value": "", "type": "query" }, { "name": "profile", "value": "", "type": "query" }, { "name": "timeout", "value": "", "type": "query" }, { "name": "token", "value": "", "type": "query" }, { "name": "trackingId", "value": "", "type": "query" } ], "body": { "type": "json", "data": "{}" } }, "docs": "A JSON-based API that returns text, html, and meta-data from a given list of selectors.\nDebugging information is available by sending in the appropriate flags in the \"debugOpts\"\nproperty. Responds with an array of JSON objects." }, { "info": { "name": "/edge/screenshot", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/edge/screenshot", "params": [ { "name": "blockAds", "value": "", "type": "query" }, { "name": "launch", "value": "", "type": "query" }, { "name": "profile", "value": "", "type": "query" }, { "name": "timeout", "value": "", "type": "query" }, { "name": "token", "value": "", "type": "query" }, { "name": "trackingId", "value": "", "type": "query" } ], "body": { "type": "json", "data": "{}" } }, "docs": "A JSON-based API for getting a screenshot binary from either a supplied\n\"url\" or \"html\" payload in your request. Many options exist including\ncookies, user-agents, setting timers and network mocks." }, { "info": { "name": "/browser/*", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/browser/*" }, "docs": "Terminates a browser instance by browserId. The browser must belong to the authenticated user." }, { "info": { "name": "/chrome/export", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/chrome/export", "params": [ { "name": "blockAds", "value": "", "type": "query" }, { "name": "externalProxyServer", "value": "", "type": "query" }, { "name": "launch", "value": "", "type": "query" }, { "name": "profile", "value": "", "type": "query" }, { "name": "proxy", "value": "", "type": "query" }, { "name": "proxyCity", "value": "", "type": "query" }, { "name": "proxyCountry", "value": "", "type": "query" }, { "name": "proxyLocaleMatch", "value": "", "type": "query" }, { "name": "proxyPreset", "value": "", "type": "query" }, { "name": "proxyState", "value": "", "type": "query" }, { "name": "proxySticky", "value": "", "type": "query" }, { "name": "timeout", "value": "", "type": "query" }, { "name": "token", "value": "", "type": "query" }, { "name": "trackingId", "value": "", "type": "query" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Exports a webpage to a PDF or image format. This API is useful for generating reports, screenshots, or PDFs of web pages." }, { "info": { "name": "/chrome/unblock", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/chrome/unblock", "params": [ { "name": "blockAds", "value": "", "type": "query" }, { "name": "externalProxyServer", "value": "", "type": "query" }, { "name": "launch", "value": "", "type": "query" }, { "name": "profile", "value": "", "type": "query" }, { "name": "proxy", "value": "", "type": "query" }, { "name": "proxyCity", "value": "", "type": "query" }, { "name": "proxyCountry", "value": "", "type": "query" }, { "name": "proxyLocaleMatch", "value": "", "type": "query" }, { "name": "proxyPreset", "value": "", "type": "query" }, { "name": "proxyState", "value": "", "type": "query" }, { "name": "proxySticky", "value": "", "type": "query" }, { "name": "timeout", "value": "", "type": "query" }, { "name": "token", "value": "", "type": "query" }, { "name": "trackingId", "value": "", "type": "query" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Unblocks the provided URL from being blocked due to bot detection.\nReturns a payload of Cookies, HTML, a base64 encoded screenshot,\nand a \"browserWSEndpoint\" to allow connecting to the browser when\nspecified in the JSON Payload. Only supports CDP or Puppeteer\nlike libraries when connecting to the \"browserWSEndpoint\"." }, { "info": { "name": "/chromium/export", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/chromium/export", "params": [ { "name": "blockAds", "value": "", "type": "query" }, { "name": "externalProxyServer", "value": "", "type": "query" }, { "name": "launch", "value": "", "type": "query" }, { "name": "profile", "value": "", "type": "query" }, { "name": "proxy", "value": "", "type": "query" }, { "name": "proxyCity", "value": "", "type": "query" }, { "name": "proxyCountry", "value": "", "type": "query" }, { "name": "proxyLocaleMatch", "value": "", "type": "query" }, { "name": "proxyPreset", "value": "", "type": "query" }, { "name": "proxyState", "value": "", "type": "query" }, { "name": "proxySticky", "value": "", "type": "query" }, { "name": "timeout", "value": "", "type": "query" }, { "name": "token", "value": "", "type": "query" }, { "name": "trackingId", "value": "", "type": "query" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Exports a webpage to a PDF or image format. This API is useful for generating reports, screenshots, or PDFs of web pages.\n\n**Note:** This endpoint is also available at: `/export` for backwards compatibility." }, { "info": { "name": "/unblock", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/unblock", "params": [ { "name": "blockAds", "value": "", "type": "query" }, { "name": "externalProxyServer", "value": "", "type": "query" }, { "name": "launch", "value": "", "type": "query" }, { "name": "profile", "value": "", "type": "query" }, { "name": "proxy", "value": "", "type": "query" }, { "name": "proxyCity", "value": "", "type": "query" }, { "name": "proxyCountry", "value": "", "type": "query" }, { "name": "proxyLocaleMatch", "value": "", "type": "query" }, { "name": "proxyPreset", "value": "", "type": "query" }, { "name": "proxyState", "value": "", "type": "query" }, { "name": "proxySticky", "value": "", "type": "query" }, { "name": "timeout", "value": "", "type": "query" }, { "name": "token", "value": "", "type": "query" }, { "name": "trackingId", "value": "", "type": "query" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Unblocks the provided URL from being blocked due to bot detection.\nReturns a payload of Cookies, HTML, a base64 encoded screenshot,\nand a \"browserWSEndpoint\" to allow connecting to the browser when\nspecified in the JSON Payload. Only supports CDP or Puppeteer\nlike libraries when connecting to the \"browserWSEndpoint\".\n\n**Note:** This endpoint is also available at: `/chromium/unblock` for backwards compatibility." }, { "info": { "name": "/proxy/cities", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/proxy/cities", "params": [ { "name": "blockAds", "value": "", "type": "query" }, { "name": "country", "value": "", "type": "query" }, { "name": "launch", "value": "", "type": "query" }, { "name": "profile", "value": "", "type": "query" }, { "name": "timeout", "value": "", "type": "query" }, { "name": "token", "value": "", "type": "query" }, { "name": "trackingId", "value": "", "type": "query" } ] }, "docs": "Returns a list of available cities for proxy connections.\n\nThis endpoint requires city proxying to be enabled on your plan.\n\nQuery Parameters:\n- country (optional): Filter cities by two-letter country code (e.g., 'US', 'GB', 'DE')\n\nThe response includes a list of available cities grouped by country code." }, { "info": { "name": "/map", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/map", "params": [ { "name": "timeout", "value": "", "type": "query" }, { "name": "token", "value": "", "type": "query" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Primarily discovers URLs from the site's sitemap, supplemented\nwith link extraction from the page via the smart-scrape strategy\npipeline (HTTP-first, browser fallback for JS-rendered pages).\nUse the search parameter to order results by relevance." }, { "info": { "name": "/pdf", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/pdf", "params": [ { "name": "blockAds", "value": "", "type": "query" }, { "name": "externalProxyServer", "value": "", "type": "query" }, { "name": "launch", "value": "", "type": "query" }, { "name": "profile", "value": "", "type": "query" }, { "name": "proxy", "value": "", "type": "query" }, { "name": "proxyCity", "value": "", "type": "query" }, { "name": "proxyCountry", "value": "", "type": "query" }, { "name": "proxyLocaleMatch", "value": "", "type": "query" }, { "name": "proxyPreset", "value": "", "type": "query" }, { "name": "proxyState", "value": "", "type": "query" }, { "name": "proxySticky", "value": "", "type": "query" }, { "name": "timeout", "value": "", "type": "query" }, { "name": "token", "value": "", "type": "query" }, { "name": "trackingId", "value": "", "type": "query" } ], "body": { "type": "json", "data": "{}" } }, "docs": "A JSON-based API for getting a PDF binary from either a supplied\n\"url\" or \"html\" payload in your request. Many options exist for\ninjecting cookies, request interceptors, user-agents and waiting for\nselectors, timers and more.\n\n**Note:** This endpoint is also available at: `/chromium/pdf` for backwards compatibility." }, { "info": { "name": "/screenshot", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/screenshot", "params": [ { "name": "blockAds", "value": "", "type": "query" }, { "name": "externalProxyServer", "value": "", "type": "query" }, { "name": "launch", "value": "", "type": "query" }, { "name": "profile", "value": "", "type": "query" }, { "name": "proxy", "value": "", "type": "query" }, { "name": "proxyCity", "value": "", "type": "query" }, { "name": "proxyCountry", "value": "", "type": "query" }, { "name": "proxyLocaleMatch", "value": "", "type": "query" }, { "name": "proxyPreset", "value": "", "type": "query" }, { "name": "proxyState", "value": "", "type": "query" }, { "name": "proxySticky", "value": "", "type": "query" }, { "name": "timeout", "value": "", "type": "query" }, { "name": "token", "value": "", "type": "query" }, { "name": "trackingId", "value": "", "type": "query" } ], "body": { "type": "json", "data": "{}" } }, "docs": "A JSON-based API for getting a screenshot binary from either a supplied\n\"url\" or \"html\" payload in your request. Many options exist including\ncookies, user-agents, setting timers and network mocks.\n\n**Note:** This endpoint is also available at: `/chromium/screenshot` for backwards compatibility." }, { "info": { "name": "/search", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/search", "params": [ { "name": "timeout", "value": "", "type": "query" }, { "name": "token", "value": "", "type": "query" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Search the web and optionally scrape result pages. Accepts a query, performs a web search via SearXNG, and optionally scrapes each result URL — returning structured, LLM-ready data (markdown, HTML, links, or screenshots)." }, { "info": { "name": "/session", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/session", "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new browser session with the specified parameters. The session can be used for persistent browser connections\nwith well-defined lifetimes and reconnection semantics. BrowserQL support is only available for stealth sessions." }, { "info": { "name": "/session/*", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/session/*", "params": [ { "name": "blockAds", "value": "", "type": "query" }, { "name": "force", "value": "", "type": "query" }, { "name": "launch", "value": "", "type": "query" }, { "name": "profile", "value": "", "type": "query" }, { "name": "timeout", "value": "", "type": "query" }, { "name": "token", "value": "", "type": "query" }, { "name": "trackingId", "value": "", "type": "query" } ] }, "docs": "Deletes a session and its associated data. This will immediately terminate any active connections to the session if \"force\" is applied.\n\nQuery Parameters:\n- force (optional): If true, forces deletion even if the session has active connections" }, { "info": { "name": "/smart-scrape", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/smart-scrape", "params": [ { "name": "profile", "value": "", "type": "query" }, { "name": "timeout", "value": "", "type": "query" }, { "name": "token", "value": "", "type": "query" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Intelligently scrapes a URL using cascading strategies (HTTP fetch, proxy, headless browser, etc)." }, { "info": { "name": "/stealth/bql?(/*)", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/stealth/bql?(/*)", "params": [ { "name": "blockAds", "value": "", "type": "query" }, { "name": "blockConsentModals", "value": "", "type": "query" }, { "name": "externalProxyServer", "value": "", "type": "query" }, { "name": "humanlike", "value": "", "type": "query" }, { "name": "launch", "value": "", "type": "query" }, { "name": "profile", "value": "", "type": "query" }, { "name": "proxy", "value": "", "type": "query" }, { "name": "proxyCity", "value": "", "type": "query" }, { "name": "proxyCountry", "value": "", "type": "query" }, { "name": "proxyLocaleMatch", "value": "", "type": "query" }, { "name": "proxyPreset", "value": "", "type": "query" }, { "name": "proxyState", "value": "", "type": "query" }, { "name": "proxySticky", "value": "", "type": "query" }, { "name": "replay", "value": "", "type": "query" }, { "name": "timeout", "value": "", "type": "query" }, { "name": "token", "value": "", "type": "query" }, { "name": "trackingId", "value": "", "type": "query" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Parses and executes BrowserQL requests, powered by the BrowserQL Editor or by other API integrations. See the BrowserQL Editor for more documentation on this API." }, { "info": { "name": "/chrome/bql?(/*)", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/chrome/bql?(/*)", "params": [ { "name": "blockAds", "value": "", "type": "query" }, { "name": "blockConsentModals", "value": "", "type": "query" }, { "name": "externalProxyServer", "value": "", "type": "query" }, { "name": "humanlike", "value": "", "type": "query" }, { "name": "launch", "value": "", "type": "query" }, { "name": "profile", "value": "", "type": "query" }, { "name": "proxy", "value": "", "type": "query" }, { "name": "proxyCity", "value": "", "type": "query" }, { "name": "proxyCountry", "value": "", "type": "query" }, { "name": "proxyLocaleMatch", "value": "", "type": "query" }, { "name": "proxyPreset", "value": "", "type": "query" }, { "name": "proxyState", "value": "", "type": "query" }, { "name": "proxySticky", "value": "", "type": "query" }, { "name": "replay", "value": "", "type": "query" }, { "name": "timeout", "value": "", "type": "query" }, { "name": "token", "value": "", "type": "query" }, { "name": "trackingId", "value": "", "type": "query" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Parses and executes BrowserQL requests, powered by the BrowserQL Editor or by other API integrations. See the BrowserQL Editor for more documentation on this API." }, { "info": { "name": "/chromium/bql?(/*)", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/chromium/bql?(/*)", "params": [ { "name": "blockAds", "value": "", "type": "query" }, { "name": "blockConsentModals", "value": "", "type": "query" }, { "name": "externalProxyServer", "value": "", "type": "query" }, { "name": "humanlike", "value": "", "type": "query" }, { "name": "launch", "value": "", "type": "query" }, { "name": "profile", "value": "", "type": "query" }, { "name": "proxy", "value": "", "type": "query" }, { "name": "proxyCity", "value": "", "type": "query" }, { "name": "proxyCountry", "value": "", "type": "query" }, { "name": "proxyLocaleMatch", "value": "", "type": "query" }, { "name": "proxyPreset", "value": "", "type": "query" }, { "name": "proxyState", "value": "", "type": "query" }, { "name": "proxySticky", "value": "", "type": "query" }, { "name": "replay", "value": "", "type": "query" }, { "name": "timeout", "value": "", "type": "query" }, { "name": "token", "value": "", "type": "query" }, { "name": "trackingId", "value": "", "type": "query" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Parses and executes BrowserQL requests, powered by the BrowserQL Editor or by other API integrations. See the BrowserQL Editor for more documentation on this API." }, { "info": { "name": "/session/bql/*", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/session/bql/*", "params": [ { "name": "blockAds", "value": "", "type": "query" }, { "name": "launch", "value": "", "type": "query" }, { "name": "profile", "value": "", "type": "query" }, { "name": "replay", "value": "", "type": "query" }, { "name": "timeout", "value": "", "type": "query" }, { "name": "token", "value": "", "type": "query" }, { "name": "trackingId", "value": "", "type": "query" } ], "body": { "type": "json", "data": "{}" } }, "docs": "> Executes BrowserQL queries against an existing session. The session must be a stealth session to support BrowserQL.\n\nBrowserQL is a GraphQL-based query language for browser automation that allows you to interact with web pages using a declarative syntax.\nQueries execute within the context of your existing session, maintaining browser state and session data across multiple operations." }, { "info": { "name": "/crawl/*", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/crawl/*", "params": [ { "name": "skip", "value": "", "type": "query" }, { "name": "token", "value": "", "type": "query" } ] }, "docs": "Get the status of a crawl job and its paginated page results. Returns progress counters, per-page metadata with content URLs, and a `next` URL for offset-based pagination via the `skip` parameter." }, { "info": { "name": "/crawl/*", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/crawl/*", "params": [ { "name": "token", "value": "", "type": "query" } ] }, "docs": "Cancel a running crawl job by its ID. Any pages already completed remain available for retrieval. Returns a 409 if the crawl is already in a terminal state." }, { "info": { "name": "/crawl", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/crawl", "params": [ { "name": "cursor", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query" }, { "name": "status", "value": "", "type": "query" }, { "name": "token", "value": "", "type": "query" } ] }, "docs": "List all crawl jobs for the authenticated token. Returns an array of crawl summaries with status, progress counters, and timestamps. Supports cursor-based pagination via the `nextCursor` field." }, { "info": { "name": "/crawl", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/crawl", "params": [ { "name": "profile", "value": "", "type": "query" }, { "name": "token", "value": "", "type": "query" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Start an asynchronous crawl job that spiders a website and scrapes every discovered page. Returns a crawl ID and status URL for polling results via GET /crawl/{id}. Supports depth control, path filtering, sitemap strategies, and webhook notifications." } ] } ], "bundled": true }