v1

latestOpenAPI 3.0.3GPL-3.02026-07-177978150.2 KB

documents

Import documents into a collection

The documents to be imported must be formatted in a newline delimited JSON structure. You can feed the output file from a Typesense export operation directly as import.

post/collections/{collectionName}/documents/import

Path parameters

collectionNamestring required

The name of the collection

Query parameters

batch_sizeinteger

return_idboolean

Returning the id of the imported documents. If you want the import response to return the ingested document's id in the response, you can use the return_id parameter.

remote_embedding_batch_sizeinteger

return_docboolean

action'create' | 'update' | 'upsert' | 'emplace'

dirty_values'coerce_or_reject' | 'coerce_or_drop' | 'drop' | 'reject'

Response

Result of the import operation. Each line of the response indicates the result of each document present in the request body (in the same order). If the import of a single document fails, it does not affect the other documents. If there is a failure, the response line will include a corresponding error message and as well as the actual document content.