Skip to main content
POST
/
api
/
agents
/
{agentId}
/
knowledge
/
url
Add URL
curl --request POST \
  --url https://api.example.com/api/agents/{agentId}/knowledge/url \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "<string>",
  "config": {}
}
'
{
  "success": true,
  "documentId": "<string>",
  "jobId": "<string>"
}

​
Description

Add a URL to the knowledge base for scraping.

​
Authentication

Required (API key or JWT token)

​
Request Body

​
url
string
required
The URL to scrape
​
config
object
Scraping configuration (crawlDepth, maxPages, etc.)

​
Response

​
success
boolean
Whether URL was added successfully
​
documentId
string
ID of the created document
​
jobId
string
ID of the scraping job