Initiate File Upload

PreviousScan Plain Text NextUpload File Chunk

Last updated 10 months ago

Was this helpful?

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.

post

/v3/upload

Authorizations

Body

fileSizeBytesinteger

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

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.nightfall.ai/v3/upload' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json'

200

400

401

429

500

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

Success