Crawl a website

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({url: 'https://example.com', maxPages: 10})
};

fetch('https://api.context.dev/v1/web/crawl', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.context.dev/v1/web/crawl"

payload = {
    "url": "https://example.com",
    "maxPages": 10
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

require 'uri'
require 'net/http'

url = URI("https://api.context.dev/v1/web/crawl")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"url\": \"https://example.com\",\n  \"maxPages\": 10\n}"

response = http.request(request)
puts response.read_body

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.context.dev/v1/web/crawl"

	payload := strings.NewReader("{\n  \"url\": \"https://example.com\",\n  \"maxPages\": 10\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.context.dev/v1/web/crawl",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'url' => 'https://example.com',
    'maxPages' => 10
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

curl --request POST \
  --url https://api.context.dev/v1/web/crawl \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "https://example.com",
  "maxPages": 10
}
'

{
  "results": [
    {
      "markdown": "<string>",
      "metadata": {
        "sourceUrl": "<string>",
        "finalUrl": "<string>",
        "title": "<string>",
        "url": "<string>",
        "crawlDepth": 123,
        "statusCode": 123,
        "success": true,
        "description": "<string>",
        "language": "<string>",
        "keywords": [
          "<string>"
        ],
        "canonicalUrl": "<string>",
        "author": "<string>",
        "siteName": "<string>",
        "image": "<string>",
        "favicon": "<string>",
        "publishedTime": "<string>",
        "modifiedTime": "<string>",
        "robots": "<string>",
        "openGraph": {},
        "twitter": {},
        "alternates": [
          {
            "href": "<string>",
            "hreflang": "<string>",
            "type": "<string>",
            "title": "<string>"
          }
        ],
        "headings": [
          {
            "level": 3,
            "text": "<string>"
          }
        ],
        "jsonLd": [
          {}
        ],
        "additionalMeta": {}
      }
    }
  ],
  "metadata": {
    "numUrls": 123,
    "maxCrawlDepth": 123,
    "numSucceeded": 123,
    "numFailed": 123,
    "numSkipped": 123
  },
  "cache_metadata": {
    "status": "hit",
    "age_ms": 1
  },
  "request_id": "3f1c2a6e-8b4d-4c1e-9f0a-2d7b5e6c8a91",
  "partial": true,
  "key_metadata": {
    "credits_consumed": 123,
    "credits_remaining": 123
  }
}

{
  "message": "<string>",
  "error_code": "INPUT_VALIDATION_ERROR",
  "request_id": "3f1c2a6e-8b4d-4c1e-9f0a-2d7b5e6c8a91",
  "key_metadata": {
    "credits_consumed": 123,
    "credits_remaining": 123
  }
}

{
  "request_id": "3f1c2a6e-8b4d-4c1e-9f0a-2d7b5e6c8a91",
  "message": "<string>",
  "error_code": "PROFILE_NOT_FOUND",
  "error_data": {
    "is_authenticated": true,
    "should_retry": false,
    "retry_condition": "sufficient_credits",
    "info_url": "https://context.dev/dashboard/subscription",
    "credits_remaining": 1,
    "credits_required": 1,
    "is_credits_required_estimated": true,
    "credits_charged": 1,
    "next_refill_at": "2023-11-07T05:31:56Z",
    "next_refill_credits": 123
  },
  "required_permission": "logs:read",
  "key_metadata": {
    "credits_consumed": 123,
    "credits_remaining": 123
  }
}

{
  "request_id": "3f1c2a6e-8b4d-4c1e-9f0a-2d7b5e6c8a91",
  "message": "<string>",
  "error_code": "PROFILE_NOT_FOUND",
  "error_data": {
    "is_authenticated": true,
    "should_retry": false,
    "retry_condition": "sufficient_credits",
    "info_url": "https://context.dev/dashboard/subscription",
    "credits_remaining": 1,
    "credits_required": 1,
    "is_credits_required_estimated": true,
    "credits_charged": 1,
    "next_refill_at": "2023-11-07T05:31:56Z",
    "next_refill_credits": 123
  },
  "required_permission": "logs:read",
  "key_metadata": {
    "credits_consumed": 123,
    "credits_remaining": 123
  }
}

{
  "request_id": "3f1c2a6e-8b4d-4c1e-9f0a-2d7b5e6c8a91",
  "message": "<string>",
  "error_code": "PROFILE_NOT_FOUND",
  "error_data": {
    "is_authenticated": true,
    "should_retry": false,
    "retry_condition": "sufficient_credits",
    "info_url": "https://context.dev/dashboard/subscription",
    "credits_remaining": 1,
    "credits_required": 1,
    "is_credits_required_estimated": true,
    "credits_charged": 1,
    "next_refill_at": "2023-11-07T05:31:56Z",
    "next_refill_credits": 123
  },
  "required_permission": "logs:read",
  "key_metadata": {
    "credits_consumed": 123,
    "credits_remaining": 123
  }
}

{
  "message": "<string>",
  "error_code": "NOT_FOUND",
  "request_id": "3f1c2a6e-8b4d-4c1e-9f0a-2d7b5e6c8a91",
  "key_metadata": {
    "credits_consumed": 123,
    "credits_remaining": 123
  }
}

{
  "request_id": "3f1c2a6e-8b4d-4c1e-9f0a-2d7b5e6c8a91",
  "message": "<string>",
  "error_code": "REQUEST_TIMEOUT",
  "key_metadata": {
    "credits_consumed": 123,
    "credits_remaining": 123
  }
}

{
  "message": "<string>",
  "error_code": "UNSUPPORTED_CONTENT",
  "request_id": "3f1c2a6e-8b4d-4c1e-9f0a-2d7b5e6c8a91",
  "key_metadata": {
    "credits_consumed": 123,
    "credits_remaining": 123
  }
}

{
  "message": "<string>",
  "error_code": "RATE_LIMITED",
  "request_id": "3f1c2a6e-8b4d-4c1e-9f0a-2d7b5e6c8a91",
  "error_data": {
    "is_authenticated": true,
    "limit_type": "concurrency",
    "limit": 1,
    "remaining": 1,
    "retry_after_seconds": 1,
    "credits_charged": 0,
    "should_retry": false,
    "retry_condition": "available_concurrency",
    "recovery_options": [
      "wait_for_in_flight_requests"
    ],
    "info_url": "https://context.dev/dashboard/subscription",
    "credits_remaining": 1
  },
  "key_metadata": {
    "credits_consumed": 123,
    "credits_remaining": 123
  }
}

{
  "request_id": "3f1c2a6e-8b4d-4c1e-9f0a-2d7b5e6c8a91",
  "message": "<string>",
  "error_code": "INTERNAL_ERROR",
  "key_metadata": {
    "credits_consumed": 123,
    "credits_remaining": 123
  }
}

POST

web

crawl

Crawl a website

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({url: 'https://example.com', maxPages: 10})
};

fetch('https://api.context.dev/v1/web/crawl', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.context.dev/v1/web/crawl"

payload = {
    "url": "https://example.com",
    "maxPages": 10
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

require 'uri'
require 'net/http'

url = URI("https://api.context.dev/v1/web/crawl")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"url\": \"https://example.com\",\n  \"maxPages\": 10\n}"

response = http.request(request)
puts response.read_body

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.context.dev/v1/web/crawl"

	payload := strings.NewReader("{\n  \"url\": \"https://example.com\",\n  \"maxPages\": 10\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.context.dev/v1/web/crawl",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'url' => 'https://example.com',
    'maxPages' => 10
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

curl --request POST \
  --url https://api.context.dev/v1/web/crawl \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "https://example.com",
  "maxPages": 10
}
'

{
  "results": [
    {
      "markdown": "<string>",
      "metadata": {
        "sourceUrl": "<string>",
        "finalUrl": "<string>",
        "title": "<string>",
        "url": "<string>",
        "crawlDepth": 123,
        "statusCode": 123,
        "success": true,
        "description": "<string>",
        "language": "<string>",
        "keywords": [
          "<string>"
        ],
        "canonicalUrl": "<string>",
        "author": "<string>",
        "siteName": "<string>",
        "image": "<string>",
        "favicon": "<string>",
        "publishedTime": "<string>",
        "modifiedTime": "<string>",
        "robots": "<string>",
        "openGraph": {},
        "twitter": {},
        "alternates": [
          {
            "href": "<string>",
            "hreflang": "<string>",
            "type": "<string>",
            "title": "<string>"
          }
        ],
        "headings": [
          {
            "level": 3,
            "text": "<string>"
          }
        ],
        "jsonLd": [
          {}
        ],
        "additionalMeta": {}
      }
    }
  ],
  "metadata": {
    "numUrls": 123,
    "maxCrawlDepth": 123,
    "numSucceeded": 123,
    "numFailed": 123,
    "numSkipped": 123
  },
  "cache_metadata": {
    "status": "hit",
    "age_ms": 1
  },
  "request_id": "3f1c2a6e-8b4d-4c1e-9f0a-2d7b5e6c8a91",
  "partial": true,
  "key_metadata": {
    "credits_consumed": 123,
    "credits_remaining": 123
  }
}

{
  "message": "<string>",
  "error_code": "INPUT_VALIDATION_ERROR",
  "request_id": "3f1c2a6e-8b4d-4c1e-9f0a-2d7b5e6c8a91",
  "key_metadata": {
    "credits_consumed": 123,
    "credits_remaining": 123
  }
}

{
  "request_id": "3f1c2a6e-8b4d-4c1e-9f0a-2d7b5e6c8a91",
  "message": "<string>",
  "error_code": "PROFILE_NOT_FOUND",
  "error_data": {
    "is_authenticated": true,
    "should_retry": false,
    "retry_condition": "sufficient_credits",
    "info_url": "https://context.dev/dashboard/subscription",
    "credits_remaining": 1,
    "credits_required": 1,
    "is_credits_required_estimated": true,
    "credits_charged": 1,
    "next_refill_at": "2023-11-07T05:31:56Z",
    "next_refill_credits": 123
  },
  "required_permission": "logs:read",
  "key_metadata": {
    "credits_consumed": 123,
    "credits_remaining": 123
  }
}

{
  "request_id": "3f1c2a6e-8b4d-4c1e-9f0a-2d7b5e6c8a91",
  "message": "<string>",
  "error_code": "PROFILE_NOT_FOUND",
  "error_data": {
    "is_authenticated": true,
    "should_retry": false,
    "retry_condition": "sufficient_credits",
    "info_url": "https://context.dev/dashboard/subscription",
    "credits_remaining": 1,
    "credits_required": 1,
    "is_credits_required_estimated": true,
    "credits_charged": 1,
    "next_refill_at": "2023-11-07T05:31:56Z",
    "next_refill_credits": 123
  },
  "required_permission": "logs:read",
  "key_metadata": {
    "credits_consumed": 123,
    "credits_remaining": 123
  }
}

{
  "request_id": "3f1c2a6e-8b4d-4c1e-9f0a-2d7b5e6c8a91",
  "message": "<string>",
  "error_code": "PROFILE_NOT_FOUND",
  "error_data": {
    "is_authenticated": true,
    "should_retry": false,
    "retry_condition": "sufficient_credits",
    "info_url": "https://context.dev/dashboard/subscription",
    "credits_remaining": 1,
    "credits_required": 1,
    "is_credits_required_estimated": true,
    "credits_charged": 1,
    "next_refill_at": "2023-11-07T05:31:56Z",
    "next_refill_credits": 123
  },
  "required_permission": "logs:read",
  "key_metadata": {
    "credits_consumed": 123,
    "credits_remaining": 123
  }
}

{
  "message": "<string>",
  "error_code": "NOT_FOUND",
  "request_id": "3f1c2a6e-8b4d-4c1e-9f0a-2d7b5e6c8a91",
  "key_metadata": {
    "credits_consumed": 123,
    "credits_remaining": 123
  }
}

{
  "request_id": "3f1c2a6e-8b4d-4c1e-9f0a-2d7b5e6c8a91",
  "message": "<string>",
  "error_code": "REQUEST_TIMEOUT",
  "key_metadata": {
    "credits_consumed": 123,
    "credits_remaining": 123
  }
}

{
  "message": "<string>",
  "error_code": "UNSUPPORTED_CONTENT",
  "request_id": "3f1c2a6e-8b4d-4c1e-9f0a-2d7b5e6c8a91",
  "key_metadata": {
    "credits_consumed": 123,
    "credits_remaining": 123
  }
}

{
  "message": "<string>",
  "error_code": "RATE_LIMITED",
  "request_id": "3f1c2a6e-8b4d-4c1e-9f0a-2d7b5e6c8a91",
  "error_data": {
    "is_authenticated": true,
    "limit_type": "concurrency",
    "limit": 1,
    "remaining": 1,
    "retry_after_seconds": 1,
    "credits_charged": 0,
    "should_retry": false,
    "retry_condition": "available_concurrency",
    "recovery_options": [
      "wait_for_in_flight_requests"
    ],
    "info_url": "https://context.dev/dashboard/subscription",
    "credits_remaining": 1
  },
  "key_metadata": {
    "credits_consumed": 123,
    "credits_remaining": 123
  }
}

{
  "request_id": "3f1c2a6e-8b4d-4c1e-9f0a-2d7b5e6c8a91",
  "message": "<string>",
  "error_code": "INTERNAL_ERROR",
  "key_metadata": {
    "credits_consumed": 123,
    "credits_remaining": 123
  }
}

1 credit per page Rate limit weight: 10 See the guide for examples and usage.

Need to crawl more than 500 pages? Use batches.

Authorizations

Authorization

string

header

required

Send Authorization: Bearer <API_KEY>. Keys have full access unless restricted to scopes.

Body

application/json

url

string<uri>

required

Start URL, including http:// or https://.

Minimum string length: 1

maxPages

integer

default:100

Maximum pages to crawl.

Required range: 1 <= x <= 500

maxDepth

integer

Maximum link depth from the starting URL (0 = only the starting page)

Required range: x >= 0

urlRegex

string

Regex pattern. Only URLs matching this pattern will be followed and scraped. An automatic prefix scope in the form ^ follows a redirect of the starting page.

Maximum string length: 256

Example:

"^https?://[^/]+/blog/"

excludeUrlRegex

string

Regex pattern. URLs matching this pattern are never followed or scraped, even when they match urlRegex. The starting URL is always scraped.

Maximum string length: 256

Example:

"/tag/|/author/"

includeLinks

boolean

default:true

Preserve hyperlinks in the Markdown output (html-conversion only).

includeImages

boolean

default:false

Include image references in the Markdown output (html-conversion only).

shortenBase64Images

boolean

default:true

Truncate base64-encoded image data in the Markdown output (html-conversion only).

useMainContentOnly

boolean

default:false

Extract only the main content, stripping headers, footers, sidebars, and navigation

sourcePreference

enum<string>[]

Markdown sources in order of preference: html-conversion converts the page HTML, markdown-direct uses Markdown the site publishes.

Minimum array length: 1

Available options:

html-conversion,

markdown-direct

followSubdomains

boolean

default:false

When true, follow links on subdomains of the starting URL's domain (e.g. docs.example.com when starting from example.com). www and apex are always treated as equivalent.

pdf

object

PDF handling. start/end limit parsing to an inclusive, 1-based page range.

Show child attributes

includeFrames

boolean

default:false

When true, the contents of iframes are rendered to Markdown for each crawled page.

includeSelectors

string[] | null

Keep matching HTML subtrees before converting each page to Markdown.

Maximum array length: 50

Required string length: 1 - 2048

excludeSelectors

string[] | null

Remove matching elements after inclusions. Exclusions take precedence.

Maximum array length: 50

Required string length: 1 - 2048

maxAgeMs

integer | null

default:86400000

Maximum cache age in milliseconds. Defaults to 1 day; 0 fetches fresh.

Required range: 0 <= x <= 2592000000

waitForMs

integer | null

default:3500

Browser wait time in milliseconds after initial page load for each crawled page. Defaults to 3500 (3.5 seconds). Min: 0. Max: 30000 (30 seconds).

Required range: 0 <= x <= 30000

settleAnimations

boolean

default:false

Wait briefly for CSS animations and transitions to settle before reading each page.

stopAfterMs

integer

default:80000

Soft crawl deadline in milliseconds. Returns pages collected before the next deadline check.

Required range: 10000 <= x <= 110000

timeoutOpts

object

Request deadline and what to return when it passes.

Show child attributes

country

enum<string>

Fetch from this country (ISO 3166-1 alpha-2).

Available options:

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

Example:

"de"

zdr

enum<string>

default:disabled

enabled turns on zero data retention. Returns 403 ZDR_NOT_ENABLED unless your organization has ZDR.

Available options:

enabled,

disabled

policies

string[]

Access policy IDs to apply. A URL must pass every policy.

Example:

["pol_3f9c2a7e5b8d4c1f9a6e0b2d7c4f8a1e"]

Response

Successful response

results

object[]

required

Show child attributes

metadata

object

required

Show child attributes

cache_metadata

object

required

Whether this response came from cache.

Show child attributes

request_id

string<uuid>

required

Unique ID of this request, also in X-Request-Id. Include it when contacting support.

Example:

"3f1c2a6e-8b4d-4c1e-9f0a-2d7b5e6c8a91"

partial

boolean

True when timeoutOpts.behavior=return-partial returned the usable results collected before the deadline. Partial collections are not cached as complete results.

key_metadata

object

Credits this request used and your remaining balance.

Show child attributes

Web Data

Brand Data

Entity Enrichment

Batches

Monitors

Webhook Deliveries

Access Policies

Account

Agent Feedback

Crawl a website

Authorizations

Body

Response