Transloadit

Transmitir en vivo los cambios de una Assembly

Transmite los cambios de estado de una Assembly como Server-Sent Events.

GET{UPDATE_STREAM_URL}

En la respuesta tras crear una Assembly encontrarás dos campos para obtener el Assembly Status: assembly_ssl_url y update_stream_url. Puedes obtener el Assembly Status actual desde la URL indicada en assembly_ssl_url. Para obtener información sobre cómo progresa la Assembly, puedes consultar esa URL periódicamente o suscribirte al flujo de actualizaciones, que se describe en este documento.

Eventos enviados por el servidor (Server-Sent Events)

La propiedad update_stream_url del Assembly Status define una URL en la que está disponible el flujo de actualizaciones de la Assembly correspondiente mediante eventos enviados por el servidor.

Los eventos enviados por el servidor son una tecnología web para enviar notificaciones en vivo desde el servidor a un cliente a través de HTTP. Es similar a Web Sockets, pero solo permite mensajes unidireccionales del servidor al cliente y consiste en un formato sencillo basado en texto.

Mientras la Assembly está en estado de carga o de ejecución, un cliente puede conectarse a este endpoint enviando una solicitud GET con el campo de encabezado Accept: text/event-stream a la URL especificada en update_stream_url y analizar el flujo de respuesta. El servidor puede enviar al cliente una combinación de mensajes y eventos. La diferencia entre ellos es que los eventos incluyen una carga útil adicional con información, mientras que los mensajes no.

Varios clientes pueden suscribirse a la misma Assembly. Cerrar una conexión deja a las demás conectadas. Durante el apagado de un uploader, los flujos existentes se cierran y las nuevas conexiones reciben una respuesta HTTP 503 vacía. Obtén el Assembly Status actual para comprobar si el procesamiento ha terminado.

Mensajes

Un mensaje consta del nombre del mensaje y no tiene carga útil adicional. En la transmisión, un mensaje con el nombre assembly_finished tiene este aspecto ([NL] indica un salto de línea):

data: assembly_finished[NL]
[NL]

Transloadit envía los siguientes mensajes:

  • assembly_upload_meta_data_extracted se emite cuando todas las cargas han terminado y se han extraído los metadatos de todas ellas.
  • assembly_uploading_finished se emite cuando todas las cargas de esta Assembly han terminado y la Assembly pasa del estado de carga al estado de ejecución.
  • assembly_finished se emite cuando la Assembly ha terminado, no necesariamente cuando el procesamiento se ha completado correctamente. También se envía tras una cancelación o al conectarse a una Assembly que ya ha terminado, incluida una que haya fallado. El servidor finaliza el flujo después de este mensaje. Consulta assembly_ssl_url e inspecciona el estado final: ok: "ASSEMBLY_COMPLETED" indica éxito, ok: "ASSEMBLY_CANCELED" indica cancelación y error indica un fallo.
  • ping se emite periódicamente para mantener viva la conexión mientras se procesa la Assembly. Actualmente se envía cada minuto, aunque este intervalo podría cambiar en el futuro.

Eventos

Un evento consta del nombre del evento y una carga útil adicional. En la transmisión, un evento con el nombre assembly_result_finished tiene este aspecto ([NL] indica un salto de línea):

event: assembly_result_finished[NL]
data: ["avatar",{"id":"5789e06b48ad450aa55f9b3721376581","basename":"lesereihe","field":"file","md5hash":"e9df77e5ee87e8ec3b4453bcddf191bc","ext":"pdf","meta":{"width":1238,"height":1750,"page_count":1},"mime":"application/pdf","name":"lesereihe.pdf","size":120456,"type":"pdf"}][NL]
[NL]

Transloadit envía los siguientes eventos:

  • assembly_error se emite cuando se produce un error mientras la Assembly se está ejecutando. El servidor finalizará el flujo después de este evento. Se incluye información adicional sobre el error, por ejemplo:

    {
  "error": "FILE_FILTER_DECLINED_FILE",
  "message": "One of your files was declined",
  "step": "filter",
  "previousStep": ":original",
  "http_code": 400
}

  • assembly_upload_finished se emite por cada carga que termina. Se incluye información adicional sobre el archivo cargado. La estructura es la misma que la de un objeto del array uploads del Assembly Status, por ejemplo:

    {
  "id": "6bb16f6cd49a44b4ae431f576e016c6d",
  "name": "lesereihe.doc",
  "basename": "lesereihe",
  "ext": "doc",
  "size": 61440,
  "mime": "application/msword",
  "type": "office",
  "field": "file",
  "md5hash": "154a9349b8f9111865a07ed0a7050f55",
  "original_id": "6bb16f6cd49a44b4ae431f576e016c6d",
  "url": null,
  "meta": {}
}

  • assembly_result_finished se emite cada vez que hay disponible un nuevo resultado de un Step. La carga útil es una tupla [stepName, file]. El objeto de archivo tiene la misma estructura que una entrada de results[stepName] del Assembly Status, por ejemplo:

    [
  "avatar",
  {
    "id": "5789e06b48ad450aa55f9b3721376581",
    "basename": "lesereihe",
    "field": "file",
    "md5hash": "e9df77e5ee87e8ec3b4453bcddf191bc",
    "ext": "pdf",
    "meta": {
      "width": 1238,
      "height": 1750,
      "page_count": 1
    },
    "mime": "application/pdf",
    "name": "lesereihe.pdf",
    "size": 120456,
    "type": "pdf"
  }
]

  • assembly_execution_progress se emite a intervalos regulares con información sobre el Execution Progress general de la Assembly y sus archivos. La estructura y los mecanismos se detallan en Assembly Execution Progress, por ejemplo:

    {
  "progress_combined": 50,
  "progress_per_original_file": [
    {
      "original_id": "6bb16f6cd49a44b4ae431f576e016c6d",
      "progress": 50
    }
  ]
}

    Nota: progress_per_original_file está indexado por original_id. Los archivos importados sin un original_id no aparecerán en esta lista.

El flujo no vuelve a enviar eventos anteriores. En particular, un listener de assembly_error no puede informar de un error que se produjo antes de que te conectaras. Una vez que la Assembly ya no está en la memoria del uploader, la URL del flujo devuelve HTTP 404. Ante una desconexión o un flujo no disponible, consulta assembly_ssl_url; si la Assembly sigue en estado de carga o de ejecución, continúa consultando esa URL periódicamente. Un flujo cerrado por sí solo no confirma el éxito.

Ejemplo en JavaScript

Los navegadores modernos ofrecen compatibilidad nativa con los eventos enviados por el servidor mediante el constructor EventSource. Suponiendo que el Assembly Status está almacenado en la variable assembly_status, el cliente puede escuchar el mensaje assembly_finished, el mensaje assembly_uploading_finished y el evento assembly_result_finished de la siguiente manera: Si el flujo se desconecta, este ejemplo pasa a consultar el estado cada dos segundos hasta que la Assembly alcanza un estado terminal. Los fallos de HTTP o de red se notifican en lugar de tratarse como éxito.

const stream = new EventSource(assembly_status.update_stream_url)
const activeStatuses = ["ASSEMBLY_UPLOADING","ASSEMBLY_EXECUTING","ASSEMBLY_REPLAYING"]
let pollingStarted = false

async function checkAssemblyStatus() {
  while (true) {
    const response = await fetch(assembly_status.assembly_ssl_url)
    if (!response.ok) {
      throw new Error(`Assembly status request failed: ${response.status}`)
    }
    const status = await response.json()
    if (status.error) {
      console.error('Assembly failed', status.error)
      return
    }
    if (status.ok === 'ASSEMBLY_COMPLETED') {
      console.log('Assembly completed', status.results)
      return
    }
    if (status.ok === 'ASSEMBLY_CANCELED') {
      console.warn('Assembly was canceled')
      return
    }
    if (!activeStatuses.includes(status.ok)) {
      throw new Error(`Assembly did not complete successfully: ${status.ok}`)
    }
    console.log('Assembly is not complete; continue polling its status URL', status.ok)
    await new Promise((resolve) => setTimeout(resolve, 2000))
  }
}

function closeStreamAndCheckStatus() {
  if (pollingStarted) return
  pollingStarted = true
  stream.close()
  checkAssemblyStatus().catch(console.error)
}

// Listen for the assembly_finished and assembly_uploading_finished messages
stream.addEventListener('message', (event) => {
  switch (event.data) {
    case 'assembly_finished':
      closeStreamAndCheckStatus()
      break
    case 'assembly_uploading_finished':
      console.log('All uploads are finished')
      break
  }
})

// Handle terminal Assembly errors without reconnecting the stream
stream.addEventListener('assembly_error', (event) => {
  const error = JSON.parse(event.data)
  console.error('Assembly failed', error)
  closeStreamAndCheckStatus()
})

// Recover from a disconnected or unavailable stream using the status URL
stream.addEventListener('error', closeStreamAndCheckStatus)

// Listen for the assembly_result_finished event
stream.addEventListener('assembly_result_finished', (event) => {
  const result = JSON.parse(event.data)
  console.log('Assembly result is available', result)
})

Ejemplo de solicitud

Asigna a UPDATE_STREAM_URL la URL completa de update_stream_url de la respuesta de creación de la Assembly. No sustituyas su nombre de host.

curl --fail-with-body -sS --request GET --no-buffer \
  --url "${UPDATE_STREAM_URL:?Set UPDATE_STREAM_URL}" \
  --header 'accept: text/event-stream'

Headers obligatorios de la solicitud

  • accept (valor fijo), obligatorio. Valor aceptado: "text/event-stream". Los valores repetidos del encabezado se unen antes de compararlos.

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.

Solicitud

No se requieren campos ni un cuerpo de solicitud adicionales.

Respuesta

Este es un ejemplo del cuerpo de la respuesta:

data: assembly_uploading_finished

event: assembly_upload_finished
data: {"id":"6bb16f6cd49a44b4ae431f576e016c6d","name":"lesereihe.doc","basename":"lesereihe","ext":"doc","size":61440,"mime":"application/msword","type":"office","field":"file","md5hash":"154a9349b8f9111865a07ed0a7050f55","original_id":"6bb16f6cd49a44b4ae431f576e016c6d","url":null,"meta":{}}

data: assembly_upload_meta_data_extracted

event: assembly_result_finished
data: ["avatar",{"id":"5789e06b48ad450aa55f9b3721376581","basename":"lesereihe","field":"file","md5hash":"e9df77e5ee87e8ec3b4453bcddf191bc","ext":"pdf","meta":{"width":1238,"height":1750,"page_count":1},"mime":"application/pdf","name":"lesereihe.pdf","size":120456,"type":"pdf"}]

event: assembly_execution_progress
data: {"progress_combined":100,"progress_per_original_file":[]}

data: assembly_finished

éxito 2xx

Stream de respuesta mediante Server-Sent Events. text/event-stream

assembly_error

Evento con nombre con un payload JSON en su campo data. El servidor cierra el flujo después de esta notificación. Obtén el estado final del recurso para determinar el resultado.

Carga útil del evento
JSON Schema completo

Abrir JSON en una pestaña nueva

Se aceptan campos adicionales a los enumerados para este objeto.

CampoTipo y descripción
error
string (longitud mínima: 1)

Código de error, cuando esté disponible. Obtén el Assembly Status final incluso cuando este campo no esté presente.

Valores conocidos (363); puede haber otros valores
  • "ADMIN_PERMISSIONS_REQUIRED"
  • "AI_CHAT_VALIDATION"
  • "ASSEMBLY_ACCOUNT_MISMATCH"
  • "ASSEMBLY_CANNOT_BE_REPLAYED"
  • "ASSEMBLY_COULD_NOT_BE_CREATED"
  • "ASSEMBLY_CRASHED"
  • "ASSEMBLY_DISALLOWED_ROBOTS_USED"
  • "ASSEMBLY_EMPTY_STEPS"
  • "ASSEMBLY_EXECUTION_PROGRESS_NOT_ENABLED"
  • "ASSEMBLY_EXPIRED"
  • "ASSEMBLY_FILE_NOT_RESERVED"
  • "ASSEMBLY_INFINITE"
  • "ASSEMBLY_INVALID_NOTIFY_URL"
  • "ASSEMBLY_INVALID_NUM_EXPECTED_UPLOAD_FILES_PARAM"
  • "ASSEMBLY_INVALID_STEPS"
  • "ASSEMBLY_JOB_ENQUEUE_ERROR"
  • "ASSEMBLY_LIST_ERROR"
  • "ASSEMBLY_MEMORY_LIMIT_EXCEEDED"
  • "ASSEMBLY_NOTIFICATIONS_LIST_ERROR"
  • "ASSEMBLY_NOTIFICATION_LIST_ERROR"
  • "ASSEMBLY_NOTIFICATION_NOT_PERSISTED"
  • "ASSEMBLY_NOTIFICATION_NOT_REPLAYED"
  • "ASSEMBLY_NOT_CAPABLE"
  • "ASSEMBLY_NOT_FINISHED"
  • "ASSEMBLY_NOT_FOUND"
  • "ASSEMBLY_NOT_REPLAYED"
  • "ASSEMBLY_NO_CHARGEABLE_STEP"
  • "ASSEMBLY_NO_NOTIFY_URL"
  • "ASSEMBLY_NO_STEPS"
  • "ASSEMBLY_PLAN_FILE_SIZE_LIMIT_EXCEEDED"
  • "ASSEMBLY_ROBOT_MISSING"
  • "ASSEMBLY_SATURATED"
  • "ASSEMBLY_STATS_ERROR"
  • "ASSEMBLY_STATS_INVALID_TIME"
  • "ASSEMBLY_STATS_MISSING_REGION"
  • "ASSEMBLY_STATUS_FETCHING_RATE_LIMIT_REACHED"
  • "ASSEMBLY_STATUS_NOT_FOUND"
  • "ASSEMBLY_STATUS_PARSE_ERROR"
  • "ASSEMBLY_STEP_INVALID"
  • "ASSEMBLY_STEP_INVALID_ROBOT"
  • "ASSEMBLY_STEP_INVALID_USE"
  • "ASSEMBLY_STEP_NO_ROBOT"
  • "ASSEMBLY_STEP_UNKNOWN_ROBOT"
  • "ASSEMBLY_STEP_UNKNOWN_USE"
  • "ASSEMBLY_URL_TRANSFORM_MISSING"
  • "AUDIO_ARTWORK_VALIDATION"
  • "AUDIO_CONCAT_INVALID_INPUT"
  • "AUDIO_CONCAT_VALIDATION"
  • "AUDIO_ENCODE_VALIDATION"
  • "AUDIO_LOOP_VALIDATION"
  • "AUDIO_MERGE_VALIDATION"
  • "AUDIO_SPLIT_NO_OUTPUT"
  • "AUDIO_SPLIT_VALIDATION"
  • "AUDIO_WAVEFORM_VALIDATION"
  • "AUTH_EXPIRED"
  • "AUTH_KEYS_NOT_FOUND"
  • "AUTH_KEY_SCOPES_NOT_FOUND"
  • "AUTH_SECRET_NOT_RETRIEVED"
  • "AZURE_IMPORT_ACCESS_DENIED"
  • "AZURE_IMPORT_FAILURE"
  • "AZURE_IMPORT_NOT_FOUND"
  • "AZURE_IMPORT_VALIDATION"
  • "AZURE_STORE_ACCESS_DENIED"
  • "AZURE_STORE_NOT_FOUND"
  • "AZURE_STORE_VALIDATION"
  • "BACKBLAZE_IMPORT_ACCESS_DENIED"
  • "BACKBLAZE_IMPORT_FAILURE"
  • "BACKBLAZE_IMPORT_NOT_FOUND"
  • "BACKBLAZE_IMPORT_VALIDATION"
  • "BACKBLAZE_STORE_ACCESS_DENIED"
  • "BACKBLAZE_STORE_FAILURE"
  • "BACKBLAZE_STORE_VALIDATION"
  • "BAD_PRICING"
  • "BEARER_TOKEN_AUTH_KEY_MISMATCH"
  • "BEARER_TOKEN_EXPIRED"
  • "BEARER_TOKEN_INVALID"
  • "BILL_LIMIT_EXCEEDED"
  • "BOX_IMPORT_ACCESS_DENIED"
  • "BOX_IMPORT_FAILURE"
  • "BOX_IMPORT_NOT_FOUND"
  • "BOX_IMPORT_VALIDATION"
  • "BOX_STORE_COULD_NOT_PARSE_URL"
  • "BOX_STORE_VALIDATION"
  • "CANNOT_ACCEPT_NEW_ASSEMBLIES"
  • "CDN_REQUIRED"
  • "CLOUDFILES_IMPORT_ACCESS_DENIED"
  • "CLOUDFILES_IMPORT_FAILURE"
  • "CLOUDFILES_IMPORT_NOT_FOUND"
  • "CLOUDFILES_IMPORT_VALIDATION"
  • "CLOUDFILES_STORE_ACCESS_DENIED"
  • "CLOUDFILES_STORE_ERROR"
  • "CLOUDFILES_STORE_VALIDATION"
  • "CLOUDFLARE_IMPORT_ACCESS_DENIED"
  • "CLOUDFLARE_IMPORT_FAILURE"
  • "CLOUDFLARE_IMPORT_NOT_FOUND"
  • "CLOUDFLARE_IMPORT_VALIDATION"
  • "CLOUDFLARE_STORE_ACCESS_DENIED"
  • "CLOUDFLARE_STORE_NOT_FOUND"
  • "CLOUDFLARE_STORE_URL_VERIFICATION_FAILURE"
  • "CLOUDFLARE_STORE_VALIDATION"
  • "CLOUDFLARE_STORE_WRONG_REGION"
  • "CLOUD_AI_IMAGE_VALIDATION"
  • "DAM_STORAGE_UNAVAILABLE"
  • "DIGITALOCEAN_IMPORT_ACCESS_DENIED"
  • "DIGITALOCEAN_IMPORT_FAILURE"
  • "DIGITALOCEAN_IMPORT_NOT_FOUND"
  • "DIGITALOCEAN_IMPORT_VALIDATION"
  • "DIGITALOCEAN_STORE_ACCESS_DENIED"
  • "DIGITALOCEAN_STORE_NOT_FOUND"
  • "DIGITALOCEAN_STORE_VALIDATION"
  • "DIGITALOCEAN_STORE_WRONG_REGION"
  • "DOCUMENT_AUTOROTATE_VALIDATION"
  • "DOCUMENT_CONVERT_UNSUPPORTED_CONVERSION"
  • "DOCUMENT_CONVERT_VALIDATION"
  • "DOCUMENT_EXTRACT_VALIDATION"
  • "DOCUMENT_MERGE_UNSUPPORTED_CONVERSION"
  • "DOCUMENT_MERGE_VALIDATION"
  • "DOCUMENT_OCR_VALIDATION"
  • "DOCUMENT_OPTIMIZE_UNSUPPORTED_INPUT"
  • "DOCUMENT_OPTIMIZE_VALIDATION"
  • "DOCUMENT_SPLIT_VALIDATION"
  • "DOCUMENT_THUMBS_INVALID_INPUT"
  • "DOCUMENT_THUMBS_VALIDATION"
  • "DO_NOT_REUSE_ASSEMBLY_IDS"
  • "DROPBOX_IMPORT_ACCESS_DENIED"
  • "DROPBOX_IMPORT_FAILURE"
  • "DROPBOX_IMPORT_NOT_FOUND"
  • "DROPBOX_IMPORT_VALIDATION"
  • "DROPBOX_STORE_COULD_NOT_PARSE_URL"
  • "DROPBOX_STORE_VALIDATION"
  • "FILE_COMPRESS_INVALID_INPUT"
  • "FILE_COMPRESS_VALIDATION"
  • "FILE_DECOMPRESS_INVALID_INPUT"
  • "FILE_DECOMPRESS_PASSWORD_INCORRECT"
  • "FILE_DECOMPRESS_PASSWORD_REQUIRED"
  • "FILE_DECOMPRESS_VALIDATION"
  • "FILE_DOWNLOAD_ERROR"
  • "FILE_FILTER_DECLINED_FILE"
  • "FILE_FILTER_INVALID_OPERATOR"
  • "FILE_FILTER_VALIDATION"
  • "FILE_HASH_VALIDATION"
  • "FILE_META_DATA_ERROR"
  • "FILE_PREVIEW_VALIDATION"
  • "FILE_READ_VALIDATION_ERROR"
  • "FILE_SERVE_NO_RESULT"
  • "FILE_SERVE_VALIDATION"
  • "FILE_VERIFY_INVALID_FILE"
  • "FILE_VERIFY_VALIDATION"
  • "FILE_VIRUSSCAN_DECLINED_FILE"
  • "FILE_VIRUSSCAN_INVALID_INPUT"
  • "FILE_VIRUSSCAN_VALIDATION"
  • "FTP_IMPORT_ACCESS_DENIED"
  • "FTP_IMPORT_FAILURE"
  • "FTP_IMPORT_NOT_FOUND"
  • "FTP_IMPORT_VALIDATION"
  • "FTP_STORE_VALIDATION"
  • "GET_ACCOUNT_DB_ERROR"
  • "GET_ACCOUNT_UNKNOWN_AUTH_KEY"
  • "GOOGLE_IMPORT_ACCESS_DENIED"
  • "GOOGLE_IMPORT_FAILURE"
  • "GOOGLE_IMPORT_NOT_FOUND"
  • "GOOGLE_IMPORT_VALIDATION"
  • "GOOGLE_STORE_INVALID_INPUT"
  • "GOOGLE_STORE_VALIDATION"
  • "HTML_CONVERT_VALIDATION"
  • "HTTP_IMPORT_ACCESS_DENIED"
  • "HTTP_IMPORT_FAILURE"
  • "HTTP_IMPORT_NOT_FOUND"
  • "HTTP_IMPORT_VALIDATION"
  • "HTTP_REQUEST_FAILURE"
  • "HTTP_REQUEST_VALIDATION"
  • "IMAGE_BGREMOVE_VALIDATION"
  • "IMAGE_COPYRIGHT_DETECT_DECLINED_FILE"
  • "IMAGE_COPYRIGHT_DETECT_VALIDATION"
  • "IMAGE_DESCRIBE_VALIDATION"
  • "IMAGE_ENHANCE_NO_INPUT_FILE"
  • "IMAGE_ENHANCE_VALIDATION"
  • "IMAGE_FACEDETECT_VALIDATION"
  • "IMAGE_GENERATE_VALIDATION"
  • "IMAGE_MERGE_FAILURE"
  • "IMAGE_MERGE_VALIDATION"
  • "IMAGE_OCR_VALIDATION"
  • "IMAGE_OPTIMIZE_VALIDATION"
  • "IMAGE_RESIZE_ERROR"
  • "IMAGE_RESIZE_INVALID_BLUR_REGION"
  • "IMAGE_RESIZE_INVALID_TEXT_OBJECT_VALUE"
  • "IMAGE_RESIZE_INVALID_TEXT_VALUE"
  • "IMAGE_RESIZE_INVALID_WATERMARK_OFFSET"
  • "IMAGE_RESIZE_INVALID_WATERMARK_POSITION"
  • "IMAGE_RESIZE_NO_CLUT_FILE"
  • "IMAGE_RESIZE_NO_INPUT_FILE"
  • "IMAGE_RESIZE_VALIDATION"
  • "IMAGE_UPSCALE_VALIDATION"
  • "IMPORT_FILE_ERROR"
  • "INCOMPLETE_PRICING"
  • "INSUFFICIENT_AUTH_SCOPE"
  • "INTERNAL_COMMAND_ERROR"
  • "INTERNAL_COMMAND_TIMEOUT"
  • "INVALID_ASSEMBLY_STATUS"
  • "INVALID_AUTH_EXPIRES_PARAMETER"
  • "INVALID_AUTH_KEY_PARAMETER"
  • "INVALID_AUTH_MAX_NUMBER_OF_FILES_PARAMETER"
  • "INVALID_AUTH_MAX_SIZE_PARAMETER"
  • "INVALID_AUTH_REFERER_PARAMETER"
  • "INVALID_FILE_META_DATA"
  • "INVALID_FORM_DATA"
  • "INVALID_INPUT_ERROR"
  • "INVALID_PARAMS_FIELD"
  • "INVALID_SIGNATURE"
  • "INVALID_STEP_NAME"
  • "INVALID_TEMPLATE_FIELD"
  • "INVALID_UPLOAD_HANDLE_STEP_NAME"
  • "INVALID_URL_ENCODING"
  • "MAX_NUMBER_OF_FILES_EXCEEDED"
  • "MAX_SIZE_EXCEEDED"
  • "MEGA_IMPORT_ACCESS_DENIED"
  • "MEGA_IMPORT_FAILURE"
  • "MEGA_IMPORT_NOT_FOUND"
  • "MEGA_IMPORT_VALIDATION"
  • "MEGA_STORE_ACCESS_DENIED"
  • "MEGA_STORE_NOT_FOUND"
  • "MEGA_STORE_VALIDATION"
  • "MEGA_STORE_WRONG_REGION"
  • "META_WRITE_VALIDATION"
  • "MINIO_IMPORT_ACCESS_DENIED"
  • "MINIO_IMPORT_FAILURE"
  • "MINIO_IMPORT_NOT_FOUND"
  • "MINIO_IMPORT_VALIDATION"
  • "MINIO_STORE_ACCESS_DENIED"
  • "MINIO_STORE_NOT_FOUND"
  • "MINIO_STORE_VALIDATION"
  • "MINIO_STORE_WRONG_REGION"
  • "NO_AUTH_EXPIRES_PARAMETER"
  • "NO_AUTH_KEY_PARAMETER"
  • "NO_AUTH_PARAMETER"
  • "NO_COUNTRY"
  • "NO_OBJECT_AUTH_PARAMETER"
  • "NO_OBJECT_PARAMS_FIELD"
  • "NO_PARAMS_FIELD"
  • "NO_PRICING"
  • "NO_RESULT_STEP_FOUND"
  • "NO_RPC_RESULT_FROM_IMAGE_RESIZER"
  • "NO_SIGNATURE_FIELD"
  • "NO_TEMPLATE_ID"
  • "PLAN_LIMIT_EXCEEDED"
  • "POSSIBLY_MALICIOUS_FILE_FOUND"
  • "PRIORITY_JOB_SLOTS_NOT_FOUND"
  • "PRIORITY_JOB_SLOT_STATS_ERROR"
  • "PRIORITY_JOB_SLOT_STATS_INVALID_AGGREGATION"
  • "PRIORITY_JOB_SLOT_STATS_INVALID_TIME"
  • "PRIORITY_JOB_SLOT_STATS_MISSING_REGION"
  • "RATE_LIMIT_REACHED"
  • "REFERER_MISMATCH"
  • "REQUEST_PREMATURE_CLOSED"
  • "ROBOT_VALIDATION_BASE_ERROR"
  • "S3_ACCESS_DENIED"
  • "S3_IMPORT_ACCESS_DENIED"
  • "S3_IMPORT_FAILURE"
  • "S3_IMPORT_NOT_FOUND"
  • "S3_IMPORT_VALIDATION"
  • "S3_NOT_FOUND"
  • "S3_STORE_ACCESS_DENIED"
  • "S3_STORE_FAILURE"
  • "S3_STORE_NOT_FOUND"
  • "S3_STORE_URL_VERIFICATION_FAILURE"
  • "S3_STORE_VALIDATION"
  • "S3_STORE_WRONG_REGION"
  • "S3_WRONG_REGION"
  • "SCRIPT_RUN_VALIDATION"
  • "SERVER_403"
  • "SERVER_404"
  • "SERVER_500"
  • "SFTP_IMPORT_ACCESS_DENIED"
  • "SFTP_IMPORT_FAILURE"
  • "SFTP_IMPORT_NOT_FOUND"
  • "SFTP_IMPORT_VALIDATION"
  • "SFTP_STORE_VALIDATION"
  • "SIGNATURE_REUSE_DETECTED"
  • "SPEECH_TRANSCRIBE_VALIDATION"
  • "STORAGE_GRANT_NOT_CREATED"
  • "SUPABASE_IMPORT_ACCESS_DENIED"
  • "SUPABASE_IMPORT_FAILURE"
  • "SUPABASE_IMPORT_NOT_FOUND"
  • "SUPABASE_IMPORT_VALIDATION"
  • "SUPABASE_STORE_ACCESS_DENIED"
  • "SUPABASE_STORE_NOT_FOUND"
  • "SUPABASE_STORE_VALIDATION"
  • "SUPABASE_STORE_WRONG_REGION"
  • "SWIFT_IMPORT_ACCESS_DENIED"
  • "SWIFT_IMPORT_FAILURE"
  • "SWIFT_IMPORT_NOT_FOUND"
  • "SWIFT_IMPORT_VALIDATION"
  • "SWIFT_STORE_ACCESS_DENIED"
  • "SWIFT_STORE_NOT_FOUND"
  • "SWIFT_STORE_VALIDATION"
  • "SWIFT_STORE_WRONG_REGION"
  • "TEMPLATE_CREDENTIALS_INJECTION_ERROR"
  • "TEMPLATE_DB_ERROR"
  • "TEMPLATE_DENIES_STEPS_OVERRIDE"
  • "TEMPLATE_INVALID_JSON"
  • "TEMPLATE_NOT_FOUND"
  • "TEXT_SPEAK_VALIDATION"
  • "TEXT_TRANSLATE_VALIDATION"
  • "TIGRIS_IMPORT_ACCESS_DENIED"
  • "TIGRIS_IMPORT_FAILURE"
  • "TIGRIS_IMPORT_NOT_FOUND"
  • "TIGRIS_IMPORT_VALIDATION"
  • "TIGRIS_STORE_ACCESS_DENIED"
  • "TIGRIS_STORE_NOT_FOUND"
  • "TIGRIS_STORE_VALIDATION"
  • "TIGRIS_STORE_WRONG_REGION"
  • "TMP_FILE_DOWNLOAD_ERROR"
  • "TOKEN_INVALID_CREDENTIALS"
  • "TRANSIENT_STORAGE_SERVICE_ERROR"
  • "TRANSLOADIT_IMPORT_ACCESS_DENIED"
  • "TRANSLOADIT_IMPORT_FAILURE"
  • "TRANSLOADIT_IMPORT_NOT_FOUND"
  • "TRANSLOADIT_IMPORT_VALIDATION"
  • "TRANSLOADIT_STORE_CONFLICT"
  • "TRANSLOADIT_STORE_FAILURE"
  • "TRANSLOADIT_STORE_UNAVAILABLE"
  • "TRANSLOADIT_STORE_VALIDATION"
  • "TUS_STORE_VALIDATION"
  • "USER_COMMAND_ERROR"
  • "VERIFIED_EMAIL_REQUIRED"
  • "VIDEO_ADAPTIVE_VALIDATION"
  • "VIDEO_ARTWORK_VALIDATION"
  • "VIDEO_CONCAT_INVALID_INPUT"
  • "VIDEO_CONCAT_NO_OUTPUT"
  • "VIDEO_CONCAT_VALIDATION"
  • "VIDEO_ENCODE_INVALID_VIDEO_CODEC"
  • "VIDEO_ENCODE_INVALID_WATERMARK_POSITION"
  • "VIDEO_ENCODE_VALIDATION"
  • "VIDEO_GENERATE_VALIDATION"
  • "VIDEO_MERGE_NO_IMAGE_FOUND"
  • "VIDEO_MERGE_VALIDATION"
  • "VIDEO_ONDEMAND_NOT_FOUND"
  • "VIDEO_ONDEMAND_VALIDATION"
  • "VIDEO_SPLIT_NO_OUTPUT"
  • "VIDEO_SPLIT_VALIDATION"
  • "VIDEO_SUBTITLE_VALIDATION"
  • "VIDEO_THUMBS_INVALID_COUNT_VALUE"
  • "VIDEO_THUMBS_INVALID_FORMAT"
  • "VIDEO_THUMBS_INVALID_INPUT"
  • "VIDEO_THUMBS_VALIDATION"
  • "VIMEO_IMPORT_ACCESS_DENIED"
  • "VIMEO_IMPORT_FAILURE"
  • "VIMEO_IMPORT_NOT_FOUND"
  • "VIMEO_IMPORT_VALIDATION"
  • "VIMEO_STORE_ACCESS_DENIED"
  • "VIMEO_STORE_PROBLEM_SENDING_FILE"
  • "VIMEO_STORE_VALIDATION"
  • "WASABI_IMPORT_ACCESS_DENIED"
  • "WASABI_IMPORT_FAILURE"
  • "WASABI_IMPORT_NOT_FOUND"
  • "WASABI_IMPORT_VALIDATION"
  • "WASABI_STORE_ACCESS_DENIED"
  • "WASABI_STORE_NOT_FOUND"
  • "WASABI_STORE_VALIDATION"
  • "WASABI_STORE_WRONG_REGION"
  • "WORKER_JOB_ERROR"
  • "YOUTUBE_STORE_PROBLEM_SENDING_FILE"
  • "YOUTUBE_STORE_VALIDATION"
http_code
number

Estado HTTP asociado al error. Este campo no cambia el estado HTTP del flujo ya abierto.

message
string

Un mensaje legible que explica el estado de esta Assembly. No siempre está presente.

previousStep
string

Nombre del Step anterior relacionado con el error, cuando esté disponible.

reason
null | string | number | boolean | Array<cualquier valor> | object

Detalles de diagnóstico opcionales. No asumas que este valor es una cadena ni lo muestres directamente; usa message para el texto legible por humanos. Los detalles de diagnóstico pueden variar; usa el código error para el manejo programático de errores.

Puede aplicarse cualquiera de los esquemas siguientes:

null
string
number
boolean
Array<cualquier valor>
Array<cualquier valor>
Esquema de los elementos del array
cualquier valor
object
object
Esquema de propiedades adicionales
cualquier valor
step
string

Nombre del Step relacionado con el error, cuando esté disponible.

assembly_execution_progress

Evento con nombre con un payload JSON en su campo data.

Carga útil del evento
JSON Schema completo

Abrir JSON en una pestaña nueva

Se aceptan campos adicionales a los enumerados para este objeto.

CampoTipo y descripción
progress_combined

obligatorio

number | null

Progreso general estimado como porcentaje. Null significa que no se puede estimar el progreso general.

progress_per_original_file

obligatorio

Array<object>

Estimaciones de progreso para los archivos de entrada originales. Los archivos importados sin un ID original no se incluyen.

Esquema de los elementos del array
object

progress_per_original_file[]: Se aceptan campos adicionales a los enumerados para este objeto.

CampoTipo y descripción
progress_per_original_file[].original_id

obligatorio

string

ID del archivo de entrada original al que corresponde esta estimación de progreso.

progress_per_original_file[].progress

obligatorio

number

Progreso estimado del procesamiento de este archivo original, expresado como porcentaje.

assembly_finished

Mensaje cuyo campo data contiene este nombre como texto sin formato, sin un campo event. El servidor cierra el flujo después de esta notificación. Obtén el estado final del recurso para determinar el resultado.

ping

Mensaje cuyo campo data contiene este nombre como texto sin formato, sin un campo event.

assembly_result_finished

Evento con nombre con un payload JSON en su campo data.

Carga útil del evento
JSON Schema completo

Abrir JSON en una pestaña nueva

[string, object] (cantidad mínima de elementos: 2, cantidad máxima de elementos: 2)
Elemento de tupla 1
string
Elemento de tupla 2

[1]: Se aceptan campos adicionales a los enumerados para este objeto.

CampoTipo y descripción
[1].as
string | Array<string> | null

Puede aplicarse cualquiera de los esquemas siguientes:

string
Array<string>
Array<string>
Esquema de los elementos del array
string
null
[1].asset_id
string

Identidad estable de un archivo almacenado mediante /transloadit/store. Consérvala junto con su Workspace y version_id; el id habitual del archivo no es un ID de activo de Storage.

[1].asset_version
number

Revisión numérica del activo almacenado. Usa version_id, no este número, para seleccionar los bytes exactos que se conservan.

[1].basename
null | string

El nombre del archivo sin la extensión.

[1].cost
number | null
[1].duration
number | null
[1].duration_human
null | string
[1].execTime
number | null
[1].exec_time
number | null
[1].ext
null | string

La extensión del archivo. Puede ser null cuando no se haya determinado una extensión, o una cadena vacía si el nombre no tiene extensión.

[1].field
null | string

El nombre del campo de formulario utilizado para enviar este archivo.

[1].filepath
null | string
[1].forcedFileExt
string
[1].from_batch_import
boolean
[1].has_alpha
boolean

Indica si esta versión almacenada de la imagen tiene un canal alfa, cuando se conoce.

[1].height
number | null
[1].hls_url
string
[1].id
string

Un ID aleatorio y único que Transloadit utiliza internamente para identificar el archivo.

[1].import_url
string
[1].ios_url
string
[1].is_temp_url
boolean
[1].is_tus_file
boolean
[1].md5hash
null | string
[1].meta
object | null

Un objeto que contiene metadatos adicionales extraídos del archivo, como se muestra a continuación. Las etiquetas de fecha repetidas pueden devolverse como listas de sus valores originales. Comprueba el tipo del valor antes de usarlo como una única marca de tiempo.

Puede aplicarse cualquiera de los esquemas siguientes:

object
object

[1].meta: Se aceptan campos adicionales a los enumerados para este objeto.

CampoTipo y descripción
[1].meta.album
string | number | null

Puede aplicarse cualquiera de los esquemas siguientes:

string | number
string | number
null
[1].meta.aperture
number | null

El valor de apertura de esta imagen, como 5.7.

[1].meta.archive_directory
null | string
[1].meta.artist
string | number | null

Muchas aplicaciones que generan audio escriben información adicional en el archivo de audio, como artist, year, album, genre.

Puede aplicarse cualquiera de los esquemas siguientes:

string | number
string | number
null
[1].meta.aspect_ratio
number | string | null

La relación de aspecto de la imagen, es decir, su ancho dividido por su alto. Será 0 si, por algún motivo, el alto de la imagen es 0.

[1].meta.audio_bitrate
number | null

La tasa de bits de audio en bits por segundo sumando todos los canales, por ejemplo, 128000.

[1].meta.audio_channel_layout
null | string
[1].meta.audio_channels
number | null

El número de canales de audio, normalmente 2 para estéreo.

[1].meta.audio_codec
null | string

El códec de audio, como "faad". Consulta los códecs de audio compatibles.

[1].meta.audio_profile
null | string
[1].meta.audio_sample_format
null | string
[1].meta.audio_samplerate
number | null

La frecuencia de muestreo del audio en hercios, como 44100.

[1].meta.author
string | number | null

El autor que tomó la imagen. Algunas cámaras rellenan este campo en lugar de creator.

Puede aplicarse cualquiera de los esquemas siguientes:

string | number
string | number
null
[1].meta.average_color
null | string

No debe confundirse con el color dominante, que cuenta un único color de píxel, el que más aparece, y tiene casos de uso limitados. El color promedio se calcula escalando primero la imagen de entrada a 1 píxel.

[1].meta.band
null | string
[1].meta.bandwidth
number | null
[1].meta.beats_per_minute
number | null
[1].meta.bit_depth
number | null
[1].meta.character_count
number | null
[1].meta.character_count_with_spaces
number | null
[1].meta.city
null | string

La ciudad en la que se tomó esta imagen, como "Berlin".

[1].meta.closed_captions
boolean | null
[1].meta.cmd
string | Array<string | number>

Los detalles adicionales del esquema están disponibles en el JSON Schema completo.

[1].meta.codecs
null | string
[1].meta.colorprimaries
null | string
[1].meta.colorspace
null | string

El espacio de color detectado del medio, como "sRGB" o "Gray". El espacio de color del video está disponible cuando se detecta mientras la extracción de metadatos está habilitada; no requiere output_meta.colorspace: true. Establecer output_meta: false deshabilita la extracción de metadatos.

[1].meta.colortransfer
null | string
[1].meta.comment
null | string
[1].meta.copyright
string | number | object | null

El campo de metadatos de copyright.

Los detalles adicionales del esquema están disponibles en el JSON Schema completo.

[1].meta.copyright_notice
string | number | null

El campo de metadatos del aviso de copyright.

Puede aplicarse cualquiera de los esquemas siguientes:

string | number
string | number
null
[1].meta.country
null | string

El país en el que se tomó esta imagen, como "Germany".

[1].meta.country_code
null | string

El código del país en el que se tomó esta imagen, como "de".

[1].meta.create_date
string | number | Array<string | number> | null

Los detalles adicionales del esquema están disponibles en el JSON Schema completo.

[1].meta.creator
string | number | Array<string> | null

El creador que tomó la imagen.

Los detalles adicionales del esquema están disponibles en el JSON Schema completo.

[1].meta.date_file_created
string | number | Array<string | number> | null

La marca de tiempo de creación que informan los metadatos del medio, cuando está disponible.

Los detalles adicionales del esquema están disponibles en el JSON Schema completo.

[1].meta.date_file_modified
string | number | Array<string | number> | null

La marca de tiempo de modificación indicada por el sistema de archivos o los metadatos multimedia incrustados.

Los detalles adicionales del esquema están disponibles en el JSON Schema completo.

[1].meta.date_recorded
string | number | Array<string | number> | null

La fecha y la hora en que se grabó el contenido multimedia. Una única marca de tiempo válida en formato de cadena se normaliza a YYYY/MM/DD HH:MM:SS. Cuando se incluye una zona horaria, la marca de tiempo se convierte a UTC/GMT y termina en GMT. Las marcas de tiempo en formato de cadena que no se pueden interpretar se convierten en null. Las marcas de tiempo numéricas y las listas de etiquetas de fecha repetidas conservan sus valores originales.

Los detalles adicionales del esquema están disponibles en el JSON Schema completo.

[1].meta.description
string | number | null

Una descripción de esta imagen, como "This tree is very old.".

Puede aplicarse cualquiera de los esquemas siguientes:

string | number
string | number
null
[1].meta.descriptions
Array<string | object>

Los detalles adicionales del esquema están disponibles en el JSON Schema completo.

[1].meta.device_name
string | number | null

El nombre del dispositivo que grabó el contenido multimedia, como "iPhone 3GS".

Puede aplicarse cualquiera de los esquemas siguientes:

string | number
string | number
null
[1].meta.device_software
string | number | null

La versión del software del dispositivo que grabó el contenido multimedia, como "3.1.2".

Puede aplicarse cualquiera de los esquemas siguientes:

string | number
string | number
null
[1].meta.device_vendor
null | string

El fabricante del dispositivo que grabó el contenido multimedia, como "Apple".

[1].meta.disc
string | number | null

Puede aplicarse cualquiera de los esquemas siguientes:

string | number
string | number
null
[1].meta.dominant_colors
Array<string> | null

Devuelve un array de hasta 10 colores dominantes de la imagen como valores hexadecimales. Omite output_meta.dominant_colors para no realizar esta extracción. Si proporcionas la propiedad, incluso con false, se solicita la extracción, lo que puede generar cargos de uso adicionales cuando se devuelven colores. Si estableces el propio output_meta en false, se desactiva la extracción de metadatos adicionales; aun así, pueden ejecutarse las comprobaciones básicas de tipo y tamaño de archivo.

Los detalles adicionales del esquema están disponibles en el JSON Schema completo.

[1].meta.duration
number | null

La duración del archivo de audio en segundos.

[1].meta.encoder
null | string
[1].meta.encoding_level
null | string
[1].meta.encoding_profile
null | string
[1].meta.ends_at
null | string
[1].meta.exitCode
number | null
[1].meta.exitSignal
null | string
[1].meta.exposure_compensation
number | string | null

La compensación de exposición de esta imagen, como "+4/3".

Puede aplicarse cualquiera de los esquemas siguientes:

number | string
number | string
null
[1].meta.exposure_mode
null | string

El modo de exposición de esta imagen, como "Auto".

[1].meta.exposure_time
number | string | null

El tiempo de exposición de esta imagen, como "1/30".

Puede aplicarse cualquiera de los esquemas siguientes:

number | string
number | string
null
[1].meta.f_number
number | null

El número f de esta imagen, como 5.6.

[1].meta.faces
Array<object> | null

Los detalles adicionales del esquema están disponibles en el JSON Schema completo.

[1].meta.field_order
null | string

El orden de campos que informa FFprobe, como "tt", "bb", "tb", "bt" o "progressive". Establece output_meta.interlaced en true para solicitar la detección que rellena este campo de diagnóstico. Esta clave puede estar presente como null cuando no se solicitó la detección o el orden de campos no estaba disponible. Usa interlaced para distinguir de forma sencilla entre entrelazado y progresivo.

[1].meta.flash
null | string

La configuración del flash de esta imagen, como "Off, Did not fire".

[1].meta.focal_length
null | string

La distancia focal de esta imagen, por ejemplo, "55.0 mm".

[1].meta.frame_count
number | null

El número de fotogramas de un archivo GIF animado. Para todos los demás tipos de imagen, este valor es 1 de forma predeterminada.

[1].meta.framerate
number | null

La velocidad de fotogramas del video, como 29.5.

[1].meta.genre
string | number | null

Puede aplicarse cualquiera de los esquemas siguientes:

string | number
string | number
null
[1].meta.has_alpha
boolean

Indica si la imagen original tiene un canal alfa, incluidas las imágenes con canal alfa totalmente opacas. Se devuelve junto con thumbhash; si falta, significa que se desconoce.

[1].meta.has_alpha_channel
boolean | null
[1].meta.has_artwork
boolean | null
[1].meta.has_clipping_path
boolean

Es true si la imagen contiene un trazado de recorte y false en caso contrario.

[1].meta.has_transparency
boolean | null

Indica si la imagen tiene áreas transparentes. Establece output_meta.has_transparency en true para solicitar la inspección de transparencia. Los valores que se sabe que son falsos, como false para imágenes JPEG, pueden devolverse incluso cuando esta opción se omite o es false. Establecer el propio output_meta en false omite la extracción de metadatos adicionales; las comprobaciones básicas de tipo y tamaño de archivo pueden seguir ejecutándose.

[1].meta.height
number | null

La altura del contenido multimedia en píxeles.

[1].meta.interlace_detection
object | null

Detalles de diagnóstico del detector de entrelazado de Transloadit. Este objeto puede incluir sampled_frames, tff, bff, progressive, undetermined, confidence, method y ffprobe_field_order. Establece output_meta.interlaced en true para solicitar la detección. Esta clave puede estar presente con el valor null cuando no se solicitó la detección; comprueba que sea un objeto no nulo antes de leer sus propiedades.

Los detalles adicionales del esquema están disponibles en el JSON Schema completo.

[1].meta.interlaced
boolean | null

Indica si el video parece usar escaneo entrelazado: true para videos entrelazados o false para videos progresivos. Establece output_meta.interlaced en true para solicitar la detección. Esta clave puede estar presente como null cuando no se solicitó la detección o cuando la detección solicitada no fue concluyente. La mera presencia del campo no demuestra que se haya ejecutado la detección.

[1].meta.iso
number | null

El valor ISO de esta imagen, como 800.

[1].meta.keywords
string | number | Array<string | number | boolean> | null

Palabras clave extraídas de los metadatos del archivo: una cadena, un número finito o un array cuyas entradas pueden ser cadenas, números finitos o booleanos. Por ejemplo, ["tree", "nature"]. El campo puede estar ausente o ser null. Comprueba su tipo antes de iterar; las entradas del array no son necesariamente cadenas.

Los detalles adicionales del esquema están disponibles en el JSON Schema completo.

[1].meta.latitude
number | null

La latitud en la que se grabó el contenido multimedia, como 52.5374.

[1].meta.light_value
number | null

El valor de luz de esta imagen, como 6.9.

[1].meta.line_count
number | null
[1].meta.location
null | string

La ubicación en la que se tomó esta imagen, que suele ser la calle, como "Zingster Str. 32".

[1].meta.longitude
number | null

La longitud en la que se grabó el contenido multimedia, como 13.4034.

[1].meta.lyrics
null | string
[1].meta.mean_volume
number | null

El volumen medio del archivo de audio. Establece output_meta.mean_volume en true para solicitar la medición. Esta clave puede estar presente como null cuando no se solicitó la medición o el valor no estaba disponible. La mera presencia del campo no indica que se haya realizado la medición.

[1].meta.metering_mode
null | string

El modo de medición de esta imagen, como "Multi-segment".

[1].meta.modify_date
string | number | Array<string | number> | null

Los detalles adicionales del esquema están disponibles en el JSON Schema completo.

[1].meta.num_audio_streams
number | null
[1].meta.num_subtitles
number | null
[1].meta.num_video_streams
number | null
[1].meta.orientation
string | number | null

Puede aplicarse cualquiera de los esquemas siguientes:

string | number
string | number
null
[1].meta.overall_bitrate
number | null
[1].meta.page_count
number | null
[1].meta.page_size
null | string
[1].meta.paragraph_count
number | null
[1].meta.performer
null | string
[1].meta.pixel_format
null | string
[1].meta.previousStep
string
[1].meta.producer
null | string
[1].meta.reason
string
[1].meta.recognized_text
Array<string> | Array<object>

Los detalles adicionales del esquema están disponibles en el JSON Schema completo.

[1].meta.reference_count
number | null
[1].meta.relative_path
null | string
[1].meta.resolution
null | string
[1].meta.rights
string | number | null

Puede aplicarse cualquiera de los esquemas siguientes:

string | number
string | number
null
[1].meta.rotation
number | null
[1].meta.seekable
boolean | null

Indica si el formato del video admite la búsqueda de posición (seeking), por ejemplo true.

[1].meta.segment_index
number | null
[1].meta.shutter_speed
number | string | null

La velocidad de obturación de esta imagen, por ejemplo "1/32".

Puede aplicarse cualquiera de los esquemas siguientes:

number | string
number | string
null
[1].meta.starts_at
null | string
[1].meta.state
string | number | null

El estado en el que se tomó esta imagen, como "Berlin".

Puede aplicarse cualquiera de los esquemas siguientes:

string | number
string | number
null
[1].meta.stderr
string
[1].meta.stdout
string
[1].meta.step
string
[1].meta.storage_url
string
[1].meta.streams
object | null

Los detalles adicionales del esquema están disponibles en el JSON Schema completo.

[1].meta.svgViewBoxHeight
number | null
[1].meta.svgViewBoxWidth
number | null
[1].meta.thumb_index
number | null

El índice de la miniatura actual, empezando por 0. Esta clave solo está presente en los resultados de 🤖/video/thumbs.

[1].meta.thumb_offset
number | string | null

El desplazamiento de la miniatura actual, en segundos. Esta clave solo está presente en los resultados de 🤖/video/thumbs.

  • number
  • string
    Patrón de validación (expresión regular)^[\x09-\x0D\x20\xA0\u1680\u2000\u2001\u2002\u2003\u2004\u2005\u2006\u2007\u2008\u2009\u200a\u2028\u2029\u202f\u205f\u3000\ufeff]*[+-]?[0-9]+
  • null
[1].meta.thumbhash
string

ThumbHash codificado en Base64 de la imagen orientada según EXIF. Solicita output_meta.thumbhash en el Step que produce la imagen. Se omite cuando no se solicita, cuando no es compatible, cuando la imagen supera los 40 megapíxeles o cuando falla la extracción. Trata el hash como datos de imagen privados cuando el original es privado.

Patrón de validación (expresión regular)^(?:[A-Za-z0-9+/]{4}){1,15}(?:[A-Za-z0-9+/]{4}|[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)$
[1].meta.time_base
null | string
[1].meta.title
string | number | null

El título de esta imagen, como "Tree".

Puede aplicarse cualquiera de los esquemas siguientes:

string | number
string | number
null
[1].meta.track
string | number | null

Puede aplicarse cualquiera de los esquemas siguientes:

string | number
string | number
null
[1].meta.turbo
boolean | null
[1].meta.version_id
string
[1].meta.video_bitrate
number | null

La tasa de bits de vídeo del vídeo, como 500000.

[1].meta.video_codec
null | string

El códec de video del video, como "ffh264".

[1].meta.white_balance
null | string

El ajuste de balance de blancos de esta imagen, como "Manual".

[1].meta.width
number | null

El ancho del medio en píxeles. En los videos cuya relación de aspecto de visualización difiere de su relación de aspecto de píxeles, este es el ancho de visualización previsto.

[1].meta.word_count
number | null
[1].meta.xp_comment
null | string
[1].meta.xp_keywords
string | number | null

Puede aplicarse cualquiera de los esquemas siguientes:

string | number
string | number
null
[1].meta.xp_subject
string | number | null

Puede aplicarse cualquiera de los esquemas siguientes:

string | number
string | number
null
[1].meta.xp_title
string | number | null

Puede aplicarse cualquiera de los esquemas siguientes:

string | number
string | number
null
[1].meta.year
string | number | null

Puede aplicarse cualquiera de los esquemas siguientes:

string | number
string | number
null
null
[1].mime
null | string

El tipo MIME determinado para este archivo.

[1].name
null | string

El nombre del archivo. Transloadit cambia la extensión utilizada en este campo si el archivo se procesa y se convierte a otro formato.

[1].original_basename
null | string
[1].original_id
string | Array<null | string>

El ID único del archivo subido originalmente a partir del cual se generó este archivo. Permite determinar qué archivo de una subida múltiple se utilizó para generar un archivo determinado, después de varios Steps de procesamiento.

Puede aplicarse cualquiera de los esquemas siguientes:

string
Array<null | string>
Array<null | string>
Esquema de los elementos del array
null | string
[1].original_md5hash
null | string
[1].original_name
null | string
[1].original_path
null | string
[1].path
null | string
[1].playlists
Array<object>
Esquema de los elementos del array
object

[1].playlists[]: Se aceptan campos adicionales a los enumerados para este objeto.

CampoTipo y descripción
[1].playlists[].content
string
[1].playlists[].meta
object

Los detalles adicionales del esquema están disponibles en el JSON Schema completo.

[1].playlists[].name
string | number
[1].playlists[].relative_path
string
[1].playlists[].stream
string
[1].preview
null | string
[1].queue
null | string
[1].queueTime
number | null
[1].queue_time
number | null
[1].remote_path
string
[1].sha256
string

Suma de comprobación SHA-256 en minúsculas de los bytes almacenados, cuando esté disponible.

Patrón de validación (expresión regular)^[a-f0-9]{64}$
[1].signed_ssl_url
string
[1].signed_url
string
[1].size
number | null

El tamaño del archivo, en bytes.

[1].size_human
null | string
[1].ssl_url
null | string
[1].streaming_url
string
[1].thumbhash
string

ThumbHash codificado en Base64 conservado junto con esta versión almacenada de la imagen, cuando esté disponible. Protege estos datos de imagen con los mismos controles de acceso que la imagen original.

Patrón de validación (expresión regular)^(?:[A-Za-z0-9+/]{4}){1,15}(?:[A-Za-z0-9+/]{4}|[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)$
[1].tus_upload_url
null | string
[1].type
null | string

Una categoría abstracta que describe el archivo. Los valores conocidos son "audio", "document", "image", "office", "pdf", "swf", "video", "xls" o null cuando no se detectó ninguna categoría. Los clientes deben aceptar otras cadenas para mantener la compatibilidad con categorías futuras.

[1].url
null | string

Una URL desde la que se puede descargar el archivo, o null cuando no hay ninguna URL de entrega disponible. Las URL temporales de nuestros servidores caducan al cabo de unas horas; exporta los archivos a un almacenamiento para usarlos más adelante. Los resultados de almacenamiento privado de /transloadit/store devuelven null tanto para url como para ssl_url. Conserva el Workspace, el asset_id y el version_id devueltos para disponer de una referencia duradera, sujeta al acceso y a la retención. /transloadit/import acepta asset_id con un version_id opcional, o un path mutable. Ni una URL temporal ni el id del archivo de procesamiento constituyen una referencia duradera al almacenamiento.

[1].user_meta
object | null

Puede aplicarse cualquiera de los esquemas siguientes:

object
object
Esquema de propiedades adicionales
cualquier valor
null
[1].version_id
string

ID de versión inmutable devuelto después de que el almacenamiento finalice el resultado. Importa con asset_id y este version_id para conservar los mismos bytes tras un traslado o una sobrescritura, con sujeción a la retención y al acceso.

Patrón de validación (expresión regular)^[A-Za-z0-9_-]{21}[AQgw]$
[1].vimeo
object

[1].vimeo: Se aceptan campos adicionales a los enumerados para este objeto.

[1].vimeo.title

obligatorio

string
[1].vimeo.uri

obligatorio

string
[1].width
number | null
[1].workspace
string (longitud mínima: 1)

Slug del Workspace al que pertenece este resultado almacenado. Autentícate para este Workspace al importarlo o gestionarlo.

assembly_upload_finished

Evento con nombre con un payload JSON en su campo data.

Carga útil del evento
JSON Schema completo

Abrir JSON en una pestaña nueva

Se aceptan campos adicionales a los enumerados para este objeto.

CampoTipo y descripción
as
string | Array<string> | null

Puede aplicarse cualquiera de los esquemas siguientes:

string
Array<string>
Array<string>
Esquema de los elementos del array
string
null
asset_id
string

Identidad estable de un archivo almacenado mediante /transloadit/store. Consérvala junto con su Workspace y version_id; el id habitual del archivo no es un ID de activo de Storage.

asset_version
number

Revisión numérica del activo almacenado. Usa version_id, no este número, para seleccionar los bytes exactos que se conservan.

basename

obligatorio

null | string

El nombre del archivo sin la extensión.

cost
number | null
exec_time
number
ext

obligatorio

null | string

La extensión del archivo. Puede ser null cuando no se haya determinado una extensión, o una cadena vacía si el nombre no tiene extensión.

field

obligatorio

null | string

El nombre del campo de formulario utilizado para enviar este archivo.

from_batch_import
boolean
has_alpha
boolean

Indica si esta versión almacenada de la imagen tiene un canal alfa, cuando se conoce.

id

obligatorio

string

Un ID aleatorio y único que Transloadit utiliza internamente para identificar el archivo.

import_url
string
is_temp_url
boolean
is_tus_file
boolean
md5hash
null | string
meta

obligatorio

object

Un objeto que contiene metadatos adicionales extraídos del archivo, como se muestra a continuación. Las etiquetas de fecha repetidas pueden devolverse como listas de sus valores originales. Comprueba el tipo del valor antes de usarlo como una única marca de tiempo.

meta: Se aceptan campos adicionales a los enumerados para este objeto.

meta.album
string | number | null

Puede aplicarse cualquiera de los esquemas siguientes:

string | number
string | number
null
meta.aperture
number | null

El valor de apertura de esta imagen, como 5.7.

meta.archive_directory
null | string
meta.artist
string | number | null

Muchas aplicaciones que generan audio escriben información adicional en el archivo de audio, como artist, year, album, genre.

Puede aplicarse cualquiera de los esquemas siguientes:

string | number
string | number
null
meta.aspect_ratio
number | string | null

La relación de aspecto de la imagen, es decir, su ancho dividido por su alto. Será 0 si, por algún motivo, el alto de la imagen es 0.

meta.audio_bitrate
number | null

La tasa de bits de audio en bits por segundo sumando todos los canales, por ejemplo, 128000.

meta.audio_channel_layout
null | string
meta.audio_channels
number | null

El número de canales de audio, normalmente 2 para estéreo.

meta.audio_codec
null | string

El códec de audio, como "faad". Consulta los códecs de audio compatibles.

meta.audio_profile
null | string
meta.audio_sample_format
null | string
meta.audio_samplerate
number | null

La frecuencia de muestreo del audio en hercios, como 44100.

meta.author
string | number | null

El autor que tomó la imagen. Algunas cámaras rellenan este campo en lugar de creator.

Puede aplicarse cualquiera de los esquemas siguientes:

string | number
string | number
null
meta.average_color
null | string

No debe confundirse con el color dominante, que cuenta un único color de píxel, el que más aparece, y tiene casos de uso limitados. El color promedio se calcula escalando primero la imagen de entrada a 1 píxel.

meta.band
null | string
meta.bandwidth
number | null
meta.beats_per_minute
number | null
meta.bit_depth
number | null
meta.character_count
number | null
meta.character_count_with_spaces
number | null
meta.city
null | string

La ciudad en la que se tomó esta imagen, como "Berlin".

meta.closed_captions
boolean | null
meta.cmd
string | Array<string | number>

Los detalles adicionales del esquema están disponibles en el JSON Schema completo.

meta.codecs
null | string
meta.colorprimaries
null | string
meta.colorspace
null | string

El espacio de color detectado del medio, como "sRGB" o "Gray". El espacio de color del video está disponible cuando se detecta mientras la extracción de metadatos está habilitada; no requiere output_meta.colorspace: true. Establecer output_meta: false deshabilita la extracción de metadatos.

meta.colortransfer
null | string
meta.comment
null | string
meta.copyright
string | number | object | null

El campo de metadatos de copyright.

Los detalles adicionales del esquema están disponibles en el JSON Schema completo.

meta.copyright_notice
string | number | null

El campo de metadatos del aviso de copyright.

Puede aplicarse cualquiera de los esquemas siguientes:

string | number
string | number
null
meta.country
null | string

El país en el que se tomó esta imagen, como "Germany".

meta.country_code
null | string

El código del país en el que se tomó esta imagen, como "de".

meta.create_date
string | number | Array<string | number> | null

Los detalles adicionales del esquema están disponibles en el JSON Schema completo.

meta.creator
string | number | Array<string> | null

El creador que tomó la imagen.

Los detalles adicionales del esquema están disponibles en el JSON Schema completo.

meta.date_file_created
string | number | Array<string | number> | null

La marca de tiempo de creación que informan los metadatos del medio, cuando está disponible.

Los detalles adicionales del esquema están disponibles en el JSON Schema completo.

meta.date_file_modified
string | number | Array<string | number> | null

La marca de tiempo de modificación indicada por el sistema de archivos o los metadatos multimedia incrustados.

Los detalles adicionales del esquema están disponibles en el JSON Schema completo.

meta.date_recorded
string | number | Array<string | number> | null

La fecha y la hora en que se grabó el contenido multimedia. Una única marca de tiempo válida en formato de cadena se normaliza a YYYY/MM/DD HH:MM:SS. Cuando se incluye una zona horaria, la marca de tiempo se convierte a UTC/GMT y termina en GMT. Las marcas de tiempo en formato de cadena que no se pueden interpretar se convierten en null. Las marcas de tiempo numéricas y las listas de etiquetas de fecha repetidas conservan sus valores originales.

Los detalles adicionales del esquema están disponibles en el JSON Schema completo.

meta.description
string | number | null

Una descripción de esta imagen, como "This tree is very old.".

Puede aplicarse cualquiera de los esquemas siguientes:

string | number
string | number
null
meta.descriptions
Array<string | object>

Los detalles adicionales del esquema están disponibles en el JSON Schema completo.

meta.device_name
string | number | null

El nombre del dispositivo que grabó el contenido multimedia, como "iPhone 3GS".

Puede aplicarse cualquiera de los esquemas siguientes:

string | number
string | number
null
meta.device_software
string | number | null

La versión del software del dispositivo que grabó el contenido multimedia, como "3.1.2".

Puede aplicarse cualquiera de los esquemas siguientes:

string | number
string | number
null
meta.device_vendor
null | string

El fabricante del dispositivo que grabó el contenido multimedia, como "Apple".

meta.disc
string | number | null

Puede aplicarse cualquiera de los esquemas siguientes:

string | number
string | number
null
meta.dominant_colors
Array<string> | null

Devuelve un array de hasta 10 colores dominantes de la imagen como valores hexadecimales. Omite output_meta.dominant_colors para no realizar esta extracción. Si proporcionas la propiedad, incluso con false, se solicita la extracción, lo que puede generar cargos de uso adicionales cuando se devuelven colores. Si estableces el propio output_meta en false, se desactiva la extracción de metadatos adicionales; aun así, pueden ejecutarse las comprobaciones básicas de tipo y tamaño de archivo.

Los detalles adicionales del esquema están disponibles en el JSON Schema completo.

meta.duration
number | null

La duración del archivo de audio en segundos.

meta.encoder
null | string
meta.encoding_level
null | string
meta.encoding_profile
null | string
meta.ends_at
null | string
meta.exitCode
number | null
meta.exitSignal
null | string
meta.exposure_compensation
number | string | null

La compensación de exposición de esta imagen, como "+4/3".

Puede aplicarse cualquiera de los esquemas siguientes:

number | string
number | string
null
meta.exposure_mode
null | string

El modo de exposición de esta imagen, como "Auto".

meta.exposure_time
number | string | null

El tiempo de exposición de esta imagen, como "1/30".

Puede aplicarse cualquiera de los esquemas siguientes:

number | string
number | string
null
meta.f_number
number | null

El número f de esta imagen, como 5.6.

meta.faces
Array<object> | null

Los detalles adicionales del esquema están disponibles en el JSON Schema completo.

meta.field_order
null | string

El orden de campos que informa FFprobe, como "tt", "bb", "tb", "bt" o "progressive". Establece output_meta.interlaced en true para solicitar la detección que rellena este campo de diagnóstico. Esta clave puede estar presente como null cuando no se solicitó la detección o el orden de campos no estaba disponible. Usa interlaced para distinguir de forma sencilla entre entrelazado y progresivo.

meta.flash
null | string

La configuración del flash de esta imagen, como "Off, Did not fire".

meta.focal_length
null | string

La distancia focal de esta imagen, por ejemplo, "55.0 mm".

meta.frame_count
number | null

El número de fotogramas de un archivo GIF animado. Para todos los demás tipos de imagen, este valor es 1 de forma predeterminada.

meta.framerate
number | null

La velocidad de fotogramas del video, como 29.5.

meta.genre
string | number | null

Puede aplicarse cualquiera de los esquemas siguientes:

string | number
string | number
null
meta.has_alpha
boolean

Indica si la imagen original tiene un canal alfa, incluidas las imágenes con canal alfa totalmente opacas. Se devuelve junto con thumbhash; si falta, significa que se desconoce.

meta.has_alpha_channel
boolean | null
meta.has_artwork
boolean | null
meta.has_clipping_path
boolean

Es true si la imagen contiene un trazado de recorte y false en caso contrario.

meta.has_transparency
boolean | null

Indica si la imagen tiene áreas transparentes. Establece output_meta.has_transparency en true para solicitar la inspección de transparencia. Los valores que se sabe que son falsos, como false para imágenes JPEG, pueden devolverse incluso cuando esta opción se omite o es false. Establecer el propio output_meta en false omite la extracción de metadatos adicionales; las comprobaciones básicas de tipo y tamaño de archivo pueden seguir ejecutándose.

meta.height
number | null

La altura del contenido multimedia en píxeles.

meta.interlace_detection
object | null

Detalles de diagnóstico del detector de entrelazado de Transloadit. Este objeto puede incluir sampled_frames, tff, bff, progressive, undetermined, confidence, method y ffprobe_field_order. Establece output_meta.interlaced en true para solicitar la detección. Esta clave puede estar presente con el valor null cuando no se solicitó la detección; comprueba que sea un objeto no nulo antes de leer sus propiedades.

Los detalles adicionales del esquema están disponibles en el JSON Schema completo.

meta.interlaced
boolean | null

Indica si el video parece usar escaneo entrelazado: true para videos entrelazados o false para videos progresivos. Establece output_meta.interlaced en true para solicitar la detección. Esta clave puede estar presente como null cuando no se solicitó la detección o cuando la detección solicitada no fue concluyente. La mera presencia del campo no demuestra que se haya ejecutado la detección.

meta.iso
number | null

El valor ISO de esta imagen, como 800.

meta.keywords
string | number | Array<string | number | boolean> | null

Palabras clave extraídas de los metadatos del archivo: una cadena, un número finito o un array cuyas entradas pueden ser cadenas, números finitos o booleanos. Por ejemplo, ["tree", "nature"]. El campo puede estar ausente o ser null. Comprueba su tipo antes de iterar; las entradas del array no son necesariamente cadenas.

Los detalles adicionales del esquema están disponibles en el JSON Schema completo.

meta.latitude
number | null

La latitud en la que se grabó el contenido multimedia, como 52.5374.

meta.light_value
number | null

El valor de luz de esta imagen, como 6.9.

meta.line_count
number | null
meta.location
null | string

La ubicación en la que se tomó esta imagen, que suele ser la calle, como "Zingster Str. 32".

meta.longitude
number | null

La longitud en la que se grabó el contenido multimedia, como 13.4034.

meta.lyrics
null | string
meta.mean_volume
number | null

El volumen medio del archivo de audio. Establece output_meta.mean_volume en true para solicitar la medición. Esta clave puede estar presente como null cuando no se solicitó la medición o el valor no estaba disponible. La mera presencia del campo no indica que se haya realizado la medición.

meta.metering_mode
null | string

El modo de medición de esta imagen, como "Multi-segment".

meta.modify_date
string | number | Array<string | number> | null

Los detalles adicionales del esquema están disponibles en el JSON Schema completo.

meta.num_audio_streams
number | null
meta.num_subtitles
number | null
meta.num_video_streams
number | null
meta.orientation
string | number | null

Puede aplicarse cualquiera de los esquemas siguientes:

string | number
string | number
null
meta.overall_bitrate
number | null
meta.page_count
number | null
meta.page_size
null | string
meta.paragraph_count
number | null
meta.performer
null | string
meta.pixel_format
null | string
meta.previousStep
string
meta.producer
null | string
meta.reason
string
meta.recognized_text
Array<string> | Array<object>

Los detalles adicionales del esquema están disponibles en el JSON Schema completo.

meta.reference_count
number | null
meta.relative_path
null | string
meta.resolution
null | string
meta.rights
string | number | null

Puede aplicarse cualquiera de los esquemas siguientes:

string | number
string | number
null
meta.rotation
number | null
meta.seekable
boolean | null

Indica si el formato del video admite la búsqueda de posición (seeking), por ejemplo true.

meta.segment_index
number | null
meta.shutter_speed
number | string | null

La velocidad de obturación de esta imagen, por ejemplo "1/32".

Puede aplicarse cualquiera de los esquemas siguientes:

number | string
number | string
null
meta.starts_at
null | string
meta.state
string | number | null

El estado en el que se tomó esta imagen, como "Berlin".

Puede aplicarse cualquiera de los esquemas siguientes:

string | number
string | number
null
meta.stderr
string
meta.stdout
string
meta.step
string
meta.storage_url
string
meta.streams
object | null

Los detalles adicionales del esquema están disponibles en el JSON Schema completo.

meta.svgViewBoxHeight
number | null
meta.svgViewBoxWidth
number | null
meta.thumb_index
number | null

El índice de la miniatura actual, empezando por 0. Esta clave solo está presente en los resultados de 🤖/video/thumbs.

meta.thumb_offset
number | string | null

El desplazamiento de la miniatura actual, en segundos. Esta clave solo está presente en los resultados de 🤖/video/thumbs.

  • number
  • string
    Patrón de validación (expresión regular)^[\x09-\x0D\x20\xA0\u1680\u2000\u2001\u2002\u2003\u2004\u2005\u2006\u2007\u2008\u2009\u200a\u2028\u2029\u202f\u205f\u3000\ufeff]*[+-]?[0-9]+
  • null
meta.thumbhash
string

ThumbHash codificado en Base64 de la imagen orientada según EXIF. Solicita output_meta.thumbhash en el Step que produce la imagen. Se omite cuando no se solicita, cuando no es compatible, cuando la imagen supera los 40 megapíxeles o cuando falla la extracción. Trata el hash como datos de imagen privados cuando el original es privado.

Patrón de validación (expresión regular)^(?:[A-Za-z0-9+/]{4}){1,15}(?:[A-Za-z0-9+/]{4}|[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)$
meta.time_base
null | string
meta.title
string | number | null

El título de esta imagen, como "Tree".

Puede aplicarse cualquiera de los esquemas siguientes:

string | number
string | number
null
meta.track
string | number | null

Puede aplicarse cualquiera de los esquemas siguientes:

string | number
string | number
null
meta.turbo
boolean | null
meta.version_id
string
meta.video_bitrate
number | null

La tasa de bits de vídeo del vídeo, como 500000.

meta.video_codec
null | string

El códec de video del video, como "ffh264".

meta.white_balance
null | string

El ajuste de balance de blancos de esta imagen, como "Manual".

meta.width
number | null

El ancho del medio en píxeles. En los videos cuya relación de aspecto de visualización difiere de su relación de aspecto de píxeles, este es el ancho de visualización previsto.

meta.word_count
number | null
meta.xp_comment
null | string
meta.xp_keywords
string | number | null

Puede aplicarse cualquiera de los esquemas siguientes:

string | number
string | number
null
meta.xp_subject
string | number | null

Puede aplicarse cualquiera de los esquemas siguientes:

string | number
string | number
null
meta.xp_title
string | number | null

Puede aplicarse cualquiera de los esquemas siguientes:

string | number
string | number
null
meta.year
string | number | null

Puede aplicarse cualquiera de los esquemas siguientes:

string | number
string | number
null
mime

obligatorio

null | string

El tipo MIME determinado para este archivo.

name

obligatorio

null | string

El nombre del archivo. Transloadit cambia la extensión utilizada en este campo si el archivo se procesa y se convierte a otro formato.

original_basename
null | string
original_id

obligatorio

string | Array<null | string>

El ID único del archivo subido originalmente a partir del cual se generó este archivo. Permite determinar qué archivo de una subida múltiple se utilizó para generar un archivo determinado, después de varios Steps de procesamiento.

Puede aplicarse cualquiera de los esquemas siguientes:

string
Array<null | string>
Array<null | string>
Esquema de los elementos del array
null | string
original_md5hash
null | string
original_name
null | string
original_path
string
queue
null | string
queue_time
number
sha256
string

Suma de comprobación SHA-256 en minúsculas de los bytes almacenados, cuando esté disponible.

Patrón de validación (expresión regular)^[a-f0-9]{64}$
size

obligatorio

number

El tamaño del archivo, en bytes.

ssl_url
null | string
thumbhash
string

ThumbHash codificado en Base64 conservado junto con esta versión almacenada de la imagen, cuando esté disponible. Protege estos datos de imagen con los mismos controles de acceso que la imagen original.

Patrón de validación (expresión regular)^(?:[A-Za-z0-9+/]{4}){1,15}(?:[A-Za-z0-9+/]{4}|[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)$
tus_upload_url
null | string
type

obligatorio

null | string

Una categoría abstracta que describe el archivo. Los valores conocidos son "audio", "document", "image", "office", "pdf", "swf", "video", "xls" o null cuando no se detectó ninguna categoría. Los clientes deben aceptar otras cadenas para mantener la compatibilidad con categorías futuras.

url

obligatorio

null | string

Una URL desde la que se puede descargar el archivo, o null cuando no hay ninguna URL de entrega disponible. Las URL temporales de nuestros servidores caducan al cabo de unas horas; exporta los archivos a un almacenamiento para usarlos más adelante. Los resultados de almacenamiento privado de /transloadit/store devuelven null tanto para url como para ssl_url. Conserva el Workspace, el asset_id y el version_id devueltos para disponer de una referencia duradera, sujeta al acceso y a la retención. /transloadit/import acepta asset_id con un version_id opcional, o un path mutable. Ni una URL temporal ni el id del archivo de procesamiento constituyen una referencia duradera al almacenamiento.

user_meta
object
Esquema de propiedades adicionales
cualquier valor
version_id
string

ID de versión inmutable devuelto después de que el almacenamiento finalice el resultado. Importa con asset_id y este version_id para conservar los mismos bytes tras un traslado o una sobrescritura, con sujeción a la retención y al acceso.

Patrón de validación (expresión regular)^[A-Za-z0-9_-]{21}[AQgw]$
workspace
string (longitud mínima: 1)

Slug del Workspace al que pertenece este resultado almacenado. Autentícate para este Workspace al importarlo o gestionarlo.

assembly_upload_meta_data_extracted

Mensaje cuyo campo data contiene este nombre como texto sin formato, sin un campo event.

assembly_uploading_finished

Mensaje cuyo campo data contiene este nombre como texto sin formato, sin un campo event.

HTTP 404, 503

Sin cuerpo de respuesta.

Respuesta de error

Cuerpo de respuesta JSON. application/json text/plain; charset=utf-8

Esquema del cuerpo de la respuesta
JSON Schema completo

Abrir JSON en una pestaña nueva

Se requiere al menos una de estas propiedades: error, message, reason

La respuesta puede contener campos adicionales.

CampoTipo y descripción
assembly_id
string
error
string (longitud mínima: 1)
http_code
number | string
  • number
  • string
    Patrón de validación (expresión regular)^[\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

Explicación del error legible por humanos. Su redacción puede variar; usa el código error cuando manejes un fallo específico.

reason
null | string | number | boolean | Array<cualquier valor> | object

Puede aplicarse cualquiera de los esquemas siguientes:

null
string
number
boolean
Array<cualquier valor>
Array<cualquier valor>
Esquema de los elementos del array
cualquier valor
object
object
Esquema de propiedades adicionales
cualquier valor

Para obtener más información sobre el formato de respuesta, consulta la documentación de Mozilla sobre eventos enviados por el servidor.