Ingest Files

POST

Ingest files into the system.

This endpoint supports multipart/form-data requests, enabling you to ingest files and their associated metadatas into R2R.

A valid user authentication token is required to access this endpoint, as regular users can only ingest files for their own access. More expansive collection permissioning is under development.

Request

This endpoint expects a multipart form with multiple files.
filesfilesRequired
document_idsstringOptional

An optional list of document ids for each file. If not provided, the system will generate a unique document id via the generate_document_id method.

metadatasstringOptional

An optional list of JSON metadata to affix to each file

ingestion_configstringOptional

An optional dictionary to override the default chunking configuration for the ingestion process. If not provided, the system will use the default server-side chunking configuration.

run_with_orchestrationbooleanOptional

Whether or not ingestion runs with orchestration, default is True. When set to False, the ingestion process will run synchronous and directly return the result.

Response

Successful Response

resultslist of objects

Errors