Transloadit

Récupérer la liste des Templates

Liste les Templates disponibles pour le Workspace authentifié.

GEThttps://api2.transloadit.com/templates

Exemple de requête

Les Workspaces résiliés ne peuvent pas créer de nouveaux jetons porteurs. Ce point de terminaison reste accessible avec une Auth Key active existante : utilisez la procédure de lecture signée à la place de la configuration du jeton ci-dessous. La clé doit accorder les portées requises par ce point de terminaison.

Exécutez cette requête dans un shell côté serveur avec curl et un jeton porteur adapté 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, définissez TRANSLOADIT_KEY et TRANSLOADIT_SECRET avec 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 exécuté dans le 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=templates:read')"; 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 GET --get \
  --url "https://api2.transloadit.com/templates" \
  --header "Authorization: Bearer ${TRANSLOADIT_TOKEN:?Set TRANSLOADIT_TOKEN}" \
  --data-urlencode 'params={}'

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 : templates:read.

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 requête

  • params (Chaîne JSON). 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 signé 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

Ouvrir le JSON dans un nouvel onglet

params: Seuls les champs répertoriés pour cet objet sont acceptés.

ChampType et description
params.auth

obligatoire pour les requêtes signées ; facultatif avec un jeton porteur

object

Contient la clé API Transloadit et les métadonnées de Signature Authentication pour une requête de Template.

params.auth: Seuls les champs répertoriés pour cet objet sont acceptés.

params.auth.expires

obligatoire

string

Horodatage 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.auth.key

obligatoire

string

Clé API Transloadit utilisée pour authentifier les requêtes

params.fromdate
string

Spécifie la date et l’heure de création minimales en UTC pour les Templates du Workspace. Seuls les Templates du Workspace créés à cet instant ou après sont renvoyés ; les Builtin Templates ne sont pas filtrés par date de création. Utilisez un horodatage UTC tel que 2026-08-01 00:00:00 (YYYY-MM-DD HH:mm:ss).

params.include_builtin
"all" | "exclusively-all" | "exclusively-latest" | "latest" | "none" (par défaut : "none")

Détermine si les Builtin Templates sont inclus. Utilisez latest (recommandé) ou all ; ajoutez le préfixe exclusively- à l’une ou l’autre de ces valeurs pour ne renvoyer que des Builtin Templates. Les Builtin Templates apparaissent avant les Templates du Workspace dans l’ordre du catalogue et partagent la pagination demandée. Les paramètres sort, order, fromdate et todate s’appliquent uniquement aux Templates du Workspace.

params.keywords
string | Array<string> (par défaut : "")

Filtre les noms des Templates du Workspace à l’aide d’un motif SQL LIKE encadré par %. Dans votre valeur, % correspond à n’importe quelle séquence de caractères et _ correspond à un caractère. Privilégiez une seule chaîne. Les tableaux de chaînes restent acceptés pour les clients déjà publiés et sont joints par des virgules pour former un seul motif, et non des termes de recherche distincts. Les slugs des Builtin Templates utilisent plutôt une recherche de sous-chaîne littérale insensible à la casse ; % et _ ne sont pas des caractères génériques pour les Builtin Templates.

N’importe lequel des schémas suivants peut s’appliquer :

string
Array<string>
Array<string>
Schéma d’un élément de tableau
string
params.nonce
string | integer

Valeur 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.

params.order
"asc" | "desc" (par défaut : "desc")

Spécifie le sens de tri des Templates du Workspace. Ne modifie pas l’ordre des Builtin Templates. La valeur par défaut est desc.

params.page
integer (par défaut : 1, minimum : 1, maximum : 9007199254740991)

Indique la page actuelle dans la pagination en cours. La valeur par défaut est 1.

params.pagesize
integer (par défaut : 850, minimum : 1, maximum : 850)

Indique le nombre de Templates à renvoyer par requête API. La valeur par défaut est 850.

params.sort
"created" | "id" | "last_used" | "modified" | "name" (par défaut : "created")

Spécifie le champ utilisé pour trier les Templates du Workspace. Ne modifie pas l’ordre des Builtin Templates. La valeur par défaut est created.

params.todate
string

Indique la date et l’heure de création maximales en UTC pour les Templates du Workspace. Seuls les Templates du Workspace créés à cet instant ou avant sont renvoyés ; les Builtin Templates ne sont pas filtrés par date de création. Utilisez un horodatage UTC tel que 2026-08-01 00:00:00 (YYYY-MM-DD HH:mm:ss).

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

Ouvrir le JSON dans un nouvel onglet

params: Seuls les champs répertoriés pour cet objet sont acceptés.

Utilise les définitions des champs ci-dessus : params.auth, params.fromdate, params.include_builtin, params.keywords, params.nonce, params.order, params.page, params.pagesize, params.sort, params.todate

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

Ouvrir le JSON dans un nouvel onglet

params: Seuls les champs répertoriés pour cet objet sont acceptés.

Utilise les définitions des champs ci-dessus : params.fromdate, params.include_builtin, params.keywords, params.nonce, params.order, params.page, params.pagesize, params.sort, params.todate

ChampType et description
params.auth
object

Contient la clé API Transloadit et les métadonnées de Signature Authentication pour une requête de Template.

params.auth: Seuls les champs répertoriés pour cet objet sont acceptés.

params.auth.expires
string

Horodatage 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.auth.key
string

Clé API Transloadit utilisée pour authentifier les requêtes

Réponse

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

Ouvrir le JSON dans un nouvel onglet

La réponse contient uniquement les champs répertoriés pour cet objet.

ChampType et description
count

obligatoire

integer (minimum : 0)
items

obligatoire

Array<object>
Schéma d’un élément de tableau
object

items[]: La réponse contient uniquement les champs répertoriés pour cet objet.

ChampType et description
items[].account_id
null | string
items[].assembly_status_expiry
null | string
items[].builtin_version
string
items[].content

obligatoire

object | Array<n’importe quelle valeur> | string | number | boolean | null

Des détails supplémentaires sur le schéma sont disponibles dans le schéma JSON complet.

items[].created
string | null
Motif 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)$
items[].deleted
null
items[].description
string
items[].encryption_version
integer | null
items[].id
string

N’importe lequel des schémas suivants peut s’appliquer :

Variante 1: string (longueur maximale : 32)
string
Motif de validation (expression régulière)^[\x00-\x7F]*$
Variante 2: string (longueur maximale : 32)
string
Motif de validation (expression régulière)^builtin\/[a-z0-9-]+(?:@[0-9a-z.-]+)?$
items[].json
null
items[].last_used
string | null
Motif 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)$
items[].modified
string | null
Motif 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)$
items[].name
string (longueur minimale : 1, longueur maximale : 255)
items[].require_signature_auth
0 | 1
items[].transcoding_result_expiry
null | string

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

Ouvrir le JSON dans un nouvel onglet

Au moins une de ces propriétés est requise : error, message, reason

La réponse peut contenir des champs supplémentaires.

ChampType et description
assembly_id
string
error
string (longueur minimale : 1)
http_code
number | string
  • number
  • string
    Motif de validation (expression régulière)^[\x09-\x0D\x20\xA0\u1680\u2000\u2001\u2002\u2003\u2004\u2005\u2006\u2007\u2008\u2009\u200a\u2028\u2029\u202f\u205f\u3000\ufeff]*[+-]?0*(?:0(?:[^0-9]|$)|(?:[1-9][0-9]{0,307}|1(?:(?:[0-6][0-9]{7}|7[0-8][0-9]{6}|79[0-6][0-9]{5}|797[0-5][0-9]{4}|7976[0-8][0-9]{3}|79769[0-2][0-9]{2}|7976930[0-9]{1}|7976931[0-2])[0-9]{300}|79769313(?:(?:[0-3][0-9]{7}|4[0-7][0-9]{6}|48[0-5][0-9]{5}|486[0-1][0-9]{4}|4862[0-2][0-9]{3}|486230[0-9]{2}|486231[0-4][0-9]{1}|4862315[0-7])[0-9]{292}|48623158(?:(?:0[0-6][0-9]{6}|07[0-8][0-9]{5}|079[0-2][0-9]{4}|0793[0-6][0-9]{3}|07937[0-1][0-9]{2}|079372[0-7][0-9]{1}|0793728[0-8])[0-9]{284}|07937289(?:(?:[0-6][0-9]{7}|70[0-9]{6}|71[0-3][0-9]{5}|7140[0-4][0-9]{3}|71405[0-2][0-9]{2}|7140530[0-2])[0-9]{276}|71405303(?:(?:[0-3][0-9]{7}|40[0-9]{6}|41[0-4][0-9]{5}|4150[0-6][0-9]{3}|41507[0-8][0-9]{2}|415079[0-8][0-9]{1}|4150799[0-2])[0-9]{268}|41507993(?:(?:[0-3][0-9]{7}|40[0-9]{6}|41[0-2][0-9]{5}|413[0-1][0-9]{4}|4132[0-6][0-9]{3}|413270[0-9]{2})[0-9]{260}|41327100(?:(?:[0-2][0-9]{7}|3[0-6][0-9]{6}|37[0-7][0-9]{5}|378[0-1][0-9]{4}|3782[0-5][0-9]{3}|37826[0-8][0-9]{2}|378269[0-2][0-9]{1}|3782693[0-5])[0-9]{252}|37826936(?:(?:0[0-9]{7}|1[0-6][0-9]{6}|17[0-2][0-9]{5}|173[0-6][0-9]{4}|1737[0-6][0-9]{3}|17377[0-7][0-9]{2}|173778[0-8][0-9]{1}|1737789[0-7])[0-9]{244}|17377898(?:(?:0[0-3][0-9]{6}|04[0-3][0-9]{5}|044[0-3][0-9]{4}|0444[0-8][0-9]{3}|04449[0-5][0-9]{2}|044496[0-7][0-9]{1}|0444968[0-1])[0-9]{236}|04449682(?:(?:[0-8][0-9]{7}|9[0-1][0-9]{6}|92[0-6][0-9]{5}|927[0-5][0-9]{4}|9276[0-3][0-9]{3}|92764[0-6][0-9]{2}|927647[0-4][0-9]{1})[0-9]{228}|92764750(?:(?:[0-8][0-9]{7}|9[0-3][0-9]{6}|94[0-5][0-9]{5}|946[0-5][0-9]{4}|9466[0-3][0-9]{3}|94664[0-8][0-9]{2}|94664900)[0-9]{220}|94664901(?:(?:[0-6][0-9]{7}|7[0-8][0-9]{6}|79[0-6][0-9]{5}|797[0-6][0-9]{4}|7977[0-4][0-9]{3}|79775[0-7][0-9]{2}|797758[0-6][0-9]{1}|7977587[0-1])[0-9]{212}|79775872(?:(?:0[0-6][0-9]{6}|070[0-8][0-9]{4}|0709[0-5][0-9]{3}|07096[0-2][0-9]{2}|070963[0-2][0-9]{1})[0-9]{204}|07096330(?:(?:[0-1][0-9]{7}|2[0-7][0-9]{6}|28[0-5][0-9]{5}|286[0-3][0-9]{4}|28640[0-9]{3}|28641[0-5][0-9]{2}|286416[0-5][0-9]{1}|2864166[0-8])[0-9]{196}|28641669(?:(?:[0-1][0-9]{7}|2[0-7][0-9]{6}|28[0-7][0-9]{5}|288[0-6][0-9]{4}|2887[0-8][0-9]{3}|288790[0-9]{2}|2887910[0-8])[0-9]{188}|28879109(?:(?:[0-3][0-9]{7}|4[0-5][0-9]{6}|46[0-4][0-9]{5}|465[0-4][0-9]{4}|4655[0-4][0-9]{3}|46555[0-4][0-9]{2}|465555[0-3][0-9]{1}|4655554[0-6])[0-9]{180}|46555547(?:(?:[0-7][0-9]{7}|8[0-4][0-9]{6}|850[0-9]{5}|851[0-8][0-9]{4}|8519[0-3][0-9]{3}|851940[0-3][0-9]{1})[0-9]{172}|85194040(?:(?:[0-1][0-9]{7}|2[0-5][0-9]{6}|26[0-2][0-9]{5}|2630[0-5][0-9]{3}|26306[0-4][0-9]{2}|263065[0-6][0-9]{1}|2630657[0-3])[0-9]{164}|26306574(?:(?:[0-7][0-9]{7}|8[0-7][0-9]{6}|88[0-5][0-9]{5}|886[0-6][0-9]{4}|88670[0-9]{3}|88671[0-4][0-9]{2}|8867150[0-4])[0-9]{156}|88671505(?:(?:[0-7][0-9]{7}|8[0-1][0-9]{6}|820[0-5][0-9]{4}|8206[0-7][0-9]{3}|820680[0-9]{2}|820681[0-8][0-9]{1})[0-9]{148}|82068190(?:(?:[0-7][0-9]{7}|8[0-8][0-9]{6}|890[0-1][0-9]{4}|8902000[0-6])[0-9]{140}|89020007(?:(?:0[0-7][0-9]{6}|08[0-2][0-9]{5}|083[0-7][0-9]{4}|0838[0-2][0-9]{3}|08383[0-5][0-9]{2}|083836[0-6][0-9]{1}|0838367[0-5])[0-9]{132}|08383676(?:(?:[0-1][0-9]{7}|2[0-6][0-9]{6}|27[0-2][0-9]{5}|273[0-7][0-9]{4}|2738[0-4][0-9]{3}|27385[0-3][0-9]{2}|273854[0-7][0-9]{1}|2738548[0-3])[0-9]{124}|27385484(?:(?:[0-4][0-9]{7}|5[0-7][0-9]{6}|580[0-9]{5}|581[0-6][0-9]{4}|5817[0-6][0-9]{3}|581770[0-9]{2}|5817710[0-9]{1}|5817711[0-4])[0-9]{116}|58177115(?:(?:[0-2][0-9]{7}|30[0-9]{6}|31[0-6][0-9]{5}|317[0-5][0-9]{4}|3176[0-3][0-9]{3}|31764[0-3][0-9]{2}|317644[0-6][0-9]{1}|3176447[0-4])[0-9]{108}|31764475(?:(?:[0-6][0-9]{7}|7[0-2][0-9]{6}|730[0-1][0-9]{4}|7302[0-6][0-9]{3}|7302700[0-5])[0-9]{100}|73027006(?:(?:[0-8][0-9]{7}|9[0-7][0-9]{6}|98[0-4][0-9]{5}|985[0-4][0-9]{4}|9855[0-4][0-9]{3}|98555[0-6][0-9]{2}|9855570[0-9]{1}|9855571[0-2])[0-9]{92}|98555713(?:(?:[0-5][0-9]{7}|6[0-5][0-9]{6}|66[0-8][0-9]{5}|669[0-4][0-9]{4}|6695[0-8][0-9]{3}|66959[0-5][0-9]{2}|669596[0-1][0-9]{1}|6695962[0-1])[0-9]{84}|66959622(?:(?:[0-7][0-9]{7}|8[0-3][0-9]{6}|84[0-1][0-9]{5}|842[0-8][0-9]{4}|84290[0-9]{3}|84291[0-3][0-9]{2}|842914[0-7][0-9]{1}|84291480)[0-9]{76}|84291481(?:(?:[0-8][0-9]{7}|9[0-7][0-9]{6}|98[0-5][0-9]{5}|9860[0-7][0-9]{3}|98608[0-2][0-9]{2}|986083[0-3][0-9]{1}|9860834[0-8])[0-9]{68}|98608349(?:(?:[0-2][0-9]{7}|3[0-5][0-9]{6}|36[0-3][0-9]{5}|364[0-6][0-9]{4}|3647[0-4][0-9]{3}|36475[0-1][0-9]{2}|364752[0-8][0-9]{1}|3647529[0-1])[0-9]{60}|36475292(?:(?:[0-6][0-9]{7}|70[0-9]{6}|71[0-8][0-9]{5}|7190[0-6][0-9]{3}|71907[0-3][0-9]{2}|7190740[0-9]{1}|7190741[0-5])[0-9]{52}|71907416(?:(?:[0-7][0-9]{7}|8[0-3][0-9]{6}|84[0-3][0-9]{5}|844[0-3][0-9]{4}|8444[0-2][0-9]{3}|84443[0-5][0-9]{2}|844436[0-4][0-9]{1}|8444365[0-4])[0-9]{44}|84443655(?:(?:0[0-9]{7}|10[0-6][0-9]{5}|1070[0-3][0-9]{3}|10704[0-2][0-9]{2}|107043[0-3][0-9]{1}|1070434[0-1])[0-9]{36}|10704342(?:(?:[0-6][0-9]{7}|70[0-9]{6}|710[0-9]{5}|711[0-4][0-9]{4}|7115[0-4][0-9]{3}|71155[0-8][0-9]{2}|711559[0-5][0-9]{1}|7115596[0-8])[0-9]{28}|71155969(?:(?:[0-8][0-9]{7}|9[0-4][0-9]{6}|950[0-7][0-9]{4}|95080[0-8][0-9]{2}|950809[0-2][0-9]{1})[0-9]{20}|95080930(?:(?:[0-3][0-9]{7}|4[0-1][0-9]{6}|42[0-7][0-9]{5}|428[0-7][0-9]{4}|428800[0-9]{2}|428801[0-6][0-9]{1}|4288017[0-6])[0-9]{12}|42880177(?:(?:[0-8][0-9]{7}|90[0-3][0-9]{5}|9040[0-9]{4}|9041[0-6][0-9]{3}|90417[0-3][0-9]{2}|904174[0-3][0-9]{1}|9041744[0-8])[0-9]{4}|90417449(?:(?:[0-6][0-9]{3}|7[0-6][0-9]{2}|77[0-8][0-9]{1}|7790)|7791))))))))))))))))))))))))))))))))))))))))(?:[^0-9]|$))
message
string

Explication de l’erreur destinée à être lue par un humain. Sa formulation peut varier ; utilisez le code error pour gérer un échec spécifique.

reason
null | string | number | boolean | Array<n’importe quelle valeur> | object

N’importe lequel des schémas suivants peut s’appliquer :

null
string
number
boolean
Array<n’importe quelle valeur>
Array<n’importe quelle valeur>
Schéma d’un élément de tableau
n’importe quelle valeur
object
object
Schéma de la propriété supplémentaire
n’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

Ouvrir le JSON dans un nouvel onglet

Erreurs nommées et format général des erreurs

error: "TEMPLATE_LIST_ERROR"

Paramètres incorrects.

La réponse peut contenir des champs supplémentaires.

ChampType et description
error

obligatoire

string (toujours : "TEMPLATE_LIST_ERROR")
http_code
number (toujours : 400)
message
string

Explication de l’erreur destinée à être lue par un humain. Sa formulation peut varier ; utilisez le code error pour gérer un échec spécifique.

Format général des erreurs

Consultez les champs généraux des réponses d’erreur.