Skip to navigation
API referenceKnowledgeCollections

Import a website into a collection

Sessions: admins.

Needs the knowledge:write scope. A key without it gets 403 insufficient_scope. Routes not in this reference cannot be called with a key at all (403 not_available_to_api_keys).

Authentication

AuthorizationBearer

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

Path parameters

cidstringRequired
The collection id.

Request

This endpoint expects an object.
urlstringRequired

The start page (https).

maxPagesintegerOptional
How many pages at most.
includePathslist of stringsOptional
excludePathslist of stringsOptional

Response

OK
idstring
A UUID.
urlstring
statusstring
maxPagesintegerOptional
includePathslist of stringsOptional
excludePathslist of stringsOptional
createdAtdatetimeOptional
updatedAtdatetimeOptional

Errors

401
Unauthorized Error
403
Forbidden Error
429
Too Many Requests Error