Create a file

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

Request

Creates a new file in the specified folder with the title specified in the request.

Note: If a file extension is different from DOCX/XLSX/PPTX and refers to one of the known text, spreadsheet or presentation formats, it will be changed to DOCX/XLSX/PPTX accordingly. If the file extension is not specified or is unknown, the DOCX extension will be added to the file title.

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

titlestring

File title

templateIdstring

Template file ID

enableExternalExtboolean

Specifies whether to allow the creation of external extension files or not

Examples

POST /api/2.0/files/%7BfolderId%7D/file 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/file \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json'

Responses

200

New file information

Namestring
UpdatedByobject
Idstringformat: uuid
DisplayNamestring
Titlestring
AvatarSmallstring
ProfileUrlstring
Updatedstring
Locationstring

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).