Document Ingestion

Crawls and ingest a URL into a collection.

Crawls and ingest a URL into a collection. The web page or document linked from this URL will be imported.

post/ingest/website

Request

Query parameters

collection_idstring required

String id of the collection to add the ingested documents into.

follow_linksboolean

Whether to import all web pages linked from this URL will be imported. External links will be ignored. Links to other pages on the same domain will be followed as long as they are at the same level or below the URL you specify. Each page will be transformed into a PDF document.

max_depthinteger

Max depth of recursion when following links, only when follow_links is true. Max_depth of 0 means don't follow any links, max_depth of 1 means follow only top-level links, etc. Use -1 for automatic (system settings).

max_documentsinteger

Max number of documents when following links, only when follow_links is true. Use None for automatic (system defaults). Use -1 for max (system limit).

gen_doc_summariesboolean

Whether to auto-generate document summaries (uses LLM).

gen_doc_questionsboolean

Whether to auto-generate sample questions for each document (uses LLM).

audio_input_languagestring

Language of audio files.

ocr_modelstring

Which method to use to extract text from images using AI-enabled optical character recognition (OCR) models. docTR is best for Latin text, PaddleOCR is best for certain non-Latin languages, Tesseract covers a wide range of languages. Mississippi works well on handwriting. - auto - Automatic will auto-select the best OCR model for every page. - off - Disable OCR for speed, but all images will then be skipped (also no image captions will be made).

tesseract_langstring

Which language to use when using ocr_model="tesseract".

keep_tables_as_one_chunkboolean

When tables are identified by the table parser the table tokens will be kept in a single chunk.

chunk_by_pageboolean

Each page will be a chunk. keep_tables_as_one_chunk will be ignored if this is true.

handwriting_checkboolean

Check pages for handwriting. Will use specialized models if handwriting is found.

ingest_mode'standard' | 'agent_only'

Ingest mode to use. - standard - Files will be ingested for use with RAG - agent_only - Bypasses standard ingestion. Files can only be used with agents.

timeoutnumber double

Timeout in seconds

Request body

urlstring required

String of the url to crawl.

Response

Successful operation

Changes

No recorded changes to this operation across all 1 revision of this API.