Skip to main content
GET
/
integrations
/
web_crawler
/
status
Check crawl status for a URL
curl --request GET \
  --url https://api.hyperspell.com/integrations/web_crawler/status \
  --header 'Authorization: Bearer <token>'
{
  "url": "<string>",
  "is_indexed": true,
  "total": 123,
  "completed": 123,
  "processing": 123,
  "failed": 123
}

Authorizations

​
Authorization
string
header
required

API Key or JWT User Token. If using an API Key, set the X-As-User header to act as a specific user. A JWT User Token is always scoped to a specific user.

Query Parameters

​
url
string
required

The URL to check crawl status for

Response

Successful Response

Response for crawl status check.

​
url
string
required
​
is_indexed
boolean
required
​
total
integer
required
​
completed
integer
required
​
processing
integer
required
​
failed
integer
required