Deepcrawl (Beta)

API endpoints for initiating and monitoring asynchronous deep crawl tasks. Every request costs 20 credits.

Authorization

AuthorizationRequiredBearer <token>

In: header

Request Body

application/jsonRequired

URL and options for the deep crawl.

urlRequiredstring

The root URL of the website to start crawling.

typestring

Link discovery mode. 'sitemap' processes only links defined in sitemap.xml (default). 'all' attempts to discover and crawl all findable links on pages.

Default: "sitemap"Value in: "sitemap" | "all"

Response Body

Task successfully queued.

TypeScript Definitions

Use the response body type in TypeScript.

taskIdRequiredstring

Unique identifier for the initiated task.

statusRequiredstring

Initial status of the task.

Value in: "queued"

curl -X POST "https://api.search1api.com/deepcrawl" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://search1api.com",
    "type": "sitemap"
  }'

{
  "taskId": "string",
  "status": "queued"
}

Authorization

AuthorizationRequiredBearer <token>

In: header

Path Parameters

taskIdRequiredstring

The ID of the task obtained from POST /deepcrawl.

Response Body

Task status retrieved successfully.

TypeScript Definitions

Use the response body type in TypeScript.

responseRequiredobject | object | object

curl -X GET "https://api.search1api.com/deepcrawl/status/string" \
  -H "Authorization: Bearer <token>"

{
  "taskId": "string",
  "status": "processing",
  "message": "string"
}