Déplacer ou renommer une ressource DAM
Déplace ou renomme une ressource DAM sans modifier son objet stocké.
https://api2.transloadit.com/ dam/ assets/ {assetId}Ce point de terminaison est en phase alpha. Son URL, ses paramètres, ses réponses et son comportement peuvent changer considérablement et rendre les intégrations existantes inopérantes.
Avant d’appeler ce point de terminaison, obtenez les identifiants des ressources existantes dans le même Workspace que l’Auth Key utilisée pour la requête.
Pour les fichiers stockés avec /transloadit/store, récupérez leur Assembly Status et attendez ASSEMBLY_COMPLETED. Dans les tableaux results[stepName] renvoyés, conservez les valeurs workspace, asset_id, version_id et path renvoyées pour chaque fichier stocké. L’id ordinaire du fichier n’est pas son identifiant de ressource de stockage. Utilisez asset_id pour ASSET_ID ou params.asset_ids dans les exemples ci-dessous.
Utilisez asset_id pour suivre une ressource lors des déplacements et des renommages natifs. Ajoutez version_id lors de l’importation pour sélectionner les mêmes octets conservés après un écrasement. Un chemin enregistré est un emplacement modifiable, pas une référence immuable. Les règles d’accès et de conservation des versions continuent de s’appliquer.
Pour une destination autre que la racine, vous devez déjà connaître l’identifiant du dossier existant dans le même Workspace. Une réponse de déplacement ou de renommage précédemment enregistrée peut fournir cet identifiant : folder_id dans une réponse concernant une seule ressource ou assets[].folder_id dans une réponse de déplacement en masse. Ces réponses décrivent le dossier après cette opération ; elles ne constituent pas une API de découverte des dossiers.
Si vous connaissez les chemins plutôt que les identifiants des dossiers, utilisez Déplacer un fichier ou un dossier de stockage. Le dossier parent de destination doit déjà exister. Pour déplacer une ressource à la racine avec ce point de terminaison fondé sur les identifiants, utilisez destination_folder_id: null.
Incluez au moins l’un des paramètres filename ou destination_folder_id dans params. Un nom de fichier doit être un nom sans chemin de dossier.
Pour renommer une ressource dans son dossier actuel, envoyez uniquement filename dans params, comme dans l’exemple de requête ci-dessous.
Pour déplacer la ressource à la racine à la place, incluez explicitement destination_folder_id: null :
{ "destination_folder_id": null, "filename": "renamed.jpg" }
Pour un autre dossier, remplacez null par l’identifiant de ce dossier. L’omission et null correspondent à des opérations différentes.
Limites des chemins des ressources
Le chemin de destination complet (dossiers et nom de fichier) ne doit pas dépasser 512 points de code Unicode et 1024 octets UTF-8 après normalisation. Un nom de fichier qui respecte ces limites à lui seul peut néanmoins les dépasser dans un dossier imbriqué.
Exemple de requête
Attribuez à ASSET_ID la valeur de votre ressource sans l’encoder en pourcentage.
Exécutez cette requête dans un shell côté serveur avec curl et un jeton porteur approprié dans TRANSLOADIT_TOKEN. Si vous avez besoin d’un jeton, développez la section de configuration ci-dessous.
Besoin d’un jeton porteur ?
Dans un shell de confiance côté serveur disposant de curl et de jq, attribuez à TRANSLOADIT_KEY et à TRANSLOADIT_SECRET les valeurs de votre Auth Key et de votre Auth Secret. Gardez ces deux informations d’identification et le jeton obtenu secrets ; n’exécutez jamais cette configuration dans du code de navigateur.
Créez d’abord un jeton avec les portées requises par ce point de terminaison. Votre Auth Key doit déjà accorder ces portées.
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
Gardez ce shell ouvert et exécutez la requête ci-dessous. Réutilisez le jeton tant qu’il reste valide.
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"}'
Authentification
Ce point de terminaison accepte des params signés ou un jeton porteur. Consultez la section Authentification pour les instructions de configuration.
Portée requise pour l’Auth Key ou le jeton porteur : dam:write.
Les requêtes signées nécessitent à la fois une signature et un horodatage params.auth.expires situé dans le futur. Les jetons porteurs ne nécessitent ni l’un ni l’autre.
Paramètres de chemin
assetId(segment de chemin), obligatoire. motif :^[A-Za-z0-9_-]{21}[AQgw]$, longueur minimale : 22, longueur maximale : 22
Champs de formulaire
Type de contenu : application/x-www-form-urlencoded
params(Chaîne JSON), obligatoire. Un objet encodé en JSON dont les clés prises en charge sont répertoriées ci-dessous.signature(chaîne de caractères). Obligatoire pour les requêtes signées. Omettez ce champ lorsque vous utilisez un jeton porteur.
Clés prises en charge dans le champ params
Les champs d’authentification de cette liste s’appliquent aux requêtes signées. Avec un jeton porteur, vous pouvez omettre params.auth et le champ distinct signature. Comparez les paramètres de requête spécifiques à l’authentification ci-dessous.
Schéma JSON complet
params: Seuls les champs répertoriés pour cet objet sont acceptés.
| Champ | Type et description |
|---|---|
params.obligatoire pour les requêtes signées ; facultatif avec un jeton porteur | Contient la clé API Transloadit et les métadonnées de Signature Authentication pour une mutation DAM.
|
params.obligatoire | stringHorodatage d’expiration au format ISO 8601 situé dans le futur. Obligatoire lorsqu’une requête est signée ou nécessite Signature Authentication ; les requêtes authentifiées par jeton porteur peuvent l’omettre. |
params.obligatoire | stringClé API Transloadit utilisée pour authentifier les requêtes |
params. | string | nullID du dossier de destination. Définissez ce paramètre sur N’importe lequel des schémas suivants peut s’appliquer : stringstringIdentifiant DAM canonique de 22 caractères au format Base64URL, sensible à la casse. Motif de validation (expression régulière)^[A-Za-z0-9_-]{21}[AQgw]$null |
params. | string (longueur minimale : 1, longueur maximale : 255)Nouveau nom de fichier sans chemin de dossier. Les noms sont normalisés en Unicode NFC et restent sensibles à la casse. Les noms composés uniquement de caractères d’espacement et les noms |
params. | string | integerValeur unique et aléatoire incluse dans les paramètres de la requête signée pour rendre chaque signature unique et empêcher la réutilisation accidentelle d’une signature. |
Paramètres de requête par méthode d’authentification
Avec des paramètres signés
Incluez votre Auth Key dans params.auth.key. Lors de la signature de la requête, incluez un horodatage futur dans params.auth.expires et envoyez la signature dans le champ distinct signature. Les définitions des champs ci-dessous utilisent des chemins à l’intérieur de params.
Schéma JSON complet
params: Seuls les champs répertoriés pour cet objet sont acceptés.
Utilise les définitions des champs ci-dessus : params.auth, params.destination_folder_id, params.filename, params.nonce
Avec un jeton porteur
Envoyez le jeton porteur dans l’en-tête Authorization. Vous pouvez omettre params.auth et le champ distinct signature. Les autres paramètres obligatoires restent requis. Les définitions des champs ci-dessous utilisent des chemins à l’intérieur de params.
Schéma JSON complet
params: Seuls les champs répertoriés pour cet objet sont acceptés.
Utilise les définitions des champs ci-dessus : params.destination_folder_id, params.filename, params.nonce
| Champ | Type et description |
|---|---|
params. | Contient la clé API Transloadit et les métadonnées de Signature Authentication pour une mutation DAM.
|
params. | stringHorodatage d’expiration au format ISO 8601 situé dans le futur. Obligatoire lorsqu’une requête est signée ou nécessite Signature Authentication ; les requêtes authentifiées par jeton porteur peuvent l’omettre. |
params. | stringClé API Transloadit utilisée pour authentifier les requêtes |
Réponse
Voici un exemple de corps de réponse :
{
"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"
}Succès 2xx
Corps de la réponse JSON. application/json text/plain; charset=utf-8
Schéma du corps de la réponse
Schéma JSON complet
La réponse contient uniquement les champs répertoriés pour cet objet.
| Champ | Type et description |
|---|---|
assetobligatoire |
|
asset.obligatoire | stringIdentifiant stable de la ressource. Il reste inchangé lors des déplacements et renommages natifs ; utilisez-le sans version pour sélectionner les octets actuels. Motif de validation (expression régulière)^[A-Za-z0-9_-]{21}[AQgw]$ |
asset. | booleanIndique si l’image possède un canal alpha, même si tous ses pixels sont opaques. Présent lorsque l’extraction ThumbHash réussit ; son absence signifie que l’information est inconnue. |
asset. | integer (minimum exclusif : 0, maximum : 9007199254740991)Hauteur d’affichage en pixels, après application de l’orientation EXIF, lorsqu’elle est connue. |
asset. | stringSomme de contrôle MD5 en minuscules des octets stockés, lorsqu’elle est disponible. Motif de validation (expression régulière)^[a-f0-9]{32}$ |
asset.obligatoire | null | stringType MIME des octets stockés, ou null si ce type est inconnu. |
asset.obligatoire | string (longueur minimale : 1)Emplacement actuel modifiable, relatif au Workspace. Un renommage rend le chemin précédent obsolète ; un écrasement peut modifier les octets à ce chemin. |
asset. | stringSomme de contrôle SHA-256 en minuscules des octets stockés, lorsqu’elle est disponible. Motif de validation (expression régulière)^[a-f0-9]{64}$ |
asset.obligatoire | integer (minimum : 0, maximum : 9007199254740991)Taille du fichier stocké en octets. |
asset. | stringThumbHash encodé en Base64 des pixels affichés de cette version, lorsqu’il est demandé avec output_meta.thumbhash sur le Step qui l’a produite. Il s’agit de données d’image : appliquez les mêmes contrôles d’accès que pour l’original. Motif de validation (expression régulière)^(?:[A-Za-z0-9+/]{4}){1,15}(?:[A-Za-z0-9+/]{4}|[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)$ |
asset.obligatoire | stringVersion exacte et immuable de cette ressource. Associez-la à asset_id pour sélectionner les octets conservés ; une version manquante n’entraîne jamais de repli vers la version actuelle. Motif de validation (expression régulière)^[A-Za-z0-9_-]{21}[AQgw]$ |
asset. | integer (minimum exclusif : 0, maximum : 9007199254740991)Largeur d’affichage en pixels, après application de l’orientation EXIF, lorsqu’elle est connue. |
asset.obligatoire | string (longueur minimale : 1)Slug du Workspace propriétaire de cette ressource. Authentifiez-vous pour ce même Workspace lorsque vous la consultez ou la gérez. |
asset_idobligatoire | stringIdentifiant DAM canonique de 22 caractères au format Base64URL, sensible à la casse. Motif de validation (expression régulière)^[A-Za-z0-9_-]{21}[AQgw]$ |
deleted_atobligatoire | string | nullMotif de validation (expression régulière)^(([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)$ |
filenameobligatoire | string (longueur minimale : 1) |
folder_idobligatoire | string | nullIdentifiant DAM canonique de 22 caractères au format Base64URL, sensible à la casse. Motif de validation (expression régulière)^[A-Za-z0-9_-]{21}[AQgw]$ |
messageobligatoire | string (longueur minimale : 1) |
okobligatoire | string (toujours : "DAM_ASSET_MOVED") |
pathobligatoire | string (longueur minimale : 1) |
updated_atobligatoire | stringMotif de validation (expression régulière)^(([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)$ |
Réponse d’erreur
Corps de la réponse JSON. application/json text/plain; charset=utf-8
Schéma du corps de la réponse
Schéma JSON complet
La réponse peut contenir des champs supplémentaires.
| Champ | Type et description |
|---|---|
assembly_id | string |
error | string (longueur minimale : 1) |
http_code | number | string
|
message | stringExplication de l’erreur destinée à être lue par un humain. Sa formulation peut varier ; utilisez le code |
reason | null | string | number | boolean | Array<n’importe quelle valeur> | objectN’importe lequel des schémas suivants peut s’appliquer : nullstringnumberbooleanArray<n’importe quelle valeur>Array<n’importe quelle valeur>Schéma d’un élément de tableaun’importe quelle valeurobjectobjectSchéma de la propriété supplémentairen’importe quelle valeur |
HTTP 400
Corps de la réponse JSON. application/json text/plain; charset=utf-8
Schéma du corps de la réponse
Schéma JSON complet
Erreurs nommées et format général des erreurs
error: "DAM_INVALID_REQUEST"
Les paramètres de la requête de stockage ne sont pas valides.
La réponse peut contenir des champs supplémentaires.
Format général des erreurs
HTTP 404
Corps de la réponse JSON. application/json text/plain; charset=utf-8
Schéma du corps de la réponse
Schéma JSON complet
Erreurs nommées et format général des erreurs
error: "DAM_RESOURCE_NOT_FOUND"
La ressource DAM demandée n’a pas été trouvée.
La réponse peut contenir des champs supplémentaires.
Format général des erreurs
HTTP 409
Corps de la réponse JSON. application/json text/plain; charset=utf-8
Schéma du corps de la réponse
Schéma JSON complet
Erreurs nommées et format général des erreurs
error: "DAM_MUTATION_CONFLICT"
La mutation DAM entre en conflit avec une ressource existante.
La réponse peut contenir des champs supplémentaires.
Format général des erreurs
HTTP 500
Corps de la réponse JSON. application/json text/plain; charset=utf-8
Schéma du corps de la réponse
Schéma JSON complet
Erreurs nommées et format général des erreurs
error: "DAM_MUTATION_FAILED"
La modification du DAM n’a pas pu être effectuée. Veuillez réessayer.
La réponse peut contenir des champs supplémentaires.