Transloadit
Preços
  • Uploads de arquivos
  • Importação de arquivos
  • Processamento em lote (English)
  • Codificação de vídeo
  • Codificação de áudio
  • Processamento de imagens
  • Processamento de documentos
  • Inteligência artificial
  • Filtragem de arquivos e segurança
  • Catalogação de mídia
  • Compressão de arquivos
  • Avaliação de código
  • Exportação de arquivos
  • Smart CDN
  • Ver todos os serviços
  • Explore integrações (English)
  • Explore demonstrações interativas (English)
  • Uppy
  • TransloaditKit
  • Android SDK
  • Node.js SDK
  • Python SDK
  • Ruby SDK
  • Go SDK
  • Java SDK
  • PHP SDK
  • Zapier
  • MCP Server
  • Transloadit CLI
  • Terraform
  • Essenciais
  • Boas práticas
  • Perguntas frequentes
  • Robots
  • API
  • Formatos
  • Crie seu primeiro app
  • Sobre a Transloadit
  • Comparações
  • Código aberto
  • Depoimentos
  • Vagas (English)
  • Segurança
  • Publicações
  • Notícias para devs (English)
  • Dicas para devs
  • Imprensa (English)
  • Pesquisa (English)
  • Estudos de caso
  • Soluções
  • Guias
  • Glossário (English)
  • Jurídico (English)
  • Ferramentas
  • Ajudando a Coursera a levar educação a milhões de pessoas no mundo todo
  • Suporte da Transloadit
  • Suporte para código aberto
  • Acordo de nível de serviço (English)
EssenciaisRobotsPerguntas frequentesAPIFormatosBoas práticas
Tópicos
  • Endpoints
  • Códigos de resposta
  • Autenticação
  • Webhooks
  • Metadados
  • Segurança da API
  • Limite de taxa
  • Filas
  • Uploads retomáveis
Autenticação
  • Criar um token bearer
  • Criar uma nova Auth Key
  • Recuperar lista de Auth Keys
  • Recuperar escopos da Auth Key
  • Editar uma Auth Key
  • Excluir uma Auth Key
  • Recuperar o segredo de uma Auth Key
Assemblies
  • Criar uma nova Assembly
  • Obter um Assembly Status
  • Criar uma Assembly com um ID fornecido
  • Transmitir alterações da Assembly em tempo real
  • Cancelar uma Assembly em execução
  • Reexecutar uma Assembly
  • Recuperar lista de Assemblies
  • Resposta do Assembly Status
  • Recuperar estatísticas de Assemblies
Webhooks
  • Recuperar Assembly Notifications
  • Reenviar Assembly Notification
Faturamento
  • Obter a fatura de um mês
Filas
  • Obter as vagas prioritárias de Jobs em uso no momento
  • Obter estatísticas de vagas prioritárias de Job
Uploads retomáveis
  • Descobrir os recursos do tus
  • Criar um upload tus
  • Obter o offset de um upload tus
  • Enviar bytes de arquivo tus
  • Encerrar um upload tus
  • Baixar um upload tus
Credenciais de Template
  • Criar uma nova credencial de Template
  • Recuperar uma credencial de Template
  • Editar uma credencial de Template
  • Excluir uma credencial de Template
  • Obter lista de credenciais de Template
  • Recuperar tipos de credenciais de Template
Templates
  • Criar um novo Template
  • Recuperar um Template
  • Editar um Template
  • Excluir um Template
  • Recuperar lista de Templates
Gerenciamento de Ativos Digitais
  • Mover ou renomear um ativo de DAM alpha
  • Excluir um ativo do DAM alpha
  • Mover ativos do DAM em massa alpha
  • Excluir ativos do DAM em massa alpha
  • Mover um arquivo ou uma pasta de armazenamento alpha
  • Obter um ativo de armazenamento
  • Listar ativos de armazenamento

Transmitir alterações da Assembly em tempo real

Transmite as alterações de status da Assembly como Server-Sent Events.

GET{UPDATE_STREAM_URL}
Observação

Use a URL de capacidade update_stream_url da resposta validada da Assembly como destino da requisição. Ela não usa credenciais implicitamente disponíveis associadas ao host da API2.

Na resposta após criar uma Assembly, você encontrará dois campos para obter o Assembly Status: assembly_ssl_url e update_stream_url. Você pode buscar o Assembly Status atual na URL informada em assembly_ssl_url. Para obter informações sobre o andamento da Assembly, você pode consultar essa URL regularmente (polling) ou assinar o stream de atualizações, descrito neste documento.

Server-Sent Events

A propriedade update_stream_url no Assembly Status define uma URL em que o stream de atualizações da Assembly correspondente está disponível por meio de server-sent events.

Server-sent events⁠ são uma tecnologia web para enviar notificações em tempo real do servidor para um cliente via HTTP. É semelhante a Web Sockets, mas permite apenas mensagens unidirecionais do servidor para o cliente e consiste em um formato simples, baseado em texto⁠.

Enquanto a Assembly estiver no estado de upload ou de execução, um cliente pode se conectar a este endpoint enviando uma requisição GET com o campo de cabeçalho Accept: text/event-stream para a URL especificada em update_stream_url e analisar o stream da resposta. O servidor pode enviar uma combinação de mensagens e eventos ao cliente. A diferença entre eles é que os eventos incluem um payload adicional com informações, enquanto as mensagens não.

Vários clientes podem assinar a mesma Assembly. Fechar uma conexão mantém as outras conectadas. Durante o desligamento de um uploader, os streams existentes são fechados e novas conexões recebem uma resposta HTTP 503 vazia. Busque o Assembly Status atual para verificar se o processamento terminou.

Mensagens

Uma mensagem consiste no nome da mensagem, sem payload adicional. Na transmissão, uma mensagem com o nome assembly_finished tem esta aparência ([NL] indica uma nova linha):

data: assembly_finished[NL]
[NL]

A Transloadit envia as seguintes mensagens:

  • assembly_upload_meta_data_extracted é emitida quando todos os uploads terminam e os metadados de todos eles foram extraídos.
  • assembly_uploading_finished é emitida quando todos os uploads desta Assembly terminam e a Assembly passa do estado de upload para o estado de execução.
  • assembly_finished é emitida quando a Assembly termina, não necessariamente quando o processamento foi bem-sucedido. Ela também é enviada após um cancelamento ou ao se conectar a uma Assembly que já terminou, inclusive uma que falhou. O servidor encerra o stream após essa mensagem. Busque assembly_ssl_url e inspecione o status final: ok: "ASSEMBLY_COMPLETED" indica sucesso, ok: "ASSEMBLY_CANCELED" indica cancelamento e error indica falha.
  • ping é emitida periodicamente para manter a conexão ativa enquanto a Assembly está sendo processada. Atualmente, ela é enviada a cada minuto, embora esse intervalo possa mudar no futuro.

Eventos

Um evento consiste no nome do evento e em um payload adicional. Na transmissão, um evento com o nome assembly_result_finished tem esta aparência ([NL] indica uma nova linha):

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]

A Transloadit envia os seguintes eventos:

  • assembly_error é emitido quando ocorre um erro durante a execução da Assembly. O servidor encerrará o stream após esse evento. Informações adicionais sobre o erro são incluídas, por exemplo:

    {
      "error": "FILE_FILTER_DECLINED_FILE",
      "message": "One of your files was declined",
      "step": "filter",
      "previousStep": ":original",
      "http_code": 400
    }
    
  • assembly_upload_finished é emitido para cada upload concluído. Informações adicionais sobre o arquivo enviado são incluídas. A estrutura é a mesma de um objeto no array uploads do Assembly Status, por exemplo:

    {
      "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 é emitido sempre que um novo resultado de um Step está disponível. O payload é uma tupla [stepName, file]. O objeto de arquivo tem a mesma estrutura de uma entrada em results[stepName] do Assembly Status, por exemplo:

    [
      "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 é emitido em intervalos regulares com informações sobre o Execution Progress geral da Assembly e de seus arquivos. A estrutura e os mecanismos são detalhados em Assembly Execution Progress, por exemplo:

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

    Observação: progress_per_original_file é indexado por original_id. Arquivos importados sem um original_id não aparecerão nesta lista.

Observação

Mensagens e eventos adicionais podem ser incluídos no futuro. Portanto, um cliente deve ignorar mensagens/eventos inesperados e não falhar com erro.

O stream não reenvia eventos anteriores. Em particular, um listener de assembly_error não pode relatar um erro que ocorreu antes de você se conectar. Quando a Assembly não estiver mais na memória do uploader, a URL do stream retornará HTTP 404. Em caso de desconexão ou de stream indisponível, busque assembly_ssl_url; se a Assembly ainda estiver em upload ou em execução, continue consultando essa URL. Um stream fechado, por si só, não indica sucesso.

Exemplo em JavaScript

Navegadores modernos oferecem suporte nativo a server-sent events por meio do construtor EventSource. Supondo que o Assembly Status esteja armazenado na variável assembly_status, o cliente pode escutar a mensagem assembly_finished, a mensagem assembly_uploading_finished e o evento assembly_result_finished da seguinte forma: Se o stream se desconectar, este exemplo passa a consultar o status a cada dois segundos até que a Assembly atinja um status terminal. Falhas de HTTP ou de rede são relatadas em vez de serem tratadas como sucesso.

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)
})

Exemplo de requisição

Defina UPDATE_STREAM_URL como a URL completa de update_stream_url da resposta de criação da Assembly. Não substitua o hostname dela.

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

Cabeçalhos de requisição obrigatórios

  • accept (valor fixo), obrigatório. Valor aceito: "text/event-stream". Valores de cabeçalho repetidos são unidos antes da correspondência.

Parâmetros de consulta opcionais da resposta

  • callback (Nome do callback JavaScript). Envolve respostas JSON em um callback JSONP. O nome do callback deve corresponder a ^(?:_jqjsp[0-9]*|jQuery[0-9]+_[0-9]+)$. Apenas a última ocorrência é usada; um valor vazio é ignorado. Nomes de callback inválidos retornam HTTP 403. A resposta transformada usa HTTP 200. O callback é aplicado após a serialização da resposta.

Requisição

Nenhum corpo de requisição ou campo adicional é necessário.

Resposta

Veja um exemplo de corpo de resposta:

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

sucesso 2xx

Fluxo de resposta de Server-Sent Events. text/event-stream

assembly_error

Evento nomeado com um payload JSON no campo data. O servidor encerra o stream após esta notificação. Consulte o status final do recurso para saber o resultado.

Payload do evento
Esquema JSON completo

Abrir JSON em uma nova aba

Campos além dos listados para este objeto são aceitos.

CampoTipo e descrição
error
string

Código de erro, quando disponível. Busque o Assembly Status final mesmo quando este campo estiver ausente.

Valores permitidos (362)
  • "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"
  • "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

Status HTTP associado ao erro. Este campo não altera o status HTTP do stream já aberto.

message
string

Uma mensagem legível por humanos que explica o estado desta Assembly. Nem sempre está presente.

previousStep
string

Nome do Step anterior associado ao erro, quando disponível.

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

Detalhes de diagnóstico opcionais. Não presuma que este valor seja uma string nem o exiba diretamente; use message para obter texto legível por humanos. Os detalhes de diagnóstico podem variar; use o código error para o tratamento programático de erros.

Qualquer um dos esquemas a seguir pode ser aplicado:

null
string
number
boolean
Array<qualquer valor>
Array<qualquer valor>
Esquema do item do array
qualquer valor
object
object
Esquema de propriedade adicional
qualquer valor
step
string

Nome do Step associado ao erro, quando disponível.

assembly_execution_progress

Evento nomeado com um payload JSON no campo data.

Payload do evento
Esquema JSON completo

Abrir JSON em uma nova aba

Campos além dos listados para este objeto são aceitos.

CampoTipo e descrição
progress_combined

obrigatório

number | null

Progresso geral estimado, em porcentagem. Null significa que não é possível estimar o progresso geral.

progress_per_original_file

obrigatório

Array<object>

Estimativas de progresso dos arquivos de entrada originais. Arquivos importados sem um ID original não são incluídos.

Esquema do item do array
object

progress_per_original_file[]: Campos além dos listados para este objeto são aceitos.

CampoTipo e descrição
progress_per_original_file[].original_id

obrigatório

string

ID do arquivo de entrada original ao qual esta estimativa de progresso pertence.

progress_per_original_file[].progress

obrigatório

number

Progresso estimado do processamento deste arquivo original, em porcentagem.

assembly_finished

Mensagem cujo campo data contém esse nome como texto simples, sem um campo event. O servidor encerra o stream após esta notificação. Consulte o status final do recurso para saber o resultado.

ping

Mensagem cujo campo data contém esse nome como texto simples, sem um campo event.

assembly_result_finished

Evento nomeado com um payload JSON no campo data.

Payload do evento
Esquema JSON completo

Abrir JSON em uma nova aba

[string, object] (itens mínimos: 2, máximo de itens: 2)
Item da tupla 1
string
Item da tupla 2

[1]: Campos além dos listados para este objeto são aceitos.

CampoTipo e descrição
[1].as
string | Array<string> | null

Qualquer um dos esquemas a seguir pode ser aplicado:

string
Array<string>
Array<string>
Esquema do item do array
string
null
[1].asset_id
string

Identidade estável de um arquivo armazenado por /transloadit/store. Guarde esse valor junto com seu Workspace e version_id; o id comum do arquivo não é um ID de ativo de armazenamento.

[1].asset_version
number

Revisão numérica do ativo armazenado. Use version_id, e não este número, para selecionar os bytes exatos retidos.

[1].basename
null | string

O nome do arquivo sem a extensão.

[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

A extensão do arquivo.

[1].field
null | string

O nome do campo de formulário usado para enviar este arquivo.

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

Indica se esta versão armazenada da imagem tem canal alfa, quando essa informação é conhecida.

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

Um ID aleatório e único usado internamente pela Transloadit para rastrear o arquivo.

[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

Um objeto contendo metadados adicionais extraídos do arquivo, conforme mostrado abaixo.

Qualquer um dos esquemas a seguir pode ser aplicado:

object
object

[1].meta: Campos além dos listados para este objeto são aceitos.

CampoTipo e descrição
[1].meta.album
string | number | null

Qualquer um dos esquemas a seguir pode ser aplicado:

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

A configuração de abertura desta imagem, como 5.7.

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

Muitos aplicativos que produzem áudio gravam informações adicionais no arquivo de áudio, como artist, year, album, genre.

Qualquer um dos esquemas a seguir pode ser aplicado:

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

A proporção da imagem, ou seja, a largura dividida pela altura. Será 0 se, por algum motivo, a altura da imagem for 0.

[1].meta.audio_bitrate
number | null

A taxa de bits do áudio em bits por segundo, considerando todos os canais, como 128000.

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

O número de canais de áudio, normalmente 2 para estéreo.

[1].meta.audio_codec
null | string

O codec de áudio, como "faad". Veja os codecs de áudio compatíveis.

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

A taxa de amostragem do áudio em hertz, como 44100.

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

O autor que tirou a imagem. Algumas câmeras preenchem este campo em vez de creator.

Qualquer um dos esquemas a seguir pode ser aplicado:

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

Não confunda com a cor dominante, que conta a cor de pixel que mais ocorre e tem casos de uso limitados. A cor média é calculada redimensionando primeiro a imagem de entrada para 1 pixel.

[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

A cidade em que esta imagem foi capturada, como "Berlin".

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

Detalhes adicionais do esquema estão disponíveis no JSON Schema completo.

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

O espaço de cores detectado da mídia, como "sRGB" ou "Gray". O espaço de cores do vídeo fica disponível quando é detectado enquanto a extração de metadados está habilitada; ele não exige output_meta.colorspace: true. Definir output_meta: false desabilita a extração de metadados.

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

O campo de metadados de copyright.

Detalhes adicionais do esquema estão disponíveis no JSON Schema completo.

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

O campo de metadados do aviso de direitos autorais.

Qualquer um dos esquemas a seguir pode ser aplicado:

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

O país em que esta imagem foi capturada, como "Germany".

[1].meta.country_code
null | string

O código do país em que esta imagem foi tirada, como "de".

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

Qualquer um dos esquemas a seguir pode ser aplicado:

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

O criador que capturou a imagem.

Detalhes adicionais do esquema estão disponíveis no JSON Schema completo.

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

O timestamp de criação informado pelos metadados da mídia, quando disponível.

Qualquer um dos esquemas a seguir pode ser aplicado:

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

A data e hora de modificação do arquivo de mídia no sistema de arquivos.

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

A data e a hora em que a mídia foi gravada, no formato YYYY/MM/DD HH:MM:SS TZ, como "2010/06/30 22:16:06 GMT".

Qualquer um dos esquemas a seguir pode ser aplicado:

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

Uma descrição desta imagem, como "This tree is very old.".

Qualquer um dos esquemas a seguir pode ser aplicado:

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

Detalhes adicionais do esquema estão disponíveis no JSON Schema completo.

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

O nome do dispositivo que gravou a mídia, como "iPhone 3GS".

Qualquer um dos esquemas a seguir pode ser aplicado:

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

A versão do software do dispositivo que gravou a mídia, como "3.1.2".

Qualquer um dos esquemas a seguir pode ser aplicado:

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

O fabricante do dispositivo que gravou a mídia, como "Apple".

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

Qualquer um dos esquemas a seguir pode ser aplicado:

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

Retorna um array com até 10 cores dominantes da imagem em valores hexadecimais. Omita output_meta.dominant_colors para pular essa extração. Informar a propriedade, inclusive com false, solicita a extração e pode gerar cobranças de uso adicionais quando cores forem retornadas. Definir o próprio output_meta como false desativa a extração de metadados adicionais; as verificações básicas de tipo e tamanho do arquivo ainda podem ser executadas.

Detalhes adicionais do esquema estão disponíveis no JSON Schema completo.

[1].meta.duration
number | null

A duração do arquivo de áudio em 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

A compensação de exposição desta imagem, como "+4/3".

Qualquer um dos esquemas a seguir pode ser aplicado:

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

O modo de exposição desta imagem, como "Auto".

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

O tempo de exposição desta imagem, como "1/30".

Qualquer um dos esquemas a seguir pode ser aplicado:

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

O número f desta imagem, como 5.6.

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

Detalhes adicionais do esquema estão disponíveis no JSON Schema completo.

[1].meta.field_order
null | string

A ordem de campos informada pelo FFprobe, como "tt", "bb", "tb", "bt" ou "progressive". Defina output_meta.interlaced como true para solicitar a detecção que preenche este campo de diagnóstico. Esta chave pode estar presente como null quando a detecção não foi solicitada ou a ordem de campos não estava disponível. Use interlaced para uma ramificação simples entre entrelaçado e progressivo.

[1].meta.flash
null | string

As configurações de flash desta imagem, como "Off, Did not fire".

[1].meta.focal_length
null | string

A distância focal desta imagem, como "55.0 mm".

[1].meta.frame_count
number | null

O número de frames em um arquivo GIF animado. Para todos os outros tipos de imagem, o padrão é 1.

[1].meta.framerate
number | null

A taxa de quadros do vídeo, como 29.5.

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

Qualquer um dos esquemas a seguir pode ser aplicado:

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

Indica se a imagem original tem um canal alfa, incluindo imagens com canal alfa totalmente opacas. É retornado junto com thumbhash; a ausência significa que o valor é desconhecido.

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

É true se a imagem contiver um traçado de recorte (clipping path) e false caso contrário.

[1].meta.has_transparency
boolean | null

Indica se a imagem tem áreas transparentes. Defina output_meta.has_transparency como true para solicitar a inspeção de transparência. Valores falsos já conhecidos, como false para imagens JPEG, podem ser retornados mesmo quando essa opção é omitida ou definida como false. Definir o próprio output_meta como false ignora a extração de metadados adicionais; as verificações básicas de tipo e tamanho de arquivo ainda podem ser executadas.

[1].meta.height
number | null

A altura da mídia em pixels.

[1].meta.interlace_detection
object | null

Detalhes de diagnóstico do detector de entrelaçamento da Transloadit. Este objeto pode incluir sampled_frames, tff, bff, progressive, undetermined, confidence, method e ffprobe_field_order. Defina output_meta.interlaced como true para solicitar a detecção. Esta chave pode estar presente como null quando a detecção não foi solicitada; verifique se há um objeto não nulo antes de ler as propriedades dele.

Detalhes adicionais do esquema estão disponíveis no JSON Schema completo.

[1].meta.interlaced
boolean | null

Se o vídeo parece usar varredura entrelaçada: true para vídeos entrelaçados ou false para vídeos progressivos. Defina output_meta.interlaced como true para solicitar a detecção. Esta chave pode estar presente como null quando a detecção não foi solicitada ou quando a detecção solicitada foi inconclusiva. A presença do campo, por si só, não indica que a detecção foi executada.

[1].meta.iso
number | null

O valor ISO desta imagem, como 800.

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

Palavras-chave extraídas dos metadados do arquivo: uma string, um número finito ou um array cujas entradas podem ser strings, números finitos ou booleanos. Por exemplo, ["tree", "nature"]. O campo pode estar ausente ou ser null. Verifique o tipo antes de iterar, porque as entradas do array não são necessariamente strings.

Detalhes adicionais do esquema estão disponíveis no JSON Schema completo.

[1].meta.latitude
number | null

A latitude em que a mídia foi gravada, como 52.5374.

[1].meta.light_value
number | null

O valor de luz desta imagem, por exemplo, 6.9.

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

O local onde esta imagem foi tirada, que geralmente é a rua, como "Zingster Str. 32".

[1].meta.longitude
number | null

A longitude em que a mídia foi gravada, por exemplo, 13.4034.

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

O volume médio do arquivo de áudio. Defina output_meta.mean_volume como true para solicitar a medição. Esta chave pode estar presente como null quando a medição não foi solicitada ou o valor não estava disponível. A presença do campo, por si só, não indica que a medição foi executada.

[1].meta.metering_mode
null | string

O modo de medição desta imagem, como "Multi-segment".

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

Qualquer um dos esquemas a seguir pode ser aplicado:

string | number
string | number
null
[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

Qualquer um dos esquemas a seguir pode ser aplicado:

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>

Detalhes adicionais do esquema estão disponíveis no 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

Qualquer um dos esquemas a seguir pode ser aplicado:

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

Indica se o formato do vídeo permite busca (seeking), como true.

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

A velocidade do obturador desta imagem, como "1/32".

Qualquer um dos esquemas a seguir pode ser aplicado:

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

O estado em que esta imagem foi capturada, como "Berlin".

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

Detalhes adicionais do esquema estão disponíveis no JSON Schema completo.

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

O índice da miniatura atual, começando em 0. Esta chave só está presente nos resultados de 🤖/video/thumbs.

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

O deslocamento da miniatura atual, em segundos. Esta chave só está presente nos resultados de 🤖/video/thumbs.

  • number
  • string
    Padrão de validação (expressão 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 em Base64 da imagem orientada conforme o EXIF. Solicite output_meta.thumbhash no Step que produz a imagem. Omitido quando não for solicitado, não for suportado, a imagem tiver mais de 40 megapixels ou a extração falhar. Trate o hash como dado privado da imagem quando o original for privado.

Padrão de validação (expressão 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

O título desta imagem, como "Tree".

Qualquer um dos esquemas a seguir pode ser aplicado:

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

Qualquer um dos esquemas a seguir pode ser aplicado:

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

A taxa de bits do vídeo, como 500000.

[1].meta.video_codec
null | string

O codec de vídeo do vídeo, como "ffh264".

[1].meta.white_balance
null | string

A configuração de balanço de branco desta imagem, como "Manual".

[1].meta.width
number | null

A largura da mídia em pixels. Para vídeos cuja proporção de exibição difere da proporção de pixels, esta é a largura de exibição pretendida.

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

Qualquer um dos esquemas a seguir pode ser aplicado:

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

Qualquer um dos esquemas a seguir pode ser aplicado:

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

O tipo MIME determinado para este arquivo.

[1].name
null | string

O nome do arquivo. A Transloadit alterará a extensão usada neste campo caso o arquivo passe por processamento para um formato diferente.

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

O ID único do arquivo de upload original a partir do qual este arquivo foi gerado. Isso é útil para determinar qual arquivo de um upload de múltiplos arquivos foi usado para gerar um determinado arquivo, após vários Steps de processamento.

Qualquer um dos esquemas a seguir pode ser aplicado:

string
Array<null | string>
Array<null | string>
Esquema do item do 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 do item do array
object

[1].playlists[]: Campos além dos listados para este objeto são aceitos.

CampoTipo e descrição
[1].playlists[].content
string
[1].playlists[].meta
object

Detalhes adicionais do esquema estão disponíveis no 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

Checksum SHA-256 em letras minúsculas dos bytes armazenados, quando disponível.

Padrão de validação (expressão regular)^[a-f0-9]{64}$
[1].signed_ssl_url
string
[1].signed_url
string
[1].size
number | null

O tamanho do arquivo, em bytes.

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

ThumbHash codificado em Base64, retido com esta versão armazenada da imagem, quando disponível. Proteja estes dados de imagem com os mesmos controles de acesso aplicados à original.

Padrão de validação (expressão 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

Uma categoria abstrata que descreve o arquivo. Os valores conhecidos são "audio", "document", "image", "office", "pdf", "swf", "video", "xls" ou null quando nenhuma categoria foi detectada. Os consumidores devem aceitar outras strings para que categorias futuras permaneçam compatíveis.

[1].url
null | string

Uma URL da qual o arquivo pode ser baixado, ou null quando nenhuma URL de entrega estiver disponível. As URLs temporárias nos nossos servidores expiram após algumas horas; exporte os arquivos para armazenamento para uso posterior. Os resultados de armazenamento privado de /transloadit/store retornam null tanto para url quanto para ssl_url. Guarde o Workspace, o asset_id e o version_id retornados para ter uma referência duradoura, sujeita a acesso e retenção. /transloadit/import aceita asset_id com um version_id opcional, ou um path mutável. Nem uma URL temporária nem o id do arquivo em processamento são referências duradouras de armazenamento.

[1].user_meta
object | null

Qualquer um dos esquemas a seguir pode ser aplicado:

object
object
Esquema de propriedade adicional
qualquer valor
null
[1].version_id
string

ID imutável da versão retornado após a finalização do resultado pelo armazenamento. Importe com asset_id e este version_id para manter os mesmos bytes após uma movimentação ou sobrescrita, sujeito à retenção e ao acesso.

Padrão de validação (expressão regular)^[A-Za-z0-9_-]{21}[AQgw]$
[1].vimeo
object

[1].vimeo: Campos além dos listados para este objeto são aceitos.

[1].vimeo.title

obrigatório

string
[1].vimeo.uri

obrigatório

string
[1].width
number | null
[1].workspace
string (comprimento mínimo: 1)

Slug do Workspace ao qual este resultado armazenado pertence. Autentique-se para esse Workspace ao importar ou gerenciar esse resultado.

assembly_upload_finished

Evento nomeado com um payload JSON no campo data.

Payload do evento
Esquema JSON completo

Abrir JSON em uma nova aba

Campos além dos listados para este objeto são aceitos.

CampoTipo e descrição
as
string | Array<string> | null

Qualquer um dos esquemas a seguir pode ser aplicado:

string
Array<string>
Array<string>
Esquema do item do array
string
null
asset_id
string

Identidade estável de um arquivo armazenado por /transloadit/store. Guarde esse valor junto com seu Workspace e version_id; o id comum do arquivo não é um ID de ativo de armazenamento.

asset_version
number

Revisão numérica do ativo armazenado. Use version_id, e não este número, para selecionar os bytes exatos retidos.

basename

obrigatório

null | string

O nome do arquivo sem a extensão.

cost
number | null
exec_time
number
ext

obrigatório

string

A extensão do arquivo.

field

obrigatório

null | string

O nome do campo de formulário usado para enviar este arquivo.

from_batch_import
boolean
has_alpha
boolean

Indica se esta versão armazenada da imagem tem canal alfa, quando essa informação é conhecida.

id

obrigatório

string

Um ID aleatório e único usado internamente pela Transloadit para rastrear o arquivo.

import_url
string
is_temp_url
boolean
is_tus_file
boolean
md5hash
null | string
meta

obrigatório

object

Um objeto contendo metadados adicionais extraídos do arquivo, conforme mostrado abaixo.

meta: Campos além dos listados para este objeto são aceitos.

meta.album
string | number | null

Qualquer um dos esquemas a seguir pode ser aplicado:

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

A configuração de abertura desta imagem, como 5.7.

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

Muitos aplicativos que produzem áudio gravam informações adicionais no arquivo de áudio, como artist, year, album, genre.

Qualquer um dos esquemas a seguir pode ser aplicado:

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

A proporção da imagem, ou seja, a largura dividida pela altura. Será 0 se, por algum motivo, a altura da imagem for 0.

meta.audio_bitrate
number | null

A taxa de bits do áudio em bits por segundo, considerando todos os canais, como 128000.

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

O número de canais de áudio, normalmente 2 para estéreo.

meta.audio_codec
null | string

O codec de áudio, como "faad". Veja os codecs de áudio compatíveis.

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

A taxa de amostragem do áudio em hertz, como 44100.

meta.author
string | number | null

O autor que tirou a imagem. Algumas câmeras preenchem este campo em vez de creator.

Qualquer um dos esquemas a seguir pode ser aplicado:

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

Não confunda com a cor dominante, que conta a cor de pixel que mais ocorre e tem casos de uso limitados. A cor média é calculada redimensionando primeiro a imagem de entrada para 1 pixel.

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

A cidade em que esta imagem foi capturada, como "Berlin".

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

Detalhes adicionais do esquema estão disponíveis no JSON Schema completo.

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

O espaço de cores detectado da mídia, como "sRGB" ou "Gray". O espaço de cores do vídeo fica disponível quando é detectado enquanto a extração de metadados está habilitada; ele não exige output_meta.colorspace: true. Definir output_meta: false desabilita a extração de metadados.

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

O campo de metadados de copyright.

Detalhes adicionais do esquema estão disponíveis no JSON Schema completo.

meta.copyright_notice
string | number | null

O campo de metadados do aviso de direitos autorais.

Qualquer um dos esquemas a seguir pode ser aplicado:

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

O país em que esta imagem foi capturada, como "Germany".

meta.country_code
null | string

O código do país em que esta imagem foi tirada, como "de".

meta.create_date
string | number | null

Qualquer um dos esquemas a seguir pode ser aplicado:

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

O criador que capturou a imagem.

Detalhes adicionais do esquema estão disponíveis no JSON Schema completo.

meta.date_file_created
string | number | null

O timestamp de criação informado pelos metadados da mídia, quando disponível.

Qualquer um dos esquemas a seguir pode ser aplicado:

string | number
string | number
null
meta.date_file_modified
null | string

A data e hora de modificação do arquivo de mídia no sistema de arquivos.

meta.date_recorded
string | number | null

A data e a hora em que a mídia foi gravada, no formato YYYY/MM/DD HH:MM:SS TZ, como "2010/06/30 22:16:06 GMT".

Qualquer um dos esquemas a seguir pode ser aplicado:

string | number
string | number
null
meta.description
string | number | null

Uma descrição desta imagem, como "This tree is very old.".

Qualquer um dos esquemas a seguir pode ser aplicado:

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

Detalhes adicionais do esquema estão disponíveis no JSON Schema completo.

meta.device_name
string | number | null

O nome do dispositivo que gravou a mídia, como "iPhone 3GS".

Qualquer um dos esquemas a seguir pode ser aplicado:

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

A versão do software do dispositivo que gravou a mídia, como "3.1.2".

Qualquer um dos esquemas a seguir pode ser aplicado:

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

O fabricante do dispositivo que gravou a mídia, como "Apple".

meta.disc
string | number | null

Qualquer um dos esquemas a seguir pode ser aplicado:

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

Retorna um array com até 10 cores dominantes da imagem em valores hexadecimais. Omita output_meta.dominant_colors para pular essa extração. Informar a propriedade, inclusive com false, solicita a extração e pode gerar cobranças de uso adicionais quando cores forem retornadas. Definir o próprio output_meta como false desativa a extração de metadados adicionais; as verificações básicas de tipo e tamanho do arquivo ainda podem ser executadas.

Detalhes adicionais do esquema estão disponíveis no JSON Schema completo.

meta.duration
number | null

A duração do arquivo de áudio em 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

A compensação de exposição desta imagem, como "+4/3".

Qualquer um dos esquemas a seguir pode ser aplicado:

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

O modo de exposição desta imagem, como "Auto".

meta.exposure_time
number | string | null

O tempo de exposição desta imagem, como "1/30".

Qualquer um dos esquemas a seguir pode ser aplicado:

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

O número f desta imagem, como 5.6.

meta.faces
Array<object> | null

Detalhes adicionais do esquema estão disponíveis no JSON Schema completo.

meta.field_order
null | string

A ordem de campos informada pelo FFprobe, como "tt", "bb", "tb", "bt" ou "progressive". Defina output_meta.interlaced como true para solicitar a detecção que preenche este campo de diagnóstico. Esta chave pode estar presente como null quando a detecção não foi solicitada ou a ordem de campos não estava disponível. Use interlaced para uma ramificação simples entre entrelaçado e progressivo.

meta.flash
null | string

As configurações de flash desta imagem, como "Off, Did not fire".

meta.focal_length
null | string

A distância focal desta imagem, como "55.0 mm".

meta.frame_count
number | null

O número de frames em um arquivo GIF animado. Para todos os outros tipos de imagem, o padrão é 1.

meta.framerate
number | null

A taxa de quadros do vídeo, como 29.5.

meta.genre
string | number | null

Qualquer um dos esquemas a seguir pode ser aplicado:

string | number
string | number
null
meta.has_alpha
boolean

Indica se a imagem original tem um canal alfa, incluindo imagens com canal alfa totalmente opacas. É retornado junto com thumbhash; a ausência significa que o valor é desconhecido.

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

É true se a imagem contiver um traçado de recorte (clipping path) e false caso contrário.

meta.has_transparency
boolean | null

Indica se a imagem tem áreas transparentes. Defina output_meta.has_transparency como true para solicitar a inspeção de transparência. Valores falsos já conhecidos, como false para imagens JPEG, podem ser retornados mesmo quando essa opção é omitida ou definida como false. Definir o próprio output_meta como false ignora a extração de metadados adicionais; as verificações básicas de tipo e tamanho de arquivo ainda podem ser executadas.

meta.height
number | null

A altura da mídia em pixels.

meta.interlace_detection
object | null

Detalhes de diagnóstico do detector de entrelaçamento da Transloadit. Este objeto pode incluir sampled_frames, tff, bff, progressive, undetermined, confidence, method e ffprobe_field_order. Defina output_meta.interlaced como true para solicitar a detecção. Esta chave pode estar presente como null quando a detecção não foi solicitada; verifique se há um objeto não nulo antes de ler as propriedades dele.

Detalhes adicionais do esquema estão disponíveis no JSON Schema completo.

meta.interlaced
boolean | null

Se o vídeo parece usar varredura entrelaçada: true para vídeos entrelaçados ou false para vídeos progressivos. Defina output_meta.interlaced como true para solicitar a detecção. Esta chave pode estar presente como null quando a detecção não foi solicitada ou quando a detecção solicitada foi inconclusiva. A presença do campo, por si só, não indica que a detecção foi executada.

meta.iso
number | null

O valor ISO desta imagem, como 800.

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

Palavras-chave extraídas dos metadados do arquivo: uma string, um número finito ou um array cujas entradas podem ser strings, números finitos ou booleanos. Por exemplo, ["tree", "nature"]. O campo pode estar ausente ou ser null. Verifique o tipo antes de iterar, porque as entradas do array não são necessariamente strings.

Detalhes adicionais do esquema estão disponíveis no JSON Schema completo.

meta.latitude
number | null

A latitude em que a mídia foi gravada, como 52.5374.

meta.light_value
number | null

O valor de luz desta imagem, por exemplo, 6.9.

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

O local onde esta imagem foi tirada, que geralmente é a rua, como "Zingster Str. 32".

meta.longitude
number | null

A longitude em que a mídia foi gravada, por exemplo, 13.4034.

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

O volume médio do arquivo de áudio. Defina output_meta.mean_volume como true para solicitar a medição. Esta chave pode estar presente como null quando a medição não foi solicitada ou o valor não estava disponível. A presença do campo, por si só, não indica que a medição foi executada.

meta.metering_mode
null | string

O modo de medição desta imagem, como "Multi-segment".

meta.modify_date
string | number | null

Qualquer um dos esquemas a seguir pode ser aplicado:

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

Qualquer um dos esquemas a seguir pode ser aplicado:

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>

Detalhes adicionais do esquema estão disponíveis no JSON Schema completo.

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

Qualquer um dos esquemas a seguir pode ser aplicado:

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

Indica se o formato do vídeo permite busca (seeking), como true.

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

A velocidade do obturador desta imagem, como "1/32".

Qualquer um dos esquemas a seguir pode ser aplicado:

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

O estado em que esta imagem foi capturada, como "Berlin".

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

Detalhes adicionais do esquema estão disponíveis no JSON Schema completo.

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

O índice da miniatura atual, começando em 0. Esta chave só está presente nos resultados de 🤖/video/thumbs.

meta.thumb_offset
number | string | null

O deslocamento da miniatura atual, em segundos. Esta chave só está presente nos resultados de 🤖/video/thumbs.

  • number
  • string
    Padrão de validação (expressão 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 em Base64 da imagem orientada conforme o EXIF. Solicite output_meta.thumbhash no Step que produz a imagem. Omitido quando não for solicitado, não for suportado, a imagem tiver mais de 40 megapixels ou a extração falhar. Trate o hash como dado privado da imagem quando o original for privado.

Padrão de validação (expressão 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

O título desta imagem, como "Tree".

Qualquer um dos esquemas a seguir pode ser aplicado:

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

Qualquer um dos esquemas a seguir pode ser aplicado:

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

A taxa de bits do vídeo, como 500000.

meta.video_codec
null | string

O codec de vídeo do vídeo, como "ffh264".

meta.white_balance
null | string

A configuração de balanço de branco desta imagem, como "Manual".

meta.width
number | null

A largura da mídia em pixels. Para vídeos cuja proporção de exibição difere da proporção de pixels, esta é a largura de exibição pretendida.

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

Qualquer um dos esquemas a seguir pode ser aplicado:

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

Qualquer um dos esquemas a seguir pode ser aplicado:

string | number
string | number
null
mime

obrigatório

null | string

O tipo MIME determinado para este arquivo.

name

obrigatório

null | string

O nome do arquivo. A Transloadit alterará a extensão usada neste campo caso o arquivo passe por processamento para um formato diferente.

original_basename
null | string
original_id

obrigatório

string | Array<null | string>

O ID único do arquivo de upload original a partir do qual este arquivo foi gerado. Isso é útil para determinar qual arquivo de um upload de múltiplos arquivos foi usado para gerar um determinado arquivo, após vários Steps de processamento.

Qualquer um dos esquemas a seguir pode ser aplicado:

string
Array<null | string>
Array<null | string>
Esquema do item do array
null | string
original_md5hash
null | string
original_name
null | string
original_path
string
queue
null | string
queue_time
number
sha256
string

Checksum SHA-256 em letras minúsculas dos bytes armazenados, quando disponível.

Padrão de validação (expressão regular)^[a-f0-9]{64}$
size

obrigatório

number

O tamanho do arquivo, em bytes.

ssl_url
null | string
thumbhash
string

ThumbHash codificado em Base64, retido com esta versão armazenada da imagem, quando disponível. Proteja estes dados de imagem com os mesmos controles de acesso aplicados à original.

Padrão de validação (expressão 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

obrigatório

null | string

Uma categoria abstrata que descreve o arquivo. Os valores conhecidos são "audio", "document", "image", "office", "pdf", "swf", "video", "xls" ou null quando nenhuma categoria foi detectada. Os consumidores devem aceitar outras strings para que categorias futuras permaneçam compatíveis.

url

obrigatório

null | string

Uma URL da qual o arquivo pode ser baixado, ou null quando nenhuma URL de entrega estiver disponível. As URLs temporárias nos nossos servidores expiram após algumas horas; exporte os arquivos para armazenamento para uso posterior. Os resultados de armazenamento privado de /transloadit/store retornam null tanto para url quanto para ssl_url. Guarde o Workspace, o asset_id e o version_id retornados para ter uma referência duradoura, sujeita a acesso e retenção. /transloadit/import aceita asset_id com um version_id opcional, ou um path mutável. Nem uma URL temporária nem o id do arquivo em processamento são referências duradouras de armazenamento.

user_meta
object
Esquema de propriedade adicional
qualquer valor
version_id
string

ID imutável da versão retornado após a finalização do resultado pelo armazenamento. Importe com asset_id e este version_id para manter os mesmos bytes após uma movimentação ou sobrescrita, sujeito à retenção e ao acesso.

Padrão de validação (expressão regular)^[A-Za-z0-9_-]{21}[AQgw]$
workspace
string (comprimento mínimo: 1)

Slug do Workspace ao qual este resultado armazenado pertence. Autentique-se para esse Workspace ao importar ou gerenciar esse resultado.

assembly_upload_meta_data_extracted

Mensagem cujo campo data contém esse nome como texto simples, sem um campo event.

assembly_uploading_finished

Mensagem cujo campo data contém esse nome como texto simples, sem um campo event.

HTTP 404, 503

Sem corpo de resposta.

Resposta de erro

Corpo da resposta JSON. application/json text/plain; charset=utf-8

Esquema do corpo da resposta
Esquema JSON completo

Abrir JSON em uma nova aba

Pelo menos uma destas propriedades é obrigatória: error, message, reason

A resposta pode conter campos adicionais.

CampoTipo e descrição
assembly_id
string
error
string (comprimento mínimo: 1)
http_code
number | string
  • number
  • string
    Padrão de validação (expressão 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

Explicação do erro legível por humanos. A redação pode variar; use o código error ao tratar uma falha específica.

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

Qualquer um dos esquemas a seguir pode ser aplicado:

null
string
number
boolean
Array<qualquer valor>
Array<qualquer valor>
Esquema do item do array
qualquer valor
object
object
Esquema de propriedade adicional
qualquer valor

Para mais informações sobre o formato da resposta, consulte a documentação da Mozilla sobre server-sent events⁠.

Página anterior ← Criar uma Assembly com um ID fornecidoPróxima página Cancelar uma Assembly em execução →
Falar com o suporte⁠

TransloaditVerificando status…

Produto

  • Serviços
  • Preços
  • Demonstrações EN (English)
  • Ferramentas
  • Segurança
  • Suporte

Empresa

  • Sobre a Transloadit/Imprensa EN (English)
  • Blog/Vagas EN (English)
  • Comparações/Matriz de conformidade EN (English)
  • Pesquisa EN (English)
  • Código aberto
  • Soluções

Documentação

  • Primeiros passos
  • Transcodificação
  • Perguntas frequentes
  • API
  • Guias/Dicas para devs
  • Formatos suportados

Mais

  • Status da plataforma⁠
  • Fórum da comunidade⁠
  • StackOverflow⁠
  • Uppy
  • tus⁠

© 2009–2026 Transloadit-II GmbH

Privacidade EN (English)Termos EN (English)Aviso legal EN (English)
EnglishDeutschEspañolPortuguês (Brasil)