alpha

Llamar a endpoints HTTP

🤖/http/request llama a tu aplicación durante una Assembly y emite los archivos de entrada seleccionados o descarga las URL de archivos de resultado devueltas.

Llama a un endpoint HTTP durante la Assembly y espera un JSON opcional que describa cero o más archivos de entrada o URL de archivos de resultado que este Step emitirá.

Tu endpoint debe devolver una respuesta 2xx. Un cuerpo vacío, [] o { "files": [] } significa que este Step no emite archivos. También puedes devolver un objeto de archivo, un array de objetos de archivo o { "files": [...] } / { "files": { "name": {...} } }. Los objetos de archivo devueltos deben incluir o bien un campo path que coincida con una de las rutas de archivos de entrada enviadas a tu endpoint, o bien un campo url HTTP(S) que Transloadit descarga y emite como un nuevo archivo de resultado.

Ejemplo de uso

Pregunta a tu aplicación qué archivos de entrada deben continuar:

{
  "steps": {
    "request": {
      "method": "POST",
      "payload": "metadata",
      "robot": "/http/request",
      "url": "https://example.com/transloadit/files",
      "use": ":original"
    }
  }
}

Parámetros

interpolate
boolean | Record<string, boolean>
Controla si las Assembly Variables se interpolan en campos de instrucciones individuales.

De forma predeterminada, la mayoría de los campos de instrucciones de los Robots interpolan Assembly Variables. Establece esta opción en false para tratar todos los campos de instrucciones como texto literal, o establece la ruta de un campo individual en false para tratar únicamente ese campo como texto literal. En el caso de los campos específicos de un Robot que son literales de forma predeterminada, establece esta opción en true o la ruta de ese campo en true para volver a habilitar la interpolación.

Usa nombres de campos como path o rutas con puntos como ffmpeg.vf para los objetos anidados.
output_meta
Record<string, boolean> | boolean | Array<string>
Te permite especificar un conjunto de metadatos cuyo cálculo requiere más recursos de CPU y que, por lo tanto, está desactivado de forma predeterminada para mantener el procesamiento de tus Assemblies rápido.

Para imágenes, puedes añadir "has_transparency": true en este objeto para extraer si la imagen contiene partes transparentes y "dominant_colors": true para extraer un array de códigos de color hexadecimales de la imagen.

Para imágenes, también puedes añadir "blurhash": true para extraer una cadena BlurHash, una representación compacta de un marcador de posición para la imagen que resulta útil para mostrar una vista previa desenfocada mientras se carga la imagen completa.

Para imágenes, "thumbhash": true extrae en su lugar un ThumbHash codificado en base64 en meta.thumbhash, junto con meta.has_alpha (si existe un canal alfa, incluso cuando es totalmente opaco). Describe píxeles orientados según EXIF y usa el primer fotograma en el caso de imágenes animadas. La extracción se realiza según el mejor esfuerzo posible: las imágenes de más de 40 megapíxeles, los formatos no compatibles o una decodificación fallida o limitada no generan ningún marcador de posición. Una extracción exitosa añade un cargo de metadatos equivalente al 20 % de los bytes de ese archivo. No se aplica ningún recargo por ThumbHash cuando está desactivado o cuando no se genera ningún hash.

Configura esta opción en el Step que genera la imagen, como /upload/handle para los originales subidos o /image/resize para las salidas procesadas. Configurarla únicamente en /transloadit/store no solicita la extracción: el almacenamiento conserva los metadatos del Step que generó la imagen. Transloadit Storage conserva un hash generado junto con su versión inmutable y lo devuelve en los resultados almacenados y en las lecturas nativas de activos. Las subidas directas a S3 no generan marcadores de posición. Un marcador de posición contiene información de la imagen, por lo que debes protegerlo con los mismos controles de acceso que la imagen completa.

Para videos, puedes añadir el parámetro "colorspace": true para extraer el espacio de color del video de salida.

Para videos, también puedes añadir "interlaced": true para detectar si el video está entrelazado. Esto combina el indicador field_order de ffprobe, cuyo costo computacional es bajo, con una pasada de muestreo limitada mediante idet sobre los primeros fotogramas de la fuente, y expone interlaced, field_order y un objeto de diagnóstico interlace_detection en file.meta. Esto requiere muchos recursos computacionales y se factura en consecuencia.

Para audio, puedes añadir "mean_volume": true para obtener un único valor que represente el volumen promedio del archivo de audio.

También puedes establecer esto en false para omitir la extracción de metadatos y acelerar la transcodificación.
user_meta
Record<string, any>(valor predeterminado: {})
Añade metadatos JSON personalizados a cada archivo emitido sin modificar su contenido. Se admiten objetos y arrays anidados.

La herencia depende del Robot. Los valores se combinan con los user_meta existentes en el archivo de salida; el Step actual reemplaza las claves coincidentes de nivel superior. Asigna explícitamente las claves necesarias cuando un Robot cree nuevos archivos de salida.

En los Steps de procesamiento, ${file.*} hace referencia a la primera entrada y ${result.*} al archivo emitido. Los valores se evalúan para cada salida después de ejecutarse el Robot, antes de la posterior extracción de metadatos y del almacenamiento temporal. En :original, los valores se evalúan para cada subida antes de la extracción de metadatos.

Los Steps posteriores leen ${file.user_meta.key}. Consulta Metadatos personalizados para ver un ejemplo completo y las reglas de herencia.
result
boolean(valor predeterminado: false)
Indica si los resultados de este Step deben aparecer en el Assembly Status JSON
queue
batch
Establecer la cola en «batch» reduce manualmente la prioridad de los Jobs de este Step para evitar consumir cupos prioritarios con Jobs que no necesitan un tiempo de espera cero en la cola
force_accept
boolean(valor predeterminado: false)
Forzar a un Robot a aceptar un tipo de archivo que habría ignorado.

De forma predeterminada, los Robots ignoran los archivos que no reconocen. 🤖/video/encode, por ejemplo, ignorará sin problemas las imágenes de entrada.

Si configuras el parámetro force_accept como true, puedes forzar a los Robots a aceptar todos los archivos que reciban. Esto normalmente provocará errores y solo debe usarse para depuración o para abordar casos extremos.
ignore_errors
boolean | Array<meta | execute>(valor predeterminado: [])
Ignorar errores durante fases específicas del procesamiento.

Establecer este parámetro en ["meta"] hará que el Robot ignore los errores durante la extracción de metadatos.

Establecer este parámetro en ["execute"] hará que el Robot ignore los errores durante la fase principal de ejecución.

Configurar este parámetro como true equivale a ["meta", "execute"] y hará que se ignoren los errores en ambas fases.
use
string | Array<string> | Array<object> | object
Especifica qué Step o Steps se usarán como entrada.
- Puedes elegir cualquier nombre para los Steps, excepto ":original" (reservado para las subidas de usuarios gestionadas por Transloadit)
- Puedes proporcionar varios Steps como entrada mediante arrays:
```
{
  "use": [
    ":original",
    "encoded",
    "resized"
  ]
}
```
- También puedes etiquetar los Steps de entrada con as para comunicar la intención semántica a los Robots:
```
{
  "use": [
    {
      "name": ":original",
      "as": "image"
    },
    {
      "name": ":original",
      "as": "mask"
    }
  ]
}
```
Consejo

Probablemente eso sea todo lo que necesitas saber sobre use, pero puedes consultar los casos de uso avanzados.
url — obligatorio
string
El endpoint HTTP o HTTPS al que se llamará.
method
DELETE | GET | PATCH | POST | PUT(valor predeterminado: "POST")
Método HTTP que se usará para la solicitud.
payload
none | metadata | file | files(valor predeterminado: "none")
Controla qué se envía a tu endpoint.
- none: no se envía ningún cuerpo de solicitud.
- metadata: se envía un cuerpo JSON con los metadatos de la Assembly, los campos, el Step anterior y los metadatos de los archivos.
- file: se envían datos de formulario multipart con un campo JSON payload y el primer archivo de entrada como parte file.
- files: se envían datos de formulario multipart con un campo JSON payload y todos los archivos de entrada como partes files[] repetidas. Para enviar varios archivos de entrada en una sola solicitud, establece bundle_steps: true en las opciones de use avanzadas.
El objeto JSON payload contiene assembly, fields, previous_step, file y files. file contiene los metadatos del primer archivo de entrada o null; files es un array de metadatos de los archivos de entrada.
headers
Array<string> | Array<Record<string, boolean | string | number | string | null>> | Record<string, boolean | string | number | string | null> | string(valor predeterminado: [])
Encabezados de solicitud personalizados.

Los encabezados pueden especificarse como un array de cadenas con el formato "Header-Name: value", un array de objetos, un mapa de objeto o una cadena JSON que se analizará para convertirla en un objeto/array.

Los nombres de los encabezados deben ser tokens HTTP válidos. Los valores de los encabezados pueden contener tabulaciones horizontales, pero se rechazan otros caracteres de control, incluidos los retornos de carro y los saltos de línea.

En un array de cadenas de encabezados, "Header-Name;" envía un valor de encabezado vacío. Cada entrada debe ser un encabezado literal; no se admite la lectura de encabezados desde un archivo con @filename.
timeout
string | number(valor predeterminado: 60)
Número máximo de segundos que se esperará la respuesta a la solicitud HTTP.

El tiempo de espera efectivo es el menor entre este valor y el límite del lado del servidor de Transloadit. Ese límite es de 30 segundos más 1 segundo por cada MiB enviado a tu endpoint.
max_response_size
string | number(valor predeterminado: 1048576)
Tamaño máximo aceptado de la respuesta, en bytes. Normalmente, la respuesta debería ser un documento JSON pequeño.
max_result_files
string | number(valor predeterminado: 10)
Número máximo de archivos que puede devolver el endpoint.
max_result_file_size
string | number(valor predeterminado: 104857600)
Tamaño máximo permitido, en bytes, para cada archivo de resultado devuelto mediante URL. Si el servidor remoto informa un tamaño de archivo mayor, la descarga del resultado se rechaza antes de comenzar. Si el servidor remoto no informa un tamaño de antemano, la descarga se cancela en cuanto se supera este límite.
result_download_timeout
string | number(valor predeterminado: 120)
Número máximo de segundos dedicados a descargar cada archivo de resultado devuelto mediante URL.

Llamar a endpoints HTTP

Ejemplo de uso

Parámetros

`interpolate`

`output_meta`

`user_meta`

`result`

`queue`

`force_accept`

`ignore_errors`

`use`

`url` — obligatorio

`method`

`payload`

`headers`

`timeout`

`max_response_size`

`max_result_files`

`max_result_file_size`

`result_download_timeout`

Llamar a endpoints HTTP

Ejemplo de uso

Parámetros

interpolate

output_meta

user_meta

result

queue

force_accept

ignore_errors

use

url — obligatorio

method

payload

headers

timeout

max_response_size

max_result_files

max_result_file_size

result_download_timeout

`interpolate`

`output_meta`

`user_meta`

`result`

`queue`

`force_accept`

`ignore_errors`

`use`

`url` — obligatorio

`method`

`payload`

`headers`

`timeout`

`max_response_size`

`max_result_files`

`max_result_file_size`

`result_download_timeout`