Builtin Template
Templateは通常、自分の Workspace 内で作成、管理します。Builtin Template は異なり、Transloadit が管理し、API2 内に存在します。ほかの Template と同様に template_id で参照できます。
Template を事前に作成せずに、一般的な変換処理の安定した、バージョン管理されたひな形を使いたい場合は、Builtin Template を利用してください。
builtin/ で始まる名前は Builtin Template 用に予約されています。この接頭辞を持つ名前の Template は、作成、編集、削除できません。
Builtin Template の使用
template_id に組み込みのスラッグを設定します。
{
"template_id": "builtin/encode-hls-video",
"steps": {}
}
注意事項:
stepsは省略可能です。下記の Builtin Template の処理設定でallow_steps_overrideがfalseに設定されていなければ、Step を上書きできます。- 既知の最新バージョンを参照するには、
builtin/<name>を使用します。 - 既知の最新バージョンを指す明示的なエイリアスには、
builtin/<name>@latestを使用します。 - 特定のバージョンに固定するには、
builtin/<name>@<version>を使用します。
Builtin Template の一覧取得
GET /templates には、クエリパラメーター
include_builtin を使って Builtin Template を含められます。詳細は Template 一覧 API を参照してください。
利用可能な Builtin Template
| スラッグ | 説明 | 必須フィールド | 任意フィールド |
|---|---|---|---|
builtin/caption-video
| アップロードした動画を文字起こしし、シンプルな字幕(デフォルト)、または大文字の Poppins テキストと発話中の単語の強調表示を使うソーシャル向け字幕を焼き込みます。字幕付き動画と SRT キューを返します。ソーシャル向けでは、同じ文字起こしからタイムスタンプ付き JSON も返します。ソーシャル向けのアクセントカラーは highlight_color で設定します。speaker_labels=true で話者を識別し、speaker_colors で話者ごとのソーシャル向け強調色を設定します。ソーシャル向けで文字サイズを自動調整するには font_size を省略します。シンプルな字幕のデフォルトは 16 です。vocabulary は Replicate または GCP に表記のヒントを渡します。AWS は空でない vocabulary を拒否します。CLI では transloadit assemblies create --template builtin/caption-video@0.0.3 --field style=social --field speaker_labels=true --field speaker_colors=FFD60A,4CC9F0 -i video.mp4 -o out/ を実行します。言語フィールドは発話の言語を指定するもので、翻訳を指定するものではありません。 | なし | fields.border_color(デフォルト:"000000")、fields.font_color(デフォルト:"FFFFFF")、fields.font_size、fields.highlight_color(デフォルト:"FFD60A")、fields.position(デフォルト:"bottom")、fields.provider(デフォルト:"auto")、fields.source_language(デフォルト:"en-US")、fields.speaker_colors(デフォルト:[])、fields.speaker_labels(デフォルト:false)、fields.style(デフォルト:"plain")、fields.target_language、fields.vocabulary(デフォルト:[]) |
builtin/capture-webpage
| 公開 HTTP(S) ウェブページまたはアップロードした HTML を PNG、JPEG、PDF としてキャプチャします。デフォルトでは、幅 1024 ピクセルのページ全体の PNG を作成します。固定ビューポートを使うには fullpage を false に設定します。URL はアップロードした HTML より優先されます。このビルトインはカスタムリクエストヘッダー、ブラウザー操作、認証情報を送信しません。 | なし | fields.delay(デフォルト:0)、fields.format(デフォルト:"png")、fields.fullpage(デフォルト:true)、fields.height(デフォルト:768)、fields.url(デフォルト:null)、fields.wait_until(デフォルト:"networkidle")、fields.width(デフォルト:1024) |
builtin/convert-to-pdf
| ドキュメント変換 Robot を使い、アップロードした Office 文書、HTML、Markdown、テキストを PDF に変換します。Markdown には既存の形式とテーマの設定を使います。用紙サイズ、余白、背景の印刷設定は HTML と Markdown のレンダリングに適用します。Office 文書とテキストは、コンバーター固有のレイアウトを維持します。 | なし | fields.markdown_format(デフォルト:"gfm")、fields.markdown_theme(デフォルト:"github")、fields.pdf_format(デフォルト:"Letter")、fields.pdf_margin(デフォルト:"6.25mm,6.25mm,14.11mm,6.25mm")、fields.pdf_print_background(デフォルト:true) |
builtin/encode-hls-video
| 入力動画を、アダプティブプレイリストを持つ HLS の解像度別出力(270p、360p、540p)にエンコードします。 | なし | なし |
builtin/encode-video
| 既存の MP4 と WebM プリセットを使い、アップロードした動画をウェブ向けにエンコードします。デフォルトは turbo エンコーディングによる 720p MP4 です。指定した寸法はプリセットの対応する寸法を上書きし、省略した寸法はプリセット値を維持します。出力サイズはソースとプリセットによって決まり、厳密なバイト数上限ではありません。 | なし | fields.height、fields.preset(デフォルト:"web/mp4/720p")、fields.turbo(デフォルト:true)、fields.width |
builtin/extract-text
| アップロードした画像、PDF、Office 文書から、読みやすいテキスト、JSON、Markdown、または HTML を抽出します。画像には OCR を使い、Office 文書は先に PDF に変換します。文書はデフォルトで OCR の前にネイティブテキストの抽出を試み、GCP を選択しない限り AWS を使います。Markdown と HTML では、ネイティブレイアウトの見出し、リスト、表と、OCR で取得した段落を維持します。パスワード、ページ選択、ページ単位のグループ化には、文書のネイティブ抽出が必要です。未対応の入力形式はスキップします。 | なし | fields.ocr_provider(デフォルト:"aws")、fields.page_range、fields.password、fields.text_format(デフォルト:"txt")、fields.text_granularity(デフォルト:"document")、fields.text_method(デフォルト:"auto") |
builtin/generate-image
| /image/generate を使い、プロンプトから画像を生成します。 | fields.prompt | なし |
builtin/generate-video
| /video/generate を使い、プロンプトから動画を生成します。 | fields.prompt | なし |
builtin/prepare-image
| アップロードした画像をウェブサイト向けに処理します。向きを自動補正し、1600×1600 以内に収め、品質 75 の WebP にエンコードし、メタデータを削除し、透明度を維持します。w/h(1–8000)、f、q(1–100)、r、bg、strip を設定できます。strip は params.fields.strip に JSON の真偽値で設定します。JPEG 出力には #ffffff などの不透明な bg が必要です。 | なし | fields.bg(デフォルト:"#00000000")、fields.f(デフォルト:"webp")、fields.h(デフォルト:1600)、fields.q(デフォルト:75)、fields.r(デフォルト:"fit")、fields.strip(デフォルト:true)、fields.w(デフォルト:1600) |
builtin/public-preview
| 宣言済みの公開プレフィックス配下にある、保持された特定のストレージバージョンを、最終段階で一度だけ画像エンコードしてプレビューします。fields.input(asset_id)と fields.v(version_id)が必要です。認可にはアセットの現在のパスを使います。公開変換は 4096px、品質 85 を上限とします。検証済みバージョンでは、イミュータブルキャッシュを利用できます。 | fields.input、fields.v | fields.bg(デフォルト:"#ffffff")、fields.cdn、fields.f(デフォルト:"jpg")、fields.h(デフォルト:300)、fields.q(デフォルト:75)、fields.r(デフォルト:"pad")、fields.w(デフォルト:400) |
builtin/public-serve
| 宣言済みの公開プレフィックス配下にある、保持された特定のストレージバージョンを配信します。fields.input(asset_id)と fields.v(version_id)が必要です。認可にはアセットの現在のパスを使い、検証済みバージョンではイミュータブルキャッシュを利用できます。アクセス権を削除しても、キャッシュ済みのバイト列は回収できません。 | fields.input、fields.v | fields.cdn |
builtin/remove-background
| アップロードした写真の背景を削除し、前景を透明な PNG として保持します。デフォルトでは Robot の自動プロバイダー選択を使います。ほかの形式や背景の選択には、プロバイダー transloadit が必要です。 | なし | fields.format(デフォルト:"png")、fields.provider(デフォルト:"auto")、fields.select(デフォルト:"foreground") |
builtin/storage-preview
| 保持された特定のストレージバージョンをプレビューします。fields.input(asset_id)と fields.v(version_id)が必要です。0.0.2 のプレビューコントロールと透明度を維持します。署名付き URL が必要で、ID だけではアクセス権は得られません。 | fields.input、fields.v | fields.bg(デフォルト:"#ffffff")、fields.cdn、fields.f(デフォルト:"jpg")、fields.h(デフォルト:300)、fields.q(デフォルト:75)、fields.r(デフォルト:"pad")、fields.w(デフォルト:400) |
builtin/storage-serve
| 保持されたストレージのバイト列をそのまま配信します。署名付きの input(asset_id)と v(version_id)が必要です。任意の download パラメーターには、添付ファイル用の Unicode ファイル名を指定します。省略するとインラインで配信します。トランスコードせずに HTTP Range に対応します。 | fields.input、fields.v | fields.cdn、fields.download(デフォルト:"") |
builtin/transcribe
| アップロードした音声または動画を、タイムスタンプ付き JSON、プレーンテキスト、SRT、または WebVTT に文字起こしします。プロバイダーは自動選択します。source_language は AWS/GCP 用の発話言語コードです。target_language は Replicate 用の任意の発話言語ヒントであり、翻訳の指定ではありません。vocabulary は Replicate または GCP にブランド名や専門用語の表記のヒントを渡します。AWS は空でない vocabulary を拒否します。CLI では transloadit assemblies create --template builtin/transcribe@0.0.2 --field vocabulary=Transloadit,Uppy -i audio.mp3 -o out/ を実行します。vocabulary フラグを繰り返すと、前の値を置き換えます。API では、カンマを含む用語も配列で渡せます。 | なし | fields.format(デフォルト:"json")、fields.provider(デフォルト:"auto")、fields.source_language(デフォルト:"en-US")、fields.target_language、fields.vocabulary(デフォルト:[]) |
builtin/video-covers
| 一定間隔または正確なオフセットで動画のカバー画像を抽出します。任意で、スマート AI スコアリングによって優れたフレームを選択できます。サムネイル Robot のデフォルト設定と制限を使います。正確なオフセットを使うには smart を JSON の真偽値 false に設定します。スマート選択では、代わりに count を使います。デフォルトの寸法は入力動画と同じです。AI スコアリングは、Assembly の警告を伴ってフォールバックする場合があります。 | なし | fields.count(デフォルト:8)、fields.format(デフォルト:"jpeg")、fields.height、fields.offsets(デフォルト:[])、fields.smart(デフォルト:false)、fields.smart_max_candidates(デフォルト:20)、fields.width |
処理設定とフィールドスキーマ
builtin/caption-video@0.0.3
{
"content": {
"allow_steps_override": false,
"fields": {
"border_color": "000000",
"font_color": "FFFFFF",
"highlight_color": "FFD60A",
"position": "bottom",
"provider": "auto",
"source_language": "en-US",
"speaker_colors": [],
"speaker_labels": false,
"style": "plain",
"vocabulary": []
},
"steps": {
":original": {
"robot": "/upload/handle"
},
"captioned": {
"border_color": "${String(fields.border_color)}",
"ffmpeg_stack": "v7",
"font_color": "${String(fields.font_color)}",
"font_size": "${fields.font_size ?? (fields.style === \"social\" ? undefined : 16)}",
"highlight_color": "${String(fields.highlight_color)}",
"position": "${fields.position}",
"preset": "empty",
"result": true,
"robot": "/video/subtitle",
"speaker_colors": "${(Array.isArray(fields.speaker_colors) ? fields.speaker_colors : fields.speaker_colors.trim() === \"\" ? [] : fields.speaker_colors.split(\",\")).length > 0 ? (Array.isArray(fields.speaker_colors) ? fields.speaker_colors : fields.speaker_colors.trim() === \"\" ? [] : fields.speaker_colors.split(\",\")) : undefined}",
"style": "${fields.style === \"social\" ? \"social\" : undefined}",
"subtitles_type": "burned",
"use": {
"group_by_original": true,
"steps": [
{
"as": "video",
"name": ":original"
},
{
"as": "subtitles",
"name": "transcription"
}
]
}
},
"transcript": {
"format": "srt",
"result": true,
"robot": "/document/convert",
"use": "transcription"
},
"transcription": {
"format": "${fields.style === \"social\" ? \"json\" : \"srt\"}",
"provider": "${fields.provider}",
"result": "${fields.style === \"social\"}",
"robot": "/speech/transcribe",
"source_language": "${fields.source_language}",
"speaker_labels": "${fields.speaker_labels === true || fields.speaker_labels === \"true\"}",
"target_language": "${fields.target_language || \"\"}",
"use": ":original",
"vocabulary": "${Array.isArray(fields.vocabulary) ? fields.vocabulary : fields.vocabulary.trim() === \"\" ? [] : fields.vocabulary.split(\",\")}"
}
}
},
"fields_schema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": true,
"properties": {
"border_color": {
"anyOf": [
{
"pattern": "^#?[0-9a-fA-F]{3}([0-9a-fA-F]{3})?$",
"type": "string"
},
{
"pattern": "^#?[0-9a-fA-F]{6}([0-9a-fA-F]{2})?$",
"type": "string"
}
],
"default": "000000"
},
"font_color": {
"anyOf": [
{
"pattern": "^#?[0-9a-fA-F]{3}([0-9a-fA-F]{3})?$",
"type": "string"
},
{
"pattern": "^#?[0-9a-fA-F]{6}([0-9a-fA-F]{2})?$",
"type": "string"
}
],
"default": "FFFFFF"
},
"font_size": {
"description": "\nSpecifies the size of the text in the 288-pixel subtitle coordinate space, scaled with the video height. The default is 16. With `\"style\": \"social\"`, the default is 54. For social JSON captions, an omitted value scales this default with the shorter side of the video, increases it by 18% for portrait video, and shrinks captions as needed to fit at most two lines. Poppins capital letters are about 7.5% of the shorter side before fitting, or about 9% for portrait video. An explicit value keeps height-relative sizing and disables automatic fitting.\n",
"minimum": 1,
"type": "integer"
},
"highlight_color": {
"anyOf": [
{
"pattern": "^#?[0-9a-fA-F]{3}([0-9a-fA-F]{3})?$",
"type": "string"
},
{
"pattern": "^#?[0-9a-fA-F]{6}([0-9a-fA-F]{2})?$",
"type": "string"
}
],
"default": "FFD60A"
},
"position": {
"default": "bottom",
"enum": [
"bottom",
"bottom-left",
"bottom-right",
"center",
"left",
"right",
"top",
"top-left",
"top-right"
],
"type": "string"
},
"provider": {
"default": "auto",
"enum": [
"auto",
"aws",
"gcp",
"replicate"
],
"type": "string"
},
"source_language": {
"default": "en-US",
"type": "string"
},
"speaker_colors": {
"anyOf": [
{
"items": {
"anyOf": [
{
"pattern": "^#?[0-9a-fA-F]{3}([0-9a-fA-F]{3})?$",
"type": "string"
},
{
"pattern": "^#?[0-9a-fA-F]{6}([0-9a-fA-F]{2})?$",
"type": "string"
}
]
},
"maxItems": 10,
"type": "array"
},
{
"type": "string"
}
],
"default": [],
"description": "Highlight colors per speaker for social captions with speaker_labels: the first color for speaker 1, and so on. Accepts an array or a comma-separated string for CLI --field speaker_colors=FFD60A,4CC9F0. Empty uses highlight_color for everyone.",
"x-transloadit-input-fidelity": "conservative"
},
"speaker_labels": {
"anyOf": [
{
"type": "boolean"
},
{
"enum": [
"true",
"false"
],
"type": "string"
}
],
"default": false,
"description": "Label who is speaking. Social captions then break at every speaker change, and plain captions name the speaker when the turn changes. Uses the aws provider, or gcp with vocabulary.",
"x-transloadit-input-fidelity": "conservative"
},
"style": {
"default": "plain",
"description": "Plain burns in SRT captions. Social uses timestamped JSON for uppercase Poppins captions with the active word highlighted, automatic fitting and lower-third positioning. Both return SRT cues and the captioned video; social also returns the JSON transcript. highlight_color applies only to social. An explicit font_size overrides automatic fitting; plain defaults to size 16.",
"enum": [
"plain",
"social"
],
"type": "string"
},
"target_language": {
"description": "\nSets the spoken language hint for the `\"replicate\"` provider. Omit this parameter to detect the spoken language automatically. Set it to the full lowercase English language name, such as `\"french\"`, when the spoken language is known. Despite its name, this parameter does not translate speech.\n\nFor the `\"aws\"` and `\"gcp\"` providers, use `source_language` instead.\n",
"type": "string"
},
"vocabulary": {
"anyOf": [
{
"items": {
"minLength": 1,
"type": "string"
},
"maxItems": 50,
"type": "array",
"x-transloadit-input-fidelity": "conservative"
},
{
"type": "string"
}
],
"default": [],
"description": "Spelling hints for brand names, jargon and proper nouns. Accepts an array, or a comma-separated string for CLI --field vocabulary=Transloadit,Uppy. Use a native array for terms containing commas. Repeated CLI flags with the same name replace earlier values. Empty means no hints. Up to 50 unique terms (ignoring case), each 1–100 characters after trimming, without control characters. Terms joined with comma-space must fit within 200 UTF-8 bytes. Supported by Replicate and GCP; AWS rejects nonempty vocabulary. Hints improve recognition without guaranteeing it; exact matches use the supplied casing.",
"x-transloadit-input-fidelity": "conservative"
}
},
"type": "object"
}
}builtin/capture-webpage@0.0.1
{
"content": {
"allow_steps_override": false,
"fields": {
"delay": 0,
"format": "png",
"fullpage": true,
"height": 768,
"url": null,
"wait_until": "networkidle",
"width": 1024
},
"steps": {
":original": {
"robot": "/upload/handle"
},
"captured": {
"delay": "${fields.delay}",
"format": "${fields.format}",
"fullpage": "${Boolean(fields.fullpage)}",
"height": "${fields.height}",
"result": true,
"robot": "/html/convert",
"url": "${fields.url ?? null}",
"use": ":original",
"wait_until": "${fields.wait_until}",
"width": "${fields.width}"
}
}
},
"fields_schema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": true,
"properties": {
"delay": {
"default": 0,
"minimum": 0,
"type": "integer"
},
"format": {
"default": "png",
"enum": [
"jpeg",
"jpg",
"pdf",
"png"
],
"type": "string"
},
"fullpage": {
"default": true,
"type": "boolean"
},
"height": {
"default": 768,
"minimum": 1,
"type": "integer"
},
"url": {
"anyOf": [
{
"pattern": "^[Hh][Tt][Tt][Pp][Ss]?:\\/\\/(?:[^ ]|[ ])",
"type": "string",
"x-transloadit-input-fidelity": "conservative"
},
{
"type": "null"
}
],
"default": null,
"description": "Public HTTP(S) URL to capture. Omit or use null to capture uploaded HTML."
},
"wait_until": {
"default": "networkidle",
"enum": [
"domcontentloaded",
"load",
"networkidle",
"commit"
],
"type": "string"
},
"width": {
"default": 1024,
"minimum": 1,
"type": "integer"
}
},
"type": "object",
"x-transloadit-input-fidelity": "conservative"
}
}builtin/convert-to-pdf@0.0.1
{
"content": {
"allow_steps_override": false,
"fields": {
"markdown_format": "gfm",
"markdown_theme": "github",
"pdf_format": "Letter",
"pdf_margin": "6.25mm,6.25mm,14.11mm,6.25mm",
"pdf_print_background": true
},
"steps": {
":original": {
"robot": "/upload/handle"
},
"pdf": {
"format": "pdf",
"markdown_format": "${fields.markdown_format}",
"markdown_theme": "${fields.markdown_theme}",
"pdf_format": "${fields.pdf_format}",
"pdf_margin": "${fields.pdf_margin}",
"pdf_print_background": "${Boolean(fields.pdf_print_background)}",
"result": true,
"robot": "/document/convert",
"use": ":original"
}
}
},
"fields_schema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": true,
"properties": {
"markdown_format": {
"default": "gfm",
"enum": [
"commonmark",
"gfm"
],
"type": "string"
},
"markdown_theme": {
"default": "github",
"enum": [
"bare",
"github"
],
"type": "string"
},
"pdf_format": {
"anyOf": [
{
"maxLength": 2,
"minLength": 2,
"pattern": "^[aA]0$",
"type": "string"
},
{
"maxLength": 2,
"minLength": 2,
"pattern": "^[aA]1$",
"type": "string"
},
{
"maxLength": 2,
"minLength": 2,
"pattern": "^[aA]2$",
"type": "string"
},
{
"maxLength": 2,
"minLength": 2,
"pattern": "^[aA]3$",
"type": "string"
},
{
"maxLength": 2,
"minLength": 2,
"pattern": "^[aA]4$",
"type": "string"
},
{
"maxLength": 2,
"minLength": 2,
"pattern": "^[aA]5$",
"type": "string"
},
{
"maxLength": 2,
"minLength": 2,
"pattern": "^[aA]6$",
"type": "string"
},
{
"maxLength": 6,
"minLength": 6,
"pattern": "^[lL][eE][dD][gG][eE][rR]$",
"type": "string"
},
{
"maxLength": 5,
"minLength": 5,
"pattern": "^[lL][eE][gG][aA][lL]$",
"type": "string"
},
{
"maxLength": 6,
"minLength": 6,
"pattern": "^[lL][eE][tT][tT][eE][rR]$",
"type": "string"
},
{
"maxLength": 7,
"minLength": 7,
"pattern": "^[tT][aA][bB][lL][oO][iI][dD]$",
"type": "string"
}
],
"default": "Letter"
},
"pdf_margin": {
"default": "6.25mm,6.25mm,14.11mm,6.25mm",
"type": "string"
},
"pdf_print_background": {
"default": true,
"type": "boolean"
}
},
"type": "object"
}
}builtin/encode-hls-video@0.0.1
{
"content": {
"steps": {
":original": {
"robot": "/upload/handle"
},
"adaptive": {
"playlist_name": "my_playlist.m3u8",
"robot": "/video/adaptive",
"technique": "hls",
"use": {
"bundle_steps": true,
"steps": [
"low",
"mid",
"high"
]
}
},
"high": {
"ffmpeg_stack": "v7.0.0",
"preset": "hls-540p",
"result": true,
"robot": "/video/encode",
"turbo": true,
"use": ":original"
},
"low": {
"ffmpeg_stack": "v7.0.0",
"preset": "hls-270p",
"result": true,
"robot": "/video/encode",
"turbo": true,
"use": ":original"
},
"mid": {
"ffmpeg_stack": "v7.0.0",
"preset": "hls-360p",
"result": true,
"robot": "/video/encode",
"turbo": true,
"use": ":original"
}
}
},
"fields_schema": null
}builtin/encode-video@0.0.1
{
"content": {
"allow_steps_override": false,
"fields": {
"preset": "web/mp4/720p",
"turbo": true
},
"steps": {
":original": {
"robot": "/upload/handle"
},
"encoded": {
"result": true,
"robot": "/file/filter",
"use": [
"preset_encoded",
"sized_encoded"
]
},
"preset_encoded": {
"ffmpeg_stack": "v7",
"preset": "${fields.preset}",
"robot": "/video/encode",
"turbo": "${Boolean(fields.turbo)}",
"use": "preset_inputs"
},
"preset_inputs": {
"declines": [
[
"${fields.width}",
"!empty",
""
],
[
"${fields.height}",
"!empty",
""
]
],
"error_on_decline": false,
"robot": "/file/filter",
"use": ":original"
},
"sized_encoded": {
"ffmpeg_stack": "v7",
"height": "${fields.height || null}",
"preset": "${fields.preset}",
"robot": "/video/encode",
"turbo": "${Boolean(fields.turbo)}",
"use": "sized_inputs",
"width": "${fields.width || null}"
},
"sized_inputs": {
"accepts": [
[
"${fields.width}",
"!empty",
""
],
[
"${fields.height}",
"!empty",
""
]
],
"error_on_decline": false,
"robot": "/file/filter",
"use": ":original"
}
}
},
"fields_schema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": true,
"properties": {
"height": {
"anyOf": [
{
"minimum": 1,
"type": "integer"
},
{
"type": "null"
}
],
"description": "\nHeight of the new video, in pixels.\n\nIf the value is not specified and the `preset` parameter is available, the `preset`'s [supplied height](/docs/presets/video/) will be implemented.\n"
},
"preset": {
"default": "web/mp4/720p",
"enum": [
"ipad",
"web/mp4/1080p",
"web/mp4/240p",
"web/mp4/360p",
"web/mp4/480p",
"web/mp4/4k",
"web/mp4/540p",
"web/mp4/720p",
"web/mp4/8k",
"web/webm/1080p",
"web/webm/240p",
"web/webm/360p",
"web/webm/480p",
"web/webm/4k",
"web/webm/720p",
"web/webm/8k",
"webm"
],
"type": "string"
},
"turbo": {
"default": true,
"type": "boolean"
},
"width": {
"anyOf": [
{
"minimum": 1,
"type": "integer"
},
{
"type": "null"
}
],
"description": "\nWidth of the new video, in pixels.\n\nIf the value is not specified and the `preset` parameter is available, the `preset`'s [supplied width](/docs/presets/video/) will be implemented.\n"
}
},
"type": "object"
}
}builtin/extract-text@0.0.2
{
"content": {
"allow_steps_override": false,
"fields": {
"ocr_provider": "aws",
"text_format": "txt",
"text_granularity": "document",
"text_method": "auto"
},
"steps": {
":original": {
"robot": "/upload/handle"
},
"converted_pdf": {
"format": "pdf",
"robot": "/document/convert",
"use": "office"
},
"document_text": {
"extract": [
"text"
],
"ocr_provider": "${fields.ocr_provider}",
"result": true,
"robot": "/document/extract",
"text_format": "${fields.text_format}",
"text_method": "${fields.text_method}",
"use": "ocr_documents"
},
"image_document_text": {
"extract": [
"text"
],
"ocr_provider": "${fields.ocr_provider}",
"result": true,
"robot": "/document/extract",
"text_format": "${fields.text_format}",
"text_method": "ocr",
"use": "image_pdf"
},
"image_pdf": {
"format": "pdf",
"robot": "/document/convert",
"use": "rich_images"
},
"image_text": {
"format": "${fields.text_format === \"txt\" ? \"text\" : \"json\"}",
"granularity": "full",
"provider": "${fields.ocr_provider}",
"result": true,
"robot": "/image/ocr",
"use": "plain_images"
},
"images": {
"accepts": [
[
"${file.type}",
"===",
"image"
]
],
"error_on_decline": false,
"robot": "/file/filter",
"use": ":original"
},
"native_documents": {
"accepts": [
[
"${fields.text_method}",
"===",
"native"
]
],
"error_on_decline": false,
"robot": "/file/filter",
"use": [
"pdfs",
"converted_pdf"
]
},
"native_text": {
"extract": [
"text"
],
"page_range": "${fields.page_range || \"\"}",
"password": "${fields.password || \"\"}",
"result": true,
"robot": "/document/extract",
"text_format": "${fields.text_format}",
"text_granularity": "${fields.text_granularity}",
"text_method": "native",
"use": "native_documents"
},
"ocr_documents": {
"declines": [
[
"${fields.text_method}",
"===",
"native"
]
],
"error_on_decline": false,
"robot": "/file/filter",
"use": [
"pdfs",
"converted_pdf"
]
},
"office": {
"accepts": [
[
[
"text/markdown",
"application/msword",
"application/vnd.openxmlformats",
"application/officedocument.wordprocessingml.document",
"application/vnd.openxmlformats-officedocument.wordprocessingml.document",
"text/html",
"application/xhtml+xml",
"text/xml",
"image/jpg",
"image/jpeg",
"image/gif",
"image/png",
"image/svg",
"image/svg+xml",
"application/postscript",
"application/postscript",
"application/postscript",
"text/plain",
"text/plain",
"text/comma-separated-values",
"text/csv",
"application/excel",
"application/vnd.ms-excel",
"application/excel",
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet",
"application/excel",
"application/oda",
"application/odt",
"application/vnd.oasis.opendocument.text",
"application/vnd.oasis.opendocument.graphics",
"application/odd",
"application/ott",
"application/mspowerpoint",
"application/vnd.ms-powerpoint",
"application/vnd.openxmlformats-officedocument.presentationml.presentation",
"application/mspowerpoint",
"application/mspowerpoint",
"application/mspowerpoint",
"application/rtf",
"text/rtf",
"text/richtext",
"application/x-latex"
],
"includes",
"${file.mime}"
]
],
"declines": [
[
"${file.type}",
"===",
"image"
],
[
"${file.mime}",
"===",
"application/pdf"
]
],
"error_on_decline": false,
"robot": "/file/filter",
"use": ":original"
},
"pdfs": {
"accepts": [
[
"${file.mime}",
"===",
"application/pdf"
]
],
"error_on_decline": false,
"robot": "/file/filter",
"use": ":original"
},
"plain_images": {
"declines": [
[
"${fields.text_format}",
"===",
"md"
],
[
"${fields.text_format}",
"===",
"html"
]
],
"error_on_decline": false,
"robot": "/file/filter",
"use": "images"
},
"rich_images": {
"accepts": [
[
"${fields.text_format}",
"===",
"md"
],
[
"${fields.text_format}",
"===",
"html"
]
],
"error_on_decline": false,
"robot": "/file/filter",
"use": "images"
}
}
},
"fields_schema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": true,
"properties": {
"ocr_provider": {
"default": "aws",
"enum": [
"aws",
"gcp"
],
"type": "string"
},
"page_range": {
"description": "\nOptional comma-separated page selection, such as `\"1\"`, `\"1-3\"`, or `\"1,3-5\"`. Page numbers start at 1. Ranges are clamped to the detected page count.\n\nAt most 1,000 selected pages are allowed per job.\n\nThis is supported for native text extraction and embedded image extraction. OCR extraction currently works on the full document.\n",
"pattern": "^[\\x09-\\x0D\\x20\\xA0
]*[0-9]+(?:[\\x09-\\x0D\\x20\\xA0
]*-[\\x09-\\x0D\\x20\\xA0
]*[0-9]+)?(?:[\\x09-\\x0D\\x20\\xA0
]*,[\\x09-\\x0D\\x20\\xA0
]*[0-9]+(?:[\\x09-\\x0D\\x20\\xA0
]*-[\\x09-\\x0D\\x20\\xA0
]*[0-9]+)?)*[\\x09-\\x0D\\x20\\xA0
]*$",
"type": "string"
},
"password": {
"description": "\nPassword used to unlock encrypted PDFs for native text extraction and embedded image extraction. OCR extraction currently does not support encrypted PDFs, so do not combine this with `text_method: \"ocr\"` or `text_method: \"auto\"`.\n",
"type": "string"
},
"text_format": {
"default": "txt",
"description": "Output format: plain text (default), JSON, Markdown or HTML. Images are not returned.",
"enum": [
"txt",
"json",
"md",
"html"
],
"type": "string"
},
"text_granularity": {
"default": "document",
"enum": [
"document",
"page"
],
"type": "string"
},
"text_method": {
"default": "auto",
"enum": [
"native",
"ocr",
"auto"
],
"type": "string"
}
},
"type": "object",
"x-transloadit-input-fidelity": "conservative"
}
}builtin/generate-image@0.0.1
{
"content": {
"steps": {
"generate": {
"model": "google/nano-banana-pro",
"prompt": "${fields.prompt}",
"result": true,
"robot": "/image/generate"
}
}
},
"fields_schema": null
}builtin/generate-video@0.0.1
{
"content": {
"steps": {
"generate": {
"format": "mp4",
"model": "minimax/video-01",
"prompt": "${fields.prompt}",
"result": true,
"robot": "/video/generate"
}
}
},
"fields_schema": null
}builtin/prepare-image@0.0.1
{
"content": {
"allow_steps_override": false,
"fields": {
"bg": "#00000000",
"f": "webp",
"h": 1600,
"q": 75,
"r": "fit",
"strip": true,
"w": 1600
},
"steps": {
":original": {
"robot": "/upload/handle"
},
"prepared": {
"background": "${fields.bg}",
"format": "${fields.f}",
"height": "${fields.h}",
"imagemagick_stack": "v3.0.2",
"quality": "${fields.q}",
"resize_strategy": "${fields.r}",
"result": true,
"robot": "/image/resize",
"rotation": "auto",
"strip": "${Boolean(fields.strip)}",
"use": ":original",
"width": "${fields.w}",
"zoom": false
}
}
},
"fields_schema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": true,
"properties": {
"bg": {
"default": "#00000000",
"pattern": "^#(?:[0-9a-fA-F]{6}|[0-9a-fA-F]{8})$",
"type": "string"
},
"f": {
"default": "webp",
"enum": [
"avif",
"gif",
"jpeg",
"jpg",
"png",
"webp"
],
"type": "string"
},
"h": {
"anyOf": [
{
"maximum": 8000,
"minimum": 1,
"type": "integer"
},
{
"pattern": "^[1-9][0-9]*$",
"type": "string",
"x-transloadit-input-fidelity": "conservative"
}
],
"default": 1600
},
"q": {
"anyOf": [
{
"maximum": 100,
"minimum": 1,
"type": "integer"
},
{
"pattern": "^(?:[1-9]|[1-9][0-9]|100)$",
"type": "string"
}
],
"default": 75
},
"r": {
"default": "fit",
"enum": [
"fillcrop",
"fit",
"min_fit",
"pad",
"stretch"
],
"type": "string"
},
"strip": {
"default": true,
"description": "Strip metadata. To disable, pass the JSON boolean false in params.fields.strip.",
"type": "boolean"
},
"w": {
"anyOf": [
{
"maximum": 8000,
"minimum": 1,
"type": "integer"
},
{
"pattern": "^[1-9][0-9]*$",
"type": "string",
"x-transloadit-input-fidelity": "conservative"
}
],
"default": 1600
}
},
"type": "object",
"x-transloadit-input-fidelity": "conservative"
}
}builtin/public-preview@0.0.3
{
"content": {
"allow_steps_override": false,
"fields": {
"bg": "#ffffff",
"f": "jpg",
"h": 300,
"q": 75,
"r": "pad",
"w": 400
},
"steps": {
"imported": {
"asset_id": "${fields.input}",
"robot": "/transloadit/import",
"version_id": "${fields.v}"
},
"previewed": {
"background": "${fields.bg}",
"format": "${fields.f}",
"height": "${fields.h}",
"optimize": false,
"quality": "${fields.q}",
"resize_strategy": "${fields.r}",
"robot": "/file/preview",
"use": "imported",
"waveform_center_color": "0099ccff",
"waveform_height": "${fields.h}",
"waveform_outer_color": "0099ccff",
"waveform_width": "${fields.w}",
"width": "${fields.w}"
},
"served": {
"robot": "/file/serve",
"use": "previewed"
}
}
},
"fields_schema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"bg": {
"pattern": "^#(?:[0-9a-fA-F]{6}|[0-9a-fA-F]{8})$",
"type": "string"
},
"cdn": {
"const": "required",
"type": "string"
},
"f": {
"enum": [
"avif",
"gif",
"jpeg",
"jpg",
"png",
"webp"
],
"type": "string"
},
"h": {
"anyOf": [
{
"allOf": [
{
"maximum": 8000,
"minimum": 1,
"type": "integer"
},
{
"maximum": 4096,
"type": "number"
}
]
},
{
"pattern": "^[1-9][0-9]*$",
"type": "string",
"x-transloadit-input-fidelity": "conservative"
}
],
"x-transloadit-input-fidelity": "conservative"
},
"input": {
"description": "Case-sensitive, canonical 22-character Base64URL DAM identifier.",
"pattern": "^[A-Za-z0-9_-]{21}[AQgw]$",
"type": "string",
"x-transloadit-description-id": "damId"
},
"q": {
"anyOf": [
{
"allOf": [
{
"maximum": 100,
"minimum": 1,
"type": "integer"
},
{
"maximum": 85,
"type": "number"
}
]
},
{
"pattern": "^(?:[1-9]|[1-9][0-9]|100)$",
"type": "string"
}
],
"x-transloadit-input-fidelity": "conservative"
},
"r": {
"enum": [
"fillcrop",
"fit",
"pad",
"stretch"
],
"type": "string"
},
"v": {
"description": "Case-sensitive, canonical 22-character Base64URL DAM identifier.",
"pattern": "^[A-Za-z0-9_-]{21}[AQgw]$",
"type": "string",
"x-transloadit-description-id": "damId"
},
"w": {
"anyOf": [
{
"allOf": [
{
"maximum": 8000,
"minimum": 1,
"type": "integer"
},
{
"maximum": 4096,
"type": "number"
}
]
},
{
"pattern": "^[1-9][0-9]*$",
"type": "string",
"x-transloadit-input-fidelity": "conservative"
}
],
"x-transloadit-input-fidelity": "conservative"
}
},
"required": [
"bg",
"f",
"h",
"input",
"q",
"r",
"w",
"v"
],
"type": "object"
}
}builtin/public-serve@0.0.2
{
"content": {
"allow_steps_override": false,
"steps": {
"imported": {
"asset_id": "${fields.input}",
"robot": "/transloadit/import",
"version_id": "${fields.v}"
},
"served": {
"robot": "/file/serve",
"use": "imported"
}
}
},
"fields_schema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"cdn": {
"const": "required",
"type": "string"
},
"input": {
"description": "Case-sensitive, canonical 22-character Base64URL DAM identifier.",
"pattern": "^[A-Za-z0-9_-]{21}[AQgw]$",
"type": "string",
"x-transloadit-description-id": "damId"
},
"v": {
"description": "Case-sensitive, canonical 22-character Base64URL DAM identifier.",
"pattern": "^[A-Za-z0-9_-]{21}[AQgw]$",
"type": "string",
"x-transloadit-description-id": "damId"
}
},
"required": [
"input",
"v"
],
"type": "object"
}
}builtin/remove-background@0.0.1
{
"content": {
"allow_steps_override": false,
"fields": {
"format": "png",
"provider": "auto",
"select": "foreground"
},
"steps": {
":original": {
"robot": "/upload/handle"
},
"foreground": {
"format": "${fields.format}",
"provider": "${fields.provider}",
"result": true,
"robot": "/image/bgremove",
"select": "${fields.select}",
"use": ":original"
}
}
},
"fields_schema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": true,
"properties": {
"format": {
"default": "png",
"enum": [
"png",
"gif",
"webp"
],
"type": "string"
},
"provider": {
"default": "auto",
"enum": [
"auto",
"transloadit",
"replicate",
"fal"
],
"type": "string"
},
"select": {
"default": "foreground",
"enum": [
"foreground",
"background"
],
"type": "string"
}
},
"type": "object",
"x-transloadit-input-fidelity": "conservative"
}
}builtin/storage-preview@0.0.3
{
"content": {
"allow_steps_override": false,
"fields": {
"bg": "#ffffff",
"f": "jpg",
"h": 300,
"q": 75,
"r": "pad",
"w": 400
},
"steps": {
"imported": {
"asset_id": "${fields.input}",
"robot": "/transloadit/import",
"version_id": "${fields.v}"
},
"optimized": {
"background": "${fields.bg}",
"format": "${fields.f}",
"imagemagick_stack": "v3.0.2",
"quality": "${fields.q}",
"robot": "/image/resize",
"strip": true,
"use": "previewed"
},
"previewed": {
"background": "${fields.bg}",
"format": "png",
"height": "${fields.h}",
"optimize": false,
"resize_strategy": "${fields.r}",
"robot": "/file/preview",
"use": "imported",
"waveform_center_color": "0099ccff",
"waveform_height": "${fields.h}",
"waveform_outer_color": "0099ccff",
"waveform_width": "${fields.w}",
"width": "${fields.w}"
},
"served": {
"robot": "/file/serve",
"use": "optimized"
}
}
},
"fields_schema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"bg": {
"pattern": "^#(?:[0-9a-fA-F]{6}|[0-9a-fA-F]{8})$",
"type": "string"
},
"cdn": {
"const": "required",
"type": "string"
},
"f": {
"enum": [
"avif",
"gif",
"jpeg",
"jpg",
"png",
"webp"
],
"type": "string"
},
"h": {
"anyOf": [
{
"maximum": 8000,
"minimum": 1,
"type": "integer"
},
{
"pattern": "^[1-9][0-9]*$",
"type": "string",
"x-transloadit-input-fidelity": "conservative"
}
]
},
"input": {
"description": "Case-sensitive, canonical 22-character Base64URL DAM identifier.",
"pattern": "^[A-Za-z0-9_-]{21}[AQgw]$",
"type": "string",
"x-transloadit-description-id": "damId"
},
"q": {
"anyOf": [
{
"maximum": 100,
"minimum": 1,
"type": "integer"
},
{
"pattern": "^(?:[1-9]|[1-9][0-9]|100)$",
"type": "string"
}
]
},
"r": {
"enum": [
"fillcrop",
"fit",
"min_fit",
"pad",
"stretch"
],
"type": "string"
},
"v": {
"description": "Case-sensitive, canonical 22-character Base64URL DAM identifier.",
"pattern": "^[A-Za-z0-9_-]{21}[AQgw]$",
"type": "string",
"x-transloadit-description-id": "damId"
},
"w": {
"anyOf": [
{
"maximum": 8000,
"minimum": 1,
"type": "integer"
},
{
"pattern": "^[1-9][0-9]*$",
"type": "string",
"x-transloadit-input-fidelity": "conservative"
}
]
}
},
"required": [
"bg",
"f",
"h",
"input",
"q",
"r",
"w",
"v"
],
"type": "object"
}
}builtin/storage-serve@0.0.3
{
"content": {
"allow_steps_override": false,
"fields": {
"download": ""
},
"steps": {
"imported": {
"asset_id": "${fields.input}",
"robot": "/transloadit/import",
"version_id": "${fields.v}"
},
"served": {
"download_name": "${fields.download}",
"robot": "/file/serve",
"use": "imported"
}
}
},
"fields_schema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"cdn": {
"const": "required",
"type": "string"
},
"download": {
"pattern": "^[^/\\\\\u0000-\u001f-]{0,255}$",
"type": "string"
},
"input": {
"description": "Case-sensitive, canonical 22-character Base64URL DAM identifier.",
"pattern": "^[A-Za-z0-9_-]{21}[AQgw]$",
"type": "string",
"x-transloadit-description-id": "damId"
},
"v": {
"description": "Case-sensitive, canonical 22-character Base64URL DAM identifier.",
"pattern": "^[A-Za-z0-9_-]{21}[AQgw]$",
"type": "string",
"x-transloadit-description-id": "damId"
}
},
"required": [
"download",
"input",
"v"
],
"type": "object"
}
}builtin/transcribe@0.0.2
{
"content": {
"allow_steps_override": false,
"fields": {
"format": "json",
"provider": "auto",
"source_language": "en-US",
"vocabulary": []
},
"steps": {
":original": {
"robot": "/upload/handle"
},
"transcript": {
"format": "${fields.format}",
"provider": "${fields.provider}",
"result": true,
"robot": "/speech/transcribe",
"source_language": "${fields.source_language}",
"target_language": "${fields.target_language || \"\"}",
"use": ":original",
"vocabulary": "${Array.isArray(fields.vocabulary) ? fields.vocabulary : fields.vocabulary.trim() === \"\" ? [] : fields.vocabulary.split(\",\")}"
}
}
},
"fields_schema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": true,
"properties": {
"format": {
"default": "json",
"enum": [
"json",
"srt",
"text",
"webvtt"
],
"type": "string"
},
"provider": {
"default": "auto",
"enum": [
"auto",
"aws",
"gcp",
"replicate"
],
"type": "string"
},
"source_language": {
"default": "en-US",
"type": "string"
},
"target_language": {
"description": "\nSets the spoken language hint for the `\"replicate\"` provider. Omit this parameter to detect the spoken language automatically. Set it to the full lowercase English language name, such as `\"french\"`, when the spoken language is known. Despite its name, this parameter does not translate speech.\n\nFor the `\"aws\"` and `\"gcp\"` providers, use `source_language` instead.\n",
"type": "string"
},
"vocabulary": {
"anyOf": [
{
"items": {
"minLength": 1,
"type": "string"
},
"maxItems": 50,
"type": "array",
"x-transloadit-input-fidelity": "conservative"
},
{
"type": "string"
}
],
"default": [],
"description": "Spelling hints for brand names, jargon and proper nouns. Accepts an array, or a comma-separated string for CLI --field vocabulary=Transloadit,Uppy. Use a native array for terms containing commas. Repeated CLI flags with the same name replace earlier values. Empty means no hints. Up to 50 unique terms (ignoring case), each 1–100 characters after trimming, without control characters. Terms joined with comma-space must fit within 200 UTF-8 bytes. Supported by Replicate and GCP; AWS rejects nonempty vocabulary. Hints improve recognition without guaranteeing it; exact matches use the supplied casing.",
"x-transloadit-input-fidelity": "conservative"
}
},
"type": "object"
}
}builtin/video-covers@0.0.1
{
"content": {
"allow_steps_override": false,
"fields": {
"count": 8,
"format": "jpeg",
"offsets": [],
"smart": false,
"smart_max_candidates": 20
},
"steps": {
":original": {
"robot": "/upload/handle"
},
"covers": {
"count": "${fields.count}",
"format": "${fields.format}",
"height": "${fields.height || null}",
"offsets": "${fields.offsets?.length ? fields.offsets : null}",
"result": true,
"robot": "/video/thumbs",
"smart": "${Boolean(fields.smart)}",
"smart_max_candidates": "${fields.smart_max_candidates}",
"use": ":original",
"width": "${fields.width || null}"
}
}
},
"fields_schema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": true,
"properties": {
"count": {
"default": 8,
"maximum": 999,
"minimum": 1,
"type": "integer"
},
"format": {
"default": "jpeg",
"enum": [
"jpeg",
"jpg",
"png"
],
"type": "string"
},
"height": {
"anyOf": [
{
"maximum": 1920,
"minimum": 1,
"type": "integer"
},
{
"type": "null"
}
],
"description": "\nThe thumbnail height in pixels, capped like `width`. Omit or use `null` for the original height.\n"
},
"offsets": {
"anyOf": [
{
"anyOf": [
{
"anyOf": [
{
"items": {
"type": "number"
},
"minItems": 1,
"type": "array"
},
{
"items": {
"pattern": "^[0-9]+%$",
"type": "string"
},
"minItems": 1,
"type": "array"
}
]
},
{
"type": "null"
}
]
},
{
"maxItems": 0,
"minItems": 0,
"type": "array"
}
],
"default": []
},
"smart": {
"default": false,
"type": "boolean"
},
"smart_max_candidates": {
"default": 20,
"maximum": 100,
"minimum": 2,
"type": "integer"
},
"width": {
"anyOf": [
{
"maximum": 1920,
"minimum": 1,
"type": "integer"
},
{
"type": "null"
}
],
"description": "\nThe width of the thumbnail, in pixels. Omit or use `null` for the original width of the video.\n"
}
},
"type": "object"
}
}