HTTP エンドポイントの呼び出し
🤖/http/request は Assembly の実行中にアプリケーションを呼び出し、選択された入力ファイルを出力するか、返された結果ファイルの URL からファイルをダウンロードします。

Assembly の実行中に HTTP エンドポイントを呼び出します。応答には、この Step から出力するゼロ個以上の入力ファイルまたは結果ファイルの URL を記述した JSON を任意で含められます。
エンドポイントは 2xx 応答を返す必要があります。本文が空、[]、または { "files": [] } の場合、この Step はファイルを出力しません。単一のファイルオブジェクト、ファイルオブジェクトの配列、または { "files": [...] } / { "files": { "name": {...} } } を返すこともできます。返すファイルオブジェクトには、エンドポイントに送信された入力ファイルのパスのいずれかと一致する path、または Transloadit がダウンロードして新しい結果ファイルとして出力する HTTP(S) の url のいずれかを含める必要があります。
使用例
どの入力ファイルの処理を続行するかをアプリケーションに問い合わせます:
{
"steps": {
"request": {
"method": "POST",
"payload": "metadata",
"robot": "/http/request",
"url": "https://example.com/transloadit/files",
"use": ":original"
}
}
}パラメーター
interpolateboolean | Record<string, boolean>処理設定の各フィールドで Assembly Variables を展開するかどうかを制御します。
デフォルトでは、Robot の処理設定のほとんどのフィールドで Assembly Variables が展開されます。すべての設定フィールドをリテラルテキストとして扱うには、このパラメーターを
falseに設定してください。特定のフィールドだけをリテラルテキストとして扱うには、そのフィールドのパスをfalseに設定してください。デフォルトでリテラルとして扱われる Robot 固有のフィールドで展開を有効にするには、このパラメーターをtrueに設定するか、そのフィールドのパスをtrueに設定してください。pathのようなフィールド名を使用してください。ネストされたオブジェクトには、ffmpeg.vfのようなドット区切りのパスを使用してください。output_metaRecord<string, boolean> | boolean | Array<string>算出に多くの CPU リソースを要するメタデータを指定できます。Assembly の処理速度を維持するため、これらはデフォルトで無効になっています。
画像の場合、このオブジェクトに
"has_transparency": trueを追加すると、画像に透明な部分が含まれるかどうかを抽出できます。"dominant_colors": trueを追加すると、画像から 16 進数のカラーコードの配列を抽出できます。画像の場合、
"blurhash": trueを追加すると、画像のプレースホルダーをコンパクトに表す BlurHash 文字列も抽出できます。画像全体の読み込み中に、ぼかしたプレビューを表示するのに役立ちます。画像の場合、代わりに
"thumbhash": trueを使用すると、base64 エンコードされた ThumbHash をmeta.thumbhashに抽出し、meta.has_alpha(完全に不透明な場合も含め、アルファチャンネルが存在するかどうか)も抽出します。ThumbHash は EXIF の向きを反映したピクセルを表し、アニメーション画像では最初のフレームを使用します。抽出はベストエフォートです。40 メガピクセルを超える画像、非対応の形式、デコードの失敗やデコード処理の上限への到達があった場合、プレースホルダーは生成されません。抽出に成功すると、そのファイルのバイト数の 20% に相当するメタデータ料金が加算されます。無効な場合やハッシュが生成されない場合、ThumbHash の追加料金は発生しません。このオプションは画像を生成する Step に設定してください。たとえば、アップロードされた元画像では
/upload/handle、処理済みの出力では/image/resizeに設定します。/transloadit/storeにのみ設定しても、抽出は要求されません。ストレージは生成元のメタデータを保持します。Transloadit Storage は生成されたハッシュをその不変のバージョンとともに永続化し、保存済みの結果やネイティブのアセット読み取り時に返します。S3 への直接アップロードではプレースホルダーは生成されません。プレースホルダーには画像情報が含まれるため、画像全体と同じアクセス制御で保護してください。動画の場合、
"colorspace": trueパラメーターを追加すると、出力動画の色空間を抽出できます。動画の場合、
"interlaced": trueを追加すると、インターレース動画かどうかも検出できます。これは、低コストの ffprobe のfield_orderフラグと、ソースの先頭フレームに対する処理範囲を制限したidetサンプリング処理を組み合わせ、file.metaの下にinterlaced、field_order、診断用のinterlace_detectionオブジェクトを出力します。この処理は計算コストが高く、それに応じて課金されます。音声の場合、
"mean_volume": trueを追加すると、音声ファイルの平均音量を表す単一の値を取得できます。また、
falseに設定すると、メタデータの抽出をスキップしてトランスコードを高速化できます。user_metaRecord<string, any>(デフォルト:{})出力される各ファイルに、ファイルの内容を変更せずにカスタム JSON メタデータを追加します。ネストしたオブジェクトと配列に対応しています。
継承の動作は Robot によって異なります。値は出力ファイルの既存の
user_metaとマージされ、一致するトップレベルのキーは現在の Step によって置き換えられます。Robot が新しい出力を作成する場合は、必要なキーを明示的に割り当ててください。処理 Step では、
${file.*}は最初の入力を、${result.*}は出力されるファイルを参照します。値は Robot の実行後、後続のメタデータ抽出と一時保存の前に、出力ごとに評価されます。:originalでは、メタデータ抽出の前にアップロードごとに値が評価されます。後続の Step は
${file.user_meta.key}を読み取ります。完全な例と継承ルールについては、カスタムメタデータ を参照してください。resultboolean(デフォルト:false)この Step の結果を Assembly Status JSON に含めるかどうか
queuebatchqueue を 'batch' に設定すると、このステップのジョブの優先度を手動で下げ、キューの待ち時間がゼロである必要のないジョブが優先ジョブスロットを消費しないようにします。
force_acceptboolean(デフォルト:false)通常は無視するファイルタイプを Robot に強制的に受け入れさせます。
デフォルトでは、Robot は認識できないファイルを無視します。たとえば、🤖/video/encodeは入力画像を無視します。
force_acceptパラメーターをtrueに設定すると、Robot に渡されたすべてのファイルを強制的に受け入れさせることができます。通常、この設定はエラーにつながるため、デバッグやエッジケースへの対処にのみ使用してください。ignore_errorsboolean | Array<meta | execute>(デフォルト:[])処理の特定のフェーズでエラーを無視します。
このパラメーターを
["meta"]に設定すると、Robot はメタデータ抽出中のエラーを無視します。このパラメーターを
["execute"]に設定すると、Robot はメイン実行フェーズ中のエラーを無視します。このパラメーターを
trueに設定すると、["meta", "execute"]と同じ動作になり、両方のフェーズでエラーを無視します。usestring | Array<string> | Array<object> | object入力として使用する Step を指定します。
- Step には任意の名前を付けられます。ただし、
":original"は Transloadit が処理するユーザーアップロード用に予約されています。 - 配列を使用して、複数の Step を入力として指定できます。
{ "use": [ ":original", "encoded", "resized" ] } - 入力 Step に
asでタグを付けて、意味上の用途を Robot に伝えることもできます。{ "use": [ { "name": ":original", "as": "image" }, { "name": ":original", "as": "mask" } ] }
ヒントuseについては、通常ここまでの内容で十分ですが、高度な使用例 も参照できます。- Step には任意の名前を付けられます。ただし、
url— 必須string呼び出す HTTP または HTTPS エンドポイントです。
methodDELETE | GET | PATCH | POST | PUT(デフォルト:"POST")リクエストに使用する HTTP メソッドです。
payloadnone | metadata | file | files(デフォルト:"none")エンドポイントに送信する内容を制御します。
none:リクエスト本文を送信しません。metadata:Assembly のメタデータ、フィールド、前の Step、ファイルのメタデータを含む JSON 本文を送信します。file:payloadJSON フィールドと、fileパートとしての最初の入力ファイルを含むマルチパートフォームデータを送信します。files:payloadJSON フィールドと、繰り返しのfiles[]パートとしてのすべての入力ファイルを含むマルチパートフォームデータを送信します。一つのリクエストで複数の入力ファイルを送信するには、詳細なuseオプションでbundle_steps: trueを設定してください。
payloadJSON オブジェクトには、assembly、fields、previous_step、file、filesが含まれます。fileは最初の入力ファイルのメタデータまたはnullです。filesは入力ファイルのメタデータの配列です。headersArray<string> | Array<Record<string, boolean | string | number | string | null>> | Record<string, boolean | string | number | string | null> | string(デフォルト:[])カスタムリクエストヘッダーです。
ヘッダーは、
"Header-Name: value"形式の文字列の配列、オブジェクトの配列、オブジェクトマップ、またはオブジェクトや配列として解析される JSON 文字列で指定できます。ヘッダー名は有効な HTTP トークンである必要があります。ヘッダー値には水平タブを含められますが、キャリッジリターンやラインフィードを含む、それ以外の制御文字は拒否されます。
ヘッダー文字列の配列では、
"Header-Name;"は空のヘッダー値を送信します。各要素にはヘッダーを直接指定する必要があります。@filenameによるファイルからのヘッダー読み込みには対応していません。timeoutstring | number(デフォルト:60)HTTP リクエストの最大待機秒数です。
実際のタイムアウトには、この値と Transloadit のサーバー側の上限のうち、小さい方が適用されます。サーバー側の上限は 30 秒に、エンドポイントに送信するデータの MiB ごとに 1 秒を加えた値です。
max_response_sizestring | number(デフォルト:1048576)受け入れる応答の最大サイズ(バイト単位)です。通常、応答は小さな JSON ドキュメントにしてください。
max_result_filesstring | number(デフォルト:10)エンドポイントが返せるファイルの最大数です。
max_result_file_sizestring | number(デフォルト:104857600)URL で返される各結果ファイルの許容最大サイズ(バイト単位)です。リモートサーバーがこれを超えるファイルサイズを報告した場合、結果ファイルのダウンロードを開始前に拒否します。リモートサーバーが事前にサイズを報告しない場合は、この上限を超えた時点でダウンロードを中止します。
result_download_timeoutstring | number(デフォルト:120)URL で返される各結果ファイルのダウンロードに費やす最大秒数です。