Get Started
Usage API
More information

POST api/2.0/files/{folderId}/upload/create_session This function requires authentication

Description

Creates a session to upload large files in multiple chunks to the folder with the ID specified in the request.

Parameters
Name Description Type Example
folderId
sent in url
Folder ID string some text
fileName
sent in body
File name string some text
fileSize
sent in body
File length in bytes number 1234
relativePath
sent in body
Folder which is relative to the selected folder string some text
Remark

Each chunk can have different length but the length should be multiple of 512 and greater or equal to 10 mb. Last chunk can have any size. After the initial response to the request with the 200 OK status, you must get the location field value from the response. Send all your chunks to this location. Each chunk must be sent in the exact order the chunks appear in the file. After receiving each chunk, the server will respond with the current information about the upload session if no errors occurred. When the number of bytes uploaded is equal to the number of bytes you sent in the initial request, the server responds with the 201 Created status and sends you information about the uploaded file.

Example
POST api/2.0/files/some+text/upload/create_session
Host: yourportal.onlyoffice.com
Content-Type: application/json
Accept: application/json

{
  "fileName": "some text",
  "fileSize": 1234,
  "relativePath": "some text"
}
Returns

Information about created session which includes:

  • id: unique ID of this upload session
  • created: UTC time when the session was created
  • expired: UTC time when the session will expire if no chunks are sent before that time
  • location: URL where you should send your next chunk
  • bytes_uploaded: number of bytes uploaded for the specific upload ID
  • bytes_total: total number of bytes which will be uploaded