Sign in

v4

OpenAPI 3.1.02026-07-313621,3961.8 MB
Agents Platform

Create Url Document

Create a knowledge base document generated by scraping the given webpage.

post/v1/convai/knowledge-base/url

Headers

xi-api-keystring nullable

Your API key. This is required by most endpoints to access our API programmatically. You can view your xi-api-key using the 'Profile' tab on the website.

Your API key. This is required by most endpoints to access our API programmatically. You can view your xi-api-key using the 'Profile' tab on the website.

Request body

urlstring required

URL to a page of documentation that the agent will have access to in order to interact with users.

namestring nullable

A custom, human-readable name for the document.

parent_folder_idstring nullable

If set, the created document or folder will be placed inside the given folder.

enable_auto_syncboolean

Whether to enable auto-sync for this URL document.

auto_removeboolean

Whether to automatically remove the document if the URL becomes unavailable. Only applicable when auto-sync is enabled.

Response

Successful Response

idstring required
namestring required