Skip to main content
Version: 8.9 (unreleased)

Type Alias: CreateDocumentsData

type CreateDocumentsData = object;

Defined in: gen/types.gen.ts:10056

Properties

body

body: object;

Defined in: gen/types.gen.ts:10057

files

files: (Blob | File)[];

The documents to upload.

metadataList?

optional metadataList: DocumentMetadata[];

Optional JSON array of metadata object whose index aligns with each file entry. The metadata array must have the same length as the files array.


path?

optional path: never;

Defined in: gen/types.gen.ts:10068


query?

optional query: object;

Defined in: gen/types.gen.ts:10069

storeId?

optional storeId: string;

The ID of the document store to upload the documents to. Currently, only a single document store is supported per cluster. However, this attribute is included to allow for potential future support of multiple document stores.


url

url: "/documents/batch";

Defined in: gen/types.gen.ts:10075