Sign in
File

Processes a file and saves the result.

Processes a file and saves the result.

post/{accountId}/save/{transformation}{filePath}

Path parameters

accountIdstring required

Your account ID.

This is visible on the settings page:

https://www.bytescale.com/dashboard/settings

Example:A623uY2
filePathstring required

Absolute path to a file. Begins with a /.

Example:/uploads/image.jpg
transformationstring required

The name of the File Processing API (e.g. image, video, audio) or transformation preset (created in the Bytescale Dashboard) to use when processing the file.

Example:image

The name of the File Processing API (e.g. image, video, audio) or transformation preset (created in the Bytescale Dashboard) to use when processing the file.

Query parameters

TransformationParamsGroup

A single group of transformation parameters provided to a Bytescale File Processing API.

See TransformationParams for more information.

OR
TransformationParamsGroup[]

Each File Processing API requires additional query string parameters to specify the desired transformation behavior.

For details, refer to the relevant documentation:

Request body

Example request

{
  "destination": "/destination/image.jpg"
}

Response

Success.

OR

Example response

{
  "async": true,
  "jobUrl": "https://api.bytescale.com/v2/accounts/W142hJk/jobs/ProcessFileJob/01HA255YE6H6DEETJ5M6595ZDA",
  "jobDocs": "https://www.bytescale.com/docs/job-api/GetJob",
  "jobId": "01HA255YE6H6DEETJ5M6595ZDA",
  "jobType": "ProcessFileJob",
  "accountId": "W142hJk",
  "created": 1694437145030,
  "lastUpdated": 1694437145030,
  "status": "Running",
  "summary": {}
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.