Advanced
Deepcrawl (Beta)
API endpoints for initiating and monitoring asynchronous deep crawl tasks. Starting a task costs 20 credits; status checks are free.
Authorization
bearerAuth AuthorizationBearer <token>
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/problem+json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/deepcrawl" \ -H "Content-Type: application/json" \ -d '{ "url": "http://example.com" }'{ "taskId": "string", "status": "queued"}{ "ok": false, "error": "string", "message": "string", "errors": [ { "field": "string", "message": "string", "code": "string" } ], "type": "http://example.com", "title": "string", "status": 0, "detail": "string"}{ "ok": false, "error": "string", "message": "string", "errors": [ { "field": "string", "message": "string", "code": "string" } ], "type": "http://example.com", "title": "string", "status": 0, "detail": "string"}{ "ok": false, "error": "string", "message": "string", "errors": [ { "field": "string", "message": "string", "code": "string" } ], "type": "http://example.com", "title": "string", "status": 0, "detail": "string"}{ "ok": false, "error": "string", "message": "string", "errors": [ { "field": "string", "message": "string", "code": "string" } ], "type": "http://example.com", "title": "string", "status": 0, "detail": "string"}{ "ok": false, "error": "string", "message": "string", "errors": [ { "field": "string", "message": "string", "code": "string" } ], "type": "http://example.com", "title": "string", "status": 0, "detail": "string"}{ "ok": false, "error": "string", "message": "string", "errors": [ { "field": "string", "message": "string", "code": "string" } ], "type": "http://example.com", "title": "string", "status": 0, "detail": "string"}{ "ok": false, "error": "string", "message": "string", "errors": [ { "field": "string", "message": "string", "code": "string" } ], "type": "http://example.com", "title": "string", "status": 0, "detail": "string"}Authorization
bearerAuth AuthorizationBearer <token>
In: header
Path Parameters
taskId*string
Length
1 <= lengthResponse Body
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/deepcrawl/status/string"{ "taskId": "string", "status": "queued", "success": true, "message": "string", "error": "string", "r2Key": "string", "zipUrl": "http://example.com"}{ "ok": false, "error": "string", "message": "string", "errors": [ { "field": "string", "message": "string", "code": "string" } ], "type": "http://example.com", "title": "string", "status": 0, "detail": "string"}{ "ok": false, "error": "string", "message": "string", "errors": [ { "field": "string", "message": "string", "code": "string" } ], "type": "http://example.com", "title": "string", "status": 0, "detail": "string"}{ "ok": false, "error": "string", "message": "string", "errors": [ { "field": "string", "message": "string", "code": "string" } ], "type": "http://example.com", "title": "string", "status": 0, "detail": "string"}{ "ok": false, "error": "string", "message": "string", "errors": [ { "field": "string", "message": "string", "code": "string" } ], "type": "http://example.com", "title": "string", "status": 0, "detail": "string"}