Collections

Creates job to import collection to the collection.

Changed on

Creates job to import collection to the collection.

post/collections/{collection_id}/import_collection_job

Request

Path parameters

collection_idstring required

Id of the destination collection.

Query parameters

migrate_scheduled_connectorsboolean

Whether to move scheduled connectors from the source collection to the target collection after documents are imported. The source collection will have no scheduled connectors after this operation. Only the owner of both collections can use this flag.

copy_lifecycle_settingsboolean

Whether to copy lifecycle settings (expiry_date, inactivity_interval, size_limit) from the source collection to the target collection.

skip_reparseboolean

Whether to skip re-parsing documents and only re-embed existing chunks with the target collection's embedding model. Much faster than full import since it skips file fetch, PDF conversion, OCR, and chunking. Only re-embeds the text chunks. Cannot be combined with copy_document=true.

copy_documentboolean

Whether to save a new copy of the document

preserve_document_statusboolean

Whether to preserve each document's original ingest mode (agent_only vs standard) when importing. When true, documents with agent_only status remain agent_only in the target collection. When false (default), all documents use the ingest_mode parameter uniformly.

preserve_metadataboolean

Whether to preserve document metadata when copying documents.

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).

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

source_collection_idstring required

Id of the collection to be inserted.

Response

Successful operation

idstring required
namestring required
overall_status'in progress' | 'completed' | 'failed' | 'canceled' required
statusstring
passed_percentagenumber double required
failed_percentagenumber double required
progressnumber double required
created_atstring date-time required
updated_atstring date-time required
kindstring required
errorsstring[] required
durationstring required
duration_secondsnumber double required
canceled_bystring
cancel_reasonstring
timeoutnumber double
start_timenumber double
files_totalinteger
files_failedinteger

Changes

    • info

      added the new optional query request parameter copy_lifecycle_settings

    • info

      added the new optional query request parameter migrate_scheduled_connectors

    • info

      added the new optional query request parameter preserve_document_status

    • info

      added the new optional query request parameter preserve_metadata

    • info

      added the new optional query request parameter skip_reparse

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status