AgentKnowledge Bases

Create Crawl Import

Kick off an async website crawl. Returns 202 with the import job row; client polls GET /{id}/imports for progress.

Authentication

AuthorizationBearer

Enter your API key with the Bearer prefix, e.g. ‘Bearer sk_…’.

Path parameters

idstringRequired

Request

This endpoint expects an object.
urlstringRequiredformat: "uri"
max_pagesintegerOptional
max_depthintegerOptional
folder_idstring or nullOptional

Folder to import the documents into. Prefixed wire identifier (kfolder_<26 char Crockford base32>); null/omitted = root.

Response

Import job queued.
jobobject

Async URL import job (sitemap, crawl, plus the auto-refresh path). The console polls GET /v1/agents/knowledge-bases/{id}/imports while the job is non-terminal.

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error