Properties
| Name | Type | Description |
|---|---|---|
| url | string | Start page (always read: path filters and robots.txt apply to the pages found from it) |
| limit | integer | Maximum pages read (and credits reserved) |
| max_depth | integer | Link hops from url (sitemap pages count as 1 hop; 0 reads only url) |
| include_paths | array | Regular expressions matched against the URL path; follow only paths matching one |
| exclude_paths | array | Regular expressions matched against the URL path; never follow paths matching one |
| include_subdomains | boolean | |
| sitemap | string | `include` also seeds the crawl with the site's sitemap URLs (after the start page's links), `only` reads the start page and sitemap URLs without following links, `skip` follows links only |
| query | string | Read the pages most relevant to these words first (best-first crawl) |
| ignore_query_parameters | boolean | Treat URLs that differ only in their query string as one page |
| format | string | |
| include_links | boolean | Return each page's outbound links |
| max_tokens | integer | Trim each page to this many tokens |
| max_age | integer | Accept cached pages up to this many seconds old (0.5 credit each) |
| webhook_url | string | Receives the signed `crawl.completed` event. Defaults to the account webhook |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://artifacts.apis.io/serpkite-com/json-schema/serpkite-com-crawl-request-schema.json",
"title": "CrawlRequest",
"x-generated": "2026-10-31",
"x-method": "derived",
"x-generator": "derive-json-schema.py",
"x-source": "openapi/serpkite-com-openapi.yaml#/components/schemas/CrawlRequest",
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"format": "uri",
"description": "Start page (always read: path filters and robots.txt apply to the pages found from it)"
},
"limit": {
"type": "integer",
"minimum": 1,
"maximum": 1000,
"default": 25,
"description": "Maximum pages read (and credits reserved)"
},
"max_depth": {
"type": "integer",
"minimum": 0,
"maximum": 10,
"default": 2,
"description": "Link hops from url (sitemap pages count as 1 hop; 0 reads only url)"
},
"include_paths": {
"type": "array",
"items": {
"type": "string"
},
"maxItems": 20,
"description": "Regular expressions matched against the URL path; follow only paths matching one"
},
"exclude_paths": {
"type": "array",
"items": {
"type": "string"
},
"maxItems": 20,
"description": "Regular expressions matched against the URL path; never follow paths matching one"
},
"include_subdomains": {
"type": "boolean",
"default": false
},
"sitemap": {
"type": "string",
"enum": [
"include",
"only",
"skip"
],
"default": "include",
"description": "`include` also seeds the crawl with the site's sitemap URLs (after the start page's links), `only` reads the start page and sitemap URLs without following links, `skip` follows links only"
},
"query": {
"type": "string",
"maxLength": 512,
"description": "Read the pages most relevant to these words first (best-first crawl)"
},
"ignore_query_parameters": {
"type": "boolean",
"default": false,
"description": "Treat URLs that differ only in their query string as one page"
},
"format": {
"type": "string",
"enum": [
"markdown",
"text"
],
"default": "markdown"
},
"include_links": {
"type": "boolean",
"default": false,
"description": "Return each page's outbound links"
},
"max_tokens": {
"type": "integer",
"minimum": 100,
"maximum": 100000,
"description": "Trim each page to this many tokens"
},
"max_age": {
"type": "integer",
"minimum": 0,
"maximum": 2592000,
"description": "Accept cached pages up to this many seconds old (0.5 credit each)"
},
"webhook_url": {
"type": "string",
"format": "uri",
"description": "Receives the signed `crawl.completed` event. Defaults to the account webhook"
}
}
}
Work with this as data
Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for schemas
4 MCP tools reach this
find_json_schemasBrowse and filter every JSON Schema in the catalog.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/serpkite-com-crawl-request"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.