Initiate File Upload

Creates a new file upload session. If this operation returns successfully, the ID returned as part of the response object shall be used to refer to the file in all subsequent upload and scanning operations.

POSThttps://api.nightfall.ai/v3/upload

Authorization

Body

fileSizeBytesinteger

the number of bytes representing the size of the file to-be-uploaded.

Response

Success

Headers

Content-Typestring

Body

idstring (uuid)

a UUID to uniquely identify a particular file upload

fileSizeBytesinteger

the size of the file in bytes

chunkSizeinteger

the number of bytes to upload in each chunk upload request

mimeTypestring

an RFC2045 media type that describes the underlying content type

Request

const response = await fetch('https://api.nightfall.ai/v3/upload', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "mimeType": "text"
}