Start file conversion

PUT /api/2.0/files/file/{fileId}/checkconversion

Request

Starts a conversion operation of a file with the ID specified in the request.

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.

Path

fileIdstring

File ID

Examples

PUT /api/2.0/files/file/%7BfileId%7D/checkconversion HTTP/1.1
Accept: application/json
Host: example.com
curl --request PUT \
  --url https://example.com/api/2.0/files/file/%7BfileId%7D/checkconversion \
  --header 'Accept: application/json'

Responses

200

Operation result

Idstring
OperationTypeenum of integerformat: int32

[0 - Move, 1 - Copy, 2 - Delete, 3 - Download, 4 - MarkAsRead, 5 - Import, 6 - Convert]

Can be one of: Move, Copy, Delete, Download, MarkAsRead, Import, Convert.

Progressintegerformat: int32
Sourcestring
Fileobject
Namestring
UpdatedByobject
Idstringformat: uuid
DisplayNamestring
Titlestring
AvatarSmallstring
ProfileUrlstring
Updatedstring
Locationstring
Errorstring
Processedstring

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