Search the local web index

Search the web index populated by /v1/web/crawl. Results are ranked by the B/U term score over each page.

POST/v1/web/search

Authorization

AuthorizationBearer token (JWT) · headerrequired

Bearer API key issued for your account. Send Authorization: Bearer <key>.

Request body

requiredapplication/json

qstringrequired

Search query

ninteger

Maximum number of results

default: 10

Responses

200

Ranked search results

resultsWebSearchResult[]required

Show properties

Array of WebSearchResult

urlstring<uri>required

titlestringrequired

scorenumber<double>required

matchesintegerrequired

400

Bad request

string

401

Missing or invalid bearer token

string

403

Billing or plan entitlement blocked the request

string

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer token (JWT)Remember on this deviceInclude my values in samples

Bodyapplication/json

qstring*Search querynintegerMaximum number of results

Request

curl -X POST 'https://api.webfold.ai/v1/web/search' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "q": "rust webassembly",
  "n": 10
}'

import requests

response = requests.post(
    "https://api.webfold.ai/v1/web/search",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Accept": "application/json",
        "Content-Type": "application/json"
    },
    data="{\n  \"q\": \"rust webassembly\",\n  \"n\": 10\n}",
)

const response = await fetch("https://api.webfold.ai/v1/web/search", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Accept": "application/json",
    "Content-Type": "application/json"
  },
  body: "{\n  \"q\": \"rust webassembly\",\n  \"n\": 10\n}"
});

Response

{
  "results": [
    {
      "url": "http://example.com",
      "title": "string",
      "score": 0.1,
      "matches": 0
    }
  ]
}

"string"

"string"

"string"