v1

latestOpenAPI 3.0.02026-07-1717466209.0 KB
Microdata

Upload file (with chunked upload support)

Upload files with support for both normal and chunked uploads. Chunked uploads are useful for large files.

For normal uploads: Send file as multipart/form-data with field name 'file'

For chunked uploads: Include these headers:

  • X-Chunk-Index: Current chunk number (0-based)
  • X-Total-Chunks: Total number of chunks
  • X-Upload-ID: Unique identifier for this upload
  • X-File-Name: Original filename
  • X-File-Size: Total file size in bytes
  • X-Is-Final-Chunk: 1 for final chunk, 0 otherwise

Send each chunk as multipart/form-data with field name 'chunk'

post/upload/{sid}

Path parameters

sidstring required

Project ID or IDNO

Headers

X-Chunk-Indexinteger

Current chunk index (0-based) for chunked uploads

X-Total-Chunksinteger

Total number of chunks for chunked uploads

X-Upload-IDstring

Unique upload identifier for chunked uploads

X-File-Namestring

Original filename for chunked uploads

X-File-Sizeinteger

Total file size in bytes for chunked uploads

X-Is-Final-Chunkinteger

Whether this is the final chunk (0 or 1) for chunked uploads

Response

File uploaded successfully (or chunk received for chunked uploads)

status'success' | 'chunk_received'
upload_method'normal' | 'chunked'
upload_idstring
file_namestring
file_pathstring
file_sizeinteger
file_typestring
chunk_indexinteger
chunks_receivedinteger
total_chunksinteger
percent_completenumber
messagestring