ScrepyDocs

Start a crawl

Starts a crawl with the project's current settings. It may consume the account's crawl allowance.

POST/projects/{project_uid}/crawls

Starts a crawl with the project's current settings. It may consume the account's crawl allowance.

Authorization

bearerApiKey
AuthorizationBearer <token>

Create a REST API key in Settings > Connected Apps. MCP credentials do not authenticate this API.

In: header

Path Parameters

project_uid*string

Accessible project UID. Discover it with GET /projects; do not guess it.

Match^[a-z0-9]{10}$

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/projects/string/crawls"
{  "data": {    "uid": "string",    "status": "string",    "target_url": "http://example.com",    "max_pages": 0,    "depth": 1,    "health_score": 0,    "seo_score": 0,    "pages_total": 0,    "critical_issues": 0,    "warnings": 0,    "notices": 0,    "queued_at": "2019-08-24T14:15:22Z",    "started_at": "2019-08-24T14:15:22Z",    "finished_at": "2019-08-24T14:15:22Z",    "created_at": "2019-08-24T14:15:22Z"  }}