Skip to main content
POST
/
v2
/
kb
/
crawl-jobs
Create Crawl Job
curl --request POST \
  --url http://localhost:3000/api/v2/kb/crawl-jobs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "matches": [
    "<string>"
  ],
  "notMatches": [
    "<string>"
  ],
  "urls": [
    "<string>"
  ],
  "deep": true,
  "isParent": true,
  "studioId": "<string>",
  "workspaceId": "<string>",
  "maxPages": 123
}'
This response does not have an example.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
matches
string[]
required
​
notMatches
string[]
required
​
urls
string[]
required
​
deep
boolean
required
​
isParent
boolean
required
​
studioId
string
required
​
workspaceId
string
required
​
maxPages
number

Response

Crawl job created successfully

⌘I