Move or rename a DAM asset
Moves or renames a DAM asset without changing its stored object.
https://api2.transloadit.com/ dam/ assets/ {assetId}This endpoint is in alpha. Its URL, parameters, responses, and behavior may change substantially and break existing integrations.
Before calling this endpoint, obtain the IDs of existing assets in the same Workspace as the Auth Key used for the request.
For files stored with /transloadit/store, retrieve their Assembly Status and wait for ASSEMBLY_COMPLETED. In the returned results[stepName] arrays, retain each stored file’s workspace, asset_id, version_id, and returned path. The ordinary file id is not its Storage asset ID. Use asset_id for ASSET_ID or params.asset_ids in the examples below.
Use asset_id to follow an asset through native moves and renames. Add version_id when importing to select the same retained bytes after an overwrite. A saved path is a mutable location, not an immutable reference. Access and version retention still apply.
For a non-root destination, you must already know the existing folder’s ID in the same Workspace. A previously saved move or rename response can provide this ID: folder_id from a single-asset response or assets[].folder_id from a bulk-move response. These responses describe the folder after that operation; they are not a folder-discovery API.
If you know paths instead of folder IDs, use Move a Storage file or folder. The destination parent folder must already exist. To move an asset to the root with this ID-based endpoint, use destination_folder_id: null.
Include at least one of filename or destination_folder_id inside params. A filename must be a name without a folder path.
To rename an asset in its current folder, send only filename inside params, as in the request example below.
To move the asset to the root instead, explicitly include destination_folder_id: null:
{ "destination_folder_id": null, "filename": "renamed.jpg" }
For another folder, replace null with its folder ID. Omission and null are different operations.
Asset path limits
The complete destination path (folders plus filename) must fit within 512 Unicode code points and 1024 UTF-8 bytes after normalization. A filename that fits on its own can still exceed these limits in a nested folder.
Request example
Set ASSET_ID to your resource value without percent-encoding it.
Run this request in a server-side shell with curl and a suitable bearer token in TRANSLOADIT_TOKEN. If you need a token, expand the setup below.
Need a bearer token?
In a trusted server-side shell with curl and jq, set TRANSLOADIT_KEY and TRANSLOADIT_SECRET to your Auth Key and Auth Secret. Keep both credentials and the resulting token secret; never run this setup in browser code.
First, create a token with this endpoint’s required scopes. Your Auth Key must already grant those scopes.
if ! TOKEN_RESPONSE="$(curl --fail-with-body -sS \
--request POST \
--url 'https://api2.transloadit.com/token' \
--user "${TRANSLOADIT_KEY:?Set TRANSLOADIT_KEY}:${TRANSLOADIT_SECRET:?Set TRANSLOADIT_SECRET}" \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'grant_type=client_credentials' \
--data-urlencode 'aud=api2' \
--data-urlencode 'scope=dam:write')"; then
printf '%s\n' "$TOKEN_RESPONSE" >&2
exit 1
fi
TRANSLOADIT_TOKEN="$(printf '%s' "$TOKEN_RESPONSE" |
jq -er '.access_token | strings | select(length > 0)')" || exit 1
Keep this shell open and run the request below. Reuse the token while it remains valid.
curl --fail-with-body -sS --request PATCH \
--url "https://api2.transloadit.com/dam/assets/${ASSET_ID:?Set ASSET_ID}" \
--header "Authorization: Bearer ${TRANSLOADIT_TOKEN:?Set TRANSLOADIT_TOKEN}" \
--data-urlencode 'params={"filename":"renamed.jpg"}'
Authentication
This endpoint accepts signed params or a bearer token. See Authentication for setup instructions.
Required scope for the Auth Key or bearer token: dam:write.
Signed requests require both a signature and a future params.auth.expires timestamp. Bearer tokens do not require either.
Path parameters
assetId(path segment), required. pattern:^[A-Za-z0-9_-]{21}[AQgw]$, minimum length: 22, maximum length: 22
Form fields
Content type: application/x-www-form-urlencoded
params(JSON string), required. A JSON-encoded object whose supported keys are listed below.signature(string). Required for signed requests. Omit this field when using a bearer token.
Supported keys inside the params field
Authentication fields in this list apply to signed requests. With a bearer token, you can omit params.auth and the separate signature field. Compare the authentication-specific request parameters below.
Complete JSON Schema
params: Only the fields listed for this object are accepted.
| Field | Type and description |
|---|---|
params.required for signed requests; optional with a bearer token | Contains the Transloadit API key and signature-authentication metadata for a DAM mutation.
|
params.required | stringISO 8601 expiration timestamp in the future. Required when a request is signed or requires signature authentication; bearer-authenticated requests may omit it. |
params.required | stringTransloadit API key used to authenticate requests |
params. | string | nullDestination folder ID. Set to Any of the following schemas may apply: stringstringCase-sensitive, canonical 22-character Base64URL DAM identifier. Validation pattern (regular expression)^[A-Za-z0-9_-]{21}[AQgw]$null |
params. | string (minimum length: 1, maximum length: 255)New filename without a folder path. Names are normalized to Unicode NFC and remain case-sensitive. Whitespace-only names, |
params. | string | integerUnique, random value included in signed request params to make each signature unique and prevent accidental signature reuse. |
Request parameters by authentication method
With signed params
Include your Auth Key as params.auth.key. When signing the request, include a future params.auth.expires timestamp and send the signature in the separate signature field. The field definitions below use paths inside params.
Complete JSON Schema
params: Only the fields listed for this object are accepted.
Uses the field definitions above: params.auth, params.destination_folder_id, params.filename, params.nonce
With a bearer token
Send the bearer token in the Authorization header. You can omit params.auth and the separate signature field. Other required parameters still apply. The field definitions below use paths inside params.
Complete JSON Schema
params: Only the fields listed for this object are accepted.
Uses the field definitions above: params.destination_folder_id, params.filename, params.nonce
| Field | Type and description |
|---|---|
params. | Contains the Transloadit API key and signature-authentication metadata for a DAM mutation.
|
params. | stringISO 8601 expiration timestamp in the future. Required when a request is signed or requires signature authentication; bearer-authenticated requests may omit it. |
params. | stringTransloadit API key used to authenticate requests |
Response
Here’s an example response body:
{
"asset": {
"asset_id": "AAAAAAAAAAAAAAAAAAAAAA",
"height": 600,
"mime": "image/jpeg",
"path": "renamed.jpg",
"size": 12345,
"version_id": "AAAAAAAAAAAAAAAAAAAAAQ",
"width": 800,
"workspace": "example-workspace"
},
"asset_id": "AAAAAAAAAAAAAAAAAAAAAA",
"deleted_at": null,
"filename": "renamed.jpg",
"folder_id": null,
"message": "The DAM asset was successfully moved.",
"ok": "DAM_ASSET_MOVED",
"path": "renamed.jpg",
"updated_at": "2026-09-12T10:00:00.000Z"
}2xx success
JSON response body. application/json text/plain; charset=utf-8
Response body schema
Complete JSON Schema
The response contains only the fields listed for this object.
| Field | Type and description |
|---|---|
assetrequired |
|
asset.required | stringStable asset ID. It survives native moves and renames; use it without a version to select the current bytes. Validation pattern (regular expression)^[A-Za-z0-9_-]{21}[AQgw]$ |
asset. | booleanWhether the image has an alpha channel, even if all its pixels are opaque. Present when ThumbHash extraction succeeds; absence means unknown. |
asset. | integer (exclusive minimum: 0, maximum: 9007199254740991)Display height in pixels, after applying EXIF orientation, when known. |
asset. | stringLowercase MD5 checksum of the stored bytes, when available. Validation pattern (regular expression)^[a-f0-9]{32}$ |
asset.required | null | stringMIME type of the stored bytes, or null when unknown. |
asset.required | string (minimum length: 1)Current mutable location relative to the Workspace. A rename makes the previous path stale; overwriting can change the bytes at this path. |
asset. | stringLowercase SHA-256 checksum of the stored bytes, when available. Validation pattern (regular expression)^[a-f0-9]{64}$ |
asset.required | integer (minimum: 0, maximum: 9007199254740991)Size of the stored file in bytes. |
asset. | stringBase64-encoded ThumbHash of this version’s displayed pixels, when requested with output_meta.thumbhash on its producing Step. This is image data: apply the same access controls as the original. Validation pattern (regular expression)^(?:[A-Za-z0-9+/]{4}){1,15}(?:[A-Za-z0-9+/]{4}|[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)$ |
asset.required | stringExact immutable version of this asset. Pair with asset_id to select retained bytes; a missing version never falls back to the current version. Validation pattern (regular expression)^[A-Za-z0-9_-]{21}[AQgw]$ |
asset. | integer (exclusive minimum: 0, maximum: 9007199254740991)Display width in pixels, after applying EXIF orientation, when known. |
asset.required | string (minimum length: 1)Workspace slug that owns this asset. Authenticate for the same Workspace when reading or managing it. |
asset_idrequired | stringCase-sensitive, canonical 22-character Base64URL DAM identifier. Validation pattern (regular expression)^[A-Za-z0-9_-]{21}[AQgw]$ |
deleted_atrequired | string | nullValidation pattern (regular expression)^(([0-9][0-9][2468][048]|[0-9][0-9][13579][26]|[0-9][0-9]0[48]|[02468][048]00|[13579][26]00)-02-29|[0-9]{4}-((0[13578]|1[02])-(0[1-9]|[12][0-9]|3[01])|(0[469]|11)-(0[1-9]|[12][0-9]|30)|(02)-(0[1-9]|1[0-9]|2[0-8])))T([01][0-9]|2[0-3]):[0-5][0-9](:[0-5][0-9](\.[0-9]+)?)?(Z)$ |
filenamerequired | string (minimum length: 1) |
folder_idrequired | string | nullCase-sensitive, canonical 22-character Base64URL DAM identifier. Validation pattern (regular expression)^[A-Za-z0-9_-]{21}[AQgw]$ |
messagerequired | string (minimum length: 1) |
okrequired | string (always: "DAM_ASSET_MOVED") |
pathrequired | string (minimum length: 1) |
updated_atrequired | stringValidation pattern (regular expression)^(([0-9][0-9][2468][048]|[0-9][0-9][13579][26]|[0-9][0-9]0[48]|[02468][048]00|[13579][26]00)-02-29|[0-9]{4}-((0[13578]|1[02])-(0[1-9]|[12][0-9]|3[01])|(0[469]|11)-(0[1-9]|[12][0-9]|30)|(02)-(0[1-9]|1[0-9]|2[0-8])))T([01][0-9]|2[0-3]):[0-5][0-9](:[0-5][0-9](\.[0-9]+)?)?(Z)$ |
Error response
JSON response body. application/json text/plain; charset=utf-8
Response body schema
Complete JSON Schema
The response may contain additional fields.
| Field | Type and description |
|---|---|
assembly_id | string |
error | string (minimum length: 1) |
http_code | number | string
|
message | stringHuman-readable explanation of the error. Its wording can vary; use the |
reason | null | string | number | boolean | Array<any value> | objectAny of the following schemas may apply: nullstringnumberbooleanArray<any value>Array<any value>Array item schemaany valueobjectobjectAdditional property schemaany value |
HTTP 400
JSON response body. application/json text/plain; charset=utf-8
Response body schema
Complete JSON Schema
Named errors and the general error format
error: "DAM_INVALID_REQUEST"
The Storage request parameters are invalid.
The response may contain additional fields.
General error format
HTTP 404
JSON response body. application/json text/plain; charset=utf-8
Response body schema
Complete JSON Schema
Named errors and the general error format
error: "DAM_RESOURCE_NOT_FOUND"
The requested DAM resource was not found.
The response may contain additional fields.
General error format
HTTP 409
JSON response body. application/json text/plain; charset=utf-8
Response body schema
Complete JSON Schema
Named errors and the general error format
error: "DAM_MUTATION_CONFLICT"
The DAM mutation conflicts with an existing resource.
The response may contain additional fields.
General error format
HTTP 500
JSON response body. application/json text/plain; charset=utf-8
Response body schema
Complete JSON Schema
Named errors and the general error format
error: "DAM_MUTATION_FAILED"
The DAM mutation could not be completed. Please try again.
The response may contain additional fields.