Upload a file

POST /api/2.0/files/{folderId}/upload

Request

Uploads a file specified in the request to the selected folder by single file uploading or standart multipart/form-data method.

Note: You can upload files in two different ways:

  1. Using single file upload. You should set the Content-Type and Content-Disposition headers to specify a file name and content type, and send the file to the request body.
  2. Using standart multipart/form-data method.

Authorization

An API key is a token that you provide when making API calls. Include the token in a header parameter called Authorization.

Example: Authorization: 864FE52C-1C1C-469F-9308-51DAFEFE7436.

Headers

Acceptenum of string

Can be one of: application/json.

Content-Typeenum of string

Can be one of: application/json.

Path

folderIdstring

Folder ID

Body

fileobject

Request input stream

contentTypeobject

Content-Type header

contentDispositionobject

Content-Disposition header

filesarray of string

List of files when specified as multipart/form-data

createNewIfExistarray of boolean

Specifies whether to create a new file if it already exists or not

storeOriginalFileFlagarray of boolean

Specifies whether to upload documents in the original formats as well or not

keepConvertStatusboolean

Specifies whether to keep the file converting status or not

Examples

POST /api/2.0/files/%7BfolderId%7D/upload HTTP/1.1
Accept: application/json
Content-Type: application/json
Host: example.com
curl --request POST \
  --url https://example.com/api/2.0/files/%7BfolderId%7D/upload \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json'

Responses

200

Uploaded file(s)

401

Unauthorized

Get Help

  • If you have any questions about ONLYOFFICE Workspace, try the FAQ section first.
  • You can request a feature or report a bug by posting an issue on GitHub.
  • You can also ask our developers on ONLYOFFICE forum (registration required).