Skip to main content
POST
Create a knowledge hub from websites

Authorizations

Authorization
string
header
required

Your API token (af_…) as the Basic-auth username, with an empty password.

Body

application/json
websites
object[]
required

Websites the hub is built from: at least 1, at most 20. Accepted values for each entry's url: any http(s) web address, with or without the scheme (brightpay.com, https://brightpay.com/pricing). Every entry is crawled and all of the collected text is pooled into ONE set of knowledge pages — entries are not kept apart, and a page reached from two entries is used once. The crawl runs in the background after the 202, so a site that cannot be fetched is never reported as an error: its entry stays on the hub with lastCrawledAt null and contributes nothing. Read the hub back to check.

Required array length: 1 - 20 elements
name
string

Hub name (1-100 characters); omit to have one generated from the crawled content once the build finishes.

Required string length: 1 - 100
notes
object[]

Free-text notes to include as sources (up to 50). Inline file uploads are not accepted here.

Maximum array length: 50
isDefault
boolean
default:false

Make this hub the default one used when a campaign does not name a hub; the previous default is unset. Default false.

Response

Success

knowledgeHub
object
required