Data Types

ProcessFileAndSaveResponseSync

Response body for ProcessFileAndSave operations where the File Processing API operation is synchronous (e.g. an image processing job).

{
"accountId": String,
"async": Boolean,
"filePath": String,
"fileUrl": String,
}
{
"async": false,
"accountId": "A623uY2",
"filePath": "/my-processed-image.jpg",
"fileUrl": "https://upcdn.io/A623uY2/raw/my-processed-image.jpg"
}

Your account ID.

This is visible on the settings page:

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

Example: "A623uY2"

Type: String

Length: 7

False for synchronous file processing operations (e.g. image processing).

For synchronous operations, the response body will contain links to the transformed file.

Type: Boolean

Value: false

The filePath of the transformed file.

If the transformation produces multiple artifacts, each artifact will be created as a child of this path.

Example: "/my-processed-image.jpg"

Type: String

Min Length: 1

Max Length: 512

The fileUrl of the transformed file.

If the transformation produces multiple artifacts, each artifact will be created as a child of this URL.

We recommend saving the filePath to your database instead of the fileUrl.

Example: "https://upcdn.io/A623uY2/raw/my-processed-image.jpg"

Type: String

Min Length: 1

Max Length: 255

Contains the contents of the file referenced by the filePath.

For some transformations, the summary may contain links to other artifacts produced by the transformation. These artifacts can be accessed by appending the artifact's path to the filePath and fileUrl field values above.

This field is only present when the filePath references a JSON file.

Type: TransformationSummary

Was this section helpful? Yes No

You are using an outdated browser.

This website requires a modern web browser -- the latest versions of these browsers are supported: