Navigation Menu

Upload a file to the "My documents" section

POST /api/2.0/files/@my/upload

Request

Uploads a file specified in the request to the "My documents" section 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 cookie parameter called asc_auth_key.

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

Headers

Acceptenum of string

Can be one of: application/json, text/json, text/plain.

Query

inDtoobject
filestringformat: binary
contentTypeobject
boundarystring
charSetstring
mediaTypestring
namestring
parametersarray of unknown
contentDispositionobject
dispositionTypestring
parametersarray of unknown
fileNamestring
creationDatestringformat: date-time
modificationDatestringformat: date-time
inlineboolean
readDatestringformat: date-time
sizeintegerformat: int64
filesarray of unknown
createNewIfExistboolean
storeOriginalFileFlagboolean
keepConvertStatusboolean
streamstringformat: binary

Examples

POST /api/2.0/files/@my/upload?inDto=%7B%22contentType%22%3A%7B%22boundary%22%3A%22some%20text%22%2C%22charSet%22%3A%22some%20text%22%2C%22mediaType%22%3A%22some%20text%22%2C%22name%22%3A%22Savannah%20Anderson%22%2C%22parameters%22%3A%5B%7B%22int%22%3A1234%2C%22string%22%3A%22some%20text%22%2C%22boolean%22%3Atrue%7D%5D%7D%2C%22contentDisposition%22%3A%7B%22dispositionType%22%3A%22some%20text%22%2C%22parameters%22%3A%5B%7B%22int%22%3A1234%2C%22string%22%3A%22some%20text%22%2C%22boolean%22%3Atrue%7D%5D%2C%22fileName%22%3A%22some%20text%22%2C%22creationDate%22%3A%222008-04-10T06%3A30%3A00.0000000%2B04%3A00%22%2C%22modificationDate%22%3A%222008-04-10T06%3A30%3A00.0000000%2B04%3A00%22%2C%22inline%22%3Atrue%2C%22readDate%22%3A%222008-04-10T06%3A30%3A00.0000000%2B04%3A00%22%2C%22size%22%3A1234%7D%2C%22files%22%3A%5B%7B%22int%22%3A1234%2C%22string%22%3A%22some%20text%22%2C%22boolean%22%3Atrue%7D%5D%2C%22createNewIfExist%22%3Atrue%2C%22storeOriginalFileFlag%22%3Atrue%2C%22keepConvertStatus%22%3Atrue%7D HTTP/1.1
Accept: application/json
Host: example.com
curl --request POST \
  --url 'https://example.com/api/2.0/files/@my/upload?inDto=%7B%22contentType%22%3A%7B%22boundary%22%3A%22some%20text%22%2C%22charSet%22%3A%22some%20text%22%2C%22mediaType%22%3A%22some%20text%22%2C%22name%22%3A%22Savannah%20Anderson%22%2C%22parameters%22%3A%5B%7B%22int%22%3A1234%2C%22string%22%3A%22some%20text%22%2C%22boolean%22%3Atrue%7D%5D%7D%2C%22contentDisposition%22%3A%7B%22dispositionType%22%3A%22some%20text%22%2C%22parameters%22%3A%5B%7B%22int%22%3A1234%2C%22string%22%3A%22some%20text%22%2C%22boolean%22%3Atrue%7D%5D%2C%22fileName%22%3A%22some%20text%22%2C%22creationDate%22%3A%222008-04-10T06%3A30%3A00.0000000%2B04%3A00%22%2C%22modificationDate%22%3A%222008-04-10T06%3A30%3A00.0000000%2B04%3A00%22%2C%22inline%22%3Atrue%2C%22readDate%22%3A%222008-04-10T06%3A30%3A00.0000000%2B04%3A00%22%2C%22size%22%3A1234%7D%2C%22files%22%3A%5B%7B%22int%22%3A1234%2C%22string%22%3A%22some%20text%22%2C%22boolean%22%3Atrue%7D%5D%2C%22createNewIfExist%22%3Atrue%2C%22storeOriginalFileFlag%22%3Atrue%2C%22keepConvertStatus%22%3Atrue%7D' \
  --header 'Accept: application/json'

Responses

200

Uploaded file(s)

401

Unauthorized

403

Forbidden

Get Help

  • If you have any questions about ONLYOFFICE DocSpace, 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).