payload.url | string | Yes | — | Full URL to scrape into LLM usable Markdown (must include http:// or https:// protocol) Format: uri. Minimum length: 1. |
payload.includeLinks | boolean | No | true | Preserve hyperlinks in Markdown output |
payload.includeImages | boolean | No | false | Include image references in Markdown output |
payload.shortenBase64Images | boolean | No | true | Shorten base64-encoded image data in the Markdown output |
payload.useMainContentOnly | boolean | No | false | Extract only the main content of the page, excluding headers, footers, sidebars, and navigation |
payload.includeHTML | boolean | No | false | When true, the response also includes an html field with the page HTML the Markdown was converted from — the same body the Scrape HTML endpoint returns for the equivalent request. |
payload.pdf | object | No | {"shouldParse":true,"ocr":false} | PDF parsing controls. Use start/end to limit text extraction and embedded-image detection/OCR to an inclusive 1-based page range. |
payload.includeFrames | boolean | No | false | When true, the contents of iframes are rendered to Markdown. |
payload.includeSelectors | array | No | — | CSS selectors. When provided, only matching HTML subtrees (and their descendants) are kept before conversion to Markdown. When omitted, the entire document is kept. Examples: “article.main”, “#content”, “[role=main]”. Maximum items: 50. |
payload.excludeSelectors | array | No | — | CSS selectors to remove before conversion to Markdown. Applied after includeSelectors. Exclusion takes precedence: an element matching both is removed. Examples: “nav”, “footer”, “.ad-banner”, “[aria-hidden=true]”. Maximum items: 50. |
payload.maxAgeMs | integer | No | 86400000 | Return a cached result if a prior scrape for the same parameters exists and is younger than this many milliseconds. Defaults to 1 day (86400000 ms) when omitted. Max is 30 days (2592000000 ms). Set to 0 to always scrape fresh. Minimum: 0. Maximum: 2592000000. |
payload.waitForMs | integer | No | — | Optional browser wait time in milliseconds after initial page load before converting the page to Markdown. Min: 0. Max: 30000 (30 seconds). Minimum: 0. Maximum: 30000. |
payload.settleAnimations | boolean | No | false | When true, waits briefly for CSS and transition animations to settle before converting to Markdown. Defaults to false. This adds a bit of latency in exchange for more stable output on animated pages. |
payload.actions | array | No | — | Optional browser actions executed in array order after the page loads and before content is captured. Send a JSON array in the query parameter. Maximum: 5 actions. Maximum items: 5. |
payload.headers | record | No | — | Optional outbound HTTP headers forwarded only to the target URL, sent as deep-object query params such as headers[X-Custom]=value. When provided, caching is bypassed: the result is neither read from nor written to cache. |
payload.country | "ad" | "ae" | "af" | "ag" | "ai" | "al" | "am" | "ao" | "ar" | "at" | "au" | "aw" | "az" | "ba" | "bb" | "bd" | "be" | "bf" | "bg" | "bh" | "bi" | "bj" | "bm" | "bn" | "bo" | "bq" | "br" | "bs" | "bw" | "by" | "bz" | "ca" | "cd" | "cf" | "cg" | "ch" | "ci" | "cl" | "cm" | "cn" | "co" | "cr" | "cv" | "cw" | "cy" | "cz" | "de" | "dj" | "dk" | "dm" | "do" | "dz" | "ec" | "ee" | "eg" | "es" | "et" | "fi" | "fj" | "fr" | "ga" | "gb" | "gd" | "ge" | "gf" | "gg" | "gh" | "gm" | "gn" | "gp" | "gq" | "gr" | "gt" | "gu" | "gw" | "gy" | "hk" | "hn" | "hr" | "ht" | "hu" | "id" | "ie" | "il" | "im" | "in" | "iq" | "ir" | "is" | "it" | "je" | "jm" | "jo" | "jp" | "ke" | "kg" | "kh" | "kn" | "kr" | "kw" | "ky" | "kz" | "la" | "lb" | "lc" | "lk" | "lr" | "ls" | "lt" | "lu" | "lv" | "ly" | "ma" | "mc" | "md" | "me" | "mf" | "mg" | "mk" | "ml" | "mm" | "mn" | "mo" | "mq" | "mr" | "mt" | "mu" | "mv" | "mw" | "mx" | "my" | "mz" | "na" | "nc" | "ne" | "ng" | "ni" | "nl" | "no" | "np" | "nz" | "om" | "pa" | "pe" | "pf" | "pg" | "ph" | "pk" | "pl" | "pr" | "ps" | "pt" | "py" | "qa" | "re" | "ro" | "rs" | "ru" | "rw" | "sa" | "sc" | "sd" | "se" | "sg" | "si" | "sk" | "sl" | "sm" | "sn" | "so" | "sr" | "ss" | "st" | "sv" | "sx" | "sy" | "sz" | "tc" | "td" | "tg" | "th" | "tj" | "tl" | "tm" | "tn" | "tr" | "tt" | "tw" | "tz" | "ua" | "ug" | "us" | "uy" | "uz" | "vc" | "ve" | "vg" | "vi" | "vn" | "ye" | "yt" | "za" | "zm" | "zw" | No | — | Fetch the target page through a residential proxy in this country (ISO 3166-1 alpha-2). Allowed: ad, ae, af, ag, ai, al, am, ao, ar, at, au, aw, az, ba, bb, bd, be, bf, bg, bh, bi, bj, bm, bn, bo, bq, br, bs, bw, by, bz, ca, cd, cf, cg, ch, ci, cl, cm, cn, co, cr, cv, cw, cy, cz, de, dj, dk, dm, do, dz, ec, ee, eg, es, et, fi, fj, fr, ga, gb, gd, ge, gf, gg, gh, See the live schema for the complete constraint. |
payload.timeoutMS | integer | No | — | Optional timeout in milliseconds for the request. If the request takes longer than this value, it will be aborted with a 408 status code. Maximum allowed value is 300000ms (5 minutes). Minimum: 1. Maximum: 300000. |
payload.zdr | "enabled" | "disabled" | No | "disabled" | Set to enabled to bypass shared caches and omit request and response content from retained usage logs. Requires zero data retention to be enabled for your organization (contact support@context.dev), otherwise the request fails with ZDR_NOT_ENABLED. Successful ZDR responses include X-Context-ZDR: true. Allowed: enabled, disabled. |
payload.tags | array | No | — | Optional comma-separated caller-defined tags for tracking this request. Tags are recorded on the request’s usage log and can be used to filter usage on the dashboard usage page. Up to 20 tags, each 1-50 characters. Maximum items: 20. |