ProcessFileAndSaveResponse

Your account ID.

This is visible on the settings page:

https://upload.io/dashboard/settings

Example: "A623uY2"

Type: String

Length: 7

Required: Yes

The filePath of the transformed file.

Transformations that produce multiple files — like the Archive Processing API running in extract mode — save files under this path. The basePath itself references a "summary file" that contains relative links to the other files produced by the transformation.

Asynchronous transformations — like the Video Processing API — save a "summary file" to the basePath immediately. The file contains a summary of the work being performed and its current status. The file is updated periodically until the transformation completes.

Example: "/example-path"

Type: String

Min Length: 1

Max Length: 512

Required: Yes

The fileUrl of the transformed file.

See basePath for more information.

We recommend saving the basePath to your database instead of the baseUrl.

Example: "https://upcdn.io/A623uY2/raw/example-path"

Type: String

Min Length: 1

Max Length: 255

Required: Yes

Contains the contents of the file referenced by the basePath.

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

Type: TransformationSummary

Required: No