> 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

> **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.

Scrape, map, crawl and search the web, and extract structured data from pages.

Prospecting data. 6 endpoints under `https://api.ken.so`. Every request sends `Authorization: Bearer <your API key>` and `Ken-Version: 2026-11-02`: see [Authentication](/docs/authentication.md), [Workspaces](/docs/workspaces.md) and [Errors](/docs/errors.md). OpenAPI for this resource only: [/docs/api/scraping/openapi.json](/docs/api/scraping/openapi.json).

- `POST /v1/scraping/scrape` - Scrape a page (`scraping.scrape`): [/docs/api/scraping/scrape.md](/docs/api/scraping/scrape.md)
- `POST /v1/scraping/map` - Map a site's URLs (`scraping.map`): [/docs/api/scraping/map.md](/docs/api/scraping/map.md)
- `POST /v1/scraping/search` - Search the web (`scraping.search`): [/docs/api/scraping/search.md](/docs/api/scraping/search.md)
- `POST /v1/scraping/crawls` - Start a crawl (`scraping.create-crawl`): [/docs/api/scraping/create-crawl.md](/docs/api/scraping/create-crawl.md)
- `POST /v1/scraping/extractions` - Start an extraction (`scraping.create-extraction`): [/docs/api/scraping/create-extraction.md](/docs/api/scraping/create-extraction.md)
- `POST /v1/scraping/batch-scrapes` - Start a batch scrape (`scraping.create-batch-scrape`): [/docs/api/scraping/create-batch-scrape.md](/docs/api/scraping/create-batch-scrape.md)

## Scrape a page

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

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

Read one public page and get its content, for example as markdown.

Send `url` and output options such as `formats`. A markdown-only request with no `actions` reads
Kenso's web archive first: a free copy up to 18 months old (send `maxAge` for a newer one), marked
`metadata.kenSource: "archive"` with `metadata.cachedAt`, the time of the copy. Each archive page
counts against the daily `webArchiveReads` quota. Other pages are read live.

Errors:

- `400 validation_failed`: the request is not valid, or the URL is not public.
- `402 plan_limit_reached`: the workspace is out of credits for a call on Kenso's key.
- `429 quota_exceeded`: the daily `webArchiveReads` quota is used up.
- `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/scrape)

### 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 `ScrapingScrapeResult`.

| Field | Type | Description |
| --- | --- | --- |
| `success` | boolean | True when the page was read. |
| `data` | ScrapingPage | The page. |

### Request

```bash
curl -X POST "https://api.ken.so/v1/scraping/scrape" \
  -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": {
      "markdown": "markdown",
      "html": "string",
      "rawHtml": "string",
      "links": [
        "string"
      ],
      "summary": "string",
      "screenshot": "string",
      "json": {
        "key": null
      },
      "metadata": {
        "sourceURL": "https://example.com",
        "url": "https://example.com",
        "statusCode": 1,
        "numPages": 1,
        "cacheState": "string",
        "cachedAt": "2026-05-04T10:12:00.000Z",
        "creditsUsed": 1,
        "kenSource": "string",
        "kenTruncated": true
      }
    }
  }
}
```

## Map a site's URLs

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

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

List the public URLs on a site, for example to pick pages to scrape or crawl. Send `url`, the site to map.

Errors:

- `400 validation_failed`: the request is not valid, or the URL is not public.
- `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/map)

### 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 `ScrapingMapResult`.

| Field | Type | Description |
| --- | --- | --- |
| `success` | boolean | True when the site was mapped. |
| `links` | array of ScrapingMapLink | The URLs found on the site. |

### Request

```bash
curl -X POST "https://api.ken.so/v1/scraping/map" \
  -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,
    "links": [
      {
        "url": "https://example.com",
        "title": "string",
        "description": "string"
      }
    ]
  }
}
```

## 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
  }
}
```

## Start a crawl

`POST /v1/scraping/crawls` - operationId `scraping.create-crawl`

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

Start a crawl that follows links from one URL and scrapes the pages it finds, to read a whole site or a part of it.

Send `url` and `limit`, the most pages to scrape (1 to 1,000). Optional fields such as
`includePaths` narrow the crawl.

The call answers `202` with the job. On Kenso's key, Kenso reserves the most credits the job can cost and
settles when a status read sees it finish, so a `webhook` needs the workspace's own key.
Poll `GET /v1/jobs/{jobId}?type=crawl`. When Kenso cannot record the job, it stops the crawl and answers
`503`.

Errors:

- `400 validation_failed`: `limit` is missing or outside 1 to 1,000, a URL is not public,
`webhook` is sent on Kenso's key, or another field 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`), failed, or
Kenso could not record the job.

Requires Search edit.

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

### 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 202

`data` is a `Job`.

| Field | Type | Description |
| --- | --- | --- |
| `id` | integer (int64) | The job's id. Ids are unique only within one `type`, so send `type` with the id when you read or cancel the job. |
| `type` | string | The job type: `contact_import`, `contact_export`, `domain_health`, `lead_scoring`, `enrichment`, `crawl`, `extraction`, `batch_scrape`, `knowledge_export`, `inbox_import` or `migration`. |
| `status` | string | One of `queued`, `running`, `succeeded`, `failed` or `canceled`. Only `crawl`, `extraction`, `batch_scrape` and `migration` jobs reach `canceled`, and a `contact_export` or `knowledge_export` is `succeeded` from the start. |
| `progress` | JobProgress | How far the job has run. |
| `pollAfterSeconds` | integer (int32) | While the job is `queued` or `running`, how many seconds to wait before reading it again: 10 for a `crawl`, `extraction` or `batch_scrape` (each read asks the scraping provider), 30 for a `migration`, and 5 for the other types. Omitted once the job has finished. |
| `resource` | JobResource | The object the job belongs to, such as its campaign. Omitted when it has none. |
| `createdAt` | string (date-time) | When the job was created, in UTC. |
| `downloadUrl` | string | The path that downloads the job's file, such as `/v1/contact-exports/{exportId}/content`. Only on a `contact_export` or `knowledge_export`, and omitted for other types. |
| `error` | JobError | Why the job failed. Present only when `status` is `failed`. |
| `result` | object | The raw status and output of a `crawl`, `extraction` or `batch_scrape`, such as the scraped pages. Returned only by `GET /v1/jobs/{jobId}` for those types, and omitted for other types and in lists. |
| `domainsListed` | integer (int32) | For a finished `domain_health` job: how many of the checked domains are on a blocklist. Omitted for other types and until the job finishes. |
| `excludedLibraryContacts` | integer (int32) | For a `contact_export` of kind `contacts`, `campaign` or `advanced`: how many contacts from a Kenso library list the export left out, since Kenso never exports them. Omitted for other kinds and types, or when Kenso could not count them. |
| `inboxImport` | InboxImportJob | Counts and row results of an `inbox_import`. Omitted for other types. |
| `personImport` | PersonImportJob | Counts of a `contact_import` with target `people`. Omitted for an import into a campaign and for other types. |
| `skipped` | ContactImportSkips | Rows a `contact_import` into a campaign skipped, by reason, with 0 for a reason that skipped none. Omitted for an import with target `people` and for other types. |

### Request

```bash
curl -X POST "https://api.ken.so/v1/scraping/crawls" \
  -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": {
    "id": 812,
    "type": "contact_import",
    "status": "queued",
    "progress": {
      "completed": 1,
      "total": 1
    },
    "pollAfterSeconds": 1,
    "resource": {
      "type": "string",
      "id": 812
    },
    "createdAt": "2026-09-23T15:02:11Z",
    "downloadUrl": "/v1/contact-exports/{exportId}/content",
    "error": {
      "code": "string",
      "message": "string"
    },
    "result": null,
    "domainsListed": 1,
    "excludedLibraryContacts": 1,
    "inboxImport": {
      "connectedCount": 1,
      "failedCount": 1,
      "skippedCount": 1,
      "startedAt": "2026-09-23T15:02:11Z",
      "updatedAt": "2026-09-23T15:02:11Z",
      "completedAt": "2026-09-23T15:02:11Z",
      "rows": [
        {
          "index": 1,
          "email": "jane@example.com",
          "status": "connected",
          "inboxId": 812,
          "errorCode": "string",
          "message": "string",
          "firstName": "Jane",
          "lastName": "Doe",
          "dailySendLimit": 1,
          "warnings": [
            "string"
          ],
          "details": [
            {}
          ]
        }
      ]
    },
    "personImport": {
      "source": "csv",
      "createdCount": 1,
      "updatedCount": 1,
      "skippedCount": 1,
      "startedAt": "2026-09-23T15:02:11Z",
      "completedAt": "2026-09-23T15:02:11Z"
    },
    "skipped": {
      "duplicateInCampaign": 1,
      "duplicateInOtherCampaign": 1,
      "duplicateInSource": 1,
      "alreadyContacted": 1,
      "blocklist": 1,
      "failedValidation": 1,
      "salesNavigatorProfileUnresolved": 1,
      "other": 1,
      "missingKey": 1,
      "invalidEmail": 1,
      "noMx": 1,
      "catchAll": 1,
      "personalEmail": 1,
      "roleAddress": 1,
      "companyContacted": 1,
      "companyCap": 1
    }
  }
}
```

## Start an extraction

`POST /v1/scraping/extractions` - operationId `scraping.create-extraction`

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

Start an extraction that reads a list of pages and pulls structured data out of them, such as prices.

Send `urls` (1 to 1,000) and say what to pull out with `prompt`, `schema` or both.

The call answers `202` with the job. On Kenso's key, Kenso reserves the most credits the job can cost and
settles when a status read sees it finish, so a `webhook` needs the workspace's own key.
Poll `GET /v1/jobs/{jobId}?type=extraction`. An extraction cannot be cancelled (`409 invalid_state`).

Errors:

- `400 validation_failed`: `urls` is missing or lists over 1,000 pages, a URL is not public,
`webhook` is sent on Kenso's key, or another field 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`), failed, or
Kenso could not record the job.

Requires Search edit.

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

### 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 202

`data` is a `Job`.

| Field | Type | Description |
| --- | --- | --- |
| `id` | integer (int64) | The job's id. Ids are unique only within one `type`, so send `type` with the id when you read or cancel the job. |
| `type` | string | The job type: `contact_import`, `contact_export`, `domain_health`, `lead_scoring`, `enrichment`, `crawl`, `extraction`, `batch_scrape`, `knowledge_export`, `inbox_import` or `migration`. |
| `status` | string | One of `queued`, `running`, `succeeded`, `failed` or `canceled`. Only `crawl`, `extraction`, `batch_scrape` and `migration` jobs reach `canceled`, and a `contact_export` or `knowledge_export` is `succeeded` from the start. |
| `progress` | JobProgress | How far the job has run. |
| `pollAfterSeconds` | integer (int32) | While the job is `queued` or `running`, how many seconds to wait before reading it again: 10 for a `crawl`, `extraction` or `batch_scrape` (each read asks the scraping provider), 30 for a `migration`, and 5 for the other types. Omitted once the job has finished. |
| `resource` | JobResource | The object the job belongs to, such as its campaign. Omitted when it has none. |
| `createdAt` | string (date-time) | When the job was created, in UTC. |
| `downloadUrl` | string | The path that downloads the job's file, such as `/v1/contact-exports/{exportId}/content`. Only on a `contact_export` or `knowledge_export`, and omitted for other types. |
| `error` | JobError | Why the job failed. Present only when `status` is `failed`. |
| `result` | object | The raw status and output of a `crawl`, `extraction` or `batch_scrape`, such as the scraped pages. Returned only by `GET /v1/jobs/{jobId}` for those types, and omitted for other types and in lists. |
| `domainsListed` | integer (int32) | For a finished `domain_health` job: how many of the checked domains are on a blocklist. Omitted for other types and until the job finishes. |
| `excludedLibraryContacts` | integer (int32) | For a `contact_export` of kind `contacts`, `campaign` or `advanced`: how many contacts from a Kenso library list the export left out, since Kenso never exports them. Omitted for other kinds and types, or when Kenso could not count them. |
| `inboxImport` | InboxImportJob | Counts and row results of an `inbox_import`. Omitted for other types. |
| `personImport` | PersonImportJob | Counts of a `contact_import` with target `people`. Omitted for an import into a campaign and for other types. |
| `skipped` | ContactImportSkips | Rows a `contact_import` into a campaign skipped, by reason, with 0 for a reason that skipped none. Omitted for an import with target `people` and for other types. |

### Request

```bash
curl -X POST "https://api.ken.so/v1/scraping/extractions" \
  -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": {
    "id": 812,
    "type": "contact_import",
    "status": "queued",
    "progress": {
      "completed": 1,
      "total": 1
    },
    "pollAfterSeconds": 1,
    "resource": {
      "type": "string",
      "id": 812
    },
    "createdAt": "2026-09-23T15:02:11Z",
    "downloadUrl": "/v1/contact-exports/{exportId}/content",
    "error": {
      "code": "string",
      "message": "string"
    },
    "result": null,
    "domainsListed": 1,
    "excludedLibraryContacts": 1,
    "inboxImport": {
      "connectedCount": 1,
      "failedCount": 1,
      "skippedCount": 1,
      "startedAt": "2026-09-23T15:02:11Z",
      "updatedAt": "2026-09-23T15:02:11Z",
      "completedAt": "2026-09-23T15:02:11Z",
      "rows": [
        {
          "index": 1,
          "email": "jane@example.com",
          "status": "connected",
          "inboxId": 812,
          "errorCode": "string",
          "message": "string",
          "firstName": "Jane",
          "lastName": "Doe",
          "dailySendLimit": 1,
          "warnings": [
            "string"
          ],
          "details": [
            {}
          ]
        }
      ]
    },
    "personImport": {
      "source": "csv",
      "createdCount": 1,
      "updatedCount": 1,
      "skippedCount": 1,
      "startedAt": "2026-09-23T15:02:11Z",
      "completedAt": "2026-09-23T15:02:11Z"
    },
    "skipped": {
      "duplicateInCampaign": 1,
      "duplicateInOtherCampaign": 1,
      "duplicateInSource": 1,
      "alreadyContacted": 1,
      "blocklist": 1,
      "failedValidation": 1,
      "salesNavigatorProfileUnresolved": 1,
      "other": 1,
      "missingKey": 1,
      "invalidEmail": 1,
      "noMx": 1,
      "catchAll": 1,
      "personalEmail": 1,
      "roleAddress": 1,
      "companyContacted": 1,
      "companyCap": 1
    }
  }
}
```

## Start a batch scrape

`POST /v1/scraping/batch-scrapes` - operationId `scraping.create-batch-scrape`

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

Start a batch scrape that reads a list of pages in one job, instead of many single scrapes.

Send `urls` (1 to 1,000) and the same output options as a scrape, such as `formats`.

The call answers `202` with the job. On Kenso's key, Kenso reserves the most credits the job can cost and
settles when a status read sees it finish, so a `webhook` needs the workspace's own key.
Poll `GET /v1/jobs/{jobId}?type=batch_scrape`. When Kenso cannot record the job, it stops it and answers
`503`.

Errors:

- `400 validation_failed`: `urls` is missing or lists over 1,000 pages, a URL is not public,
`webhook` is sent on Kenso's key, or another field 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`), failed, or
Kenso could not record the job.

Requires Search edit.

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

### 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 202

`data` is a `Job`.

| Field | Type | Description |
| --- | --- | --- |
| `id` | integer (int64) | The job's id. Ids are unique only within one `type`, so send `type` with the id when you read or cancel the job. |
| `type` | string | The job type: `contact_import`, `contact_export`, `domain_health`, `lead_scoring`, `enrichment`, `crawl`, `extraction`, `batch_scrape`, `knowledge_export`, `inbox_import` or `migration`. |
| `status` | string | One of `queued`, `running`, `succeeded`, `failed` or `canceled`. Only `crawl`, `extraction`, `batch_scrape` and `migration` jobs reach `canceled`, and a `contact_export` or `knowledge_export` is `succeeded` from the start. |
| `progress` | JobProgress | How far the job has run. |
| `pollAfterSeconds` | integer (int32) | While the job is `queued` or `running`, how many seconds to wait before reading it again: 10 for a `crawl`, `extraction` or `batch_scrape` (each read asks the scraping provider), 30 for a `migration`, and 5 for the other types. Omitted once the job has finished. |
| `resource` | JobResource | The object the job belongs to, such as its campaign. Omitted when it has none. |
| `createdAt` | string (date-time) | When the job was created, in UTC. |
| `downloadUrl` | string | The path that downloads the job's file, such as `/v1/contact-exports/{exportId}/content`. Only on a `contact_export` or `knowledge_export`, and omitted for other types. |
| `error` | JobError | Why the job failed. Present only when `status` is `failed`. |
| `result` | object | The raw status and output of a `crawl`, `extraction` or `batch_scrape`, such as the scraped pages. Returned only by `GET /v1/jobs/{jobId}` for those types, and omitted for other types and in lists. |
| `domainsListed` | integer (int32) | For a finished `domain_health` job: how many of the checked domains are on a blocklist. Omitted for other types and until the job finishes. |
| `excludedLibraryContacts` | integer (int32) | For a `contact_export` of kind `contacts`, `campaign` or `advanced`: how many contacts from a Kenso library list the export left out, since Kenso never exports them. Omitted for other kinds and types, or when Kenso could not count them. |
| `inboxImport` | InboxImportJob | Counts and row results of an `inbox_import`. Omitted for other types. |
| `personImport` | PersonImportJob | Counts of a `contact_import` with target `people`. Omitted for an import into a campaign and for other types. |
| `skipped` | ContactImportSkips | Rows a `contact_import` into a campaign skipped, by reason, with 0 for a reason that skipped none. Omitted for an import with target `people` and for other types. |

### Request

```bash
curl -X POST "https://api.ken.so/v1/scraping/batch-scrapes" \
  -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": {
    "id": 812,
    "type": "contact_import",
    "status": "queued",
    "progress": {
      "completed": 1,
      "total": 1
    },
    "pollAfterSeconds": 1,
    "resource": {
      "type": "string",
      "id": 812
    },
    "createdAt": "2026-09-23T15:02:11Z",
    "downloadUrl": "/v1/contact-exports/{exportId}/content",
    "error": {
      "code": "string",
      "message": "string"
    },
    "result": null,
    "domainsListed": 1,
    "excludedLibraryContacts": 1,
    "inboxImport": {
      "connectedCount": 1,
      "failedCount": 1,
      "skippedCount": 1,
      "startedAt": "2026-09-23T15:02:11Z",
      "updatedAt": "2026-09-23T15:02:11Z",
      "completedAt": "2026-09-23T15:02:11Z",
      "rows": [
        {
          "index": 1,
          "email": "jane@example.com",
          "status": "connected",
          "inboxId": 812,
          "errorCode": "string",
          "message": "string",
          "firstName": "Jane",
          "lastName": "Doe",
          "dailySendLimit": 1,
          "warnings": [
            "string"
          ],
          "details": [
            {}
          ]
        }
      ]
    },
    "personImport": {
      "source": "csv",
      "createdCount": 1,
      "updatedCount": 1,
      "skippedCount": 1,
      "startedAt": "2026-09-23T15:02:11Z",
      "completedAt": "2026-09-23T15:02:11Z"
    },
    "skipped": {
      "duplicateInCampaign": 1,
      "duplicateInOtherCampaign": 1,
      "duplicateInSource": 1,
      "alreadyContacted": 1,
      "blocklist": 1,
      "failedValidation": 1,
      "salesNavigatorProfileUnresolved": 1,
      "other": 1,
      "missingKey": 1,
      "invalidEmail": 1,
      "noMx": 1,
      "catchAll": 1,
      "personalEmail": 1,
      "roleAddress": 1,
      "companyContacted": 1,
      "companyCap": 1
    }
  }
}
```

## Types

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

### ScrapingPage

A scraped page, in the formats the request asked for.

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `markdown` | string | no | The page as markdown. Present when `formats` includes `markdown`, the default. |
| `html` | string | no | The page's cleaned HTML. Present when `formats` includes `html`. |
| `rawHtml` | string | no | The page's HTML as the site served it. Present when `formats` includes `rawHtml`. |
| `links` | array of string | no | The URLs the page links to. Present when `formats` includes `links`. |
| `summary` | string | no | A short summary of the page. Present when `formats` includes `summary`. |
| `screenshot` | string | no | The URL of a screenshot of the page. Present when `formats` includes `screenshot`. |
| `json` | map of object | no | The data pulled out of the page, shaped by the `schema` or `prompt` of the request's `json` format, so its fields are the caller's. Present when `formats` includes `json`. |
| `metadata` | ScrapingPageMetadata | no | Facts about the page and how it was read. |

### ScrapingPageMetadata

Facts about a scraped page and how it was read. The page's own meta tags come through under their own names, for example `title`, `description`, `language`, `ogTitle` and `og:type`; each may be a string or a list of strings, as the page wrote it.

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `sourceURL` | string | no | The URL the request asked for. |
| `url` | string | no | The URL the page was read from, after any redirect. |
| `statusCode` | integer (int32) | no | The HTTP status the site answered with. |
| `numPages` | integer (int32) | no | How many pages a PDF had. Present only for a PDF. |
| `cacheState` | string | no | `hit` when the page came from a stored copy. A page read live may say `miss` or leave it out. |
| `cachedAt` | string | no | When the stored copy was made, UTC, for example `2026-05-04T10:12:00.000Z`. Present with `cacheState` `hit`. |
| `creditsUsed` | integer (int32) | no | The live source's credits the read used. 0 for a page from Kenso's web archive. |
| `kenSource` | string | no | `archive` when the page came from Kenso's free web archive. Left out for a page read live. |
| `kenTruncated` | boolean | no | True when Kenso's web archive cut the page's markdown at its size limit, so the live page may be longer. Left out otherwise. |

### ScrapingMapLink

A URL found on a mapped site.

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `url` | string | no | The URL. |
| `title` | string | no | The page title. Left out when unknown. |
| `description` | string | no | The page's description. Left out when unknown. |

### 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. |

### JobProgress

How far a job has run.

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `completed` | integer (int32) | no | How many items the job has finished. The item depends on `type`: for example imported contacts for a campaign `contact_import`, checked domains for `domain_health` and processed rows for `inbox_import`. |
| `total` | integer (int32) | no | How many items the job handles in all. Omitted when Kenso does not know the total, as for `domain_health`. |

### JobResource

The object a job belongs to.

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `type` | string | no | The kind of object: `campaign` for a campaign `contact_import`, a `contact_export` of a campaign, `lead_scoring` and `enrichment`, or `migration_run` for a `migration`. |
| `id` | integer (int64) | no | The object's id. |

### JobError

Why a job failed.

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | no | The reason code. It is `failed` for every job type except `inbox_import`, which uses `interrupted`, `feature_disabled` or `forbidden`. |
| `message` | string | no | A readable description of what went wrong. |

### InboxImportJob

Counts and row results of an inbox import, without any passwords.

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `connectedCount` | integer (int32) | no | Rows that connected an inbox. |
| `failedCount` | integer (int32) | no | Rows that failed to connect. |
| `skippedCount` | integer (int32) | no | Rows Kenso skipped, such as an inbox the workspace already has. |
| `startedAt` | string (date-time) | no | When the import started on its first row, in UTC. Omitted while it waits in the queue. |
| `updatedAt` | string (date-time) | no | When the import last made progress, in UTC. An import with no progress for 10 minutes reads `failed` with `error.code` `interrupted`. |
| `completedAt` | string (date-time) | no | When the import finished, in UTC. Omitted until it finishes. |
| `rows` | array of InboxImportRow | no | Processed rows in `index` order, empty until the first row has a result. Returned when you create or get the import, and omitted in lists and for a member without Delivery view. |

### PersonImportJob

Counts of a contact import with target `people`.

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `source` | string | no | Where the rows came from, the import's `source`, such as `csv`, `search` or `google_sheets`. |
| `createdCount` | integer (int32) | no | Rows that created a new person. |
| `updatedCount` | integer (int32) | no | Rows that matched a person already in the workspace and updated it. Kenso matches by email, LinkedIn URL, or name and company domain. |
| `skippedCount` | integer (int32) | no | Rows Kenso skipped: a row with no email, no LinkedIn URL and no name with a business company domain, or a row Kenso could not take in. |
| `startedAt` | string (date-time) | no | When the import started, in UTC. Omitted while it waits in the queue. |
| `completedAt` | string (date-time) | no | When the import finished or failed, in UTC. Omitted until then. |

### ContactImportSkips

Rows a campaign contact import skipped, with each row counted under one reason.

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `duplicateInCampaign` | integer (int32) | no | Rows that match a contact already in this campaign. |
| `duplicateInOtherCampaign` | integer (int32) | no | Rows that match a contact in another campaign of the workspace, skipped because this campaign removes duplicates across campaigns. |
| `duplicateInSource` | integer (int32) | no | Rows that repeat an earlier row of the same import. |
| `alreadyContacted` | integer (int32) | no | Rows that match a contact emailed within the campaign's recently emailed window. |
| `blocklist` | integer (int32) | no | Rows that match the workspace's blocklist. |
| `failedValidation` | integer (int32) | no | Rows that failed row checks, such as a row with no first and last name or no company name or domain. |
| `salesNavigatorProfileUnresolved` | integer (int32) | no | Sales Navigator people Kenso could not turn into a LinkedIn profile URL, so no LinkedIn step could reach them. |
| `other` | integer (int32) | no | Rows skipped for any other reason, such as a row Kenso could not process. |
| `missingKey` | integer (int32) | no | Rows with no email and no LinkedIn URL, dropped by the `missingKey` List check fix. |
| `invalidEmail` | integer (int32) | no | Rows whose email Kenso knows is invalid, dropped by the `invalidEmail` List check fix. |
| `noMx` | integer (int32) | no | Rows whose email domain takes no mail (no MX record), dropped by the `noMx` List check fix. |
| `catchAll` | integer (int32) | no | Rows whose email domain accepts every address, dropped by the `catchAll` List check fix. |
| `personalEmail` | integer (int32) | no | Rows with a personal email address, such as Gmail or Outlook.com, dropped by the `personalEmail` List check fix. |
| `roleAddress` | integer (int32) | no | Rows with a role address such as info@ or sales@, dropped by the `roleAddress` List check fix. |
| `companyContacted` | integer (int32) | no | Rows at a company where someone else recently got a Kenso email, dropped by the `companyContacted` List check fix. |
| `companyCap` | integer (int32) | no | Rows past the first 5 people at one company, dropped by the `companyCap` List check fix. |

### InboxImportRow

One processed row of an inbox import.

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `index` | integer (int32) | no | Zero-based position of the row in the request's `rows` array. |
| `email` | string | no | The row's email address. |
| `status` | string | no | The row's result: `connected`, `failed` or `skipped`. |
| `inboxId` | integer (int64) | no | The connected inbox, the existing inbox a skipped row matched, or the disconnected inbox a failed connect left in the workspace. Omitted when there is none. |
| `errorCode` | string | no | Why the row did not connect, omitted for a connected row. A skipped row has `already_exists`, `duplicate_in_file`, or `feature_disabled` or `forbidden` when the import stopped before the row because inbox import was turned off for the workspace or the member who started it lost Delivery edit. A failed row has `email_in_use` (another Kenso inbox has the email), `host_failure_limit` (not tried, because its host refused several logins or could not be reached earlier in the import) or an API error code such as `validation_failed` or `service_unavailable`. |
| `message` | string | no | A readable message about the row's result, when Kenso has one. |
| `firstName` | string | no | On a connected row that set one in the file, the sender first name now on the mailbox. Omitted otherwise. |
| `lastName` | string | no | On a connected row that set one in the file, the sender last name now on the mailbox. Omitted otherwise. |
| `dailySendLimit` | integer (int32) | no | On a connected row that set one in the file, the daily limit now stored on the mailbox, after the provider ceiling. Omitted otherwise. |
| `warnings` | array of string | no | Warning codes of a row that connected, omitted when there are none: `daily_limit_clamped` (the row's `dailySendLimit` was above the mailbox's provider ceiling and was stored at the ceiling) or `settings_not_applied` (the mailbox connected, but its names or limit could not be saved). |
| `details` | array of InboxImportRowDetail | no | On a row that failed a column check, one entry per refused column, with `field` naming the column. Omitted otherwise. |

### InboxImportRowDetail

One refused column of an inbox import row.

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `field` | string | no | The row column, such as `firstName` or `dailySendLimit`. |
| `code` | string | no | Stable code for the problem, such as `invalid`. |
| `message` | string | no | A sentence for people that says what is wrong with the column. |

All resources: [/docs.md](/docs.md).
