POST /v2/gen-ai/knowledge_bases/{knowledge_base_uuid}/data_sources

To add a data source to a knowledge base, send a POST request to /v2/gen-ai/knowledge_bases/{knowledge_base_uuid}/data_sources.

Servers

Path parameters

Name Type Required Description
knowledge_base_uuid String Yes

Knowledge base id

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
knowledge_base_uuid String No

Knowledge base id

spaces_data_source Object No

Spaces Bucket Data Source

spaces_data_source.region String No

Region of bucket

spaces_data_source.bucket_name String No

Spaces bucket name

spaces_data_source.item_path String No
web_crawler_data_source Object No

WebCrawlerDataSource

web_crawler_data_source.embed_media Boolean No

Whether to ingest and index media (images, etc.) on web pages.

web_crawler_data_source.crawling_option String No

Options for specifying how URLs found on pages should be handled.

  • UNKNOWN: Default unknown value
  • SCOPED: Only include the base URL.
  • PATH: Crawl the base URL and linked pages within the URL path.
  • DOMAIN: Crawl the base URL and linked pages within the same domain.
  • SUBDOMAINS: Crawl the base URL and linked pages for any subdomain.

Possible values:

  • "SCOPED"
  • "PATH"
  • "UNKNOWN"
  • "DOMAIN"
  • "SUBDOMAINS"

Default value: "UNKNOWN"

web_crawler_data_source.base_url String No

The base url to crawl.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.