Skip to main content
POST
/
browser
/
v1
/
crawl
Start a crawl job
curl --request POST \
  --url https://api.voyant.travel/browser/v1/crawl \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "https://example.com"
}
'
{
  "id": "<string>",
  "providerJobId": "<string>"
}

Authorizations

​
Authorization
string
header
required

Voyant Cloud API token, passed as Authorization: Bearer <token>. Each token carries a fixed set of scopes; an operation rejects tokens missing its required scope.

Body

application/json
​
url
string<uri>
required
Example:

"https://example.com"

Response

Crawl started

​
id
string
required
​
status
enum<string>
required
Available options:
queued,
running,
completed,
errored,
cancelled_due_to_timeout,
cancelled_due_to_limits,
cancelled_by_user
​
providerJobId
string
required