Liveblocks icon

Liveblocks

Call the Liveblocks REST API (rooms, comments, feeds, Yjs, AI, and more)

AI Knowledge → Create Web Source

AI-generated

Summary

Create a new web knowledge source for a specified AI copilot by providing the source URL and crawl type, enabling the AI to access and utilize this web content for knowledge.

Inputs

  • Copilot ID (required) — The identifier of the AI copilot to which the web knowledge source will be added.
  • URL (required) — The URL of the web source to be added as knowledge for the AI copilot.
  • Crawl Type (required) — The type of crawl to perform on the provided URL, choosing among 'Individual Link', 'Crawl', or 'Sitemap'.
  • Include Request in Error — Optional flag to include detailed request information in error messages for debugging failed API calls.

Output shape

a single record containing the created web knowledge source's details, including at least the URL and crawl type assigned to the specified AI copilot

The output contains the newly created web knowledge source object as returned by the Liveblocks API. If the operation fails, error details may include request information if 'Include Request in Error' is set to true.

Examples

Example 1: Create a web knowledge source using an individual link crawl type for AI copilot 'abc123' targeting 'https://example\.com'\.

Set Copilot ID to 'abc123', URL to 'https://example.com', and Crawl Type to 'Individual Link'. Optionally enable Include Request in Error for debugging.

Links

Discussion