Uploading files via API

You can create a file or folder using ClickHelp API. Below you find more information about the available options and its specifics.

Available Upload Methods

ClickHelp provides three file upload methods, each optimized for different scenarios:

Upload type Method
Query Parameter
 Max File Size Best For Key Characteristics
Base64 Upload v1: Create File or Folder / Start Resumable Upload
v2: Create File or Folder / Start Resumable Upload
format=base64
 10 MB Small files (<5 MB)
  • Single request
  • Base64-encoded JSON body
  • 33% data overhead
Multipart/Form-Data Upload v1: Create File or Folder / Start Resumable Upload
v2: Create File or Folder / Start Resumable Upload
format=multipart
 10 MB Standard uploads (≤10 MB)
  • Single request
  • No data overhead
  • Simple implementation
Resumable Upload

v1:
step 1: Create File or Folder / Start Resumable Upload
step 2: Upload file chunks (Resumable Step 2)
v2:
step 1: Create File or Folder / Start Resumable Upload
step 2: Upload file chunks (Resumable Step 2)

format=resumable
 1 GB Large files or unreliable connections
  • Chunked transfer
  • Resume capability
  • Progress tracking
  • Complex client-side logic
Common query parameter for all methods:
isOverwrite (boolean, optional) – specifies whether to overwrite an existing file with the same name. Default value: false.

Choose the appropriate method based on your requirements:

  • For small files and simple implementations: Use Base64 Upload when working with JavaScript clients or when simplicity is prioritized.
  • For reliable uploads up to 10 MB: Use Multipart/Form-Data Upload for standard HTTP file uploads without Base64 overhead.
  • For large files or critical data: Use Resumable Upload when uploading files larger than 10 MB, or when operating over unreliable network connections that may require resume capability.

For detailed instructions, refer to the dedicated documentation for each method.