Skip to main content
POST
/
crawl
Initiate a web crawl
curl --request POST \
  --url https://api.askmy.biz/crawl \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '{
  "base_url": "https://example.com",
  "namespace": "example_com",
  "max_pages": 1
}'
{
  "job_id": "645f3c1649ec746bc1871307",
  "namespace": "example_com"
}

Authorizations

​
X-API-Key
string
header
required

API key for authentication

Body

application/json
​
base_url
string
required

The base domain to crawl

Example:

"https://example.com"

​
namespace
string

Stable identifier for this domain's vector data

Example:

"example_com"

​
max_pages
integer
default:1

Maximum number of pages to process

Response

200 - application/json

Crawl job successfully initiated

​
job_id
string
Example:

"645f3c1649ec746bc1871307"

​
namespace
string
Example:

"example_com"

⌘I