v4

latestOpenAPI 3.1.0raw.githubusercontent.com2026-06-13216144508.7 KB
kb

Ingest Web

Ingest website content into the knowledge base.

Args: collection: Target collection name start_url: Starting URL for crawling max_pages: Maximum number of pages to crawl max_depth: Maximum crawl depth url_patterns: Comma-separated URL match patterns (regex) exclude_patterns: Comma-separated exclusion patterns (regex) same_domain_only: Only crawl same domain content_selector: CSS selector for main content area remove_selectors: Comma-separated CSS selectors to remove concurrent_requests: Number of concurrent requests request_delay: Delay between requests in seconds timeout: Request timeout in seconds respect_robots_txt: Respect robots.txt rules parse_method: Parser for document ingestion chunk_strategy: Chunking strategy chunk_size: Chunk size in characters chunk_overlap: Chunk overlap in characters embedding_model_id: Embedding model ID embedding_batch_size: Batch size for embedding max_retries: Maximum retry attempts retry_delay: Delay between retries

post/api/kb/ingest-web

Response

Successful Response

statusstring required

Overall status: success|error|partial

collectionstring required

Target collection name

total_urls_foundinteger required

Total number of unique URLs discovered

pages_crawledinteger required

Number of successfully crawled pages

pages_failedinteger required

Number of pages that failed to crawl

documents_createdinteger required

Number of documents created in collection

chunks_createdinteger required

Total number of chunks created

embeddings_createdinteger required

Total number of embeddings generated

crawled_urlsstring[]

List of successfully crawled URLs

failed_urlsobject

Map of failed URLs to error messages

messagestring required

Human-readable summary message

warningsstring[]

Non-critical warnings

side_effects_may_remainboolean

Whether rollback failed after an ingestion error and persisted side effects may still exist

elapsed_time_msinteger required

Total elapsed time in milliseconds