Skip to main content
POST
/
v2
/
kb
/
packages
Create KB Package
curl --request POST \
  --url http://localhost:3000/api/v2/kb/packages \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>",
  "description": "<string>",
  "maxPages": 123,
  "refreshRate": "daily",
  "matches": [
    "<string>"
  ],
  "unMatches": [
    "<string>"
  ],
  "isPrivate": true,
  "links": [
    "<string>"
  ],
  "keywords": [
    "<string>"
  ],
  "imageUrl": "<string>",
  "crawl": true,
  "deepScan": true
}'
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
​
name
string
required
​
isPrivate
boolean
required
​
links
string[]
required
​
keywords
string[]
required
​
crawl
boolean
required
​
deepScan
boolean
required
​
description
string
​
maxPages
number
​
refreshRate
enum<string>
Available options:
daily,
weekly,
monthly
​
matches
string[]
​
unMatches
string[]
​
imageUrl
string

Response

KB package created successfully

⌘I