Interface: IngestUrlRequest
@kortexya/reasoninglayer / IngestUrlRequest
Interface: IngestUrlRequest
Section titled “Interface: IngestUrlRequest”Defined in: src/types/ingestion.ts:1947
Body of POST /api/v1/ingest/url.
Remarks
Section titled “Remarks”The wire keys are snake_case (max_depth, max_pages); the engine refuses
an unknown key with 422. Read the limits from
client.ingestion.getWebCapabilities().
Properties
Section titled “Properties”maxDepth?
Section titled “maxDepth?”
optionalmaxDepth?:number
Defined in: src/types/ingestion.ts:1954
Link hops to follow from the start page. 0 reads the start page only.
At most urlIngestion.maxDepthLimit (5).
Default Value
Section titled “Default Value”0maxPages?
Section titled “maxPages?”
optionalmaxPages?:number
Defined in: src/types/ingestion.ts:1961
Most page URLs to request, read or skipped. At most
urlIngestion.maxPagesLimit (100).
Default Value
Section titled “Default Value”20scope?
Section titled “scope?”
optionalscope?:CrawlScope
Defined in: src/types/ingestion.ts:1963
Which links may be followed.
Default Value
Section titled “Default Value”'path_prefix'url:
string
Defined in: src/types/ingestion.ts:1965
Absolute http or https URL of the start page.