Data Types

ProcessFileParams

Parameter object passed to the ProcessFile method in the Upload SDKs.

Structure

{
"accountId": String,
"artifact": String,
"cache": Boolean,
"filePath": String,
"version": String
}

Example

{
"accountId": "YOUR_ACCOUNT_ID",
"artifact": "/example/video/part-a.ts",
"cache": true,
"filePath": "/uploads/image.jpg",
"transformation": "thumbnail",
"version": "1"
}

Properties

accountId

Your account ID.

This is visible on the settings page:

https://upload.io/dashboard/settings

Type: String

Length: 7

Example: "A623uY2"

Required: No

artifact

Path to an artifact generated by the transformation.

All image transformations output the transformed image to the "/" artifact. Video transformations may output multiple artifacts.

Default: "/"

Type: String

Example: "/example/video/part-a.ts"

Required: No

cache

Prevents the response from being cached.

Transformation will be executed on every request.

Important: do not use this parameter when serving files to your users, since the re-execution of Upload's transformation pipelines on every request will result in higher download latencies.

Recommendation: use the _version parameter to "cache bust" instead.

Type: Boolean

Example: true

Required: No

filePath

Absolute path to a file. Must begin with a /.

Type: String

Min Length: 1

Max Length: 512

Example: "/uploads/image.jpg"

Required: No

transformation

Transformation URL slug.

These are created in the Upload Dashboard:

https://upload.io/dashboard/transformations

Type: String

Min Length: 1

Max Length: 100

Example: "thumbnail"

Required: No

version

Re-runs your transformation (after you have made configuration changes) when added to the URL with a unique value.

The value can be anything, e.g. an incremental number, a timestamp, etc.

You only need to provide and update this value if/when you make changes to your transformation's configuration.

The alias _v is also supported.

Type: String

Example: "1"

Required: No

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: