Convert document

POST

Uploadcare allows you to convert files to different target formats. Check out the conversion capabilities for each supported format.

Headers

AcceptstringOptional
Version header.

Request

This endpoint expects an object.
pathslist of stringsOptional

An array of UUIDs of your source documents to convert together with the specified target format (see documentation).

storeenumOptional
Allowed values: 0false1true

When store is set to "0", the converted files will only be available for 24 hours. "1" makes converted files available permanently. If the parameter is omitted, it checks the Auto file storing setting of your Uploadcare project identified by the public_key provided in the auth-param.

save_in_groupenumOptionalDefaults to 0
Allowed values: 0false1true

When save_in_group is set to "1", multi-page documents additionally will be saved as a file group.

Response

This endpoint returns an object.
problemsmap from strings to stringsOptional

Dictionary of problems related to your processing job, if any. A key is the path you requested.

resultlist of objectsOptional
Result for each requested path, in case of no errors for that path.

Errors