POST
/
crawl
Submit a URL for crawling
curl --request POST \
  --url https://api.open.cx/crawl \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "url": "https://example.com",
  "limit": 100,
  "excludePaths": [
    "/blog/*",
    "/private/*"
  ],
  "allowExternalLinks": true,
  "includePaths": [
    "/blog/*",
    "/private/*"
  ]
}'
{
  "id": "<string>",
  "org_id": "<string>",
  "url": "<string>",
  "status": "cancelled",
  "created_at": "<string>",
  "updated_at": "<string>",
  "completed_at": "<string>",
  "completed_pages": 123,
  "error_message": "<string>",
  "total_pages": 123
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Response

201
application/json

Crawl job has been created successfully.

The response is of type object.