v1

latestOpenAPI 3.0.02026-07-17132430.9 KB
Upload

Initiate the upload flow

The client will call this endpoint to initiate the flow of uploading documents to the CDE.

post/upload-documents

Request body

server_contextstring nullable

A CDE controlled identifier recording the user's context on the CDE. For example which project and folder the user was on. If the client provides the server_context in subsequent calls then the CDE will attemp to load the UI at the same place.

Response

The CDE returns a URL for the client to open in a local browser. The user will then be presented with the CDE UI to enter document metadata

upload_ui_urlstring required

A CDE UI URL for the client to open in a local browser. The user would enter document metadata directly in the CDE

expires_ininteger required

upload_ui_url expiry in seconds

max_size_in_bytesinteger required

The maximum file size supported by the CDE. Attempts to upload a larger file will fail