Transloadit
料金
  • ファイルアップロード
  • ファイルインポート
  • バッチ処理
  • 動画エンコーディング
  • 音声エンコーディング
  • 画像処理
  • ドキュメント処理
  • 人工知能
  • ファイルフィルタリングとセキュリティ
  • メディアカタログ化
  • ファイル圧縮
  • コード評価
  • ファイルエクスポート
  • Smart CDN
  • すべてのサービスを表示
  • 連携機能を見る
  • 実行可能なデモを試す (English)
  • Uppy
  • TransloaditKit
  • Android 用 SDK
  • Node.js 用 SDK
  • Next.js 用ビューアー
  • Python 用 SDK
  • Ruby 用 SDK
  • Go 用 SDK
  • Java 用 SDK
  • PHP 用 SDK
  • Zapier
  • MCP サーバー
  • Transloadit CLI
  • Terraform
  • 基本事項
  • ベストプラクティス
  • よくある質問
  • Robot
  • API
  • 形式
  • 初めてのアプリ開発
  • 会社概要
  • 比較
  • オープンソース
  • お客様の声
  • 採用情報 (English)
  • セキュリティ
  • 記事
  • 開発者ニュース (English)
  • 開発のヒント
  • プレス
  • 研究 (English)
  • 導入事例
  • ソリューション
  • ガイド (English)
  • 用語集
  • 法務 (English)
  • ツール
  • 世界中の数百万人に教育を届ける Coursera を支援
  • Transloadit サポート
  • オープンソースサポート
  • サービスレベル契約 (English)
  • エンジニアによるデモを予約 (English)
基本事項Robotよくある質問API形式ベストプラクティス
トピック
  • エンドポイント
  • レスポンスコード
  • 認証
  • ウェブフック
  • メタデータ
  • API のセキュリティ
  • レート制限
  • キュー
  • 再開可能なアップロード
認証
  • Bearer トークンを作成する
  • 新しい Auth Key を作成する
  • Auth Keys の一覧を取得する
  • Auth Key のスコープを取得する
  • Auth Key を編集する
  • Auth Key を削除する
  • Auth Key のシークレットを取得する
Assemblies
  • 新しい Assembly を作成する
  • Assembly Status を取得する
  • 指定された ID で Assembly を作成する
  • Assembly の変更をリアルタイムでストリーミングする
  • 実行中の Assembly をキャンセルする
  • Assembly を再実行する
  • Assemblies の一覧を取得する
  • Assembly Status レスポンス
  • Assembly の統計情報を取得する
ウェブフック
  • Assembly Notifications を取得する
  • Assembly Notification を再送する
請求
  • 対象月の請求書を取得する
キュー
  • 現在使用中の Priority Job Slots を取得する
  • Priority Job Slots の統計を取得する
再開可能なアップロード
  • tus の機能を確認する
  • tus アップロードを作成する
  • tus アップロードのオフセットを取得する
  • tus ファイルのバイト列をアップロードする
  • tus アップロードを終了する
  • tus アップロードをダウンロードする
Template 認証情報
  • 新しい Template 認証情報を作成する
  • Template 認証情報を取得する
  • Template 認証情報を編集する
  • Template 認証情報を削除する
  • Template 認証情報の一覧を取得する
  • Template 認証情報の種類を取得する
Templates
  • 新しい Template を作成する
  • Template を取得する
  • Template を編集する
  • Template を削除する
  • Templates の一覧を取得する
  • Cron Template の実行履歴を取得する alpha
デジタルアセット管理
  • DAM アセットを移動するか、名前を変更する alpha
  • DAM アセットを削除 alpha
  • DAM アセットを一括移動する alpha
  • DAM アセットを一括削除する alpha
  • ストレージ内のファイルまたはフォルダーを移動 alpha
  • ストレージ内のアセットを取得
  • ストレージ内のアセットを一覧表示

Assembly の変更をリアルタイムでストリーミングする

Assembly Status の変更を Server-Sent Events としてストリーミングします。

GET{UPDATE_STREAM_URL}
補足

検証済みの Assembly レスポンスに含まれる update_stream_url ケイパビリティ URL をリクエスト先として使用します。API2 ホストに関連付けられ、暗黙的に利用可能な認証情報は使用しません。

Assembly を作成した後のレスポンスには、Assembly Status を取得するための 2 つのフィールド、assembly_ssl_url と update_stream_url があります。assembly_ssl_url に指定された URL から現在の Assembly Status を取得できます。Assembly の進行状況を把握するには、その URL を定期的にポーリングするか、このドキュメントで説明する更新ストリームを購読できます。

サーバー送信イベント

Assembly Status の update_stream_url プロパティは、対応する Assembly の更新ストリームをサーバー送信イベントで利用できる URL を定義します。

サーバー送信イベント⁠は、HTTP 経由でサーバーからクライアントへリアルタイムに通知を送信するための Web 技術です。Web Sockets に似ていますが、サーバーからクライアントへの一方向のメッセージのみを許可し、シンプルなテキストベースの形式⁠で構成されます。

Assembly がアップロード中または実行中の状態にある間、クライアントは update_stream_url に指定された URL に、Accept: text/event-stream ヘッダーフィールドを付けた GET リクエストを送信してこのエンドポイントに接続し、レスポンスストリームを解析できます。サーバーは、メッセージとイベントを混在させてクライアントに送信できます。両者の違いは、イベントには情報を含む追加のペイロードがありますが、メッセージにはないことです。

複数のクライアントが同じ Assembly を購読できます。1 つの接続を閉じても、他の接続は維持されます。アップローダーのシャットダウン中は、既存のストリームが閉じられ、新しい接続には空の HTTP 503 レスポンスが返されます。現在の Assembly Status を取得して、処理が終了したかどうかを確認してください。

メッセージ

メッセージはメッセージ名で構成され、追加のペイロードはありません。通信上では、assembly_finished という名前のメッセージは次のようになります([NL] は改行を示します)。

data: assembly_finished[NL]
[NL]

Transloadit は次のメッセージを送信します。

  • assembly_upload_meta_data_extracted は、すべてのアップロードが完了し、それらすべてのメタデータが抽出されたときに送信されます。
  • assembly_uploading_finished は、この Assembly のすべてのアップロードが完了し、Assembly がアップロード中から実行中の状態に移行するときに送信されます。
  • assembly_finished は、Assembly が終了したときに送信されますが、必ずしも処理が成功したことを意味するわけではありません。キャンセル後や、失敗したものを含め、すでに終了した Assembly に接続したときにも送信されます。サーバーはこのメッセージの後にストリームを終了します。assembly_ssl_url の内容を取得し、最終ステータスを確認してください。ok: "ASSEMBLY_COMPLETED" は成功、ok: "ASSEMBLY_CANCELED" はキャンセル、error は失敗を示します。
  • ping は、Assembly の処理中に接続を維持するため、定期的に送信されます。現在は毎分送信されますが、この間隔は将来変更される可能性があります。

イベント

イベントは、イベント名と追加のペイロードで構成されます。通信上では、assembly_result_finished という名前のイベントは次のようになります([NL] は改行を示します)。

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

Transloadit は次のイベントを送信します。

  • assembly_error は、Assembly の実行中にエラーが発生したときに送信されます。サーバーはこのイベントの後にストリームを終了します。エラーに関する追加情報が含まれます。例:

    {
      "error": "FILE_FILTER_DECLINED_FILE",
      "message": "One of your files was declined",
      "step": "filter",
      "previousStep": ":original",
      "http_code": 400
    }
    
  • assembly_upload_finished は、完了したアップロードごとに送信されます。アップロードされたファイルに関する追加情報が含まれます。構造は、Assembly Status の uploads 配列内のオブジェクトと同じです。例:

    {
      "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 は、Step の新しい結果が利用可能になるたびに送信されます。ペイロードは [stepName, file] タプルです。file オブジェクトは、Assembly Status の results[stepName] 内の要素と同じ構造です。例:

    [
      "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 は、Assembly とそのファイルの全体的な Execution Progress に関する情報とともに、一定の間隔で送信されます。構造と仕組みの詳細は、Assembly Execution Progress で説明しています。例:

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

    注:progress_per_original_file は original_id をキーとします。original_id のないインポートされたファイルは、このリストには表示されません。

補足

将来、メッセージやイベントが追加される可能性があります。そのため、クライアントは想定外のメッセージやイベントを無視し、エラーで停止しないようにする必要があります。

ストリームは過去のイベントを再送しません。特に、assembly_error リスナーは、接続する前に発生したエラーを報告できません。Assembly がアップローダーのメモリ内に存在しなくなると、ストリーム URL は HTTP 404 を返します。切断された場合やストリームを利用できない場合は、assembly_ssl_url の内容を取得してください。Assembly がまだアップロード中または実行中であれば、その URL のポーリングを続けてください。ストリームが閉じられたことだけでは、成功したとは判断できません。

JavaScript の例

最新のブラウザーは、EventSource コンストラクターを通じてサーバー送信イベントをネイティブにサポートしています。Assembly Status が assembly_status 変数に格納されている場合、クライアントは次のように assembly_finished メッセージ、assembly_uploading_finished メッセージ、および assembly_result_finished イベントをリッスンできます。ストリームが切断されると、この例では 2 秒ごとのポーリングに切り替え、Assembly が終端ステータスに達するまで続けます。HTTP またはネットワークの障害は、成功として扱われるのではなく、報告されます。

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

リクエスト例

UPDATE_STREAM_URL に、Assembly 作成レスポンスの update_stream_url の完全な URL を設定してください。ホスト名は置き換えないでください。

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

必須のリクエストヘッダー

  • accept (固定値)、必須。指定可能な値: "text/event-stream"。 複数回出現するヘッダーの値は、照合前に結合されます。

任意のレスポンスクエリパラメーター

  • callback (JavaScript コールバック名)。JSON レスポンスを JSONP コールバックでラップします。コールバック名は ^(?:_jqjsp[0-9]*|jQuery[0-9]+_[0-9]+)$ に一致する必要があります。最後に指定されたものだけが使用され、空の値は無視されます。コールバック名が無効な場合は HTTP 403 が返されます。変換後のレスポンスは HTTP 200 を使用します。コールバックはレスポンスのシリアライズ後に適用されます。

リクエスト

追加のリクエストボディやフィールドは必要ありません。

レスポンス

レスポンスボディの例を以下に示します:

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

2xx 成功

Server-Sent Events のレスポンスストリーム。 text/event-stream

assembly_error

data フィールドに JSON ペイロードを持つ名前付きイベント。 サーバーはこの通知の後にストリームを閉じます。結果を判断するには、リソースの最終ステータスを取得してください。

イベントペイロード
完全な JSON スキーマ

JSON を新しいタブで開く

このオブジェクトについて列挙されているフィールド以外のフィールドも受け付けます。

フィールド型と説明
error
string (最小長: 1)

エラーコード(利用可能な場合)。このフィールドが存在しない場合でも、最終的な Assembly Status を取得してください。

既知の値(370)。その他の値もあり得ます
  • "ADMIN_PERMISSIONS_REQUIRED"
  • "AI_CHAT_VALIDATION"
  • "ASSEMBLY_ACCOUNT_MISMATCH"
  • "ASSEMBLY_CANNOT_BE_REPLAYED"
  • "ASSEMBLY_COULD_NOT_BE_CREATED"
  • "ASSEMBLY_CRASHED"
  • "ASSEMBLY_DISALLOWED_ROBOTS_USED"
  • "ASSEMBLY_EMPTY_STEPS"
  • "ASSEMBLY_EXECUTION_PROGRESS_NOT_ENABLED"
  • "ASSEMBLY_EXPIRED"
  • "ASSEMBLY_FILE_NOT_RESERVED"
  • "ASSEMBLY_INFINITE"
  • "ASSEMBLY_INVALID_NOTIFY_URL"
  • "ASSEMBLY_INVALID_NUM_EXPECTED_UPLOAD_FILES_PARAM"
  • "ASSEMBLY_INVALID_STEPS"
  • "ASSEMBLY_JOB_ENQUEUE_ERROR"
  • "ASSEMBLY_LIST_ERROR"
  • "ASSEMBLY_MEMORY_LIMIT_EXCEEDED"
  • "ASSEMBLY_NOTIFICATIONS_LIST_ERROR"
  • "ASSEMBLY_NOTIFICATION_LIST_ERROR"
  • "ASSEMBLY_NOTIFICATION_NOT_PERSISTED"
  • "ASSEMBLY_NOTIFICATION_NOT_REPLAYED"
  • "ASSEMBLY_NOT_CAPABLE"
  • "ASSEMBLY_NOT_FINISHED"
  • "ASSEMBLY_NOT_FOUND"
  • "ASSEMBLY_NOT_REPLAYED"
  • "ASSEMBLY_NO_CHARGEABLE_STEP"
  • "ASSEMBLY_NO_NOTIFY_URL"
  • "ASSEMBLY_NO_STEPS"
  • "ASSEMBLY_PLAN_FILE_SIZE_LIMIT_EXCEEDED"
  • "ASSEMBLY_ROBOT_MISSING"
  • "ASSEMBLY_SATURATED"
  • "ASSEMBLY_STATS_ERROR"
  • "ASSEMBLY_STATS_INVALID_TIME"
  • "ASSEMBLY_STATS_MISSING_REGION"
  • "ASSEMBLY_STATUS_FETCHING_RATE_LIMIT_REACHED"
  • "ASSEMBLY_STATUS_NOT_FOUND"
  • "ASSEMBLY_STATUS_PARSE_ERROR"
  • "ASSEMBLY_STEP_INVALID"
  • "ASSEMBLY_STEP_INVALID_ROBOT"
  • "ASSEMBLY_STEP_INVALID_USE"
  • "ASSEMBLY_STEP_NO_ROBOT"
  • "ASSEMBLY_STEP_UNKNOWN_ROBOT"
  • "ASSEMBLY_STEP_UNKNOWN_USE"
  • "ASSEMBLY_URL_TRANSFORM_MISSING"
  • "AUDIO_ARTWORK_VALIDATION"
  • "AUDIO_CONCAT_INVALID_INPUT"
  • "AUDIO_CONCAT_VALIDATION"
  • "AUDIO_ENCODE_VALIDATION"
  • "AUDIO_LOOP_VALIDATION"
  • "AUDIO_MERGE_VALIDATION"
  • "AUDIO_SPLIT_NO_OUTPUT"
  • "AUDIO_SPLIT_VALIDATION"
  • "AUDIO_WAVEFORM_VALIDATION"
  • "AUTH_EXPIRED"
  • "AUTH_KEYS_NOT_FOUND"
  • "AUTH_KEY_SCOPES_NOT_FOUND"
  • "AUTH_SECRET_NOT_RETRIEVED"
  • "AZURE_IMPORT_ACCESS_DENIED"
  • "AZURE_IMPORT_FAILURE"
  • "AZURE_IMPORT_NOT_FOUND"
  • "AZURE_IMPORT_VALIDATION"
  • "AZURE_STORE_ACCESS_DENIED"
  • "AZURE_STORE_NOT_FOUND"
  • "AZURE_STORE_VALIDATION"
  • "BACKBLAZE_IMPORT_ACCESS_DENIED"
  • "BACKBLAZE_IMPORT_FAILURE"
  • "BACKBLAZE_IMPORT_NOT_FOUND"
  • "BACKBLAZE_IMPORT_VALIDATION"
  • "BACKBLAZE_STORE_ACCESS_DENIED"
  • "BACKBLAZE_STORE_FAILURE"
  • "BACKBLAZE_STORE_VALIDATION"
  • "BAD_PRICING"
  • "BEARER_TOKEN_AUTH_KEY_MISMATCH"
  • "BEARER_TOKEN_EXPIRED"
  • "BEARER_TOKEN_INVALID"
  • "BILL_LIMIT_EXCEEDED"
  • "BOX_IMPORT_ACCESS_DENIED"
  • "BOX_IMPORT_FAILURE"
  • "BOX_IMPORT_NOT_FOUND"
  • "BOX_IMPORT_VALIDATION"
  • "BOX_STORE_COULD_NOT_PARSE_URL"
  • "BOX_STORE_VALIDATION"
  • "CANNOT_ACCEPT_NEW_ASSEMBLIES"
  • "CDN_REQUIRED"
  • "CLOUDFILES_IMPORT_ACCESS_DENIED"
  • "CLOUDFILES_IMPORT_FAILURE"
  • "CLOUDFILES_IMPORT_NOT_FOUND"
  • "CLOUDFILES_IMPORT_VALIDATION"
  • "CLOUDFILES_STORE_ACCESS_DENIED"
  • "CLOUDFILES_STORE_ERROR"
  • "CLOUDFILES_STORE_VALIDATION"
  • "CLOUDFLARE_IMPORT_ACCESS_DENIED"
  • "CLOUDFLARE_IMPORT_FAILURE"
  • "CLOUDFLARE_IMPORT_NOT_FOUND"
  • "CLOUDFLARE_IMPORT_VALIDATION"
  • "CLOUDFLARE_STORE_ACCESS_DENIED"
  • "CLOUDFLARE_STORE_NOT_FOUND"
  • "CLOUDFLARE_STORE_URL_VERIFICATION_FAILURE"
  • "CLOUDFLARE_STORE_VALIDATION"
  • "CLOUDFLARE_STORE_WRONG_REGION"
  • "CLOUD_AI_IMAGE_VALIDATION"
  • "DAM_STORAGE_UNAVAILABLE"
  • "DIGITALOCEAN_IMPORT_ACCESS_DENIED"
  • "DIGITALOCEAN_IMPORT_FAILURE"
  • "DIGITALOCEAN_IMPORT_NOT_FOUND"
  • "DIGITALOCEAN_IMPORT_VALIDATION"
  • "DIGITALOCEAN_STORE_ACCESS_DENIED"
  • "DIGITALOCEAN_STORE_NOT_FOUND"
  • "DIGITALOCEAN_STORE_VALIDATION"
  • "DIGITALOCEAN_STORE_WRONG_REGION"
  • "DOCUMENT_AUTOROTATE_VALIDATION"
  • "DOCUMENT_CONVERT_UNSUPPORTED_CONVERSION"
  • "DOCUMENT_CONVERT_VALIDATION"
  • "DOCUMENT_EXTRACT_VALIDATION"
  • "DOCUMENT_MERGE_UNSUPPORTED_CONVERSION"
  • "DOCUMENT_MERGE_VALIDATION"
  • "DOCUMENT_OCR_VALIDATION"
  • "DOCUMENT_OPTIMIZE_UNSUPPORTED_INPUT"
  • "DOCUMENT_OPTIMIZE_VALIDATION"
  • "DOCUMENT_SPLIT_VALIDATION"
  • "DOCUMENT_THUMBS_INVALID_INPUT"
  • "DOCUMENT_THUMBS_VALIDATION"
  • "DOCUMENT_WATERMARK_INVALID_INPUT"
  • "DOCUMENT_WATERMARK_INVALID_LAYOUT"
  • "DOCUMENT_WATERMARK_UNSUPPORTED_TEXT"
  • "DOCUMENT_WATERMARK_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_ACCESS_DENIED"
  • "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_NOT_AVAILABLE_FOR_CLIENT"
  • "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"
  • "TMP_FILE_UPLOAD_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

エラーに関連する HTTP ステータスです。このフィールドは、すでに開かれているストリームの HTTP ステータスを変更しません。

message
string

この Assembly の状態を説明する、人が読んで理解できるメッセージです。必ずしも含まれるとは限りません。

previousStep
string

エラーに関連する前の Step の名前(取得可能な場合)。

reason
null | string | number | boolean | Array<任意の値> | object

省略可能な診断の詳細情報です。この値が文字列であると仮定したり、そのまま表示したりしないでください。人が読めるテキストには message を使用してください。診断の詳細情報は変わることがあります。プログラムによるエラー処理には error コードを使用してください。

次のいずれかのスキーマが適用される場合があります:

null
string
number
boolean
Array<任意の値>
Array<任意の値>
配列要素のスキーマ
任意の値
object
object
追加プロパティのスキーマ
任意の値
step
string

エラーに関連付けられた Step の名前(取得可能な場合)。

assembly_execution_progress

data フィールドに JSON ペイロードを持つ名前付きイベント。

イベントペイロード
完全な JSON スキーマ

JSON を新しいタブで開く

このオブジェクトについて列挙されているフィールド以外のフィールドも受け付けます。

フィールド型と説明
progress_combined

必須

number | null

全体の進捗の推定値をパーセントで表したものです。Null は、全体の進捗を推定できないことを意味します。

progress_per_original_file

必須

Array<object>

元の入力ファイルの進捗推定値です。元の ID を持たないインポート済みファイルは含まれません。

配列要素のスキーマ
object

progress_per_original_file[]: このオブジェクトについて列挙されているフィールド以外のフィールドも受け付けます。

フィールド型と説明
progress_per_original_file[].original_id

必須

string

この進捗推定値に対応する元の入力ファイルの ID。

progress_per_original_file[].progress

必須

number

この元ファイルの推定処理進捗をパーセントで表した値です。

assembly_finished

data フィールドにこの名前をプレーンテキストとして含み、event フィールドを持たないメッセージ。 サーバーはこの通知の後にストリームを閉じます。結果を判断するには、リソースの最終ステータスを取得してください。

ping

data フィールドにこの名前をプレーンテキストとして含み、event フィールドを持たないメッセージ。

assembly_result_finished

data フィールドに JSON ペイロードを持つ名前付きイベント。

イベントペイロード
完全な JSON スキーマ

JSON を新しいタブで開く

[string, object] (最小項目数: 2, 最大項目数: 2)
タプルの要素 1
string
タプルの要素 2

[1]: このオブジェクトについて列挙されているフィールド以外のフィールドも受け付けます。

フィールド型と説明
[1].as
string | Array<string> | null

次のいずれかのスキーマが適用される場合があります:

string
Array<string>
Array<string>
配列要素のスキーマ
string
null
[1].asset_id
string

/transloadit/store によって保存されたファイルの安定した識別子です。この識別子は、その Workspace および version_id とともに保持してください。通常のファイルの id は、ストレージ内のアセットの ID ではありません。

[1].asset_version
number

保存されたアセットのリビジョンを表す数値。保持されている正確なバイト列を選択するには、この数値ではなく version_id を使用してください。

[1].basename
null | string

拡張子を除いたファイル名。

[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

ファイルの拡張子です。拡張子が判定されていない場合は null、名前に拡張子がない場合は空文字列になることがあります。

[1].field
null | string

このファイルの送信に使用するフォームフィールドの名前。

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

この保存済み画像バージョンにアルファチャンネルがあるかどうか(判明している場合)。

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

Transloadit がファイルを追跡するために内部で使用する、ランダムかつ一意の ID。

[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

以下に示すような、ファイルから抽出された追加のメタデータを含むオブジェクトです。繰り返し現れる日付タグは、元の値のリストとして返されることがあります。値を単一のタイムスタンプとして使用する前に、その値の型を確認してください。

次のいずれかのスキーマが適用される場合があります:

object
object

[1].meta: このオブジェクトについて列挙されているフィールド以外のフィールドも受け付けます。

フィールド型と説明
[1].meta.album
string | number | null

次のいずれかのスキーマが適用される場合があります:

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

この画像の絞り値(例: 5.7)。

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

メディアのメタデータに記録されているアーティスト情報です。繰り返し出現するタグはリストとして返されます。数値のように見える名前や true および false という語は、リスト内の場合も含め、JSON の数値またはブール値として返されることがあります。文字列メソッドを使用する前やリストを反復処理する前に、型を確認してください。

スキーマに関する追加の詳細は、完全な JSON Schema で確認できます。

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

画像のアスペクト比で、幅を高さで割った値です。何らかの理由で画像の高さが 0 の場合は、0 になります。

[1].meta.audio_bitrate
number | null

全チャンネルを合計した音声ビットレートをビット/秒で表した値(例: 128000)。

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

音声チャンネル数。ステレオの場合は通常 2 です。

[1].meta.audio_codec
null | string

音声コーデック("faad" など)。サポートされている音声コーデックを参照してください。

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

音声のサンプルレート(ヘルツ単位)。例: 44100。

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

画像の撮影者。一部のカメラは、creator ではなくこのフィールドに値を設定します。

次のいずれかのスキーマが適用される場合があります:

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

最も出現頻度の高いピクセルの色を 1 色だけ集計し、用途が限られるドミナントカラーと混同しないでください。平均色は、まず入力画像を 1 ピクセルに縮小して計算されます。

[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

Office ドキュメントのプロパティに保存されている文字数。

[1].meta.character_count_with_spaces
number | null
[1].meta.city
string | number | null

この画像が撮影された都市(例: "Berlin")。文字列と数値のメタデータ値は保持されます。文字列メソッドを使用する前に型を確認してください。

次のいずれかのスキーマが適用される場合があります:

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

スキーマに関する追加の詳細は、完全な JSON Schema で確認できます。

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

検出されたメディアの色空間("sRGB" や "Gray" など)。動画の色空間は、メタデータ抽出が有効な状態で検出された場合に利用でき、output_meta.colorspace: true を設定する必要はありません。output_meta: false を設定すると、メタデータ抽出が無効になります。

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

著作権のメタデータフィールド。

スキーマに関する追加の詳細は、完全な JSON Schema で確認できます。

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

ファイルから抽出された著作権表示のメタデータです。元のスカラー値は保持されます。文字列メソッドを使用する前に型を確認してください。

次のいずれかのスキーマが適用される場合があります:

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

この画像が撮影された国(例: "Germany")。

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

画像のメタデータに記録された国コードです。例:"de"、528。文字列値と数値はそのまま保持されます。文字列メソッドを使用する前に型を確認してください。

次のいずれかのスキーマが適用される場合があります:

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

スキーマに関する追加の詳細は、完全な JSON Schema で確認できます。

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

ファイルから抽出された作成者メタデータです。元のスカラー値は、それらの値のリストも含めて保持されます。文字列メソッドを使用する前に型を確認してください。

スキーマに関する追加の詳細は、完全な JSON Schema で確認できます。

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

メディアのメタデータで報告される作成タイムスタンプ(利用可能な場合)。

スキーマに関する追加の詳細は、完全な JSON Schema で確認できます。

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

ファイルシステムまたはメディアに埋め込まれたメタデータによって報告される更新タイムスタンプ。

スキーマに関する追加の詳細は、完全な JSON Schema で確認できます。

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

メディアが記録された日時。単一の有効な文字列のタイムスタンプは、YYYY/MM/DD HH:MM:SS に正規化されます。タイムゾーンが含まれている場合は、UTC/GMT に変換され、末尾に GMT が付きます。解析できない文字列のタイムスタンプは null になります。数値のタイムスタンプと、繰り返し出現する日付タグのリストは、元の値が維持されます。

スキーマに関する追加の詳細は、完全な JSON Schema で確認できます。

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

この画像の説明(例: "This tree is very old.")。

次のいずれかのスキーマが適用される場合があります:

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

スキーマに関する追加の詳細は、完全な JSON Schema で確認できます。

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

メディアを記録したデバイスの名前です("iPhone 3GS" など)。

次のいずれかのスキーマが適用される場合があります:

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

メディアを記録したデバイスのソフトウェアバージョン("3.1.2" など)。

次のいずれかのスキーマが適用される場合があります:

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

メディアを記録したデバイスの製造元("Apple" など)。文字列および数値のメタデータ値は保持されます。文字列メソッドを使用する前に型を確認してください。

次のいずれかのスキーマが適用される場合があります:

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

次のいずれかのスキーマが適用される場合があります:

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

画像の主要な色を最大 10 色、16 進数の値の配列として返します。この抽出をスキップするには、output_meta.dominant_colors を省略してください。false を含め、このプロパティを指定すると抽出がリクエストされ、色が返された場合には追加の使用料金が発生することがあります。output_meta 自体を false に設定すると、追加のメタデータ抽出が無効になりますが、基本的なファイルの種類とサイズのチェックは引き続き実行されることがあります。

スキーマに関する追加の詳細は、完全な JSON Schema で確認できます。

[1].meta.duration
number | null

音声ファイルの長さ(秒単位)。

[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

この画像の露出補正値("+4/3" など)。

次のいずれかのスキーマが適用される場合があります:

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

この画像の露出モードです("Auto" など)。文字列および数値のメタデータ値はそのまま保持されます。文字列メソッドを使用する前に型を確認してください。

次のいずれかのスキーマが適用される場合があります:

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

この画像の露光時間です(例: "1/30")。

次のいずれかのスキーマが適用される場合があります:

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

この画像の F 値(5.6 など)。

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

スキーマに関する追加の詳細は、完全な JSON Schema で確認できます。

[1].meta.field_order
null | string

FFprobe が報告するフィールドオーダーで、"tt"、"bb"、"tb"、"bt"、"progressive" などがあります。この診断フィールドに値を設定するための検出を要求するには、output_meta.interlaced を true に設定してください。検出が要求されなかった場合やフィールドオーダーを取得できなかった場合、このキーは null として存在することがあります。インターレース/プログレッシブによる単純な条件分岐には interlaced を使用してください。

[1].meta.flash
null | string

この画像のフラッシュ設定("Off, Did not fire" など)。

[1].meta.focal_length
null | string

この画像の焦点距離(例:"55.0 mm")。

[1].meta.frame_count
number | null

アニメーション GIF ファイルに含まれるフレーム数です。その他のすべての画像形式では、デフォルトで 1 です。

[1].meta.framerate
number | null

動画のフレームレート(29.5 など)。

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

次のいずれかのスキーマが適用される場合があります:

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

完全に不透明なアルファチャンネル付き画像も含め、元の画像にアルファチャンネルがあるかどうかを示します。thumbhash とともに返され、この項目がない場合は不明を意味します。

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

画像にクリッピングパスが含まれる場合は true、それ以外の場合は false です。

[1].meta.has_transparency
boolean | null

画像に透明な領域があるかどうか。透明部分の検査をリクエストするには、output_meta.has_transparency を true に設定します。JPEG 画像に対する false のように、偽であることが既知の値は、このオプションを省略した場合や false に設定した場合でも返されることがあります。output_meta 自体を false に設定すると、追加のメタデータ抽出はスキップされますが、基本的なファイルの種類とサイズのチェックは引き続き実行されることがあります。

[1].meta.height
number | null

メディアの高さ(ピクセル単位)。

[1].meta.interlace_detection
object | null

Transloadit のインターレース検出器による診断情報です。このオブジェクトには sampled_frames、tff、bff、progressive、undetermined、confidence、method、ffprobe_field_order が含まれることがあります。検出をリクエストするには、output_meta.interlaced を true に設定してください。このキーは、検出がリクエストされていない場合、値が null の状態で存在することがあります。そのプロパティを読み取る前に、null ではないオブジェクトであることを確認してください。

スキーマに関する追加の詳細は、完全な JSON Schema で確認できます。

[1].meta.interlaced
boolean | null

動画がインターレース走査を使用していると見られるかどうかを示します。インターレース動画の場合は true、プログレッシブ動画の場合は false です。検出を要求するには、output_meta.interlaced を true に設定します。検出を要求しなかった場合、または要求した検出で結論が得られなかった場合、このキーは null として存在することがあります。フィールドが存在するだけでは、検出が実行されたことを示しません。

[1].meta.iso
number | null

この画像の ISO 値(例: 800)。

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

ファイルのメタデータから抽出されたキーワード。値は文字列、有限の数値、または要素が文字列、有限の数値、真偽値のいずれかである配列です。たとえば、["tree", "nature"]。このフィールドは存在しない場合や null の場合があります。反復処理を行う前に型を確認してください。配列の要素は必ずしも文字列とは限りません。

スキーマに関する追加の詳細は、完全な JSON Schema で確認できます。

[1].meta.latitude
number | null

メディアが記録された場所の緯度(例:52.5374)。

[1].meta.light_value
number | null

この画像の明るさの値です(例: 6.9)。

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

この画像が撮影された場所で、通常は "Zingster Str. 32" のような通りの情報です。文字列および数値のメタデータ値は保持されます。文字列メソッドを使用する前に型を確認してください。

次のいずれかのスキーマが適用される場合があります:

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

メディアが記録された地点の経度です。例: 13.4034。

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

音声ファイルの平均音量です。測定を要求するには、output_meta.mean_volume を true に設定してください。測定が要求されなかった場合や値が利用できなかった場合、このキーが null として存在することがあります。フィールドが存在するだけでは、測定が実行されたことを示しません。

[1].meta.metering_mode
null | string

この画像の測光モード("Multi-segment" など)。

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

スキーマに関する追加の詳細は、完全な JSON Schema で確認できます。

[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

次のいずれかのスキーマが適用される場合があります:

string | number
string | number
null
[1].meta.overall_bitrate
number | null
[1].meta.page_count
number | null

ページ数。Office ドキュメントの場合、この値はファイルに保存されているプロパティから取得されます。

[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>

スキーマに関する追加の詳細は、完全な JSON Schema で確認できます。

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

ファイルから抽出された権利に関するメタデータ。元のスカラー値は保持されます。文字列メソッドを使用する前に型を確認してください。

次のいずれかのスキーマが適用される場合があります:

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

動画の形式がシークをサポートしているかどうか(例:true)。

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

この画像のシャッタースピード(例: "1/32")。

次のいずれかのスキーマが適用される場合があります:

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

この画像が撮影された州(例: "Berlin")。

次のいずれかのスキーマが適用される場合があります:

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

スキーマに関する追加の詳細は、完全な JSON Schema で確認できます。

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

現在のサムネイルのインデックスです(0 から始まります)。このキーは、🤖/video/thumbs の結果にのみ含まれます。

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

現在のサムネイルのオフセット(秒単位)。このキーは、🤖/video/thumbs の結果にのみ含まれます。

  • number
  • string
    検証パターン(正規表現)^[\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

EXIF の向き情報を適用した画像の Base64 エンコードされた ThumbHash。生成元の Step で output_meta.thumbhash をリクエストしてください。リクエストされていない場合、未対応の場合、40 メガピクセルを超える場合、または抽出に失敗した場合は省略されます。元の画像が非公開の場合、ハッシュを非公開の画像データとして扱ってください。

検証パターン(正規表現)^(?:[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

この画像のタイトル(例:"Tree")。

次のいずれかのスキーマが適用される場合があります:

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

次のいずれかのスキーマが適用される場合があります:

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

動画の映像ビットレート(500000 など)。

[1].meta.video_codec
null | string

動画のビデオコーデック("ffh264" など)。

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

この画像のホワイトバランス設定です(例: "Manual")。文字列および数値のメタデータ値はそのまま保持されます。文字列メソッドを使用する前に型を確認してください。

次のいずれかのスキーマが適用される場合があります:

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

メディアの幅(ピクセル単位)です。表示比率がピクセル比率と異なる動画の場合、これは意図された表示幅です。

[1].meta.word_count
number | null

Office ドキュメントのプロパティに保存されている単語数。

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

次のいずれかのスキーマが適用される場合があります:

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

次のいずれかのスキーマが適用される場合があります:

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

次のいずれかのスキーマが適用される場合があります:

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

次のいずれかのスキーマが適用される場合があります:

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

このファイルについて判定された MIME タイプ。

[1].name
null | string

ファイルの名前です。ファイルが処理によって別の形式に変換される場合、Transloadit はこのフィールドで使用する拡張子を変更します。

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

このファイルの生成元となった元のアップロードファイルの一意の ID です。これは、いくつかの Steps の処理を経た後に、複数ファイルのアップロードのうち、特定のファイルの生成にどのファイルが使用されたかを判断するのに役立ちます。

次のいずれかのスキーマが適用される場合があります:

string
Array<null | string>
Array<null | string>
配列要素のスキーマ
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>
配列要素のスキーマ
object

[1].playlists[]: このオブジェクトについて列挙されているフィールド以外のフィールドも受け付けます。

フィールド型と説明
[1].playlists[].content
string
[1].playlists[].meta
object

スキーマに関する追加の詳細は、完全な JSON Schema で確認できます。

[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

保存されたバイト列の SHA-256 チェックサム(小文字、利用可能な場合)。

検証パターン(正規表現)^[a-f0-9]{64}$
[1].signed_ssl_url
string
[1].signed_url
string
[1].size
number | null

ファイルのサイズ(バイト単位)。

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

利用可能な場合に、この保存済み画像バージョンとともに保持される Base64 エンコード済みの ThumbHash。この画像データは、元の画像と同じアクセス制御で保護してください。

検証パターン(正規表現)^(?:[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

ファイルを表す抽象的なカテゴリです。既知の値は "audio"、"document"、"image"、"office"、"pdf"、"swf"、"video"、"xls"、またはカテゴリが検出されなかった場合の null です。利用側は、将来のカテゴリとの互換性を保つため、他の文字列も受け入れるようにしてください。

[1].url
null | string

ファイルをダウンロードできる URL、または配信用 URL が利用できない場合は null です。当社のサーバー上の一時的な URL は数時間後に有効期限が切れるため、後で使用するファイルはストレージにエクスポートしてください。/transloadit/store は、url/ssl_url に署名付きの Smart CDN URL を設定します。キーがない場合は null を設定します。アクセスおよび保持の条件に従って長期的に参照できるように、返された Workspace、asset_id、version_id を保持してください。/transloadit/import は、asset_id と任意の version_id、または変更される可能性のある path を受け付けます。一時的な URL も、処理対象ファイルの id も、長期的に利用できるストレージ参照ではありません。

[1].user_meta
object | null

次のいずれかのスキーマが適用される場合があります:

object
object
追加プロパティのスキーマ
任意の値
null
[1].version_id
string

ストレージが結果を確定した後に返される不変のバージョン ID です。保持およびアクセスに関する条件の範囲内で、移動や上書きの後も同じバイト列を保持するには、asset_id とこの version_id を指定してインポートしてください。

検証パターン(正規表現)^[A-Za-z0-9_-]{21}[AQgw]$
[1].vimeo
object

[1].vimeo: このオブジェクトについて列挙されているフィールド以外のフィールドも受け付けます。

[1].vimeo.title

必須

string
[1].vimeo.uri

必須

string
[1].width
number | null
[1].workspace
string (最小長: 1)

この保存済みの結果を所有する Workspace のスラッグです。この結果をインポートまたは管理する際は、この Workspace に対して認証してください。

assembly_upload_finished

data フィールドに JSON ペイロードを持つ名前付きイベント。

イベントペイロード
完全な JSON スキーマ

JSON を新しいタブで開く

このオブジェクトについて列挙されているフィールド以外のフィールドも受け付けます。

フィールド型と説明
as
string | Array<string> | null

次のいずれかのスキーマが適用される場合があります:

string
Array<string>
Array<string>
配列要素のスキーマ
string
null
asset_id
string

/transloadit/store によって保存されたファイルの安定した識別子です。この識別子は、その Workspace および version_id とともに保持してください。通常のファイルの id は、ストレージ内のアセットの ID ではありません。

asset_version
number

保存されたアセットのリビジョンを表す数値。保持されている正確なバイト列を選択するには、この数値ではなく version_id を使用してください。

basename

必須

null | string

拡張子を除いたファイル名。

cost
number | null
exec_time
number
ext

必須

null | string

ファイルの拡張子です。拡張子が判定されていない場合は null、名前に拡張子がない場合は空文字列になることがあります。

field

必須

null | string

このファイルの送信に使用するフォームフィールドの名前。

from_batch_import
boolean
has_alpha
boolean

この保存済み画像バージョンにアルファチャンネルがあるかどうか(判明している場合)。

id

必須

string

Transloadit がファイルを追跡するために内部で使用する、ランダムかつ一意の ID。

import_url
string
is_temp_url
boolean
is_tus_file
boolean
md5hash
null | string
meta

必須

object

以下に示すような、ファイルから抽出された追加のメタデータを含むオブジェクトです。繰り返し現れる日付タグは、元の値のリストとして返されることがあります。値を単一のタイムスタンプとして使用する前に、その値の型を確認してください。

meta: このオブジェクトについて列挙されているフィールド以外のフィールドも受け付けます。

meta.album
string | number | null

次のいずれかのスキーマが適用される場合があります:

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

この画像の絞り値(例: 5.7)。

meta.archive_directory
null | string
meta.artist
string | number | boolean | Array<string | number | boolean> | null

メディアのメタデータに記録されているアーティスト情報です。繰り返し出現するタグはリストとして返されます。数値のように見える名前や true および false という語は、リスト内の場合も含め、JSON の数値またはブール値として返されることがあります。文字列メソッドを使用する前やリストを反復処理する前に、型を確認してください。

スキーマに関する追加の詳細は、完全な JSON Schema で確認できます。

meta.aspect_ratio
number | string | null

画像のアスペクト比で、幅を高さで割った値です。何らかの理由で画像の高さが 0 の場合は、0 になります。

meta.audio_bitrate
number | null

全チャンネルを合計した音声ビットレートをビット/秒で表した値(例: 128000)。

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

音声チャンネル数。ステレオの場合は通常 2 です。

meta.audio_codec
null | string

音声コーデック("faad" など)。サポートされている音声コーデックを参照してください。

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

音声のサンプルレート(ヘルツ単位)。例: 44100。

meta.author
string | number | null

画像の撮影者。一部のカメラは、creator ではなくこのフィールドに値を設定します。

次のいずれかのスキーマが適用される場合があります:

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

最も出現頻度の高いピクセルの色を 1 色だけ集計し、用途が限られるドミナントカラーと混同しないでください。平均色は、まず入力画像を 1 ピクセルに縮小して計算されます。

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

Office ドキュメントのプロパティに保存されている文字数。

meta.character_count_with_spaces
number | null
meta.city
string | number | null

この画像が撮影された都市(例: "Berlin")。文字列と数値のメタデータ値は保持されます。文字列メソッドを使用する前に型を確認してください。

次のいずれかのスキーマが適用される場合があります:

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

スキーマに関する追加の詳細は、完全な JSON Schema で確認できます。

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

検出されたメディアの色空間("sRGB" や "Gray" など)。動画の色空間は、メタデータ抽出が有効な状態で検出された場合に利用でき、output_meta.colorspace: true を設定する必要はありません。output_meta: false を設定すると、メタデータ抽出が無効になります。

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

著作権のメタデータフィールド。

スキーマに関する追加の詳細は、完全な JSON Schema で確認できます。

meta.copyright_notice
string | number | boolean | null

ファイルから抽出された著作権表示のメタデータです。元のスカラー値は保持されます。文字列メソッドを使用する前に型を確認してください。

次のいずれかのスキーマが適用される場合があります:

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

この画像が撮影された国(例: "Germany")。

meta.country_code
string | number | null

画像のメタデータに記録された国コードです。例:"de"、528。文字列値と数値はそのまま保持されます。文字列メソッドを使用する前に型を確認してください。

次のいずれかのスキーマが適用される場合があります:

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

スキーマに関する追加の詳細は、完全な JSON Schema で確認できます。

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

ファイルから抽出された作成者メタデータです。元のスカラー値は、それらの値のリストも含めて保持されます。文字列メソッドを使用する前に型を確認してください。

スキーマに関する追加の詳細は、完全な JSON Schema で確認できます。

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

メディアのメタデータで報告される作成タイムスタンプ(利用可能な場合)。

スキーマに関する追加の詳細は、完全な JSON Schema で確認できます。

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

ファイルシステムまたはメディアに埋め込まれたメタデータによって報告される更新タイムスタンプ。

スキーマに関する追加の詳細は、完全な JSON Schema で確認できます。

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

メディアが記録された日時。単一の有効な文字列のタイムスタンプは、YYYY/MM/DD HH:MM:SS に正規化されます。タイムゾーンが含まれている場合は、UTC/GMT に変換され、末尾に GMT が付きます。解析できない文字列のタイムスタンプは null になります。数値のタイムスタンプと、繰り返し出現する日付タグのリストは、元の値が維持されます。

スキーマに関する追加の詳細は、完全な JSON Schema で確認できます。

meta.description
string | number | null

この画像の説明(例: "This tree is very old.")。

次のいずれかのスキーマが適用される場合があります:

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

スキーマに関する追加の詳細は、完全な JSON Schema で確認できます。

meta.device_name
string | number | null

メディアを記録したデバイスの名前です("iPhone 3GS" など)。

次のいずれかのスキーマが適用される場合があります:

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

メディアを記録したデバイスのソフトウェアバージョン("3.1.2" など)。

次のいずれかのスキーマが適用される場合があります:

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

メディアを記録したデバイスの製造元("Apple" など)。文字列および数値のメタデータ値は保持されます。文字列メソッドを使用する前に型を確認してください。

次のいずれかのスキーマが適用される場合があります:

string | number
string | number
null
meta.disc
string | number | null

次のいずれかのスキーマが適用される場合があります:

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

画像の主要な色を最大 10 色、16 進数の値の配列として返します。この抽出をスキップするには、output_meta.dominant_colors を省略してください。false を含め、このプロパティを指定すると抽出がリクエストされ、色が返された場合には追加の使用料金が発生することがあります。output_meta 自体を false に設定すると、追加のメタデータ抽出が無効になりますが、基本的なファイルの種類とサイズのチェックは引き続き実行されることがあります。

スキーマに関する追加の詳細は、完全な JSON Schema で確認できます。

meta.duration
number | null

音声ファイルの長さ(秒単位)。

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

この画像の露出補正値("+4/3" など)。

次のいずれかのスキーマが適用される場合があります:

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

この画像の露出モードです("Auto" など)。文字列および数値のメタデータ値はそのまま保持されます。文字列メソッドを使用する前に型を確認してください。

次のいずれかのスキーマが適用される場合があります:

string | number
string | number
null
meta.exposure_time
number | string | null

この画像の露光時間です(例: "1/30")。

次のいずれかのスキーマが適用される場合があります:

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

この画像の F 値(5.6 など)。

meta.faces
Array<object> | null

スキーマに関する追加の詳細は、完全な JSON Schema で確認できます。

meta.field_order
null | string

FFprobe が報告するフィールドオーダーで、"tt"、"bb"、"tb"、"bt"、"progressive" などがあります。この診断フィールドに値を設定するための検出を要求するには、output_meta.interlaced を true に設定してください。検出が要求されなかった場合やフィールドオーダーを取得できなかった場合、このキーは null として存在することがあります。インターレース/プログレッシブによる単純な条件分岐には interlaced を使用してください。

meta.flash
null | string

この画像のフラッシュ設定("Off, Did not fire" など)。

meta.focal_length
null | string

この画像の焦点距離(例:"55.0 mm")。

meta.frame_count
number | null

アニメーション GIF ファイルに含まれるフレーム数です。その他のすべての画像形式では、デフォルトで 1 です。

meta.framerate
number | null

動画のフレームレート(29.5 など)。

meta.genre
string | number | null

次のいずれかのスキーマが適用される場合があります:

string | number
string | number
null
meta.has_alpha
boolean

完全に不透明なアルファチャンネル付き画像も含め、元の画像にアルファチャンネルがあるかどうかを示します。thumbhash とともに返され、この項目がない場合は不明を意味します。

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

画像にクリッピングパスが含まれる場合は true、それ以外の場合は false です。

meta.has_transparency
boolean | null

画像に透明な領域があるかどうか。透明部分の検査をリクエストするには、output_meta.has_transparency を true に設定します。JPEG 画像に対する false のように、偽であることが既知の値は、このオプションを省略した場合や false に設定した場合でも返されることがあります。output_meta 自体を false に設定すると、追加のメタデータ抽出はスキップされますが、基本的なファイルの種類とサイズのチェックは引き続き実行されることがあります。

meta.height
number | null

メディアの高さ(ピクセル単位)。

meta.interlace_detection
object | null

Transloadit のインターレース検出器による診断情報です。このオブジェクトには sampled_frames、tff、bff、progressive、undetermined、confidence、method、ffprobe_field_order が含まれることがあります。検出をリクエストするには、output_meta.interlaced を true に設定してください。このキーは、検出がリクエストされていない場合、値が null の状態で存在することがあります。そのプロパティを読み取る前に、null ではないオブジェクトであることを確認してください。

スキーマに関する追加の詳細は、完全な JSON Schema で確認できます。

meta.interlaced
boolean | null

動画がインターレース走査を使用していると見られるかどうかを示します。インターレース動画の場合は true、プログレッシブ動画の場合は false です。検出を要求するには、output_meta.interlaced を true に設定します。検出を要求しなかった場合、または要求した検出で結論が得られなかった場合、このキーは null として存在することがあります。フィールドが存在するだけでは、検出が実行されたことを示しません。

meta.iso
number | null

この画像の ISO 値(例: 800)。

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

ファイルのメタデータから抽出されたキーワード。値は文字列、有限の数値、または要素が文字列、有限の数値、真偽値のいずれかである配列です。たとえば、["tree", "nature"]。このフィールドは存在しない場合や null の場合があります。反復処理を行う前に型を確認してください。配列の要素は必ずしも文字列とは限りません。

スキーマに関する追加の詳細は、完全な JSON Schema で確認できます。

meta.latitude
number | null

メディアが記録された場所の緯度(例:52.5374)。

meta.light_value
number | null

この画像の明るさの値です(例: 6.9)。

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

この画像が撮影された場所で、通常は "Zingster Str. 32" のような通りの情報です。文字列および数値のメタデータ値は保持されます。文字列メソッドを使用する前に型を確認してください。

次のいずれかのスキーマが適用される場合があります:

string | number
string | number
null
meta.longitude
number | null

メディアが記録された地点の経度です。例: 13.4034。

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

音声ファイルの平均音量です。測定を要求するには、output_meta.mean_volume を true に設定してください。測定が要求されなかった場合や値が利用できなかった場合、このキーが null として存在することがあります。フィールドが存在するだけでは、測定が実行されたことを示しません。

meta.metering_mode
null | string

この画像の測光モード("Multi-segment" など)。

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

スキーマに関する追加の詳細は、完全な JSON Schema で確認できます。

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

次のいずれかのスキーマが適用される場合があります:

string | number
string | number
null
meta.overall_bitrate
number | null
meta.page_count
number | null

ページ数。Office ドキュメントの場合、この値はファイルに保存されているプロパティから取得されます。

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>

スキーマに関する追加の詳細は、完全な JSON Schema で確認できます。

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

ファイルから抽出された権利に関するメタデータ。元のスカラー値は保持されます。文字列メソッドを使用する前に型を確認してください。

次のいずれかのスキーマが適用される場合があります:

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

動画の形式がシークをサポートしているかどうか(例:true)。

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

この画像のシャッタースピード(例: "1/32")。

次のいずれかのスキーマが適用される場合があります:

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

この画像が撮影された州(例: "Berlin")。

次のいずれかのスキーマが適用される場合があります:

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

スキーマに関する追加の詳細は、完全な JSON Schema で確認できます。

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

現在のサムネイルのインデックスです(0 から始まります)。このキーは、🤖/video/thumbs の結果にのみ含まれます。

meta.thumb_offset
number | string | null

現在のサムネイルのオフセット(秒単位)。このキーは、🤖/video/thumbs の結果にのみ含まれます。

  • number
  • string
    検証パターン(正規表現)^[\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

EXIF の向き情報を適用した画像の Base64 エンコードされた ThumbHash。生成元の Step で output_meta.thumbhash をリクエストしてください。リクエストされていない場合、未対応の場合、40 メガピクセルを超える場合、または抽出に失敗した場合は省略されます。元の画像が非公開の場合、ハッシュを非公開の画像データとして扱ってください。

検証パターン(正規表現)^(?:[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

この画像のタイトル(例:"Tree")。

次のいずれかのスキーマが適用される場合があります:

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

次のいずれかのスキーマが適用される場合があります:

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

動画の映像ビットレート(500000 など)。

meta.video_codec
null | string

動画のビデオコーデック("ffh264" など)。

meta.white_balance
string | number | null

この画像のホワイトバランス設定です(例: "Manual")。文字列および数値のメタデータ値はそのまま保持されます。文字列メソッドを使用する前に型を確認してください。

次のいずれかのスキーマが適用される場合があります:

string | number
string | number
null
meta.width
number | null

メディアの幅(ピクセル単位)です。表示比率がピクセル比率と異なる動画の場合、これは意図された表示幅です。

meta.word_count
number | null

Office ドキュメントのプロパティに保存されている単語数。

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

次のいずれかのスキーマが適用される場合があります:

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

次のいずれかのスキーマが適用される場合があります:

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

次のいずれかのスキーマが適用される場合があります:

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

次のいずれかのスキーマが適用される場合があります:

string | number
string | number
null
mime

必須

null | string

このファイルについて判定された MIME タイプ。

name

必須

null | string

ファイルの名前です。ファイルが処理によって別の形式に変換される場合、Transloadit はこのフィールドで使用する拡張子を変更します。

original_basename
null | string
original_id

必須

string | Array<null | string>

このファイルの生成元となった元のアップロードファイルの一意の ID です。これは、いくつかの Steps の処理を経た後に、複数ファイルのアップロードのうち、特定のファイルの生成にどのファイルが使用されたかを判断するのに役立ちます。

次のいずれかのスキーマが適用される場合があります:

string
Array<null | string>
Array<null | string>
配列要素のスキーマ
null | string
original_md5hash
null | string
original_name
null | string
original_path
string
queue
null | string
queue_time
number
sha256
string

保存されたバイト列の SHA-256 チェックサム(小文字、利用可能な場合)。

検証パターン(正規表現)^[a-f0-9]{64}$
size

必須

number

ファイルのサイズ(バイト単位)。

ssl_url
null | string
thumbhash
string

利用可能な場合に、この保存済み画像バージョンとともに保持される Base64 エンコード済みの ThumbHash。この画像データは、元の画像と同じアクセス制御で保護してください。

検証パターン(正規表現)^(?:[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

必須

null | string

ファイルを表す抽象的なカテゴリです。既知の値は "audio"、"document"、"image"、"office"、"pdf"、"swf"、"video"、"xls"、またはカテゴリが検出されなかった場合の null です。利用側は、将来のカテゴリとの互換性を保つため、他の文字列も受け入れるようにしてください。

url

必須

null | string

ファイルをダウンロードできる URL、または配信用 URL が利用できない場合は null です。当社のサーバー上の一時的な URL は数時間後に有効期限が切れるため、後で使用するファイルはストレージにエクスポートしてください。/transloadit/store は、url/ssl_url に署名付きの Smart CDN URL を設定します。キーがない場合は null を設定します。アクセスおよび保持の条件に従って長期的に参照できるように、返された Workspace、asset_id、version_id を保持してください。/transloadit/import は、asset_id と任意の version_id、または変更される可能性のある path を受け付けます。一時的な URL も、処理対象ファイルの id も、長期的に利用できるストレージ参照ではありません。

user_meta
object
追加プロパティのスキーマ
任意の値
version_id
string

ストレージが結果を確定した後に返される不変のバージョン ID です。保持およびアクセスに関する条件の範囲内で、移動や上書きの後も同じバイト列を保持するには、asset_id とこの version_id を指定してインポートしてください。

検証パターン(正規表現)^[A-Za-z0-9_-]{21}[AQgw]$
workspace
string (最小長: 1)

この保存済みの結果を所有する Workspace のスラッグです。この結果をインポートまたは管理する際は、この Workspace に対して認証してください。

assembly_upload_meta_data_extracted

data フィールドにこの名前をプレーンテキストとして含み、event フィールドを持たないメッセージ。

assembly_uploading_finished

data フィールドにこの名前をプレーンテキストとして含み、event フィールドを持たないメッセージ。

HTTP 404, 503

レスポンスボディはありません。

エラーレスポンス

JSON レスポンスの本文。 application/json text/plain; charset=utf-8

レスポンスボディのスキーマ
完全な JSON スキーマ

JSON を新しいタブで開く

次のプロパティのうち、少なくとも 1 つが必須です: error, message, reason

レスポンスには追加のフィールドが含まれる場合があります。

フィールド型と説明
assembly_id
string
error
string (最小長: 1)
http_code
number | string
  • number
  • string
    検証パターン(正規表現)^[\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

人が読んで理解できる形式のエラー説明です。文言は変わる場合があるため、特定の失敗を処理する際は error コードを使用してください。

reason
null | string | number | boolean | Array<任意の値> | object

次のいずれかのスキーマが適用される場合があります:

null
string
number
boolean
Array<任意の値>
Array<任意の値>
配列要素のスキーマ
任意の値
object
object
追加プロパティのスキーマ
任意の値

レスポンス形式の詳細については、Mozilla のサーバー送信イベント⁠に関するドキュメントを参照してください。

前のページ ← 指定された ID で Assembly を作成する次のページ 実行中の Assembly をキャンセルする →
サポートに問い合わせる
Transloadit稼働状況を確認中…

製品

  • サービス
  • 料金
  • デモ EN (English)
  • ツール
  • セキュリティ
  • サポート

会社

  • 会社概要/プレス
  • ブログ/採用情報 EN (English)
  • 比較/コンプライアンス対応表
  • 研究 EN (English)
  • オープンソース
  • ソリューション
  • ウェブの先駆者たち

ドキュメント

  • はじめに
  • トランスコーディング
  • よくある質問
  • API
  • ガイド EN (English)/開発のヒント
  • 対応フォーマット

その他

  • プラットフォームの稼働状況⁠
  • コミュニティフォーラム⁠
  • Uppy
  • tus⁠

© 2009–2026 Transloadit-II GmbH

Transloadit®、tus®、Uppy® は、米国における Transloadit-II GmbH の登録商標です。

プライバシー EN (English)利用規約 EN (English)運営者情報 EN (English)商標 EN (English)DMCA ポリシー EN (English)
EnglishDeutschEspañolFrançaisPortuguês (Brasil)日本語