新しい Assembly を作成する
アップロードされたファイルと Assembly Instructions から Assembly を作成します。
https://api2.transloadit.com/ assemblies一般的なワークフロー:
- ファイルと処理用の Instructions を指定して、以下のリクエスト例を送信します。最終ステータスを
Webhook で受け取るには、リクエストを送信する前に、その
Instructions に
notify_urlを含めてください。 - 返された
assembly_ssl_urlは秘密にしてください。この URL を使用して進行状況を確認するか、設定済みの Webhook を待ちます。 - 処理済みファイルを使用する前に、
ok: "ASSEMBLY_COMPLETED"になるまで待ちます。errorまたはキャンセルは、処理の成功を意味しません。出力ファイルはresults内で Step 名ごとにグループ化されます。レスポンスフィールドを参照してください。
直接、または Template を通じて /transloadit/import を使用する Assemblies には、Bearer トークン、または未来の時刻を示す params.auth.expires タイムスタンプを含む署名済みの params が必要です。これは、Workspace の Signature Authentication が無効になっている場合にも適用されます。Auth Key だけでは不十分です。Bearer トークンで認証されたリクエストには、別途 Signature や有効期限は必要ありません。公開ストレージ用の Builtin Templates は例外です。すべてのストレージからのインポートが、宣言された公開プレフィックスの範囲内に収まる場合に限り、署名なしのリクエストに対応できます。これは、任意の Steps を含む署名なしの Assemblies や、非公開のストレージパスへのアクセスを許可するものではありません。
Assembly は、ファイルの処理とエクスポートを行えます。Assembly Instructions は、ファイルをどのように処理するかを決定します。Instructions は直接(steps パラメータ内で)渡すことも、Template に保存することもできます(template_id パラメータで参照します)。Templates を使用すると、Instructions を再利用したり、アプリをデプロイせずに更新したり、アプリのデプロイ先にシークレットを一切公開せずに済むようにしたりできます。
このサービスへの通常の <form> アップロード(および XHR / SDK の使用)に対応するため、multipart/form-data の POST リクエストを受け付けています。
UTF-8 でエンコードされた params フィールドの上限は 1048576 バイトです。リクエストのメタデータに含められるネストされたオブジェクトまたは配列は、最大 64 個です。JSON および URL エンコードされたフォームのボディの上限は、URL エンコードによる増加分を含めて 1048576 バイトです。ファイルのアップロードにはマルチパートリクエストを使用してください。
このリクエストには、複数のファイルを含めることができます。再開可能なファイルアップロードを行う場合は、再開可能なアップロードで説明しているとおり、このリクエストにファイルを含めません。
Transloadit は最大 200 GB のファイルサイズに対応しています。アプリケーションで、これより高い上限が必要な場合は、お問い合わせください。
リクエスト例
curl を使用できるサーバー側のシェルで、適切な Bearer トークンを TRANSLOADIT_TOKEN に設定して、このリクエストを実行してください。トークンが必要な場合は、以下の設定手順を展開してください。
リクエストを実行する前に、入力ファイルを ./example.jpg に配置してください。
Bearer トークンが必要ですか?
curl と jq を使用できる信頼できるサーバー側のシェルで、TRANSLOADIT_KEY と TRANSLOADIT_SECRET に、それぞれ Auth Key と Auth Secret を設定してください。両方の認証情報と生成されたトークンは秘密にしてください。この設定手順をブラウザーのコードで実行しないでください。
最初に、このエンドポイントで必要なスコープを持つトークンを作成します。Auth Key には、これらのスコープがすでに付与されている必要があります。
if ! TOKEN_RESPONSE="$(curl --fail-with-body -sS \
--request POST \
--url 'https://api2.transloadit.com/token' \
--user "${TRANSLOADIT_KEY:?Set TRANSLOADIT_KEY}:${TRANSLOADIT_SECRET:?Set TRANSLOADIT_SECRET}" \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'grant_type=client_credentials' \
--data-urlencode 'aud=api2' \
--data-urlencode 'scope=assemblies:write')"; then
printf '%s\n' "$TOKEN_RESPONSE" >&2
exit 1
fi
TRANSLOADIT_TOKEN="$(printf '%s' "$TOKEN_RESPONSE" |
jq -er '.access_token | strings | select(length > 0)')" || exit 1
このシェルを開いたまま、以下のリクエストを実行してください。トークンが有効な間は再利用してください。
curl --fail-with-body -sS --request POST \
--url "https://api2.transloadit.com/assemblies" \
--header "Authorization: Bearer ${TRANSLOADIT_TOKEN:?Set TRANSLOADIT_TOKEN}" \
--form-string 'params={"steps":{"resize":{"robot":"/image/resize","use":":original","width":320}}}' \
--form 'file=@./example.jpg'
この後の流れ
成功の HTTP レスポンスは、Assembly が受け付けられたことを示します。処理が完了したことを意味するものではありません。最初のレスポンスは、次のようになります(抜粋。ID と URL は異なります)。
{
"ok": "ASSEMBLY_EXECUTING",
"assembly_id": "0fce5b1063e611e88d8eb130f7921d8a",
"assembly_ssl_url": "https://api2-morven.transloadit.com/assemblies/0fce5b1063e611e88d8eb130f7921d8a",
"results": {}
}
レスポンスから assembly_ssl_url をコピーし、数秒おきにステータスを確認するか、作成前に設定した Webhook を使用してください。この URL は秘密にしてください。error またはキャンセルが発生したら停止してください。どちらも処理の成功を意味しません。
ok が ASSEMBLY_COMPLETED になると、この例の出力は results.resize に格納されています。完了時のレスポンスには、次のフィールドが含まれます(抜粋。出力 URL は説明用の例です)。
{
"ok": "ASSEMBLY_COMPLETED",
"message": "The Assembly was successfully completed.",
"assembly_id": "0fce5b1063e611e88d8eb130f7921d8a",
"results": {
"resize": [
{
"name": "example.jpg",
"mime": "image/jpeg",
"ssl_url": "https://example.com/temporary-output/example.jpg",
"meta": {
"width": 320
}
}
]
}
}
results.resize[0].ssl_url を使用して、リサイズされた画像をダウンロードしてください。これらの一時的な出力 URL には有効期限があります。ファイルを保持する必要がある場合は、エクスポート用の Step(/s3/store など)を追加してください。
認証
このエンドポイントは、署名付きの params または Bearer トークンを受け付けます。設定手順については、認証を参照してください。
Auth Key または Bearer トークンに必要なスコープ: assemblies:write。
キー認証を使用するリクエストでは、Signature Authentication が有効な場合に Signature が必要です。Bearer トークンでは、別途 Signature は必要ありません。
任意のレスポンスクエリパラメーター
callback(JavaScript コールバック名)。JSON レスポンスを JSONP コールバックでラップします。コールバック名は^(?:_jqjsp[0-9]*|jQuery[0-9]+_[0-9]+)$に一致する必要があります。最後に指定されたものだけが使用され、空の値は無視されます。コールバック名が無効な場合は HTTP 403 が返されます。変換後のレスポンスは HTTP 200 を使用します。コールバックはレスポンスのシリアライズ後に適用されます。
マルチパートフォームのフィールド
コンテンツタイプ: multipart/form-data
params(JSON 文字列)、必須。JSON エンコードされたオブジェクトで、サポートされるキーは以下のとおりです。signature(文字列)。リクエストで Signature Authentication を使用する場合に必須です。num_expected_upload_files(フォームフィールド)。再開可能なアップロードを使用する場合、アップロードされるファイルの数を指定します。詳細は再開可能なアップロード に記載されています。tus_num_expected_upload_files(フォームフィールド)。古い SDK との互換性のために維持されている、num_expected_upload_filesの旧来のエイリアスです。*(バイナリまたは文字列)。バイナリファイルおよび追加の Assembly フィールドには、任意のフィールド名を使用できます。
params フィールド内でサポートされるキー
この一覧の認証フィールドは、署名付きリクエストに適用されます。Bearer トークンを使用する場合は、params.auth と、それとは別の signature フィールドを省略できます。以下の認証方式ごとのリクエストパラメーターを比較してください。
完全な JSON スキーマ
直接指定した Steps または Template から Assembly を作成する際に使用する署名付きパラメーター。
| フィールド | 型と説明 |
|---|---|
params.署名付きリクエストでは必須。Bearer トークンを使用する場合は任意 | 署名付き Assembly リクエストの認証メタデータとアップロード制約。API キーは必須です。 少なくとも、 Signature Authentication を有効にする場合は、expires プロパティにリクエストの有効期限も設定する必要があります。 リクエストごとに、ランダムに生成した
referer がないアップロードは常にチェックを通過します(一部のブラウザーでは referer が無効になっているため)。そのため、これが役立つユースケースはごく限られています。正規表現の詳細については、Mozilla の RegExp ドキュメントを参照してください。 無効な正規表現と、評価時間の上限を超える正規表現は拒否されます。このチェックは Signature Authentication の代わりにはなりません。クライアントは Referer ヘッダーを省略したり、偽装したりできます。
保存済みの Template、または Assembly リクエストの この上限によって、サイズが上限を超える転送がすべて開始前に拒否されることを前提にしないでください。再開可能なアップロードでは、申告されたサイズまたは受信済みのサイズが tus の更新を通じて利用可能になり、完了したアップロードが処理されるときに Assembly が上限をチェックします。サイズの確定を延期したアップロードのサイズは作成時には不明であり、Assembly が拒否する前に、すでにデータが転送されている場合があります。 一定のサイズを超えるファイルだけを無視し、それ以外のファイルをすべて処理したい場合は、🤖/file/filter を使用してください。
これらのプロパティは、Assembly リクエストの一部として、または Template の一部として設定できます。
|
params. | string将来の日時を示す ISO 8601 形式の有効期限タイムスタンプ。リクエストが署名されている場合、または Signature Authentication が必要な場合は必須です。Bearer 認証を使用するリクエストでは省略できます。 |
params.必須 | stringリクエストの認証に使用する Transloadit API キー |
params. | integer (最小値: 1)Assembly ごとに許可される入力ファイルの最大数です。アップロードまたはインポートされたファイルの数がこの上限を超えると、Assembly はエラーで停止します。これは、Signature Authentication の認証情報が露出した場合の不正利用を防ぐのに役立ちます。 |
params. | numberリクエストボディのオーバーヘッドを含む、Assembly で想定されるアップロードの合計サイズの上限(バイト単位)。これはファイルごとの制限ではなく、再開可能な転送が始まる前に拒否されることを保証するものではありません。 |
params. | string指定された HTTP Referer と照合する正規表現です。無効な式や、評価の制限時間を超える式は拒否されます。Referer ヘッダーがない場合は、このチェックを通過します。リクエストを認証するには Signature Authentication を使用してください。 |
params. | booleanリアルタイムの Assembly Execution Progress イベントを発行するには、true に設定します。URL 変換の Assemblies では、この設定は無視されます。 |
params. | stringこの Assembly でメタデータ抽出に使用する ExifTool スタックを選択します。Robot Steps の処理スタックを選択するものではありません。 |
params. | stringこの Assembly でメタデータ抽出に使用する FFmpeg スタックを選択します。これは Robot Steps の処理スタックを選択するものではありません。処理スタックを選択するには、該当する Robot Step で |
params. | object文字列をキーとする値のオブジェクト(名前 -> 値)で、追加のフォームフィールドと同様に Assembly Variables として使用できます。値には、JSON として文字列化できるものであれば何でも使用できます。 追加プロパティのスキーマ任意の値 |
params. | stringこの Assembly でメタデータ抽出に使用する ImageMagick スタックを選択します。これは Robot Steps の処理スタックを選択するものではありません。処理スタックを選択するには、該当する Robot Step の |
params. | stringこの Assembly でメタデータ抽出に使用する MediaInfo スタックを選択します。Robot Steps の処理スタックを選択するものではありません。 |
params. | stringこの Assembly でメタデータ抽出に使用する MPlayer スタックを選択します。Robot Steps の処理スタックを選択するものではありません。 |
params. | string | number各 Signature を一意にし、Signature の意図しない再利用を防ぐために、署名付きリクエストのパラメーターに含める一意のランダムな値。 |
params. | Array<"without_params" | "without_result_meta_data" | "without_results" | "without_upload_meta_data" | "without_uploads">Assembly Notifications で送信されるペイロードのサイズを制御します。Notification の再送では、元の Assembly リクエストで指定されたフィルターが再利用されます。Template 内でのみ定義されたフィルターは、再送時には保持されません。空の配列(デフォルト)を指定すると、完全な Assembly Status が送信されます。トップレベルの未加工の Assembly Instructions フィールド 配列要素のスキーマ"without_params" | "without_result_meta_data" | "without_results" | "without_upload_meta_data" | "without_uploads" |
params. | null | stringTransloadit は、Assembly が完了したときにサーバーへピングバックを送信できます。ここで指定された URL に、 |
params. | booleanAssembly 作成時の初期レスポンスを最小限に抑えるには、これを true に設定してください。成功時のレスポンスには ok と assembly_id のみが含まれます。エラーレスポンスでは、error、http_code、message、reason、および assembly_id が、利用可能な場合に保持されます。これはレスポンスの最小化であり、アクセス制御ではありません。返された Assembly ID を持つ人は誰でも、追加の認証なしで、フィールドと結果を含む完全な Assembly Status を引き続き取得できます。Assembly IDs とステータス URL は、秘密のケイパビリティとして扱ってください。notify_url が設定されている場合は、完全な Assembly Status が引き続き notify_url に送信されます。 |
params. | stringブラウザーからのアップロードが完了した後のリダイレクト先 URL。既存のクエリパラメーターとフラグメントを保持したまま、Assembly ID とステータス URL がクエリパラメーターとして追加されます。 |
params. | Assembly が出力する CORS レスポンスヘッダーです。以下に示す CORS ヘッダーを
|
params. | object |
params. | stringAssembly に記録された使用状況タグ。 |
次のいずれかのスキーマが適用される場合があります:
必須プロパティ: steps, template_id
直接指定した Steps または Template から Assembly を作成するためのパラメータ。
params: このオブジェクトでは、一覧に記載されているフィールドのみが受け付けられます。
| フィールド | 型と説明 |
|---|---|
params.必須 | object保存されている Template 内の指定された Steps にマージされる、部分的な Step 値です。これらの値の Robot 固有の完全な構造は、Template の読み込み後に検証されます。 |
params.必須 | string (最小長: 1)Assembly Instructions を含む Template の ID です。Template で |
バリアント 2
直接指定した Steps または Template から Assembly を作成するためのパラメータ。
params: このオブジェクトでは、一覧に記載されているフィールドのみが受け付けられます。
| フィールド | 型と説明 |
|---|---|
params. | string | Array<string>
次のいずれかのスキーマが適用される場合があります: string (最小長: 1, 最大長: 4096)stringArray<string> (最小項目数: 1, 最大項目数: 10)Array<string>配列要素のスキーマstring (最小長: 1, 最大長: 4096) |
params. | objectAssembly Instructions を含みます。 |
params. | stringAssembly Instructions を含む Template の ID です。Template で |
認証方式別のリクエストパラメーター
署名付き params
Auth Key を params.auth.key として含めてください。リクエストに署名する場合は、将来の時刻を示す params.auth.expires タイムスタンプを含め、Signature を別の signature フィールドで送信してください。以下のフィールド定義では、params 内のパスを使用しています。
完全な JSON スキーマ
直接指定した Steps または Template から Assembly を作成する際に使用する署名付きパラメーター。
上記のフィールド定義を使用します: params.auth, params.emit_execution_progress, params.exiftool_stack, params.ffmpeg_stack, params.fields, params.imagemagick_stack, params.mediainfo_stack, params.mplayer_stack, params.nonce, params.notification_payload, params.notify_url, params.quiet, params.redirect_url, params.response_headers, params.usage_tags
次のいずれかのスキーマが適用される場合があります:
必須プロパティ: steps, template_id
直接指定した Steps または Template から Assembly を作成するためのパラメータ。
params: このオブジェクトでは、一覧に記載されているフィールドのみが受け付けられます。
上記のフィールド定義を使用します: params.steps, params.template_id
バリアント 2
直接指定した Steps または Template から Assembly を作成するためのパラメータ。
params: このオブジェクトでは、一覧に記載されているフィールドのみが受け付けられます。
上記のフィールド定義を使用します: params.input_url, params.steps, params.template_id
Bearer トークンを使用する場合
Bearer トークンを Authorization ヘッダーで送信してください。params.auth と、それとは別の signature フィールドは省略できます。他の必須パラメーターの要件は引き続き適用されます。以下のフィールド定義では、params 内のパスを使用します。
完全な JSON スキーマ
直接指定した Steps または Template から Assembly を作成するためのパラメータ。
上記のフィールド定義を使用します: params.emit_execution_progress, params.exiftool_stack, params.ffmpeg_stack, params.fields, params.imagemagick_stack, params.mediainfo_stack, params.mplayer_stack, params.nonce, params.notification_payload, params.notify_url, params.quiet, params.redirect_url, params.response_headers, params.usage_tags
| フィールド | 型と説明 |
|---|---|
params. | Bearer 認証を使用する Assembly リクエストの認証メタデータとアップロードの制約です。トークンが API キーを提供するため、リクエストでは API キーを省略できます。
referer のないアップロードは常にこのチェックを通過します(一部のブラウザーでは referer が無効になっているため)。そのため、この機能が役立つユースケースはごく限られます。正規表現の詳細については、Mozilla の RegExp ドキュメントを参照してください。 無効な正規表現と、評価の制限時間を超える正規表現は拒否されます。このチェックは Signature Authentication の代わりにはなりません。クライアントは Referer ヘッダーを省略したり偽装したりできます。
上限は、保存済みの Template または Assembly リクエストの この上限によって、サイズ超過のすべての転送を開始前に拒否できると考えないでください。再開可能なアップロードでは、申告されたサイズまたは受信済みのサイズが tus の更新を通じて利用可能になり、完了したアップロードが処理される際に Assembly が上限をチェックします。遅延アップロードのサイズは作成時には不明であり、Assembly がそのアップロードを拒否する前に、すでにデータが転送されている場合があります。 一定のサイズを超えるファイルだけを無視し、それ以外のすべてのファイルを処理したい場合は、🤖/file/filter を使用してください。
これらのプロパティは、Assembly リクエストの一部として、または Template の一部として設定できます。
|
params. | string将来の日時を示す ISO 8601 形式の有効期限タイムスタンプ。リクエストが署名されている場合、または Signature Authentication が必要な場合は必須です。Bearer 認証を使用するリクエストでは省略できます。 |
params. | stringリクエストの認証に使用する Transloadit API キー |
params. | integer (最小値: 1)Assembly ごとに許可される入力ファイルの最大数です。アップロードまたはインポートされたファイルの数がこの上限を超えると、Assembly はエラーで停止します。これは、Signature Authentication の認証情報が露出した場合の不正利用を防ぐのに役立ちます。 |
params. | numberリクエストボディのオーバーヘッドを含む、Assembly で想定されるアップロードの合計サイズの上限(バイト単位)。これはファイルごとの制限ではなく、再開可能な転送が始まる前に拒否されることを保証するものではありません。 |
params. | string指定された HTTP Referer と照合する正規表現です。無効な式や、評価の制限時間を超える式は拒否されます。Referer ヘッダーがない場合は、このチェックを通過します。リクエストを認証するには Signature Authentication を使用してください。 |
次のいずれかのスキーマが適用される場合があります:
必須プロパティ: steps, template_id
直接指定した Steps または Template から Assembly を作成するためのパラメータ。
params: このオブジェクトでは、一覧に記載されているフィールドのみが受け付けられます。
上記のフィールド定義を使用します: params.steps, params.template_id
バリアント 2
直接指定した Steps または Template から Assembly を作成するためのパラメータ。
params: このオブジェクトでは、一覧に記載されているフィールドのみが受け付けられます。
上記のフィールド定義を使用します: params.input_url, params.steps, params.template_id
ここでは、ほかの POST フィールド(params、signature、num_expected_upload_files、tus_num_expected_upload_files という名前ではないもの)も指定できます。これらは、Assembly Instructions を動的にするための変数として使用できます。
Builtin Template の入力を URL からインポートする
ファイルをアップロードする代わりに、Signature 付きまたは Bearer 認証済みのリクエストでは、以下に挙げる Builtin Template の template_id とともに、ファイルの URL を input_url に指定できます。Transloadit はファイルをダウンロードし、それらに対して Builtin の公開済み Steps を実行します。
{
"template_id": "builtin/caption-video@0.0.1",
"input_url": "https://example.com/videos/interview.mp4"
}
input_url は、1 つの HTTP(S) URL、または最大 10 個の URL のリストを受け付けます。builtin/caption-video は各動画をその動画の文字起こしと対応付けるため、Assembly ごとに 1 つの URL を受け取ります。リクエストに steps やアップロードを同時に含めることはできません。また、通常のインポート保護措置が適用されるため、プライベートネットワークのアドレスは拒否されます。Assembly では template_id と Builtin のフィールド検証が維持され、その Instructions ではインポートが imported Step として表示されます。この Assembly をリプレイすると、同じ URL が再度インポートされます。input_url を受け付ける Builtins: builtin/caption-video、builtin/convert-to-pdf、builtin/encode-video、builtin/extract-text、builtin/prepare-image、builtin/remove-background、builtin/transcribe、builtin/video-covers。
レスポンス
レスポンスボディの例を以下に示します:
{
"account_id": "6c8b8d10d68b11e3a799b579dfce333a",
"assembly_id": "0fce5b1063e611e88d8eb130f7921d8a",
"assembly_ssl_url": "https://api2-morven.transloadit.com/assemblies/0fce5b1063e611e88d8eb130f7921d8a",
"assembly_url": "http://api2.morven.transloadit.com/assemblies/0fce5b1063e611e88d8eb130f7921d8a",
"bytes_expected": 1687,
"bytes_received": 1687,
"bytes_usage": 0,
"companion_url": "https://api2-morven.transloadit.com/companion/",
"execution_duration": 0.001,
"execution_start": "2018/05/30 08:47:19 GMT",
"fields": {},
"instance": "morven.transloadit.com",
"jobs_queue_duration": 0,
"message": "The Assembly is currently being executed.",
"ok": "ASSEMBLY_EXECUTING",
"parent_id": null,
"queue_duration": 0.04,
"results": {},
"start_date": "2018/05/30 08:47:19 GMT",
"template": null,
"template_id": null,
"tus_url": "https://api2-morven.transloadit.com/resumable/files/",
"update_stream_url": "https://api2-morven.transloadit.com/ws20243?assembly=0fce5b1063e611e88d8eb130f7921d8a",
"upload_duration": 0.049,
"uploads": [],
"uppyserver_url": "https://api2-morven.transloadit.com/companion/",
"warnings": [],
"websocket_url": "https://api2-morven.transloadit.com/ws20243"
}2xx 成功
JSON レスポンスの本文。 application/json text/plain; charset=utf-8
レスポンスボディのスキーマ
完全な JSON スキーマ
| フィールド | 型と説明 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
account_id | null | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
account_name | null | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
account_slug | null | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
api_auth_key_id | null | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
assemblyId | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
assembly_id | stringこの Assembly の一意の ID です。Assembly が作成されたときにこの ID をデータベースに保存し、受信する Notifications との照合に使用できます。 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
assembly_ssl_url | null | stringこの Assembly の現在のステータスを照会するための一意の URL で、SSL/HTTPS 経由で使用できます。 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
assembly_url | null | stringこの Assembly の現在のステータスを照会するために使用する一意の URL。 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
build_id | stringサポートによるトラブルシューティング用の、省略可能なビルド識別子です。不透明な値として扱ってください。Assemblies 間で変わる場合があります。 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
bytes_expected | numberこの Assembly でアップロードされると見込まれるバイト数。 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
bytes_received | numberこれまでにこの Assembly にアップロードされたバイト数です。これは主に、クライアントがアップロードの進行状況を表示するために使用します。 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
bytes_usage | number | nullこの Assembly が処理したバイトのうち、利用料金の請求対象となるバイトの総数です。すべての Assemblies の | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
client_agent | null | stringアップローダーのユーザーエージェントは公開されません。この非推奨フィールドは常に | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
client_ip | null | stringアップロード元の IP アドレスは公開されません。この非推奨フィールドは常に | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
client_referer | null | stringアップローダーのリファラー URL は公開されません。この非推奨のフィールドは常に | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
companion_url | null | stringこの Assembly が通信できる Companion サーバーの URL。 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
cron_input_file_limit | integer (最小値: 1, 最大値: 1000)スケジュールされた Assembly の入力ファイル数に対する実効上限。クラッシュからの自動復旧では、保存済みの Instructions が無効になっている場合も、この上限が維持されます。通常の Assemblies では、このフィールドは省略されます。 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
executing_jobs | Array<string>配列要素のスキーマstring | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
execution_duration | number | nullTransloadit がこの Assembly の実行に要した時間(秒)。 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
execution_start | null | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
expected_tus_uploads | number | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
fields | objectUppy など、 追加プロパティのスキーマ任意の値 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
finished_tus_uploads | number | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
has_dupe_jobs | boolean | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ignored_error_count | number | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ignored_errors | Array<object>配列要素のスキーマ
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
info |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
info. | number | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
instance | null | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
is_infinite | boolean | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
jobs_queue_duration | number | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
last_job_completed | null | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
merged_params | null | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
message | stringこの Assembly の状態を説明する、人が読んで理解できるメッセージです。必ずしも含まれるとは限りません。 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
notify_duration | number | null自動再試行とその間の待機時間を含む、配信にかかった時間(秒)。 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
notify_error | null | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
notify_response_code | number | null | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
notify_response_data | null | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
notify_start | null | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
notify_status | null | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
notify_url | null | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
num_input_files | number | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
params | null | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
parent_assembly_status | 任意の値 | null次のいずれかのスキーマが適用される場合があります: 任意の値任意の値null | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
parent_id | null | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
previousStep | stringエラーに関連する前の Step の名前(取得可能な場合)。 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
queue_duration | number | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
region | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
results | objectTransloadit がこれまでに生成した結果ファイルです。各キーは、ファイルを生成した Step の名前です。ストレージ Robots はファイルを生成しないため、それらの Step 名は省略されます。 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
running_jobs | Array<string>配列要素のスキーマstring | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
start_date | stringこの Assembly のアップロードが開始された日時。 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
started_jobs | Array<string>配列要素のスキーマstring | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
started_tus_uploads | number | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
step | stringエラーに関連付けられた Step の名前(取得可能な場合)。 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
template | null | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
template_id | null | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
template_name | null | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
transloadit_client | null | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
tus_uploads | Array<object>配列要素のスキーマ
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
tus_url | stringこの Assembly が再開可能なアップロードに使用する tus サーバーの URL。 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
update_stream_url | null | stringこの Assembly のステータス更新をリアルタイムで取得できる、サーバー送信イベントストリームの URL。 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
upload_duration | numberアップローダーがファイルのアップロードに要した時間(秒)。 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
upload_meta_data_extracted | boolean | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
uploads | Array<object>この Assembly 用にアップロードされたファイルの配列です。詳細については、メタデータのドキュメントを参照してください。 配列要素のスキーマ
次のいずれかのスキーマが適用される場合があります: 必須プロパティ: basename, ext, field, id, meta, mime, name, size, type, url: object
バリアント 2: object
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
uppyserver_url | null | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
usage_tags | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
virusname | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
warnings | Array<object>配列要素のスキーマ
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
websocket_url | null | stringこの Assembly のステータス更新をリアルタイムで取得できる Websocket(Socket.IO を使用)サーバーの URL。 |
次のいずれかのスキーマが適用される場合があります:
ok: "ASSEMBLY_EXECUTING" | "ASSEMBLY_REPLAYING" | "ASSEMBLY_UPLOADING"
レスポンスには追加のフィールドが含まれる場合があります。
| フィールド | 型と説明 |
|---|---|
error | なしエラーステータスを示します。このキーは、Assembly が失敗した場合にのみ存在します。新しいエラーコードが追加されることがあります。認識できないコードは失敗として処理し、プログラムで検査できるようにその値を保持してください。 この値は禁止されています。 |
ok必須 | "ASSEMBLY_EXECUTING" | "ASSEMBLY_REPLAYING" | "ASSEMBLY_UPLOADING"エラーではないライフサイクルのステータスを示し、アップロード中、実行中、中止済み、キャンセル済みの状態が含まれます。処理の成功は |
ok: string
レスポンスには追加のフィールドが含まれる場合があります。
| フィールド | 型と説明 |
|---|---|
error | なしエラーステータスを示します。このキーは、Assembly が失敗した場合にのみ存在します。新しいエラーコードが追加されることがあります。認識できないコードは失敗として処理し、プログラムで検査できるようにその値を保持してください。 この値は禁止されています。 |
ok必須 | stringエラーではないライフサイクルのステータスを示し、アップロード中、実行中、中止済み、キャンセル済みの状態が含まれます。処理の成功は 指定可能な値 (6)
|
必須プロパティ: error
レスポンスには追加のフィールドが含まれる場合があります。
| フィールド | 型と説明 |
|---|---|
cmd | string | Array<string | number>トラブルシューティング用の処理コマンドの詳細情報です(省略可能)。診断情報の詳細は異なる場合があります。プログラムによるエラー処理には 次のいずれかのスキーマが適用される場合があります: stringArray<string | number>Array<string | number>配列要素のスキーマstring | number |
error必須 | string (最小長: 1)エラーステータスを示します。このキーは、Assembly が失敗した場合にのみ存在します。新しいエラーコードが追加されることがあります。認識できないコードは失敗として処理し、プログラムで検査できるようにその値を保持してください。 既知の値(370)。その他の値もあり得ます
|
exitCode | number | null失敗した処理コマンドの終了ステータス(省略可能)。診断の詳細は異なる場合があります。プログラムによるエラー処理には |
exitSignal | null | string処理コマンドを終了させたシグナル(省略可能)。診断の詳細は異なる場合があります。プログラムによるエラー処理には |
file | string |
headers | object追加プロパティのスキーマ任意の値 |
is_private_address | boolean |
name | string |
numRetries | number |
ok | null |
playwright_error_code | string |
reason | null | string | number | boolean | Array<任意の値> | object省略可能な診断の詳細情報です。この値が文字列であると仮定したり、そのまま表示したりしないでください。人が読めるテキストには 次のいずれかのスキーマが適用される場合があります: nullstringnumberbooleanArray<任意の値>Array<任意の値>配列要素のスキーマ任意の値objectobject追加プロパティのスキーマ任意の値 |
response_code | number | null |
retries | number |
retryable | boolean |
stderr | stringトラブルシューティング用の、処理コマンドからの診断出力です(省略可能)。診断の詳細は変わる場合があります。プログラムによるエラー処理には |
stdout | stringトラブルシューティング用の、処理コマンドからの標準出力です(省略可能)。診断情報の詳細は異なる場合があります。プログラムによるエラー処理には |
url | string |
url_host | null | string |
エラーレスポンス
JSON レスポンスの本文。 application/json text/plain; charset=utf-8
レスポンスボディのスキーマ
完全な JSON スキーマ
レスポンスには追加のフィールドが含まれる場合があります。
| フィールド | 型と説明 |
|---|---|
assembly_id | string |
error | string (最小長: 1) |
http_code | number | string
|
message | string人が読んで理解できる形式のエラー説明です。文言は変わる場合があるため、特定の失敗を処理する際は |
reason | null | string | number | boolean | Array<任意の値> | object次のいずれかのスキーマが適用される場合があります: nullstringnumberbooleanArray<任意の値>Array<任意の値>配列要素のスキーマ任意の値objectobject追加プロパティのスキーマ任意の値 |
HTTP 400
JSON レスポンスの本文。 application/json text/plain; charset=utf-8
レスポンスボディのスキーマ
完全な JSON スキーマ
名前付きエラーと一般的なエラー形式
error: "INVALID_PARAMS_FIELD"
不正な params フィールドが指定されました。無効な JSON が含まれています。
レスポンスには追加のフィールドが含まれる場合があります。
一般的なエラー形式
レスポンスの詳細については、Assembly Status レスポンスのドキュメントを参照してください。