Crear una nueva Assembly
Crea una Assembly a partir de archivos subidos y Assembly Instructions.
https://api2.transloadit.com/ assembliesFlujo de trabajo habitual:
- Envía el ejemplo de solicitud que aparece a continuación con tu archivo y las Instructions de procesamiento. Para recibir
el estado final a través de un webhook, incluye
notify_urlen esas Instructions antes de enviar la solicitud. - Mantén en secreto el valor de
assembly_ssl_urldevuelto. Úsalo para consultar el progreso, o espera al webhook que has configurado. - Espera a que aparezca
ok: "ASSEMBLY_COMPLETED"antes de utilizar los archivos procesados. Ni unerrorni una cancelación constituyen un procesamiento satisfactorio. Los archivos de salida se agrupan por nombre de Step enresults; consulta los campos de la respuesta.
Las Assemblies que usan /transloadit/import, directamente o a través de un Template, requieren
un token Bearer o el valor de params firmado con una marca de tiempo futura en params.auth.expires.
Esto se aplica incluso cuando Signature Authentication está desactivada en el Workspace. Una Auth Key por sí sola
no es suficiente; las solicitudes autenticadas con un token Bearer no necesitan una Signature ni una caducidad por separado.
Una Assembly puede procesar y exportar archivos.
Las Assembly Instructions determinan cómo debemos procesarlos.
Las Instructions se pueden pasar directamente (dentro de un parámetro steps) o guardar en un
Template (al que se hace referencia en un parámetro template_id). Los Templates te permiten
reutilizar las Instructions, modificarlas sin desplegar tu aplicación y no exponer ningún secreto en el entorno donde
se despliega tu aplicación.
Aceptamos solicitudes POST multipart/form-data para admitir las cargas habituales mediante <form> a nuestro servicio
(así como el uso de XHR / SDK).
Se pueden incluir varios archivos como parte de esta solicitud. Si quieres realizar cargas de archivos reanudables, los archivos no se incluyen en esta solicitud, tal como se describe en Cargas reanudables.
Transloadit admite tamaños de archivo de hasta 200 GB. Si necesitas un límite superior para tu aplicación, ponte en contacto con nosotros.
Ejemplo de solicitud
Ejecuta esta solicitud en un shell del lado del servidor con curl y un token Bearer adecuado en TRANSLOADIT_TOKEN. Si necesitas un token, despliega la configuración que aparece a continuación.
Coloca tu archivo de entrada en ./example.jpg antes de ejecutar la solicitud.
¿Necesitas un token Bearer?
En un shell de confianza del lado del servidor con curl y jq, asigna tu Auth Key a TRANSLOADIT_KEY y tu Auth Secret a TRANSLOADIT_SECRET. Mantén en secreto ambas credenciales y el token resultante; nunca ejecutes esta configuración en código del navegador.
Primero, crea un token con los ámbitos que requiere este endpoint. Tu Auth Key ya debe conceder esos ámbitos.
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
Mantén este shell abierto y ejecuta la solicitud que aparece a continuación. Reutiliza el token mientras siga siendo válido.
curl --fail-with-body -sS --request POST \
--url "https://api2.transloadit.com/assemblies" \
--header "Authorization: Bearer ${TRANSLOADIT_TOKEN:?Set TRANSLOADIT_TOKEN}" \
--form-string 'params={"steps":{"resize":{"robot":"/image/resize","use":":original","width":320}}}' \
--form 'file=@./example.jpg'
Qué ocurre después
Una respuesta HTTP satisfactoria indica que se ha aceptado la Assembly; no significa que el procesamiento haya finalizado. Una respuesta inicial puede tener este aspecto (fragmento; los IDs y las URLs serán diferentes):
{
"ok": "ASSEMBLY_EXECUTING",
"assembly_id": "0fce5b1063e611e88d8eb130f7921d8a",
"assembly_ssl_url": "https://api2-morven.transloadit.com/assemblies/0fce5b1063e611e88d8eb130f7921d8a",
"results": {}
}
Copia assembly_ssl_url de tu respuesta y consulta su estado
cada pocos segundos, o usa un webhook configurado antes de la creación.
Mantén esa URL en secreto. Detente si hay un error o una cancelación; ninguno de los dos constituye un procesamiento satisfactorio.
Cuando ok sea ASSEMBLY_COMPLETED, la salida de este ejemplo estará en results.resize.
Una respuesta al completarse la Assembly incluye los siguientes campos (fragmento; la URL de salida es ilustrativa):
{
"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
}
}
]
}
}
Usa results.resize[0].ssl_url para descargar la imagen redimensionada. Estas URLs temporales de salida
caducan; añade un Step de exportación como /s3/store si necesitas conservar los archivos.
Autenticación
Este endpoint acepta params firmados o un token Bearer. Consulta Autenticación para ver las instrucciones de configuración.
Ámbito requerido para el Auth Key o el token de portador: assemblies:write.
Las solicitudes autenticadas con una clave requieren una firma cuando Signature Authentication está activada. Los tokens Bearer no requieren una firma separada.
Parámetros opcionales de consulta de la respuesta
callback(Nombre del callback de JavaScript). Envuelve las respuestas JSON en un callback JSONP. El nombre del callback debe coincidir con^(?:_jqjsp[0-9]*|jQuery[0-9]+_[0-9]+)$. Solo se utiliza la última aparición; los valores vacíos se ignoran. Los nombres de callback no válidos devuelven HTTP 403. La respuesta transformada utiliza HTTP 200. El callback se aplica después de serializar la respuesta.
Campos de formulario multipart
Tipo de contenido: multipart/form-data
params(cadena JSON), obligatorio. Un objeto codificado en JSON cuyas claves compatibles se enumeran a continuación.signature(cadena). Obligatorio cuando la solicitud usa Signature Authentication.num_expected_upload_files(campo de formulario). Cuando se usan subidas reanudables, especifica la cantidad de archivos que se subirán. Encontrarás más detalles en Subidas reanudables.tus_num_expected_upload_files(campo de formulario). Alias heredado denum_expected_upload_files, conservado por compatibilidad con SDK antiguos.*(binario o cadena). Los archivos binarios y los campos adicionales de la Assembly pueden usar nombres de campo arbitrarios.
Claves admitidas dentro del campo params
Los campos de autenticación de esta lista se aplican a las solicitudes firmadas. Con un token Bearer puedes omitir params.auth y el campo separado signature. Compara a continuación los parámetros de solicitud de cada método de autenticación.
JSON Schema completo
Parámetros firmados utilizados para crear una Assembly a partir de Steps directos o de un Template.
| Campo | Tipo y descripción |
|---|---|
params.obligatorio para las solicitudes firmadas; opcional con un token Bearer | Metadatos de autenticación y restricciones de carga para una solicitud firmada de Assembly. La clave de API es obligatoria. Contiene, como mínimo, tu Auth Key de Transloadit en la propiedad Si activas Signature Authentication, también debes establecer una fecha de caducidad para la solicitud en la propiedad expires: Recomendamos encarecidamente incluir un valor La propiedad Las cargas sin referer siempre superarán la comprobación (ya que algunos navegadores lo desactivan), por lo que esta opción solo resulta útil en unos pocos casos de uso. Para obtener más información sobre las expresiones regulares, consulta la documentación de RegExp de Mozilla. Se rechazan las expresiones regulares no válidas y las que superan el límite de tiempo de evaluación. Esta comprobación no sustituye a Signature Authentication: los clientes pueden omitir o falsificar la cabecera Referer. La propiedad La propiedad Estas propiedades se pueden establecer como parte de la solicitud de Assembly o como parte del Template.
|
params. | stringMarca de tiempo de vencimiento ISO 8601 en el futuro. Es obligatoria cuando una solicitud está firmada o requiere autenticación mediante firma; las solicitudes autenticadas con Bearer pueden omitirla. |
params.obligatorio | stringClave de API de Transloadit utilizada para autenticar solicitudes |
params. | integer (mínimo: 1)Número máximo de archivos de entrada permitidos por Assembly. Si la cantidad de archivos subidos o importados supera este límite, la Assembly se detiene con un error. Es útil para evitar abusos cuando se exponen las credenciales de Signature Authentication. |
params. | numberTamaño total máximo de carga previsto para la Assembly, en bytes, incluida la sobrecarga del cuerpo de la solicitud. No es un límite por archivo y no garantiza el rechazo antes de que comience una transferencia reanudable. |
params. | stringExpresión regular que se compara con el HTTP Referer proporcionado. Se rechazan las expresiones no válidas y las que superan el límite de tiempo de evaluación. Las solicitudes sin encabezado Referer superan esta comprobación; usa Signature Authentication para autenticar las solicitudes. |
params. | booleanEstablece este valor en true para publicar eventos en tiempo real sobre el progreso de ejecución de la Assembly. Esta opción se ignora en las URL Transform Assemblies. |
params. | stringSelecciona la pila de ExifTool para la extracción de metadatos en esta Assembly. Esto no selecciona la pila de procesamiento para los Steps de los Robots. |
params. | stringSelecciona la pila de FFmpeg para la extracción de metadatos en esta Assembly. Esto no selecciona la pila de procesamiento de los Steps de Robot. Establece |
params. | objectUn objeto de valores identificados por claves de cadena (nombre -> valor) que pueden utilizarse como Assembly Variables, al igual que los campos adicionales de un formulario. Puedes usar como valor cualquier elemento que pueda serializarse como JSON Esquema de propiedades adicionalescualquier valor |
params. | stringSelecciona la pila de ImageMagick para la extracción de metadatos en esta Assembly. Esto no selecciona la pila de procesamiento de los Steps de los Robots. Establece |
params. | stringSelecciona la pila de MediaInfo para la extracción de metadatos en esta Assembly. Esto no selecciona la pila de procesamiento para los Steps de Robot. |
params. | stringSelecciona la pila de MPlayer para la extracción de metadatos en esta Assembly. Esto no selecciona la pila de procesamiento para los Steps de Robot. |
params. | string | numberValor aleatorio y único incluido en los parámetros de las solicitudes firmadas para que cada firma sea única y evitar su reutilización accidental. |
params. | Array<"without_params" | "without_result_meta_data" | "without_results" | "without_upload_meta_data" | "without_uploads">Controla el tamaño de la carga útil enviada en las Notifications de Assembly. Los reenvíos de Notifications reutilizan los filtros proporcionados en la solicitud original de Assembly; los filtros definidos solo en un Template no se conservan al reenviar. Un arreglo vacío (valor predeterminado) envía el Assembly Status completo. Añade Esquema de los elementos del array"without_params" | "without_result_meta_data" | "without_results" | "without_upload_meta_data" | "without_uploads" |
params. | null | stringTransloadit puede enviar una devolución de llamada a tu servidor cuando se complete la Assembly. Enviaremos el Assembly Status como una cadena JSON en el campo |
params. | booleanEstablece este valor en true para minimizar la respuesta inicial de creación de la Assembly. Una respuesta correcta solo incluye ok y assembly_id; una respuesta de error conserva error, http_code, message, reason y assembly_id cuando estén disponibles. Esto minimiza la respuesta, pero no controla el acceso: cualquier persona con el Assembly ID devuelto puede seguir consultando el Assembly Status completo, incluidos los campos y los resultados, sin autenticación adicional. Trata los Assembly IDs y las URLs de estado como capacidades de acceso secretas. El Assembly Status completo sigue enviándose a notify_url cuando está configurada. |
params. | stringURL a la que se redirige una subida desde el navegador una vez finalizada. El ID de la Assembly y la URL de estado se añaden como parámetros de consulta, conservando los parámetros de consulta y el fragmento existentes. |
params. | Encabezados de respuesta personalizados emitidos por una Assembly. Las modificaciones de CORS deben definirse en
|
params. | objectLos detalles adicionales del esquema están disponibles en el JSON Schema completo. |
params. | stringEtiquetas de uso registradas en una Assembly. |
Puede aplicarse cualquiera de los esquemas siguientes:
propiedades obligatorias: steps, template_id
Parámetros utilizados para crear una Assembly a partir de Steps directos o de un Template.
params: Solo se aceptan los campos enumerados para este objeto.
| Campo | Tipo y descripción |
|---|---|
params.obligatorio | objectValores parciales de Step que se combinan con los Steps correspondientes del Template almacenado. Su estructura completa específica de cada Robot se valida después de cargar el Template. Esquema de propiedades adicionalesobjectLos detalles adicionales del esquema están disponibles en el JSON Schema completo. |
params.obligatorio | string (longitud mínima: 1)El ID del Template que contiene tus Assembly Instructions. Si estableces |
Variante 2
Parámetros utilizados para crear una Assembly a partir de Steps directos o de un Template.
params: Solo se aceptan los campos enumerados para este objeto.
| Campo | Tipo y descripción |
|---|---|
params. | objectContiene Assembly Instructions. Esquema de propiedades adicionalesobjectLos detalles adicionales del esquema están disponibles en el JSON Schema completo. |
params. | stringEl ID del Template que contiene tus Assembly Instructions. Si estableces |
Parámetros de solicitud según el método de autenticación
Con parámetros firmados
Incluye tu Auth Key como params.auth.key. Al firmar la solicitud, incluye una marca de tiempo futura en params.auth.expires y envía la Signature en el campo separado signature. Las definiciones de los campos que aparecen a continuación usan rutas dentro de params.
JSON Schema completo
Parámetros firmados utilizados para crear una Assembly a partir de Steps directos o de un Template.
Utiliza las definiciones de campos indicadas arriba: 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
Puede aplicarse cualquiera de los esquemas siguientes:
propiedades obligatorias: steps, template_id
Parámetros utilizados para crear una Assembly a partir de Steps directos o de un Template.
params: Solo se aceptan los campos enumerados para este objeto.
Utiliza las definiciones de campos indicadas arriba: params.steps, params.template_id
Variante 2
Parámetros utilizados para crear una Assembly a partir de Steps directos o de un Template.
params: Solo se aceptan los campos enumerados para este objeto.
Utiliza las definiciones de campos indicadas arriba: params.steps, params.template_id
Con un token Bearer
Envía el token Bearer en el encabezado Authorization. Puedes omitir params.auth y el campo independiente signature. Los demás parámetros obligatorios siguen siendo necesarios. Las definiciones de los campos que aparecen a continuación usan rutas dentro de params.
JSON Schema completo
Parámetros utilizados para crear una Assembly a partir de Steps directos o de un Template.
Utiliza las definiciones de campos indicadas arriba: 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
| Campo | Tipo y descripción |
|---|---|
params. | Metadatos de autenticación y restricciones de carga para una solicitud de Assembly autenticada con un token Bearer. El token proporciona la clave de API, por lo que la solicitud puede omitirla. La propiedad Las cargas sin referer siempre pasarán la comprobación (ya que algunos navegadores lo desactivan), por lo que esto solo resulta útil en unos pocos casos de uso. Para obtener más información sobre las expresiones regulares, consulta la documentación de RegExp de Mozilla. Se rechazan las expresiones regulares no válidas y las que superan el límite de tiempo de evaluación. Esta comprobación no sustituye a Signature Authentication: los clientes pueden omitir o falsificar la cabecera Referer. La propiedad La propiedad Estas propiedades se pueden establecer como parte de la solicitud de Assembly o como parte del Template.
|
params. | stringMarca de tiempo de vencimiento ISO 8601 en el futuro. Es obligatoria cuando una solicitud está firmada o requiere autenticación mediante firma; las solicitudes autenticadas con Bearer pueden omitirla. |
params. | stringClave de API de Transloadit utilizada para autenticar solicitudes |
params. | integer (mínimo: 1)Número máximo de archivos de entrada permitidos por Assembly. Si la cantidad de archivos subidos o importados supera este límite, la Assembly se detiene con un error. Es útil para evitar abusos cuando se exponen las credenciales de Signature Authentication. |
params. | numberTamaño total máximo de carga previsto para la Assembly, en bytes, incluida la sobrecarga del cuerpo de la solicitud. No es un límite por archivo y no garantiza el rechazo antes de que comience una transferencia reanudable. |
params. | stringExpresión regular que se compara con el HTTP Referer proporcionado. Se rechazan las expresiones no válidas y las que superan el límite de tiempo de evaluación. Las solicitudes sin encabezado Referer superan esta comprobación; usa Signature Authentication para autenticar las solicitudes. |
Puede aplicarse cualquiera de los esquemas siguientes:
propiedades obligatorias: steps, template_id
Parámetros utilizados para crear una Assembly a partir de Steps directos o de un Template.
params: Solo se aceptan los campos enumerados para este objeto.
Utiliza las definiciones de campos indicadas arriba: params.steps, params.template_id
Variante 2
Parámetros utilizados para crear una Assembly a partir de Steps directos o de un Template.
params: Solo se aceptan los campos enumerados para este objeto.
Utiliza las definiciones de campos indicadas arriba: params.steps, params.template_id
También puedes proporcionar aquí otros campos POST (que no se llamen params, signature,
num_expected_upload_files ni tus_num_expected_upload_files). Puedes usarlos como variables para
hacer dinámicas tus Assembly
Instructions.
Respuesta
Este es un ejemplo del cuerpo de la respuesta:
{
"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"
}éxito 2xx
Cuerpo de respuesta JSON. application/json text/plain; charset=utf-8
Esquema del cuerpo de la respuesta
JSON Schema completo
| Campo | Tipo y descripción | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
account_id | null | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
account_name | null | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
account_slug | null | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
api_auth_key_id | null | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
assemblyId | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
assembly_id | stringEl ID único de esta Assembly. Puedes almacenarlo en una base de datos cuando se crea una Assembly y usarlo para relacionar las Notifications entrantes. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
assembly_ssl_url | null | stringLa URL única que se utiliza para consultar el estado actual de esta Assembly, pero preparada para
usarse mediante SSL/HTTPS. Todas las solicitudes a la API que se envían a | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
assembly_url | null | stringLa URL única que se utiliza para consultar el estado actual de esta Assembly. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
build_id | stringIdentificador de compilación opcional para que el equipo de soporte pueda investigar problemas. Trátalo como un valor opaco; puede cambiar entre Assemblies. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
bytes_expected | numberLa cantidad de bytes que esta Assembly espera que se suban. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
bytes_received | numberLa cantidad de bytes que se han subido hasta el momento a esta Assembly. Los clientes utilizan este valor principalmente para mostrar el progreso de la subida. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
bytes_usage | number | nullLa cantidad total de bytes procesados por esta Assembly que se contabilizan en tu factura de
uso. La suma de | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
client_agent | null | stringEl agente de usuario de quien realiza la subida no se expone; este campo obsoleto siempre es | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
client_ip | null | stringLa dirección IP de quien realiza la subida no se expone; este campo obsoleto siempre es | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
client_referer | null | stringLa URL de referencia de quien realiza la subida no se expone; este campo obsoleto siempre es | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
companion_url | null | stringLa URL del servidor Companion con el que esta Assembly puede comunicarse. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
executing_jobs | Array<string>Esquema de los elementos del arraystring | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
execution_duration | number | nullEl tiempo que tardó Transloadit en ejecutar esta Assembly, en segundos. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
execution_start | null | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
expected_tus_uploads | number | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
fields | objectUn mapa de claves y valores de cualquier campo adicional presente en tu formulario, para integraciones que no pueden usar
la encapsulación Esquema de propiedades adicionalescualquier valor | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
finished_tus_uploads | number | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
has_dupe_jobs | boolean | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ignored_error_count | number | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ignored_errors | Array<object>Esquema de los elementos del array
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
info |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
info. | number | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
instance | null | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
is_infinite | boolean | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
jobs_queue_duration | number | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
last_job_completed | null | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
merged_params | null | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
message | stringUn mensaje legible que explica el estado de esta Assembly. No siempre está presente. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
notify_duration | number | nullTiempo transcurrido durante la entrega, en segundos, incluidos los reintentos automáticos y las esperas entre ellos. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 | cualquier valor | nullPuede aplicarse cualquiera de los esquemas siguientes: cualquier valorcualquier valornull | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
parent_id | null | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
previousStep | stringNombre del Step anterior relacionado con el error, cuando esté disponible. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
queue_duration | number | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
region | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
results | objectLos archivos de resultados que Transloadit ha producido hasta el momento. Cada clave de este objeto es el nombre del
Step que produjo un archivo específico. Como los Robots de almacenamiento no producen archivos,
los nombres de sus Steps no se incluyen aquí. Si se produce un Esquema de propiedades adicionalesArray<object>Los detalles adicionales del esquema están disponibles en el JSON Schema completo. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
running_jobs | Array<string>Esquema de los elementos del arraystring | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
start_date | stringLa fecha y hora en que comenzó la subida para esta Assembly. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
started_jobs | Array<string>Esquema de los elementos del arraystring | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
started_tus_uploads | number | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
step | stringNombre del Step relacionado con el error, cuando esté disponible. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
template | null | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
template_id | null | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
template_name | null | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
transloadit_client | null | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
tus_uploads | Array<object>Esquema de los elementos del array
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
tus_url | stringLa URL del servidor tus que utiliza esta Assembly para las subidas reanudables. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
update_stream_url | null | stringLa URL de un flujo de eventos enviados por el servidor desde el que puedes obtener actualizaciones de estado en tiempo real de esta Assembly. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
upload_duration | numberEl tiempo que tardó quien realizó la subida en subir los archivos, en segundos. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
upload_meta_data_extracted | boolean | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
uploads | Array<object>Un arreglo de archivos subidos para esta Assembly. Para obtener más información, consulta la documentación de metadatos. Esquema de los elementos del array
Puede aplicarse cualquiera de los esquemas siguientes: propiedades obligatorias: 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>Esquema de los elementos del array
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
websocket_url | null | stringLa URL de un servidor Websocket (utiliza Socket.IO) desde el que puedes obtener actualizaciones en tiempo real sobre el estado de esta Assembly. |
Puede aplicarse cualquiera de los esquemas siguientes:
ok: "ASSEMBLY_EXECUTING" | "ASSEMBLY_REPLAYING" | "ASSEMBLY_UPLOADING"
La respuesta puede contener campos adicionales.
| Campo | Tipo y descripción |
|---|---|
error | nuncaIndica un estado de error. Esta clave solo está presente si la Assembly ha fallado. Es posible que se añadan nuevos códigos de error. Trata los códigos no reconocidos como fallos y conserva sus valores para inspeccionarlos mediante programación. Este valor está prohibido. |
okobligatorio | "ASSEMBLY_EXECUTING" | "ASSEMBLY_REPLAYING" | "ASSEMBLY_UPLOADING"Indica un estado del ciclo de vida sin error, incluidos los estados de subida, ejecución, solicitud abortada y Assembly cancelada. El procesamiento correcto se indica con |
ok: string
La respuesta puede contener campos adicionales.
| Campo | Tipo y descripción |
|---|---|
error | nuncaIndica un estado de error. Esta clave solo está presente si la Assembly ha fallado. Es posible que se añadan nuevos códigos de error. Trata los códigos no reconocidos como fallos y conserva sus valores para inspeccionarlos mediante programación. Este valor está prohibido. |
okobligatorio | stringIndica un estado del ciclo de vida sin error, incluidos los estados de subida, ejecución, solicitud abortada y Assembly cancelada. El procesamiento correcto se indica con Valores permitidos (6)
|
propiedades obligatorias: error
La respuesta puede contener campos adicionales.
| Campo | Tipo y descripción |
|---|---|
cmd | string | Array<string | number>Detalles opcionales del comando de procesamiento para investigar problemas. Los detalles de diagnóstico pueden variar; usa el código Puede aplicarse cualquiera de los esquemas siguientes: stringArray<string | number>Array<string | number>Esquema de los elementos del arraystring | number |
errorobligatorio | string (longitud mínima: 1)Indica un estado de error. Esta clave solo está presente si la Assembly ha fallado. Es posible que se añadan nuevos códigos de error. Trata los códigos no reconocidos como fallos y conserva sus valores para inspeccionarlos mediante programación. Valores conocidos (363); puede haber otros valores
|
exitCode | number | nullEstado de salida opcional de un comando de procesamiento que ha fallado. Los detalles de diagnóstico pueden variar; usa el código |
exitSignal | null | stringSeñal opcional que terminó un comando de procesamiento. Los detalles de diagnóstico pueden variar; usa el código |
file | string |
headers | objectEsquema de propiedades adicionalescualquier valor |
is_private_address | boolean |
name | string |
numRetries | number |
ok | null |
playwright_error_code | string |
reason | null | string | number | boolean | Array<cualquier valor> | objectDetalles de diagnóstico opcionales. No asumas que este valor es una cadena ni lo muestres directamente; usa Puede aplicarse cualquiera de los esquemas siguientes: nullstringnumberbooleanArray<cualquier valor>Array<cualquier valor>Esquema de los elementos del arraycualquier valorobjectobjectEsquema de propiedades adicionalescualquier valor |
response_code | number | null |
retries | number |
retryable | boolean |
stderr | stringSalida de diagnóstico opcional de un comando de procesamiento para investigar problemas. Los detalles de diagnóstico pueden variar; usa el código |
stdout | stringSalida estándar opcional de un comando de procesamiento para investigar problemas. Los detalles de diagnóstico pueden variar; usa el código |
url | string |
url_host | null | string |
Respuesta de error
Cuerpo de respuesta JSON. application/json text/plain; charset=utf-8
Esquema del cuerpo de la respuesta
JSON Schema completo
La respuesta puede contener campos adicionales.
| Campo | Tipo y descripción |
|---|---|
assembly_id | string |
error | string (longitud mínima: 1) |
http_code | number | string
|
message | stringExplicación del error legible por humanos. Su redacción puede variar; usa el código |
reason | null | string | number | boolean | Array<cualquier valor> | objectPuede aplicarse cualquiera de los esquemas siguientes: nullstringnumberbooleanArray<cualquier valor>Array<cualquier valor>Esquema de los elementos del arraycualquier valorobjectobjectEsquema de propiedades adicionalescualquier valor |
HTTP 400
Cuerpo de respuesta JSON. application/json text/plain; charset=utf-8
Esquema del cuerpo de la respuesta
JSON Schema completo
Errores con nombre y el formato general de error
error: "INVALID_PARAMS_FIELD"
Se proporcionó un campo params incorrecto, contiene json no válido.
La respuesta puede contener campos adicionales.
Formato general de error
Para obtener más información sobre la respuesta, consulta nuestra documentación sobre la Respuesta de Assembly Status.