Skip to main content
POST
/
1
/
crawlers
/
{id}
/
urls
/
crawl
Crawl URLs
curl --request POST \
  --url https://crawler.algolia.com/api/1/crawlers/{id}/urls/crawl \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '{
  "urls": [
    "https://www.algolia.com/products/crawler/"
  ],
  "save": true
}'
{
  "taskId": "98458796-b7bb-4703-8b1b-785c1080b110"
}

Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

​
id
string
required

Crawler ID.

Example:

"e0f6db8a-24f5-4092-83a4-1b2c6cb6d809"

Body

application/json
​
urls
string[]
required

URLs to crawl.

Example:
["https://www.algolia.com/products/crawler/"]
​
save
boolean

Whether the specified URLs should be added to the extraURLs property of the crawler configuration. If unspecified, the URLs are added to the extraUrls field only if they haven't been indexed during the last reindex.

Response

OK

​
taskId
string
required

Universally unique identifier (UUID) of the task.

Example:

"98458796-b7bb-4703-8b1b-785c1080b110"

⌘I