Skip to main content
Version: 8.9 (unreleased)

Type Alias: CreateDocumentData

type CreateDocumentData = object;

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

Properties

body

body: object;

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

file

file: Blob | File;

metadata?

optional metadata: DocumentMetadata;

path?

optional path: never;

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


query?

optional query: object;

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

documentId?

optional documentId: DocumentId;

The ID of the document to upload. If not provided, a new ID will be generated. Specifying an existing ID will result in an error if the document already exists.

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";

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