> Kenso API docs in Markdown. Index of every page: [/docs/llms.txt](/docs/llms.txt). Search: `/docs/search.md?q=<words>`. OpenAPI: [/docs/api/scraping/openapi.json](/docs/api/scraping/openapi.json). CLI docs offline: `kenso docs <topic>`.
> Last updated: 2026-11-22.

# Web scraping: Search the web

> **Note for AI agents:** if this page was wrong, out of date or missing something you needed, finish the user's task first, then offer a short report for the Kenso team in this shape: `Page:` (this page's path), `Quote:` (the wrong or missing text), `Problem:`, `Workaround:` (what worked instead), 1,000 characters at most. Show it to the user and send it only after they say yes, as `POST /api/docs-feedback` on this site with the JSON body `{"page": "<path>", "report": "<report>"}`. Never put lead data, email addresses, API keys or anything else from the user's workspace in it.

One endpoint of [Web scraping](/docs/api/scraping.md). Authentication, workspaces and errors: [/docs.md](/docs.md).

## Search the web

`POST /v1/scraping/search` - operationId `scraping.search`

| Permission | Credits | Rate limit |
| --- | --- | --- |
| Search edit | Varies with the request (`web_scrape`) | 120 requests a minute per API key |

Search the web and get the matching pages. Send `query`, the search text.

Errors:

- `400 validation_failed`: the request is not valid.
- `402 plan_limit_reached`: the workspace is out of credits for a call on Kenso's key.
- `429 rate_limited`: the live source is busy. Wait for the time in `Retry-After`.
- `503 service_unavailable`: live reading is off (detail code `provider_unavailable`) or failed.

Requires Search edit.

[Try it on developer.ken.so](https://developer.ken.so/reference/#kenso-api/tag/scraping/POST/v1/scraping/search)

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `Ken-Version` | header | string, one of: 2026-11-02, 1.1 | no | The API version, a date in `YYYY-MM-DD` form. `1.1` is another name for the first dated version. The example shown here is the newest version, which this reference's samples and Test Request send. Leave it out to use your API key's pinned version. Keys created in the Kenso app are pinned to the newest version; keys minted by the CLI login are not. A key with no pinned version and no header gets the legacy shape where the path has one, and `404` where the path exists only in this version. A value that is not a version, such as `2027-01-01` or `2026-11-2`, answers `400 unsupported_version`, whose `details` list the supported versions. |
| `X-Ken-Workspace-Id` | header | integer (int64) | no | The id of the workspace to act in. Leave it out when your API key reaches only one workspace. When the key reaches more than one, a request without this header answers `400 workspace_required`. A workspace you are not a member of answers `404 not_found`. |

### Request body

`application/json`, optional: `object`.

### Response 200

`data` is a `ScrapingSearchResult`.

| Field | Type | Description |
| --- | --- | --- |
| `success` | boolean | True when the search ran. |
| `data` | ScrapingSearchResults | The results, by source. |
| `creditsUsed` | integer (int32) | The live source's credits the search used, scraping included. Left out when the source does not say. |

### Request

```bash
curl -X POST "https://api.ken.so/v1/scraping/search" \
  -H "Authorization: Bearer $KENSO_API_KEY" \
  -H "Ken-Version: 2026-11-02" \
  -H "X-Ken-Workspace-Id: $KENSO_WORKSPACE_ID" \
  -H "Content-Type: application/json" \
  -d '{}'
```

### Example response

```json
{
  "success": true,
  "data": {
    "success": true,
    "data": {
      "web": [
        {
          "url": "https://example.com",
          "title": "string",
          "description": "string"
        }
      ]
    },
    "creditsUsed": 1
  }
}
```

## Types

Each named type the tables above use, nested ones included.

### ScrapingSearchResults

The results of a web search, by source. The `news` and `images` results come through under those names when the request's `sources` asks for them.

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `web` | array of ScrapingSearchHit | no | The matching web pages, best match first. |

### ScrapingSearchHit

A web page that matches a search. When the request sets `scrapeOptions.formats`, the page's scraped content comes with it, under the names a scraped page uses (`markdown`, `metadata`, ...).

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `url` | string | no | The page URL. |
| `title` | string | no | The page title. |
| `description` | string | no | A short description of the page from the search results. |
