Créer une Assembly avec un ID fourni
Crée une Assembly avec un nouvel identifiant d’Assembly choisi par l’appelant.
https://api2.transloadit.com/ assemblies/ {assemblyId}Crée une Assembly à l’aide d’un nouvel identifiant fourni par l’appelant. Cela ne remplace pas une Assembly existante.
Vous ne devez jamais réutiliser un identifiant d’Assembly, y compris après l’expiration ou la suppression d’une Assembly.
Un conflit avec un identifiant actif peut renvoyer ASSEMBLY_COULD_NOT_BE_CREATED ; une utilisation antérieure enregistrée peut
renvoyer DO_NOT_REUSE_ASSEMBLY_IDS. Ces vérifications ne constituent pas une garantie de déduplication permanente.
Ce point de terminaison n’est pas un mécanisme de nouvelle tentative idempotent.
Flux de travail type :
- Envoyez l’exemple de requête ci-dessous avec votre fichier et vos Instructions de traitement. Pour recevoir
le statut final via un webhook, incluez
notify_urldans ces Instructions avant d’envoyer la requête. - Gardez secrète la valeur
assembly_ssl_urlrenvoyée. Utilisez-la pour consulter la progression, ou attendez le webhook que vous avez configuré. - Attendez
ok: "ASSEMBLY_COMPLETED"avant d’exploiter les fichiers traités. Uneerrorou une annulation ne constitue pas un traitement réussi. Les fichiers de sortie sont regroupés par nom de Step dansresults; consultez les champs de la réponse.
Les Assemblies qui utilisent /transloadit/import, directement ou via un Template, exigent
soit un jeton porteur, soit des params signés avec un horodatage params.auth.expires situé dans le futur.
Cela s’applique même lorsque la Signature Authentication du Workspace est désactivée. Une Auth Key seule
ne suffit pas ; les requêtes authentifiées par jeton porteur n’ont pas besoin d’une signature ni d’une expiration distinctes.
Utilisez Rejouer une Assembly pour relancer le traitement des entrées récupérables sous la forme d’une nouvelle Assembly, ou Annuler une Assembly pour arrêter une Assembly existante.
Exemple de requête
La requête ci-dessous utilise openssl pour générer un nouvel identifiant d’Assembly imprévisible. Générez un nouvel identifiant pour chaque requête ; n’en réutilisez jamais un.
Exécutez cette requête dans un shell côté serveur disposant de curl et d’un jeton porteur adapté dans TRANSLOADIT_TOKEN. Si vous avez besoin d’un jeton, dépliez la configuration ci-dessous.
Placez votre fichier d’entrée à l’emplacement ./example.jpg avant d’exécuter la requête.
Besoin d’un jeton porteur ?
Dans un shell côté serveur de confiance disposant de curl et de jq, définissez TRANSLOADIT_KEY et TRANSLOADIT_SECRET sur votre Auth Key et votre Auth Secret. Gardez secrets ces deux informations d’identification ainsi que le jeton obtenu ; n’exécutez jamais cette configuration dans du code exécuté dans le navigateur.
Commencez par créer 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=assemblies: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.
ASSEMBLY_ID="$(openssl rand -hex 16)" || exit 1
curl --fail-with-body -sS --request PUT \
--url "https://api2.transloadit.com/assemblies/${ASSEMBLY_ID:?Set ASSEMBLY_ID}" \
--header "Authorization: Bearer ${TRANSLOADIT_TOKEN:?Set TRANSLOADIT_TOKEN}" \
--form-string 'params={"steps":{"resize":{"robot":"/image/resize","use":":original","width":320}}}' \
--form 'file=@./example.jpg'
Ce qui se passe ensuite
Une réponse HTTP réussie indique que l’Assembly est acceptée ; elle ne signifie pas que le traitement est terminé. Une réponse initiale peut ressembler à ceci (extrait ; les identifiants et les URL seront différents) :
{
"ok": "ASSEMBLY_EXECUTING",
"assembly_id": "0fce5b1063e611e88d8eb130f7921d8a",
"assembly_ssl_url": "https://api2-morven.transloadit.com/assemblies/0fce5b1063e611e88d8eb130f7921d8a",
"results": {}
}
Copiez assembly_ssl_url depuis votre réponse et vérifiez son statut
toutes les quelques secondes, ou utilisez un webhook configuré avant la création.
Gardez cette URL secrète. Arrêtez-vous en cas d’error ou d’annulation ; ni l’une ni l’autre ne constitue un traitement réussi.
Lorsque ok vaut ASSEMBLY_COMPLETED, la sortie de cet exemple se trouve dans results.resize.
Une réponse terminée comprend les champs suivants (extrait ; l’URL de sortie est donnée à titre d’illustration) :
{
"ok": "ASSEMBLY_COMPLETED",
"message": "The Assembly was successfully completed.",
"assembly_id": "0fce5b1063e611e88d8eb130f7921d8a",
"results": {
"resize": [
{
"name": "example.jpg",
"mime": "image/jpeg",
"ssl_url": "https://example.com/temporary-output/example.jpg",
"meta": {
"width": 320
}
}
]
}
}
Utilisez results.resize[0].ssl_url pour télécharger l’image redimensionnée. Ces URL de sortie temporaires
expirent ; ajoutez un Step d’exportation tel que /s3/store (English) si vous devez conserver les fichiers.
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 : assemblies:write.
Les requêtes authentifiées par clé nécessitent une signature lorsque Signature Authentication est activée. Les jetons porteurs ne nécessitent pas de signature distincte.
Paramètres de chemin
assemblyId(segment de chemin), obligatoire. motif :^[a-z0-9]{32}$
Paramètres de requête facultatifs pour la réponse
callback(Nom de la fonction de rappel JavaScript). Encapsule les réponses JSON dans une fonction de rappel JSONP. Le nom de la fonction de rappel doit correspondre à^(?:_jqjsp[0-9]*|jQuery[0-9]+_[0-9]+)$. Seule la dernière occurrence est utilisée ; une valeur vide est ignorée. Les noms de fonction de rappel invalides renvoient le statut HTTP 403. La réponse transformée utilise le statut HTTP 200. La fonction de rappel est appliquée après la sérialisation de la réponse.
Champs de formulaire multipart
Type de contenu : multipart/form-data
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 lorsque la requête utilise Signature Authentication.num_expected_upload_files(champ de formulaire). Lorsque vous utilisez des téléversements avec reprise, ce champ indique le nombre de fichiers qui seront téléversés. Pour plus de détails, consultez Téléversements avec reprise.tus_num_expected_upload_files(champ de formulaire). Ancien alias denum_expected_upload_files, conservé pour la compatibilité avec les anciens SDK.*(binaire ou chaîne de caractères). Les fichiers binaires et les champs supplémentaires d’une Assembly peuvent utiliser des noms de champs arbitraires.
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
Paramètres signés utilisés pour créer une Assembly à partir de Steps directs ou d’un Template.
| Champ | Type et description |
|---|---|
params.obligatoire pour les requêtes signées ; facultatif avec un jeton porteur | Métadonnées d’authentification et contraintes de téléversement pour une requête d’Assembly signée. La clé d’API est obligatoire. Contient au minimum votre Auth Key Transloadit dans la propriété Si vous activez Signature Authentication, vous devez également définir une date d’expiration pour la requête dans la propriété expires : Nous vous recommandons vivement d’inclure une valeur La propriété Les téléversements sans referer passent toujours (car il est désactivé dans certains navigateurs), si bien que cette propriété n’est utile que dans une poignée de cas d’usage. Pour en savoir plus sur les expressions régulières, consultez la documentation RegExp de Mozilla. Les expressions régulières invalides et les expressions qui dépassent la limite de temps d’évaluation sont rejetées. Cette vérification ne remplace pas Signature Authentication : les clients peuvent omettre ou falsifier l’en-tête Referer. La propriété La propriété Ces propriétés peuvent être définies dans la requête d’Assembly ou dans le Template.
|
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.obligatoire | stringClé API Transloadit utilisée pour authentifier les requêtes |
params. | integer (minimum : 1)Nombre maximal de fichiers d’entrée autorisés par Assembly. Si le nombre de fichiers téléversés ou importés dépasse cette limite, l’Assembly sera arrêtée avec une erreur. Cette limite est utile pour prévenir les abus lorsque les informations d’authentification de Signature Authentication sont exposées. |
params. | numberTaille totale maximale attendue du téléversement pour l’Assembly, en octets, y compris la surcharge liée au corps de la requête. Il ne s’agit pas d’une limite par fichier et cela ne garantit pas le rejet avant le début d’un transfert pouvant être repris. |
params. | stringExpression régulière appliquée à un en-tête HTTP Referer fourni. Les expressions non valides et celles qui dépassent la limite de temps d’évaluation sont rejetées. Les requêtes sans en-tête Referer passent cette vérification ; utilisez Signature Authentication pour authentifier les requêtes. |
params. | booleanDéfinissez ce paramètre sur true pour publier en temps réel des événements Assembly Execution Progress. Ce paramètre est ignoré pour les Assemblies URL Transform. |
params. | stringSélectionne la pile ExifTool pour l’extraction des métadonnées dans cette Assembly. Cela ne sélectionne pas la pile de traitement des Steps de Robot. |
params. | stringSélectionne la pile FFmpeg pour l’extraction des métadonnées dans cette Assembly. Ce paramètre ne sélectionne pas la pile de traitement des Steps de Robot. Définissez |
params. | objectUn objet de valeurs associées à des clés de type chaîne (nom -> valeur), qui peuvent être utilisées comme Assembly Variables, tout comme des champs de formulaire supplémentaires. Vous pouvez utiliser comme valeur tout élément sérialisable en JSON Schéma de la propriété supplémentairen’importe quelle valeur |
params. | stringSélectionne la pile ImageMagick pour l’extraction des métadonnées dans cette Assembly. Cela ne sélectionne pas la pile de traitement des Steps de Robot. Définissez |
params. | stringSélectionne la pile MediaInfo pour l’extraction des métadonnées dans cette Assembly. Cela ne sélectionne pas la pile de traitement des Steps de Robot. |
params. | stringSélectionne la pile MPlayer pour l’extraction des métadonnées dans cette Assembly. Cela ne sélectionne pas la pile de traitement des Steps de Robot. |
params. | string | numberValeur 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. | Array<"without_params" | "without_result_meta_data" | "without_results" | "without_upload_meta_data" | "without_uploads">Contrôle la taille de la charge utile envoyée dans les Assembly Notifications. Les renvois de Notifications réutilisent les filtres fournis dans la requête initiale de l’Assembly ; les filtres définis uniquement dans un Template ne sont pas conservés lors du renvoi. Un tableau vide (valeur par défaut) envoie l’intégralité de l’Assembly Status. Ajoutez Schéma d’un élément de tableau"without_params" | "without_result_meta_data" | "without_results" | "without_upload_meta_data" | "without_uploads" |
params. | null | stringTransloadit peut envoyer un pingback à votre serveur lorsque l’Assembly est terminée. Nous enverrons l’Assembly Status sous forme de chaîne JSON dans le champ |
params. | booleanDéfinissez ce paramètre sur true pour réduire au minimum la réponse initiale à la création de l’Assembly. Une réponse réussie contient uniquement ok et assembly_id ; une réponse d’erreur conserve error, http_code, message, reason et assembly_id lorsqu’ils sont disponibles. Il s’agit d’une réduction de la réponse, et non d’un contrôle d’accès : toute personne disposant de l’identifiant d’Assembly renvoyé peut toujours récupérer l’Assembly Status complet, y compris fields et results, sans authentification supplémentaire. Traitez les identifiants d’Assembly et les URL de statut comme des capacités secrètes. L’Assembly Status complet est toujours envoyé à notify_url si ce paramètre est configuré. |
params. | stringURL vers laquelle rediriger un téléversement effectué depuis le navigateur, une fois ce téléversement terminé. L’identifiant de l’Assembly et l’URL de statut sont ajoutés en tant que paramètres de requête, tout en conservant les éventuels paramètres de requête et le fragment existants. |
params. | En-têtes de réponse personnalisés émis par une Assembly. Les surcharges CORS doivent figurer dans
|
params. | objectDes détails supplémentaires sur le schéma sont disponibles dans le schéma JSON complet. |
params. | stringÉtiquettes d’utilisation enregistrées sur une Assembly. |
N’importe lequel des schémas suivants peut s’appliquer :
propriétés requises : steps, template_id
Paramètres utilisés pour créer une Assembly à partir de Steps directs ou d’un Template.
params: Seuls les champs répertoriés pour cet objet sont acceptés.
| Champ | Type et description |
|---|---|
params.obligatoire | objectValeurs partielles de Step fusionnées dans les Steps nommés du Template enregistré. Leur structure complète, spécifique au Robot, est validée après le chargement du Template. Schéma de la propriété supplémentaireobjectDes détails supplémentaires sur le schéma sont disponibles dans le schéma JSON complet. |
params.obligatoire | string (longueur minimale : 1)L’ID du Template qui contient vos Assembly Instructions. Si vous définissez |
Variante 2
Paramètres utilisés pour créer une Assembly à partir de Steps directs ou d’un Template.
params: Seuls les champs répertoriés pour cet objet sont acceptés.
| Champ | Type et description |
|---|---|
params. | objectContient les Assembly Instructions. Schéma de la propriété supplémentaireobjectDes détails supplémentaires sur le schéma sont disponibles dans le schéma JSON complet. |
params. | stringL’ID du Template qui contient vos Assembly Instructions. Si vous définissez |
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
Paramètres signés utilisés pour créer une Assembly à partir de Steps directs ou d’un Template.
Utilise les définitions des champs ci-dessus : params.auth, params.emit_execution_progress, params.exiftool_stack, params.ffmpeg_stack, params.fields, params.imagemagick_stack, params.mediainfo_stack, params.mplayer_stack, params.nonce, params.notification_payload, params.notify_url, params.quiet, params.redirect_url, params.response_headers, params.usage_tags
N’importe lequel des schémas suivants peut s’appliquer :
propriétés requises : steps, template_id
Paramètres utilisés pour créer une Assembly à partir de Steps directs ou d’un Template.
params: Seuls les champs répertoriés pour cet objet sont acceptés.
Utilise les définitions des champs ci-dessus : params.steps, params.template_id
Variante 2
Paramètres utilisés pour créer une Assembly à partir de Steps directs ou d’un Template.
params: Seuls les champs répertoriés pour cet objet sont acceptés.
Utilise les définitions des champs ci-dessus : params.steps, params.template_id
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
Paramètres utilisés pour créer une Assembly à partir de Steps directs ou d’un Template.
Utilise les définitions des champs ci-dessus : params.emit_execution_progress, params.exiftool_stack, params.ffmpeg_stack, params.fields, params.imagemagick_stack, params.mediainfo_stack, params.mplayer_stack, params.nonce, params.notification_payload, params.notify_url, params.quiet, params.redirect_url, params.response_headers, params.usage_tags
| Champ | Type et description |
|---|---|
params. | Métadonnées d’authentification et contraintes de téléversement pour une requête d’Assembly authentifiée par Bearer. Le jeton fournit la clé d’API, la requête peut donc l’omettre. La propriété Les téléversements sans referer seront toujours acceptés (car celui-ci est désactivé dans certains navigateurs), ce qui rend cette option utile dans seulement quelques cas d’usage. Pour en savoir plus sur les expressions régulières, consultez la documentation RegExp de Mozilla. Les expressions régulières invalides et les expressions qui dépassent la limite de temps d’évaluation sont rejetées. Cette vérification ne remplace pas la Signature Authentication : les clients peuvent omettre ou falsifier l’en-tête Referer. La propriété La propriété Ces propriétés peuvent être définies dans la requête d’Assembly ou dans le Template.
|
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 |
params. | integer (minimum : 1)Nombre maximal de fichiers d’entrée autorisés par Assembly. Si le nombre de fichiers téléversés ou importés dépasse cette limite, l’Assembly sera arrêtée avec une erreur. Cette limite est utile pour prévenir les abus lorsque les informations d’authentification de Signature Authentication sont exposées. |
params. | numberTaille totale maximale attendue du téléversement pour l’Assembly, en octets, y compris la surcharge liée au corps de la requête. Il ne s’agit pas d’une limite par fichier et cela ne garantit pas le rejet avant le début d’un transfert pouvant être repris. |
params. | stringExpression régulière appliquée à un en-tête HTTP Referer fourni. Les expressions non valides et celles qui dépassent la limite de temps d’évaluation sont rejetées. Les requêtes sans en-tête Referer passent cette vérification ; utilisez Signature Authentication pour authentifier les requêtes. |
N’importe lequel des schémas suivants peut s’appliquer :
propriétés requises : steps, template_id
Paramètres utilisés pour créer une Assembly à partir de Steps directs ou d’un Template.
params: Seuls les champs répertoriés pour cet objet sont acceptés.
Utilise les définitions des champs ci-dessus : params.steps, params.template_id
Variante 2
Paramètres utilisés pour créer une Assembly à partir de Steps directs ou d’un Template.
params: Seuls les champs répertoriés pour cet objet sont acceptés.
Utilise les définitions des champs ci-dessus : params.steps, params.template_id
Réponse
Voici un exemple de corps de réponse :
{
"account_id": "6c8b8d10d68b11e3a799b579dfce333a",
"assembly_id": "0fce5b1063e611e88d8eb130f7921d8a",
"assembly_ssl_url": "https://api2-morven.transloadit.com/assemblies/0fce5b1063e611e88d8eb130f7921d8a",
"assembly_url": "http://api2.morven.transloadit.com/assemblies/0fce5b1063e611e88d8eb130f7921d8a",
"bytes_expected": 1687,
"bytes_received": 1687,
"bytes_usage": 0,
"companion_url": "https://api2-morven.transloadit.com/companion/",
"execution_duration": 0.001,
"execution_start": "2018/05/30 08:47:19 GMT",
"fields": {},
"instance": "morven.transloadit.com",
"jobs_queue_duration": 0,
"message": "The Assembly is currently being executed.",
"ok": "ASSEMBLY_EXECUTING",
"parent_id": null,
"queue_duration": 0.04,
"results": {},
"start_date": "2018/05/30 08:47:19 GMT",
"template": null,
"template_id": null,
"tus_url": "https://api2-morven.transloadit.com/resumable/files/",
"update_stream_url": "https://api2-morven.transloadit.com/ws20243?assembly=0fce5b1063e611e88d8eb130f7921d8a",
"upload_duration": 0.049,
"uploads": [],
"uppyserver_url": "https://api2-morven.transloadit.com/companion/",
"warnings": [],
"websocket_url": "https://api2-morven.transloadit.com/ws20243"
}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
| Champ | Type et description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
account_id | null | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
account_name | null | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
account_slug | null | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
api_auth_key_id | null | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
assemblyId | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
assembly_id | stringL’ID unique de cette Assembly. Vous pouvez l’enregistrer dans une base de données lorsqu’une Assembly est créée, et l’utiliser pour faire correspondre les Notifications entrantes. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
assembly_ssl_url | null | stringL’URL unique utilisée pour consulter l’état actuel de cette Assembly, mais prête à être
utilisée via SSL/HTTPS. Toutes les requêtes API envoyées à | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
assembly_url | null | stringL’URL unique utilisée pour consulter l’état actuel de cette Assembly. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
build_id | stringIdentifiant de build facultatif pour le dépannage par l’assistance. Traitez-le comme une valeur opaque ; il peut changer d’une Assembly à l’autre. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
bytes_expected | numberLe nombre d’octets que cette Assembly s’attend à recevoir par téléversement. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
bytes_received | numberLe nombre d’octets téléversés vers cette Assembly jusqu’à présent. Cette valeur est principalement utilisée par les clients pour afficher la progression du téléversement. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
bytes_usage | number | nullLe nombre total d’octets traités par cette Assembly qui sont pris en compte dans la facturation de votre utilisation.
La somme des valeurs | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
client_agent | null | stringL’agent utilisateur du client de téléversement n’est pas exposé ; ce champ obsolète vaut toujours | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
client_ip | null | stringL’adresse IP de l’auteur du téléversement n’est pas exposée ; ce champ obsolète est toujours | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
client_referer | null | stringL’URL de provenance de l’outil de téléversement n’est pas exposée ; ce champ déprécié vaut toujours | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
companion_url | null | stringL’URL du serveur Companion avec lequel cette Assembly peut communiquer. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
executing_jobs | Array<string>Schéma d’un élément de tableaustring | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
execution_duration | number | nullLe temps mis par Transloadit pour exécuter cette Assembly, en secondes. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
execution_start | null | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
expected_tus_uploads | number | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
fields | objectUn dictionnaire clé/valeur de champs de formulaire supplémentaires pour les intégrations qui ne peuvent pas utiliser l’encapsulation Schéma de la propriété supplémentairen’importe quelle valeur | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
finished_tus_uploads | number | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
has_dupe_jobs | boolean | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ignored_error_count | number | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ignored_errors | Array<object>Schéma d’un élément de tableau
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
info |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
info. | number | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
instance | null | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
is_infinite | boolean | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
jobs_queue_duration | number | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
last_job_completed | null | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
merged_params | null | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
message | stringUn message lisible par un humain expliquant l’état de cette Assembly. Ce message n’est pas toujours présent. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
notify_duration | number | nullTemps écoulé pour la livraison, en secondes, y compris les nouvelles tentatives automatiques et les délais qui les séparent. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
notify_error | null | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
notify_response_code | number | null | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
notify_response_data | null | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
notify_start | null | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
notify_status | null | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
notify_url | null | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
num_input_files | number | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
params | null | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
parent_assembly_status | n’importe quelle valeur | nullN’importe lequel des schémas suivants peut s’appliquer : n’importe quelle valeurn’importe quelle valeurnull | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
parent_id | null | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
previousStep | stringNom du Step précédent associé à l’erreur, lorsqu’il est disponible. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
queue_duration | number | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
region | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
results | objectLes fichiers de résultat que Transloadit a produits jusqu’à présent. Chaque clé est le nom du Step qui a produit un fichier. Les Robots de stockage ne produisent pas de fichiers, donc leurs noms de Step sont omis. Lorsqu’une Schéma de la propriété supplémentaireArray<object>Des détails supplémentaires sur le schéma sont disponibles dans le schéma JSON complet. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
running_jobs | Array<string>Schéma d’un élément de tableaustring | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
start_date | stringLa date et l’heure auxquelles le téléversement a commencé pour cette Assembly. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
started_jobs | Array<string>Schéma d’un élément de tableaustring | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
started_tus_uploads | number | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
step | stringNom du Step associé à l’erreur, lorsqu’il est disponible. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
template | null | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
template_id | null | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
template_name | null | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
transloadit_client | null | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
tus_uploads | Array<object>Schéma d’un élément de tableau
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
tus_url | stringL’URL du serveur tus utilisé par cette Assembly pour les téléversements avec reprise. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
update_stream_url | null | stringL’URL d’un flux d’événements envoyés par le serveur, à partir duquel vous pouvez obtenir des mises à jour en temps réel de l’état de cette Assembly. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
upload_duration | numberLe temps mis par l’outil de téléversement pour téléverser les fichiers, en secondes. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
upload_meta_data_extracted | boolean | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
uploads | Array<object>Un tableau de fichiers téléversés pour cette Assembly. Pour plus d’informations, consultez la documentation sur les métadonnées. Schéma d’un élément de tableau
N’importe lequel des schémas suivants peut s’appliquer : propriétés requises : basename, ext, field, id, meta, mime, name, size, type, url: object
Variante 2: object
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
uppyserver_url | null | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
usage_tags | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
virusname | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
warnings | Array<object>Schéma d’un élément de tableau
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
websocket_url | null | stringL’URL d’un serveur Websocket (utilisant Socket.IO) depuis lequel vous pouvez obtenir des mises à jour en temps réel de l’état de cette Assembly. |
N’importe lequel des schémas suivants peut s’appliquer :
ok: "ASSEMBLY_EXECUTING" | "ASSEMBLY_REPLAYING" | "ASSEMBLY_UPLOADING"
La réponse peut contenir des champs supplémentaires.
| Champ | Type et description |
|---|---|
error | jamaisIndique un statut d’erreur. Cette clé n’est présente que si l’Assembly a échoué. Cette valeur est interdite. |
okobligatoire | "ASSEMBLY_EXECUTING" | "ASSEMBLY_REPLAYING" | "ASSEMBLY_UPLOADING"Indique un statut de cycle de vie sans erreur, y compris les états de téléversement, d’exécution, d’abandon et d’annulation. La réussite du traitement est indiquée par |
ok: string
La réponse peut contenir des champs supplémentaires.
| Champ | Type et description |
|---|---|
error | jamaisIndique un statut d’erreur. Cette clé n’est présente que si l’Assembly a échoué. Cette valeur est interdite. |
okobligatoire | stringIndique un statut de cycle de vie sans erreur, y compris les états de téléversement, d’exécution, d’abandon et d’annulation. La réussite du traitement est indiquée par Valeurs autorisées (6)
|
propriétés requises : error
La réponse peut contenir des champs supplémentaires.
| Champ | Type et description |
|---|---|
cmd | string | Array<string | number>Détails facultatifs sur la commande de traitement pour le dépannage. Les détails de diagnostic peuvent varier ; utilisez le code N’importe lequel des schémas suivants peut s’appliquer : stringArray<string | number>Array<string | number>Schéma d’un élément de tableaustring | number |
errorobligatoire | stringIndique un statut d’erreur. Cette clé n’est présente que si l’Assembly a échoué. Valeurs autorisées (362)
|
exitCode | number | nullCode de sortie facultatif d’une commande de traitement ayant échoué. Les détails de diagnostic peuvent varier ; utilisez le code |
exitSignal | null | stringSignal facultatif ayant mis fin à une commande de traitement. Les détails du diagnostic peuvent varier ; utilisez le code |
file | string |
headers | objectSchéma de la propriété supplémentairen’importe quelle valeur |
is_private_address | boolean |
name | string |
numRetries | number |
ok | null |
playwright_error_code | string |
reason | null | string | number | boolean | Array<n’importe quelle valeur> | objectDétails de diagnostic facultatifs. Ne supposez pas que cette valeur est une chaîne de caractères et ne l’affichez pas directement ; utilisez N’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 |
response_code | number | null |
retries | number |
retryable | boolean |
stderr | stringSortie de diagnostic facultative produite par une commande de traitement, destinée au dépannage. Les détails du diagnostic peuvent varier ; utilisez le code |
stdout | stringSortie standard facultative d’une commande de traitement, destinée au dépannage. Les détails de diagnostic peuvent varier ; utilisez le code |
url | string |
url_host | 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
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: "INVALID_PARAMS_FIELD"
Le champ params fourni est invalide : il contient du JSON invalide.
La réponse peut contenir des champs supplémentaires.
Format général des erreurs
Pour en savoir plus sur la réponse, consultez notre documentation sur la réponse Assembly Status.