Skip to main content
POST
Web services API
Get the current status and results of a crawl operation. For large crawls, results may be paginated.

Path Parameters

string
required
The ID of the crawl job to check

Response Fields

string
Current status of the crawl: scraping, completed, or failed
integer
Total number of pages attempted to crawl
integer
Number of successfully crawled pages
integer
Number of credits consumed by the crawl
string
ISO 8601 timestamp when the crawl data expires
string
URL to retrieve next batch of data (for paginated results)
array

Example Request

Example Response

Status Codes

Status retrieved successfully
Insufficient credits
Rate limit exceeded
Server error or crawl failed

Authorizations

Authorization
string
header
required

Enter your API key prefixed with 'Bearer '

Body

application/json
model
enum<string>
required

Type of web service to use

Available options:
scrape,
crawl,
map,
taam-ai-search,
crawl-status
params
object

Parameters specific to the selected model

Response

200 - application/json

Successful response

id
string

Unique identifier for the request

object
string

Type of completion (e.g., scrape.completion)

created
integer

Unix timestamp of when the request was created

model
string

Model used for the request

data
object

Model-specific response data

usage
object
system_fingerprint
string