Create Knowledge Base From Url Endpoint

curl --request POST \
  --url https://api.example.com/v1/knowledge-base/url \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "<string>"
}
'

{
  "id": "<string>",
  "name": "<string>"
}

Knowledge Base

Create Knowledge Base From Url Endpoint

Create a knowledge base document by scraping a URL.

Request body:

url: URL to scrape (required)

Returns:

id: Generated document ID
name: Document name (auto-extracted from page title)

The endpoint will:

Validate the URL format
Scrape the webpage content
Auto-extract the page title as the document name
Store the content in the knowledge base
Return the document ID and name

Error cases:

400: Invalid URL, inaccessible page, content too large/small
401: Invalid authentication
408: Scraping timeout (>30s)
500: Server error

POST

knowledge-base

url

Create Knowledge Base From Url Endpoint

curl --request POST \
  --url https://api.example.com/v1/knowledge-base/url \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "<string>"
}
'

{
  "id": "<string>",
  "name": "<string>"
}

Headers

x-api-key

string | null

API key for authentication

Body

application/json

Model for creating a knowledge base document from URL

url

string

required

URL to scrape

Minimum string length: 1

Response

Successful Response

Response after creating a knowledge base document

string

required

name

string

required

Update Knowledge Base Document

Create Knowledge Base From Text Endpoint

⌘I

Getting Started

Agents

Batch Calling

Voices

Conversations

Payments

Knowledge Base

Webhooks

Workers

Create Knowledge Base From Url Endpoint

Headers

Body

Response