Skip to main content
PUT
Update a crawl request

Authorizations

Authorization
string
header
required

Headers

TR-Dataset
string<uuid>
required

The dataset id to use for the request

Body

application/json

JSON request payload to update a crawl

crawl_id
string<uuid>
required

Crawl ID to update

crawl_options
object
required

Options for setting up the crawl which will populate the dataset.

Example:

Response

Crawl updated successfully

attempt_number
integer<int32>
required
crawl_options
object
required

Options for setting up the crawl which will populate the dataset.

Example:
crawl_type
enum<string>
required
Available options:
firecrawl,
openapi,
shopify,
youtube
created_at
string<date-time>
required
dataset_id
string<uuid>
required
id
string<uuid>
required
scrape_id
string<uuid>
required
status
required
Available options:
Pending
url
string
required
interval
string | null
next_crawl_at
string<date-time> | null