To process files and save the results:
Create a file transformation URL (see ProcessFile docs).
Test the file transformation URL (with GET).
Add /save to the URL (after your account ID).
Submit a POST request to the URL (with the request body described below).
Tip: you can use ProcessFile to use GET requests instead. You can leverage Bytescale's permanent caching to ensure each URL is only processed once, no matter how many times it is requested.
1curl "https://upcdn.io/{accountId}/save/{transformation}/{filePath}{?params}" \2 -H "Authorization: Bearer YOUR_API_KEY" \3 -H "Content-Type: application/json" \4 -d @- << EOF5 {6 "destination": {7 "fileName": "example-{UNIQUE_DIGITS_4}{ORIGINAL_FILE_EXT}"8 }9 }10EOF1{2 "async": false,3 "accountId": "A623uY2",4 "filePath": "/my-processed-image.jpg",5 "fileUrl": "https://upcdn.io/A623uY2/raw/my-processed-image.jpg"6}Your account ID.
This is visible on the settings page:
https://www.bytescale.com/dashboard/settings
Example: A623uY2
Type: String
Length: 7
Absolute path to a file. Begins with a /.
Example: /uploads/image.jpg
Type: String
Min Length: 1
Max Length: 512
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: thumbnail
Type: String
Min Length: 1
Max Length: 100
Parameters to submit to the File Processing API (e.g. the Image Processing API).
Please see the documentation for each File Processing API to determine which values can appear here:
•https://www.bytescale.com/docs/image-processing-api
•https://www.bytescale.com/docs/video-processing-api
•https://www.bytescale.com/docs/audio-processing-api
•https://www.bytescale.com/docs/archive-processing-api
Type: Object
Add one of these Authorization header values to your request:
•Option 1: prefix "Bearer " to your API key. The result is your Authorization header value.
•Option 2: use HTTP basic authorization with apikey as your username and your API key as your password.
Type: String
This endpoints requires a JSON request body.
Type: String
Value: "application/json"
This website uses cookies. By continuing you are consenting to the use of cookies per our Cookie Policy. Our Terms of Service were updated on October 20 2023.
This website requires a modern web browser -- the latest versions of these browsers are supported: