Skip to navigation
Knowledge BasesKnowledge

Knowledge · Add a web page to a knowledge base

View as Markdown

Fetches the URL, extracts its text and indexes it. Returns the source record straight away with status: pending — processing happens in the background, so the passages are not searchable yet.

Only one page, not the site behind it: links are not followed. Add each page that matters as its own source.

Authentication

AuthorizationApi-Key

Header authentication of the form Api-Key <token>

OR
AuthorizationBearer

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

Path parameters

knowledge_base_idstringRequired
Knowledge base UUID.

Request

This endpoint expects an object.
urlstringRequired

Page to fetch and index. Public HTTP(S) only — private and loopback addresses are rejected.

titlestringOptional
Label for the source. Defaults to the URL.

Response

The created source, at status: pending.

Errors

400
Bad Request Error
404
Not Found Error