API Reference

Create Knowledge Base Item

post
https://api.whippy.co/v1/knowledge_bases//items

Adds an item to a knowledge base draft. If no draft exists, one is created from the current published version.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required

Knowledge Base ID

Body Params

Create Knowledge Base Item Request

Request schema for adding an item to a knowledge base draft.
File metadata (filename, extension, size_kb) is fetched automatically
for document, audio, and video items and is not client-writable.

string
required

Content source for the selected type.

  • text: Literal text content.
  • url: Source URL for one web page.
  • website: Source URL for a website whose pages are crawled.
  • document, audio, and video: Publicly accessible file URL. File metadata is fetched automatically by the server.
string
required

Item name

settings
object | null

Settings of the knowledge base item. Only the settings listed for the selected type are used.

  • url:

    • Optional:
      • auto_refresh_enabled: Whether to refresh the URL content automatically.

  • website:

    • Optional:
      • include_paths: Regex patterns of website paths to include when crawling.
      • exclude_paths: Regex patterns of website paths to exclude when crawling.
      • auto_refresh_enabled: Whether to refresh discovered child URL content automatically.
      • auto_crawl_enabled: Whether to crawl automatically for new or removed website pages.

  • text, document, audio, and video:

    • No settings are used.
string
enum
required

Item type

Allowed:
Responses

Callback

Updated about 2 months ago

Did this page help you?
Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 2 months ago

Did this page help you?