alpha

Chamar endpoints HTTP

🤖/http/request chama seu aplicativo durante uma Assembly e emite os arquivos de entrada selecionados ou baixa os arquivos de resultado das URLs retornadas.

Chama um endpoint HTTP durante a Assembly e espera um JSON opcional que descreva zero ou mais arquivos de entrada ou URLs de arquivos de resultado a serem emitidos por este Step.

Seu endpoint deve retornar uma resposta 2xx. Um corpo vazio, [] ou { "files": [] } significa que este Step não emite nenhum arquivo. Você também pode retornar um objeto de arquivo, um array de objetos de arquivo ou { "files": [...] } / { "files": { "name": {...} } }. Os objetos de arquivo retornados devem incluir um path que corresponda a um dos caminhos de arquivo de entrada enviados ao seu endpoint ou uma url HTTP(S) que a Transloadit baixa e emite como um novo arquivo de resultado.

Exemplo de uso

Pergunte ao seu aplicativo quais arquivos de entrada devem continuar:

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

Parâmetros

interpolate
boolean | Record<string, boolean>
Controla se as Assembly Variables são interpoladas em campos individuais de instruções.

Por padrão, a maioria dos campos de instruções dos Robots interpola Assembly Variables. Defina isso como false para tratar todos os campos de instruções como texto literal, ou defina o caminho de um campo individual como false para tratar apenas esse campo como texto literal. Para campos específicos de um Robot que são literais por padrão, defina isso como true ou defina o caminho desse campo como true para voltar a usar a interpolação.

Use nomes de campos como path ou caminhos com pontos como ffmpeg.vf para objetos aninhados.
output_meta
Record<string, boolean> | boolean | Array<string>
Permite especificar um conjunto de metadados cujo cálculo é mais custoso para a CPU e que, por isso, vem desativado por padrão para manter o processamento das suas Assemblies rápido.

Para imagens, você pode adicionar "has_transparency": true neste objeto para extrair se a imagem contém partes transparentes e "dominant_colors": true para extrair um array de códigos de cores hexadecimais da imagem.

Para imagens, você também pode adicionar "blurhash": true para extrair uma string BlurHash, uma representação compacta de um placeholder da imagem, útil para exibir uma prévia desfocada enquanto a imagem completa carrega.

Para imagens, "thumbhash": true em vez disso extrai um ThumbHash codificado em base64 em meta.thumbhash, junto com meta.has_alpha (se existe um canal alfa, mesmo quando totalmente opaco). Ele descreve pixels orientados por EXIF e usa o primeiro quadro de imagens animadas. A extração é feita em regime de melhor esforço: imagens acima de 40 megapixels, formatos não suportados ou uma decodificação com falha/limitada não geram placeholder. Uma extração bem-sucedida adiciona uma cobrança de metadados equivalente a 20% dos bytes desse arquivo. Nenhuma sobretaxa de ThumbHash se aplica quando desativado ou quando nenhum hash é gerado.

Defina essa opção no Step que produz a imagem, como /upload/handle para originais enviados por upload ou /image/resize para saídas processadas. Defini-la apenas em /transloadit/store não solicita a extração: o armazenamento preserva os metadados do produtor. O Transloadit Storage persiste um hash gerado com sua versão imutável e o retorna em resultados armazenados e em leituras nativas de ativos. Uploads diretos para o S3 não geram placeholders. Um placeholder contém informações da imagem, portanto proteja-o com os mesmos controles de acesso da imagem completa.

Para vídeos, você pode adicionar o parâmetro "colorspace": true para extrair o espaço de cores do vídeo de saída.

Para vídeos, você também pode adicionar "interlaced": true para detectar se o vídeo é entrelaçado. Isso combina a flag barata do ffprobe field_order com uma passagem de amostragem idet limitada sobre os primeiros quadros da origem, expondo interlaced, field_order e um objeto de diagnóstico interlace_detection em file.meta. Isso é computacionalmente caro e cobrado de acordo.

Para áudio, você pode adicionar "mean_volume": true para obter um único valor que representa o volume médio do arquivo de áudio.

Você também pode definir isso como false para pular a extração de metadados e acelerar a transcodificação.
user_meta
Record<string, any>(padrão: {})
Adiciona metadados JSON personalizados a cada arquivo emitido sem modificar seu conteúdo. Objetos e arrays aninhados são suportados.

A herança depende do Robot. Os valores são mesclados com o user_meta existente no arquivo de saída; o Step atual substitui as chaves de nível superior com o mesmo nome. Atribua explicitamente as chaves necessárias quando um Robot criar novas saídas.

Nos Steps de processamento, ${file.*} se refere à primeira entrada e ${result.*} ao arquivo emitido. Os valores são avaliados para cada saída após a execução do Robot, antes da extração subsequente de metadados e do armazenamento temporário. Em :original, os valores são avaliados para cada upload antes da extração de metadados.

Os Steps subsequentes leem ${file.user_meta.key}. Consulte Metadados personalizados para ver um exemplo completo e as regras de herança.
result
boolean(padrão: false)
Se os resultados deste Step devem estar presentes no Assembly Status JSON
queue
batch
Definir a fila como “batch” rebaixa manualmente a prioridade dos Jobs deste Step, para evitar o consumo de vagas prioritárias de Jobs em Jobs que não precisam de tempo zero de espera na fila
force_accept
boolean(padrão: false)
Forçar um Robot a aceitar um tipo de arquivo que ele teria ignorado.

Por padrão, os Robots ignoram arquivos que não conhecem. O 🤖/video/encode, por exemplo, ignora tranquilamente imagens de entrada.

Com o parâmetro force_accept definido como true, você pode forçar os Robots a aceitar todos os arquivos enviados a eles. Isso normalmente leva a erros e só deve ser usado para depuração ou para lidar com casos extremos.
ignore_errors
boolean | Array<meta | execute>(padrão: [])
Ignorar erros durante fases específicas do processamento.

Definir isso como ["meta"] fará com que o Robot ignore erros durante a extração de metadados.

Definir isso como ["execute"] fará com que o Robot ignore erros durante a fase principal de execução.

Definir isso como true equivale a ["meta", "execute"] e fará com que erros sejam ignorados nas duas fases.
use
string | Array<string> | Array<object> | object
Especifica quais Steps usar como entrada.
- Você pode escolher qualquer nome para os Steps, exceto ":original" (reservado para uploads de usuários tratados pela Transloadit)
- Você pode fornecer vários Steps como entrada usando arrays:
```
{
  "use": [
    ":original",
    "encoded",
    "resized"
  ]
}
```
- Você também pode marcar os Steps de entrada com as para transmitir intenção semântica aos Robots:
```
{
  "use": [
    {
      "name": ":original",
      "as": "image"
    },
    {
      "name": ":original",
      "as": "mask"
    }
  ]
}
```
Dica

Provavelmente é tudo o que você precisa saber sobre use, mas você pode ver os casos de uso avançados.
url — obrigatório
string
O endpoint HTTP ou HTTPS a ser chamado.
method
DELETE | GET | PATCH | POST | PUT(padrão: "POST")
Método HTTP a ser usado na requisição.
payload
none | metadata | file | files(padrão: "none")
Controla o que é enviado ao seu endpoint.
- none: Não envia nenhum corpo de requisição.
- metadata: Envia um corpo JSON com metadados da Assembly, campos, o Step anterior e metadados dos arquivos.
- file: Envia dados de formulário multipart com um campo JSON payload e o primeiro arquivo de entrada como uma parte file.
- files: Envia dados de formulário multipart com um campo JSON payload e todos os arquivos de entrada como partes files[] repetidas. Para enviar vários arquivos de entrada em uma única requisição, defina bundle_steps: true nas opções avançadas de use.
O objeto JSON payload contém assembly, fields, previous_step, file e files. O valor file contém os metadados do primeiro arquivo de entrada ou é null; files é um array de metadados de arquivos de entrada.
headers
Array<string> | Array<Record<string, boolean | string | number | string | null>> | Record<string, boolean | string | number | string | null> | string(padrão: [])
Cabeçalhos de requisição personalizados.

Os cabeçalhos podem ser especificados como um array de strings no formato "Header-Name: value", um array de objetos, um mapa de objeto ou uma string JSON que será convertida em um objeto/array.

Os nomes dos cabeçalhos devem ser tokens HTTP válidos. Os valores dos cabeçalhos podem conter tabulações horizontais, mas outros caracteres de controle, incluindo retornos de carro e quebras de linha, são rejeitados.

Em um array de strings de cabeçalhos, "Header-Name;" envia um valor de cabeçalho vazio. Cada entrada deve ser um cabeçalho literal; a leitura de cabeçalhos de um arquivo com @filename não é compatível.
timeout
string | number(padrão: 60)
Número máximo de segundos de espera pela requisição HTTP.

O tempo limite efetivo é o menor valor entre este e o limite máximo do lado do servidor da Transloadit. Esse limite é de 30 segundos mais 1 segundo por MiB enviado ao seu endpoint.
max_response_size
string | number(padrão: 1048576)
Tamanho máximo aceito da resposta, em bytes. Normalmente, a resposta deve ser um pequeno documento JSON.
max_result_files
string | number(padrão: 10)
Número máximo de arquivos que o endpoint pode retornar.
max_result_file_size
string | number(padrão: 104857600)
Tamanho máximo permitido, em bytes, para cada arquivo de resultado retornado por URL. Se o servidor remoto informar um tamanho de arquivo maior, o download do resultado será rejeitado antes de começar. Se o servidor remoto não informar um tamanho antecipadamente, o download será interrompido assim que esse limite for excedido.
result_download_timeout
string | number(padrão: 120)
Número máximo de segundos para baixar cada arquivo de resultado retornado por URL.

Chamar endpoints HTTP

Exemplo de uso

Parâmetros

`interpolate`

`output_meta`

`user_meta`

`result`

`queue`

`force_accept`

`ignore_errors`

`use`

`url` — obrigatório

`method`

`payload`

`headers`

`timeout`

`max_response_size`

`max_result_files`

`max_result_file_size`

`result_download_timeout`

Chamar endpoints HTTP

Exemplo de uso

Parâmetros

interpolate

output_meta

user_meta

result

queue

force_accept

ignore_errors

use

url — obrigatório

method

payload

headers

timeout

max_response_size

max_result_files

max_result_file_size

result_download_timeout

`interpolate`

`output_meta`

`user_meta`

`result`

`queue`

`force_accept`

`ignore_errors`

`use`

`url` — obrigatório

`method`

`payload`

`headers`

`timeout`

`max_response_size`

`max_result_files`

`max_result_file_size`

`result_download_timeout`