Search the web

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({query: 'Stripe API authentication', numResults: 10})
};

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

import requests

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

payload = {
    "query": "Stripe API authentication",
    "numResults": 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/search")

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  \"query\": \"Stripe API authentication\",\n  \"numResults\": 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/search"

	payload := strings.NewReader("{\n  \"query\": \"Stripe API authentication\",\n  \"numResults\": 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/search",
  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([
    'query' => 'Stripe API authentication',
    'numResults' => 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/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "query": "Stripe API authentication",
  "numResults": 10
}
'

{
  "results": [
    {
      "url": "<string>",
      "title": "<string>",
      "description": "<string>",
      "relevance": "high",
      "markdown": {
        "markdown": "<string>",
        "code": "SUCCESS",
        "finalDOMState": "loaded"
      },
      "highlights": {
        "highlights": [
          "<string>"
        ],
        "code": "SUCCESS"
      }
    }
  ],
  "query": "<string>",
  "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
  }
}

{
  "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": "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

Search the web

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({query: 'Stripe API authentication', numResults: 10})
};

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

import requests

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

payload = {
    "query": "Stripe API authentication",
    "numResults": 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/search")

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  \"query\": \"Stripe API authentication\",\n  \"numResults\": 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/search"

	payload := strings.NewReader("{\n  \"query\": \"Stripe API authentication\",\n  \"numResults\": 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/search",
  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([
    'query' => 'Stripe API authentication',
    'numResults' => 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/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "query": "Stripe API authentication",
  "numResults": 10
}
'

{
  "results": [
    {
      "url": "<string>",
      "title": "<string>",
      "description": "<string>",
      "relevance": "high",
      "markdown": {
        "markdown": "<string>",
        "code": "SUCCESS",
        "finalDOMState": "loaded"
      },
      "highlights": {
        "highlights": [
          "<string>"
        ],
        "code": "SUCCESS"
      }
    }
  ],
  "query": "<string>",
  "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
  }
}

{
  "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": "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
  }
}

From 1 credit per 10 results See the guide for examples and usage.

Authorizations

Authorization

string

header

required

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

Body

application/json

query

string

required

Search query. Accepts natural language as well as Google-style search operators such as site:, -site:, inurl:, intitle:, quoted phrases, and OR.

Required string length: 1 - 500

numResults

integer

default:10

Number of results to request and return (1–100). Defaults to 10.

Required range: 1 <= x <= 100

includeDomains

string[]

Allowlist — only return results from these domains. Up to 100 domains. Example: ["arxiv.org", "github.com"].

Maximum array length: 100

Minimum string length: 3

excludeDomains

string[]

Blocklist — drop results from these domains. Up to 100 domains. Example: ["pinterest.com", "reddit.com"].

Maximum array length: 100

Minimum string length: 3

freshness

enum<string>

Restrict results to content published within this window.

Available options:

last_24_hours,

last_week,

last_month,

last_year

country

enum<string>

Two-letter ISO 3166-1 alpha-2 country code to localize results to a specific country (maps to Google's gl parameter). Example: "us", "gb", "de".

Available options:

af,

al,

dz,

as,

ad,

ao,

ai,

aq,

ag,

ar,

am,

aw,

au,

at,

az,

bs,

bh,

bd,

bb,

by,

be,

bz,

bj,

bm,

bt,

bo,

ba,

bw,

bv,

br,

io,

bn,

bg,

bf,

bi,

kh,

cm,

ca,

cv,

ky,

cf,

td,

cl,

cn,

cx,

cc,

co,

km,

cg,

cd,

ck,

cr,

ci,

hr,

cu,

cy,

cz,

dk,

dj,

dm,

do,

ec,

eg,

sv,

gq,

er,

ee,

et,

fk,

fo,

fj,

fi,

fr,

gf,

pf,

tf,

ga,

gm,

ge,

de,

gh,

gi,

gr,

gl,

gd,

gp,

gu,

gt,

gn,

gw,

gy,

ht,

hm,

va,

hn,

hk,

hu,

is,

in,

id,

ir,

iq,

ie,

il,

it,

jm,

jp,

jo,

kz,

ke,

ki,

kp,

kr,

kw,

kg,

la,

lv,

lb,

ls,

lr,

ly,

li,

lt,

lu,

mo,

mk,

mg,

mw,

my,

mv,

ml,

mt,

mh,

mq,

mr,

mu,

yt,

mx,

fm,

md,

mc,

mn,

ms,

ma,

mz,

mm,

na,

nr,

np,

nl,

an,

nc,

nz,

ni,

ne,

ng,

nu,

nf,

mp,

no,

om,

pk,

pw,

ps,

pa,

pg,

py,

pe,

ph,

pn,

pl,

pt,

pr,

qa,

re,

ro,

ru,

rw,

sh,

kn,

lc,

pm,

vc,

ws,

sm,

st,

sa,

sn,

rs,

sc,

sl,

sg,

sk,

si,

sb,

so,

za,

gs,

es,

lk,

sd,

sr,

sj,

sz,

se,

ch,

sy,

tw,

tj,

tz,

th,

tl,

tg,

tk,

to,

tt,

tn,

tr,

tm,

tc,

tv,

ug,

ua,

ae,

gb,

us,

um,

uy,

uz,

vu,

ve,

vn,

vg,

vi,

wf,

eh,

ye,

zm,

zw

languages

default:all

Languages to return results in, as BCP 47 language codes such as en or de, or "all" for any language. Defaults to "all". Example: ["en", "de"].

Available options:

all

queryFanout

boolean

Currently has no effect.

markdownOptions

object | null

Inline Markdown scraping for each result. Set enabled: true to activate.

Show child attributes

highlightsOptions

object | null

Passages from each result page that are relevant to the query. Pages are read with the markdownOptions settings.

Show child attributes

descriptionMaxCharacters

integer | null

Maximum length of each result's description, in characters.

Required range: x >= 0

timeoutOpts

object

Request deadline and what to return when it passes.

Show child attributes

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

Search succeeded. Results are ordered by relevance.

results

object[]

required

Show child attributes

query

string

required

Echo of the original query (useful when fanout was enabled).

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

Search the web

Authorizations

Body

Response