Add web pages

POST

/api/v1/knowledge/bases/{kb_id}/urls

A page, a sitemap's pages, or a site crawled from a URL, fetched into the base (_web/<host>/…) with robots.txt respected, and fetched again on the base's schedule. 202: the crawl runs on. In cloud a crawl fetches only through the platform's egress proxy, which refuses any address that is not on the public internet; it reads at most 500 pages, 3 links deep, one request a second per site, and stops when the plan's vault storage is full.

Authorization

apiKey

headerAuthorizationBearer <token>

An API key, sk-syn- and 32 characters. On SynapseOrch Cloud an owner or admin makes it under Settings → Developer; on a self-hosted install, under Settings → API Keys.

Path Parameters

kb_id*string

Request Body

application/json

body

urls*array<string>

Items1 <= items <= 100

kind?string

Default"page"

Value in"page""sitemap""site"

max_depth?|null

max_pages?|null

metadata?

Response Body

Successful Response

application/json

response

crawl_id*string

accepted*integer

status?string

Default"queued"

curl -X POST "https://api.synapseorch.com/api/v1/knowledge/bases/kb_01a10d3f5a7c9e1b3d5f7a9c1e3b5d7f/urls" \  -H "Authorization: Bearer sk-syn-..." \  -H "Content-Type: application/json" \  -d '{    "urls": [      "string"    ]  }'

{  "crawl_id": "string",  "accepted": 0,  "status": "queued"}