Skip to main content
POST
Crawl Web Pages

Path Parameters

kb_id
string
required

Knowledge Base ID.

Body

application/json

Request body for crawling web pages into a knowledge base.

page_urls
string[]
required

Pages to crawl. One call creates one document covering every URL in this list, not one document per URL.

Response

Crawl accepted and queued. Not yet searchable.

Acknowledgement that a document was accepted for asynchronous ingestion.

document_id
string
required

Server-minted identifier for the submitted document. Keep it - you need it to poll the status endpoint.

status
enum<string>
required

Always 'processing' at submission time.

Available options:
processing,
completed,
failed
message
string | null

Human-readable detail, for example 'File processing started'.