For AI agents: a documentation index is available at /llms.txt
Skip to main content

/screenshot

POST 

/screenshot

Returns a screenshot binary from a url or html payload. "url" or "html" payload in your request. Many options exist including cookies, user-agents, setting timers and network mocks.

Note: This is the preferred endpoint. The /chromium/screenshot route is equivalent.

Request​

Query Parameters

    allowedDomains string[]
    blockAds boolean
    blockAdsInclude string
    credentials object
    externalProxyServer string
    integrationId string
    launch object
    profile string
    proxy ProxyType

    Possible values: [datacenter, residential]

    proxyCity string
    proxyCountry string
    proxyLocaleMatch string

    Possible values: [0, 1, false, true]

    proxyPreset string
    proxyState string
    proxySticky string

    Possible values: [0, 1, false, true]

    timeout number
    token string
    trackingId string

Body

    blockConsentModalsboolean

    Whether to automatically block cookie consent modals and popups.

    options object

    Screenshot options based on Puppeteer's ScreenshotOptions interface. Includes properties like type, quality, fullPage, clip, etc.

    optimizeForSpeedboolean
    typestring

    Possible values: [jpeg, png, webp]

    qualitynumber

    Quality of the image, between 0-100. Not applicable to png images.

    fromSurfaceboolean

    Capture the screenshot from the surface, rather than the view.

    fullPageboolean

    When true, takes a screenshot of the full page.

    omitBackgroundboolean

    Hides default white background and allows capturing screenshots with transparency.

    clip object

    Specifies the region of the page/element to clip.

    scalenumber
    widthnumberrequired

    the width of the element in pixels.

    heightnumberrequired

    the height of the element in pixels.

    xnumberrequired
    ynumberrequired
    encodingstring

    Encoding of the image.

    Possible values: [base64, binary]

    captureBeyondViewportboolean

    Capture the screenshot beyond the viewport.

    addScriptTag object[]

    An array of script tags to add to the page before performing actions. Each object can contain either a url or a content property. path is rejected.

  • Array [
  • typestring
    idstring
    urlstring
    contentstring
    property name*any
  • ]
  • addStyleTag object[]

    An array of style tags to add to the page before performing actions. Each object can contain either a url or a content property. path is rejected.

  • Array [
  • urlstring
    contentstring
    property name*any
  • ]
  • authenticate object

    Credentials for HTTP authentication. Contains username and password properties.

    usernamestringrequired
    passwordstringrequired
    bestAttemptboolean

    When bestAttempt is set to true, browserless will attempt to proceed when "awaited" events fail or timeout. This includes things like goto, waitForSelector, and more.

    cookies object[]

    An array of cookies to set on the page before navigation. Each cookie object should contain at least name and value properties.

  • Array [
  • namestringrequired

    Cookie name.

    valuestringrequired

    Cookie value.

    urlstring

    The request-URI to associate with the setting of the cookie. This value can affect the default domain, path, and source scheme values of the created cookie.

    domainstring

    Cookie domain.

    pathstring

    Cookie path.

    secureboolean

    True if cookie is secure.

    httpOnlyboolean

    True if cookie is http-only.

    sameSitestring

    Cookie SameSite type.

    Possible values: [Default, Lax, None, Strict]

    expiresnumber

    Cookie expiration date, session cookie if not set

    prioritystring

    Cookie Priority. Supported only in Chrome.

    Possible values: [High, Low, Medium]

    sourceSchemestring

    Cookie source scheme type. Supported only in Chrome.

    Possible values: [NonSecure, Secure, Unset]

    partitionKey object

    Cookie partition key. In Chrome, it matches the top-level site the partitioned cookie is available in. In Firefox, it matches the source origin in the {@link https://w3c.github.io/webdriver-bidi/#type-storage-PartitionKey PartitionKey}.

    anyOf

    Represents a cookie partition key in Chrome.

    sourceOriginstringrequired

    The site of the top-level URL the browser was visiting at the start of the request to the endpoint that set the cookie.

    In Chrome, maps to the CDP's topLevelSite partition key.

    hasCrossSiteAncestorboolean

    Indicates if the cookie has any ancestors that are cross-site to the topLevelSite.

    Supported only in Chrome.

  • ]
  • emulateMediaTypestring

    Changes the CSS media type of the page. Accepts values like "screen" or "print".

    gotoOptions object

    Options to configure the page navigation, such as timeout and waitUntil.

    refererstring

    If provided, it will take preference over the referer header value set by {@link Page.setExtraHTTPHeaderspage.setExtraHTTPHeaders()}.

    referrerPolicystring

    If provided, it will take preference over the referer-policy header value set by {@link Page.setExtraHTTPHeaderspage.setExtraHTTPHeaders()}.

    timeoutnumber

    Maximum wait time in milliseconds. Pass 0 to disable the timeout.

    The default value can be changed by using the {@link Page.setDefaultTimeout} or {@link Page.setDefaultNavigationTimeout} methods.

    waitUntil object

    When to consider waiting succeeds. Given an array of event strings, waiting is considered to be successful after all events have been fired.

    anyOf
  • Array [
  • PuppeteerLifeCycleEvent

    Possible values: [domcontentloaded, load, networkidle0, networkidle2]

  • ]
  • signal object

    A signal object that allows you to cancel the call.

    abortedbooleanrequired
    onabort objectrequired
    anyOf
    object
    reasonrequired
    htmlstring

    HTML content to set as the page content instead of navigating to a URL.

    rejectRequestPatternstring[]

    An array of patterns to match against request URLs for automatic rejection. Requests matching these patterns will be aborted.

    rejectResourceTypesstring[]

    An array of resource types to reject during page load. Common types include "image", "stylesheet", "font", "script", etc.

    Possible values: [cspviolationreport, document, eventsource, fedcm, fetch, font, image, manifest, media, other, ping, prefetch, preflight, script, signedexchange, stylesheet, texttrack, websocket, xhr]

    requestInterceptors object[]

    An array of request interceptors that can modify or mock network requests. Each interceptor has a pattern to match URLs and a response to return.

  • Array [
  • patternstringrequired

    An array of patterns (using req.url().match(r.pattern) to match) and their corresponding responses to use in order to fulfill those requests.

    response objectrequired
    statusnumber
    headers object

    Optional response headers. Either a {@link https://developer.mozilla.org/en-US/docs/Web/API/Headers Headers} instance or a plain record.

    The record values will be converted to string following: Arrays' values will be mapped to String (Used when you need multiple headers with the same name). Non-arrays will be converted to String.

    anyOf
    object
    contentTypestring
    bodystring

    A string representation of the body to return. Can be a base64-encoded string but please omit any leading content-type data (eg "data:image/png;base64,").

  • ]
  • setExtraHTTPHeaders object

    An object containing additional HTTP headers to send with every request.

    property name*string
    setJavaScriptEnabledboolean

    Whether or not to allow JavaScript to run on the page.

    urlstring

    The URL to navigate to before performing actions.

    userAgent object

    The user agent string to use for the page.

    userAgentstring
    userAgentMetadata object

    Used to specify User Agent Client Hints to emulate. See https://wicg.github.io/ua-client-hints Missing optional values will be filled in by the target with what it would normally use.

    brands object[]

    Brands appearing in Sec-CH-UA.

  • Array [
  • brandstringrequired
    versionstringrequired
  • ]
  • fullVersionList object[]

    Brands appearing in Sec-CH-UA-Full-Version-List.

  • Array [
  • brandstringrequired
    versionstringrequired
  • ]
  • fullVersionstring
    platformstringrequired
    platformVersionstringrequired
    architecturestringrequired
    modelstringrequired
    mobilebooleanrequired
    bitnessstring
    wow64boolean
    formFactorsstring[]

    Used to specify User Agent form-factor values. See https://wicg.github.io/ua-client-hints/#sec-ch-ua-form-factors

    platformstring
    viewport object

    The viewport dimensions and settings for the page. Includes properties like width, height, deviceScaleFactor, etc.

    widthnumberrequired

    The page width in CSS pixels.

    heightnumberrequired

    The page height in CSS pixels.

    deviceScaleFactornumber

    Specify device scale factor. See {@link https://developer.mozilla.org/en-US/docs/Web/API/Window/devicePixelRatio devicePixelRatio} for more info.

    isMobileboolean

    Whether the meta viewport tag is taken into account.

    isLandscapeboolean

    Specifies if the viewport is in landscape mode.

    hasTouchboolean

    Specify if the viewport supports touch events.

    waitForEvent object

    Options for waiting for a specific event to be fired on the page.

    eventstringrequired
    timeoutnumber
    waitForFunction object

    Options for waiting for a JavaScript function to execute.

    fnstringrequired

    The function, or statement, to be evaluated in browser context

    pollingstring | number

    An interval at which the pageFunction is executed, defaults to raf. If polling is a number, then it is treated as an interval in milliseconds at which the function would be executed. If polling is a string, then it can be one of the following values: "raf" or "mutation"

    timeoutnumber

    Maximum time to wait for in milliseconds. Defaults to 30000 (30 seconds). Pass 0 to disable timeout.

    waitForSelector object

    Options for waiting for a specific CSS selector to appear on the page.

    hiddenboolean
    selectorstringrequired
    timeoutnumber
    visibleboolean
    waitForTimeoutnumber

    The amount of time in milliseconds to wait before proceeding.

    scrollPageboolean

    Whether to scroll through the entire page before capturing content. Useful for triggering lazy-loaded content.

    selectorstring

    A CSS selector to target a specific element instead of the full page.

Responses​

Response can either be a text/plain base64 encoded body or a binary stream with png/jpeg as a content-type

Schema
    stringstring<binary>
Was this page helpful?