Sign in
kb

Ingest Cloud

Ingest files from cloud storage.

post/api/kb/ingest-cloud

Request body

collectionstring required
parse_method'default' | 'pypdf' | 'pdfplumber' | 'unstructured' | 'pymupdf' | 'deepdoc'

Available parsing methods

chunk_strategy'recursive' | 'fixed_size' | 'markdown'

Available chunk strategies

chunk_sizeinteger nullable
chunk_overlapinteger nullable
separatorsstring[] nullable
embedding_model_idstring
embedding_batch_sizeinteger nullable
max_retriesinteger nullable
retry_delaynumber nullable

Response

Successful Response

statusstring required

Pipeline status: success|error|partial

doc_idstring nullable

Document identifier produced by register_document

parse_hashstring nullable

Parse hash produced during parse_document step

chunk_countinteger

Number of chunks created; must be non-negative

embedding_countinteger

Number of embeddings generated; must be non-negative

vector_countinteger

Number of vectors written to storage; must be non-negative

failed_stepstring nullable

Pipeline step where failure occurred, if any

messagestring required

Human-readable summary of pipeline result

warningsstring[]

Non-fatal warnings encountered

file_idstring nullable

Uploaded file ID for preview/download via /api/files (when ingest registers the file)

Changes

Changed in 1 of the 4 revisions of this API.1