FIfiles
file_actions
File Actions

Transform a file and save the output to a destination path.

Changed on

Transform a file and save the output to a destination path.

post/file_actions/transform/{path}

Request

  • Base URL
    https://app.files.com/api/rest/v1
  • URL
    https://app.files.com/api/rest/v1/file_actions/transform/{path}
  • Auth
    none declared

Path parameters

pathstring required

Path to operate on.

Request body multipart/form-data

destinationstring required

Destination file path for the transformed output.

transform_typestring required

Transform type. Supported values are image_convert, document_convert, and files_transform_script_execute.

target_formatstring required

Destination format to create.

scriptstring

Files TransformScript source. Required when transform_type is files_transform_script_execute.

widthinteger

Maximum output width for image_convert.

heightinteger

Maximum output height for image_convert.

overwriteboolean

Overwrite existing file in the destination?

Response

The FileActions object.

statusstring

Status of file operation.

file_migration_idinteger

If status is pending, this is the id of the File Migration to check for status updates. Delete actions include it whenever the deletion runs as a File Migration, including while it is processing.

Example response

{
  "status": "pending",
  "file_migration_id": 1
}

Changes