Skip to main content
POST
Create Url Document

Headers

x-api-key
string | null

Your API key for programmatic access. Send it in the x-api-key header; you can create and manage keys from the Developers page.

Body

application/json
url
string
required

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

name
string | null

A custom, human-readable name for the document.

Minimum string length: 1
parent_folder_id
string | null

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

enable_auto_sync
boolean
default:false

Whether to enable auto-sync for this URL document.

auto_remove
boolean
default:false

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

minimum_frequency_days
integer | null

Minimum frequency (in days) at which the document is refreshed. The actual interval may be shorter, never longer. Defaults to 7, tightened to the parent folder's frequency if that is stricter. Only applicable when auto-sync is enabled.

Required range: 1 <= x <= 180

Response

Successful Response

id
string
required
name
string
required
folder_path
KnowledgeBaseFolderPathSegmentSummaryResponseModel · object[]

The folder path segments leading to this entity, from root to parent folder.