, another. 🤖/tlcdn/deliver is not a part of your Assembly Instructions, but it may appear on your invoices as bandwidth charges incur when distributing the cached copies. 🤖/file/serve only charges when the CDN does not have a cached copy and requests to regenerate the original content, which depending on your caching settings could be just once a month, or year, per file/transformation.\n\nWhile theoretically possible, you could use [🤖/file/serve](/docs/robots/file-serve/) directly in HTML files, but we strongly recommend against this, because if your site gets popular and the media URL that /file/serve is handling gets hit one million times, that is one million new image resizes. Wrapping it with a CDN (and thanks to the caching that comes with it) makes sure encoding charges stay low, as well as latencies.\n\nAlso consider configuring caching headers and cache-control directives to control how content is cached and invalidated on the CDN edge servers, balancing between freshness and efficiency.\n\n## Smart CDN security with signed URLs\n\nYou can leverage [signed Smart CDN URLs](/docs/api/authentication/#smart-cdn) to avoid abuse of our encoding platform. Below is a quick Node.js example using our Node SDK, but there are [examples for other languages and SDKs](/docs/api/authentication/#example-code) as well.\n\n```javascript\n// yarn add @transloadit/node\n// or\n// npm install --save @transloadit/node\n\nimport { Transloadit } from '@transloadit/node'\n\nconst transloadit = new Transloadit({\n authKey: 'YOUR_TRANSLOADIT_KEY',\n authSecret: 'YOUR_TRANSLOADIT_SECRET',\n})\n\nconst url = transloadit.getSignedSmartCDNUrl({\n workspace: 'YOUR_WORKSPACE',\n template: 'YOUR_TEMPLATE',\n input: 'image.png',\n urlParams: { height: 100, width: 100 },\n})\n\nconsole.log(url)\n```\n\nThis will generate a signed Smart CDN URL that includes authentication parameters, preventing unauthorized access to your transformation endpoints.\n\nFor new integrations, use the modern `sig` + `exp` format. Legacy `s` signatures are deprecated. Also note that the expiration window is the practical cache window for signed results: shorter expirations tighten access control, while longer expirations improve cache reuse and lower encoding volume.\n\n## More information\n\n- [Content Delivery](/services/content-delivery/)\n- [🤖/file/serve](/docs/robots/file-serve/) pricing\n- [🤖/tlcdn/deliver](/docs/robots/tlcdn-deliver/) pricing\n- [File Preview Feature](/blog/2024/06/file-preview-with-smart-cdn/) blog post\n","type":"string"},"use":{"$ref":"#/components/schemas/Schema_47b2fd205d779e1de6bc4fd78c788d8393756436c48ec6f785f30dc6e16238aa"},"user_meta":{"$ref":"#/components/schemas/Schema_070d50917dd042191e4290744649be38025190ee43499886e5481a7d5627241d"}},"required":["robot"],"type":"object"},{"additionalProperties":false,"properties":{"error_msg":{"$ref":"#/components/schemas/Schema_bf2046fbe6985102c38f69c30542d74796e31ca5b37925448ed8a9ac879d4c26"},"error_on_decline":{"$ref":"#/components/schemas/Schema_6e004c1fd5129d97457a92f4f20e65d0eebb689e98b3ca78a325ca39894070d4"},"force_accept":{"$ref":"#/components/schemas/Schema_a7b463c184f2431703a1692b1402307bb6bb726278c59f7075fd0b8d6eb2be3c"},"ignore_errors":{"$ref":"#/components/schemas/Schema_866196eee82a663b71c0a383fdfb2f39a777749440b227619ea17fc8101eb5f4"},"interpolate":{"$ref":"#/components/schemas/Schema_210bc4cac49d5a8403766e579b22242786bad39b0b9ff4753e56b678e29f38d4"},"output_meta":{"$ref":"#/components/schemas/Schema_60f6dcc23a68fee86135afddfdf2d63c170b886a6deb46563e7193f688ef4e6e"},"queue":{"$ref":"#/components/schemas/Schema_d0a30e0594348bac539404e659baaa1896ab178c82448e3cb657bb8df8a525c4"},"repair_pdf":{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"anyOf":[{"type":"boolean"},{"enum":["false","true"],"type":"string"}]}],"default":false,"description":"\nAttempt to repair invalid PDFs with `mutool clean`. This is best-effort and only applies when `verify_to_be` is `\"pdf\"`.\n"},"result":{"$ref":"#/components/schemas/Schema_e2eec9f0d3cf6892bbba08d6f0cb6582dc8dc7e3d2f71da8cbd997ad577ec0be"},"robot":{"const":"/file/verify","description":"Identifier of the [robot](https://transloadit.com/docs/robots/) to execute","type":"string"},"use":{"$ref":"#/components/schemas/Schema_47b2fd205d779e1de6bc4fd78c788d8393756436c48ec6f785f30dc6e16238aa"},"user_meta":{"$ref":"#/components/schemas/Schema_070d50917dd042191e4290744649be38025190ee43499886e5481a7d5627241d"},"verify_to_be":{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"type":"string"}],"default":"pdf","description":"\nThe type that you want to match against to ensure your file is of this type. For example, `image` will verify whether uploaded files are images. This also works against file media types, in this case `image/png` would also work to match against specifically `png` files.\n"}},"required":["robot"],"type":"object"},{"additionalProperties":false,"properties":{"error_msg":{"$ref":"#/components/schemas/Schema_bf2046fbe6985102c38f69c30542d74796e31ca5b37925448ed8a9ac879d4c26"},"error_on_decline":{"$ref":"#/components/schemas/Schema_6e004c1fd5129d97457a92f4f20e65d0eebb689e98b3ca78a325ca39894070d4"},"force_accept":{"$ref":"#/components/schemas/Schema_a7b463c184f2431703a1692b1402307bb6bb726278c59f7075fd0b8d6eb2be3c"},"ignore_errors":{"$ref":"#/components/schemas/Schema_866196eee82a663b71c0a383fdfb2f39a777749440b227619ea17fc8101eb5f4"},"interpolate":{"$ref":"#/components/schemas/Schema_210bc4cac49d5a8403766e579b22242786bad39b0b9ff4753e56b678e29f38d4"},"output_meta":{"$ref":"#/components/schemas/Schema_60f6dcc23a68fee86135afddfdf2d63c170b886a6deb46563e7193f688ef4e6e"},"queue":{"$ref":"#/components/schemas/Schema_d0a30e0594348bac539404e659baaa1896ab178c82448e3cb657bb8df8a525c4"},"result":{"$ref":"#/components/schemas/Schema_e2eec9f0d3cf6892bbba08d6f0cb6582dc8dc7e3d2f71da8cbd997ad577ec0be"},"robot":{"const":"/file/virusscan","description":"\nThis Robot is built on top of [ClamAV](https://www.clamav.net/), the best open source antivirus engine available. We update its signatures on a daily basis.\n\nBy default, this Robot excludes all malicious files from further processing without any additional notification. This behavior can be changed by setting `error_on_decline` to `true`, which will stop Assemblies as soon as malicious files are found. Such Assemblies will then be marked with an error.\n\nWe allow the use of industry standard [EICAR files](https://www.eicar.org/download-anti-malware-testfile/) for integration testing without needing to use potentially dangerous live virus samples.\n","type":"string"},"use":{"$ref":"#/components/schemas/Schema_47b2fd205d779e1de6bc4fd78c788d8393756436c48ec6f785f30dc6e16238aa"},"user_meta":{"$ref":"#/components/schemas/Schema_070d50917dd042191e4290744649be38025190ee43499886e5481a7d5627241d"}},"required":["robot"],"type":"object"},{"additionalProperties":false,"properties":{"credentials":{"$ref":"#/components/schemas/Schema_2ef8a6ef0566a139b8bf3bc13f536067802a8067f5e00428aa0b8d66372e2b61"},"force_accept":{"$ref":"#/components/schemas/Schema_a7b463c184f2431703a1692b1402307bb6bb726278c59f7075fd0b8d6eb2be3c"},"force_name":{"$ref":"#/components/schemas/Schema_e2d753e6b6111506a4565bdb18eccafd67d2027839616974639f5565d695fafd"},"host":{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"type":"string"}]},"ignore_errors":{"$ref":"#/components/schemas/Schema_03e4961eba9e9b422ce714f9224b8d47a380c80d27b8342a78ba4e2702feb4db"},"import_on_errors":{"$ref":"#/components/schemas/Schema_61808f40a326596fd9674ebbd91184b0a2e04f8c67eb49fdf9f9449580271ab8"},"interpolate":{"$ref":"#/components/schemas/Schema_210bc4cac49d5a8403766e579b22242786bad39b0b9ff4753e56b678e29f38d4"},"output_meta":{"$ref":"#/components/schemas/Schema_60f6dcc23a68fee86135afddfdf2d63c170b886a6deb46563e7193f688ef4e6e"},"passive_mode":{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"anyOf":[{"type":"boolean"},{"enum":["false","true"],"type":"string"}]}],"default":true,"description":"\nDetermines if passive mode should be used for the FTP connection.\n"},"password":{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"type":"string"}]},"path":{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"type":"string"}]},{"$ref":"#/components/schemas/Schema_bc9fbfc32e2939087e1b877c2b51ce63f08c8cdfdcf7adca01505a0498ab5691"}],"description":"\nThe path on your FTP server where to search for files. Files are imported recursively from all sub-directories and sub-sub-directories (and so on) from this path.\n"},"port":{"$ref":"#/components/schemas/Schema_54b7efa14685483f18a4ce6218bf13b9d3acda9c88f6de43b469c7cae2b8ee42"},"queue":{"$ref":"#/components/schemas/Schema_d0a30e0594348bac539404e659baaa1896ab178c82448e3cb657bb8df8a525c4"},"result":{"$ref":"#/components/schemas/Schema_e2eec9f0d3cf6892bbba08d6f0cb6582dc8dc7e3d2f71da8cbd997ad577ec0be"},"robot":{"const":"/ftp/import","description":"Identifier of the [robot](https://transloadit.com/docs/robots/) to execute","type":"string"},"user":{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"type":"string"}]},"user_meta":{"$ref":"#/components/schemas/Schema_070d50917dd042191e4290744649be38025190ee43499886e5481a7d5627241d"}},"required":["path","robot"],"type":"object"},{"additionalProperties":false,"properties":{"credentials":{"$ref":"#/components/schemas/Schema_2ef8a6ef0566a139b8bf3bc13f536067802a8067f5e00428aa0b8d66372e2b61"},"force_accept":{"$ref":"#/components/schemas/Schema_a7b463c184f2431703a1692b1402307bb6bb726278c59f7075fd0b8d6eb2be3c"},"host":{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"type":"string"}]},"ignore_errors":{"$ref":"#/components/schemas/Schema_866196eee82a663b71c0a383fdfb2f39a777749440b227619ea17fc8101eb5f4"},"interpolate":{"$ref":"#/components/schemas/Schema_210bc4cac49d5a8403766e579b22242786bad39b0b9ff4753e56b678e29f38d4"},"output_meta":{"$ref":"#/components/schemas/Schema_60f6dcc23a68fee86135afddfdf2d63c170b886a6deb46563e7193f688ef4e6e"},"password":{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"type":"string"}]},"path":{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"type":"string"}],"default":"${unique_prefix}/${file.url_name}","description":"\nThe path at which the file is to be stored. This can contain any available [Assembly variables](/docs/topics/assembly-instructions/#assembly-variables).\n\nPlease note that you might need to include your homedir at the beginning of the path.\n"},"port":{"$ref":"#/components/schemas/Schema_54b7efa14685483f18a4ce6218bf13b9d3acda9c88f6de43b469c7cae2b8ee42"},"queue":{"$ref":"#/components/schemas/Schema_d0a30e0594348bac539404e659baaa1896ab178c82448e3cb657bb8df8a525c4"},"result":{"$ref":"#/components/schemas/Schema_e2eec9f0d3cf6892bbba08d6f0cb6582dc8dc7e3d2f71da8cbd997ad577ec0be"},"robot":{"const":"/ftp/store","description":"Identifier of the [robot](https://transloadit.com/docs/robots/) to execute","type":"string"},"secure":{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"anyOf":[{"type":"boolean"},{"enum":["false","true"],"type":"string"}]}],"default":false,"description":"\nDetermines whether to establish a secure connection to the FTP server using SSL.\n"},"ssl_url_template":{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"type":"string"}],"default":"https://{HOST}/{PATH}","description":"\nThe SSL URL of the file in the result JSON. The following [Assembly variables](/docs/topics/assembly-instructions/#assembly-variables) are supported.\n"},"url_template":{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"type":"string"}],"default":"https://{HOST}/{PATH}","description":"\nThe URL of the file in the result JSON. The following [Assembly variables](/docs/topics/assembly-instructions/#assembly-variables) are supported.\n"},"use":{"$ref":"#/components/schemas/Schema_47b2fd205d779e1de6bc4fd78c788d8393756436c48ec6f785f30dc6e16238aa"},"user":{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"type":"string"}]},"user_meta":{"$ref":"#/components/schemas/Schema_070d50917dd042191e4290744649be38025190ee43499886e5481a7d5627241d"}},"required":["robot"],"type":"object"},{"additionalProperties":false,"properties":{"credentials":{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"type":"string"}],"description":"\nCreate a new [Google service account](https://cloud.google.com/storage/docs/authentication). Set its role to \"Storage Object Creator\". Choose \"JSON\" for the key file format and download it to your computer. You will need to upload this file when creating your Template Credentials.\n\nGo back to your Google credentials project and enable the \"Google Cloud Storage JSON API\" for it. Wait around ten minutes for the action to propagate through the Google network. Grab the project ID from the dropdown menu in the header bar on the Google site. You will also need it later on.\n\nNow you can set up the `storage.objects.create` and `storage.objects.delete` permissions. The latter is optional and only required if you intend to overwrite existing paths.\n\nTo do this from the Google Cloud console, navigate to \"IAM & Admin\" and select \"Roles\". From here, click \"Create Role\", enter a name, set the role launch stage to _General availability,_ and set the permissions stated above.\n\nNext, go to Storage browser and select the ellipsis on your bucket to edit bucket permissions. From here, select \"Add Member\", enter your service account as a new member, and select your newly created role.\n\nThen, create your associated [Template Credentials](/c/template-credentials/) in your Transloadit account and use the name of your Template Credentials as this parameter's value.\n"},"files_per_page":{"$ref":"#/components/schemas/Schema_fb8110ac8e46afd357588fdb3f6e0487d14ea219ff23b237b83413793ce39f30"},"force_accept":{"$ref":"#/components/schemas/Schema_a7b463c184f2431703a1692b1402307bb6bb726278c59f7075fd0b8d6eb2be3c"},"force_name":{"$ref":"#/components/schemas/Schema_e2d753e6b6111506a4565bdb18eccafd67d2027839616974639f5565d695fafd"},"ignore_errors":{"$ref":"#/components/schemas/Schema_03e4961eba9e9b422ce714f9224b8d47a380c80d27b8342a78ba4e2702feb4db"},"import_on_errors":{"$ref":"#/components/schemas/Schema_61808f40a326596fd9674ebbd91184b0a2e04f8c67eb49fdf9f9449580271ab8"},"interpolate":{"$ref":"#/components/schemas/Schema_210bc4cac49d5a8403766e579b22242786bad39b0b9ff4753e56b678e29f38d4"},"next_page_token":{"$ref":"#/components/schemas/Schema_64187d2c5d197bbf686767819d827fe59b36816001ff849e7ed9a50ef83083d4"},"output_meta":{"$ref":"#/components/schemas/Schema_60f6dcc23a68fee86135afddfdf2d63c170b886a6deb46563e7193f688ef4e6e"},"path":{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"type":"string"}]},{"$ref":"#/components/schemas/Schema_bc9fbfc32e2939087e1b877c2b51ce63f08c8cdfdcf7adca01505a0498ab5691"}],"description":"\nThe path in your bucket to the specific file or directory. If the path points to a file, only this file will be imported. For example: `images/avatar.jpg`.\n\nIf it points to a directory, indicated by a trailing slash (`/`), then all files that are direct descendants of this directory will be imported. For example: `images/`.\n\nDirectories are **not** imported recursively. If you want to import files from subdirectories and sub-subdirectories, enable the `recursive` parameter.\n\nIf you want to import all files from the root directory, please use `/` as the value here. In this case, make sure all your objects belong to a path. If you have objects in the root of your bucket that aren't prefixed with `/`, you'll receive a 404 `GOOGLE_IMPORT_NOT_FOUND` error.\n\nYou can also use an array of path strings here to import multiple paths in the same Robot's Step.\n"},"queue":{"$ref":"#/components/schemas/Schema_d0a30e0594348bac539404e659baaa1896ab178c82448e3cb657bb8df8a525c4"},"recursive":{"$ref":"#/components/schemas/Schema_0d5e623ef607f7e5a5d864341fe8b479821f0bbb4438d97a29e9da5ff1902f4e"},"result":{"$ref":"#/components/schemas/Schema_e2eec9f0d3cf6892bbba08d6f0cb6582dc8dc7e3d2f71da8cbd997ad577ec0be"},"robot":{"const":"/google/import","description":"Identifier of the [robot](https://transloadit.com/docs/robots/) to execute","type":"string"},"user_meta":{"$ref":"#/components/schemas/Schema_070d50917dd042191e4290744649be38025190ee43499886e5481a7d5627241d"}},"required":["path","robot"],"type":"object"},{"additionalProperties":false,"properties":{"acl":{"anyOf":[{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"enum":["authenticated-read","bucket-owner-full-control","private","project-private","public-read"],"type":"string"}]},{"type":"null"}],"default":"public-read","description":"\nThe permissions used for this file.\n"},"cache_control":{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"type":"string"}],"description":"\nThe `Cache-Control` header determines how long browsers are allowed to cache your object for. Values specified with this parameter will be added to the object's metadata under the `Cache-Control` header. For more information on valid values, take a look at the [official Google documentation](https://cloud.google.com/storage/docs/metadata#cache-control).\n"},"credentials":{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"description":"\nCreate a new [Google service account](https://cloud.google.com/storage/docs/authentication). Set its role to \"Storage Object Creator\". Choose \"JSON\" for the key file format and download it to your computer. You will need to upload this file when creating your Template Credentials.\n\nGo back to your Google credentials project and enable the \"Google Cloud Storage JSON API\" for it. Wait around ten minutes for the action to propagate through the Google network. Grab the project ID from the dropdown menu in the header bar on the Google site. You will also need it later on.\n\nNow you can set up the `storage.objects.create` and `storage.objects.delete` permissions. The latter is optional and only required if you intend to overwrite existing paths.\n\nTo do this from the Google Cloud console, navigate to \"IAM & Admin\" and select \"Roles\". From here, click \"Create Role\", enter a name, set the role launch stage to _General availability,_ and set the permissions stated above.\n\nNext, go to Storage browser and select the ellipsis on your bucket to edit bucket permissions. From here, select \"Add Member\", enter your service account as a new member, and select your newly created role.\n\nThen, create your associated [Template Credentials](/c/template-credentials/) in your Transloadit account and use the name of your Template Credentials as this parameter's value.\n","type":"string"}],"description":"\nCreate a new [Google service account](https://cloud.google.com/storage/docs/authentication). Set its role to \"Storage Object Creator\". Choose \"JSON\" for the key file format and download it to your computer. You will need to upload this file when creating your Template Credentials.\n\nGo back to your Google credentials project and enable the \"Google Cloud Storage JSON API\" for it. Wait around ten minutes for the action to propagate through the Google network. Grab the project ID from the dropdown menu in the header bar on the Google site. You will also need it later on.\n\nNow you can set up the `storage.objects.create` and `storage.objects.delete` permissions. The latter is optional and only required if you intend to overwrite existing paths.\n\nTo do this from the Google Cloud console, navigate to \"IAM & Admin\" and select \"Roles\". From here, click \"Create Role\", enter a name, set the role launch stage to _General availability,_ and set the permissions stated above.\n\nNext, go to Storage browser and select the ellipsis on your bucket to edit bucket permissions. From here, select \"Add Member\", enter your service account as a new member, and select your newly created role.\n\nThen, create your associated [Template Credentials](/c/template-credentials/) in your Transloadit account and use the name of your Template Credentials as this parameter's value.\n"},"force_accept":{"$ref":"#/components/schemas/Schema_a7b463c184f2431703a1692b1402307bb6bb726278c59f7075fd0b8d6eb2be3c"},"ignore_errors":{"$ref":"#/components/schemas/Schema_866196eee82a663b71c0a383fdfb2f39a777749440b227619ea17fc8101eb5f4"},"interpolate":{"$ref":"#/components/schemas/Schema_210bc4cac49d5a8403766e579b22242786bad39b0b9ff4753e56b678e29f38d4"},"output_meta":{"$ref":"#/components/schemas/Schema_60f6dcc23a68fee86135afddfdf2d63c170b886a6deb46563e7193f688ef4e6e"},"path":{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"type":"string"}],"default":"${unique_prefix}/${file.url_name}","description":"\nThe path at which the file is to be stored. This may include any available [Assembly Variables](/docs/topics/assembly-instructions/#assembly-variables).\n"},"queue":{"$ref":"#/components/schemas/Schema_d0a30e0594348bac539404e659baaa1896ab178c82448e3cb657bb8df8a525c4"},"result":{"$ref":"#/components/schemas/Schema_ca159bf04e5ff3004e76aa992115890f7a332c46f90913826648557e7fc86b82"},"robot":{"const":"/google/store","description":"\nThe URL to the exported file in your Google bucket will be presented in the Transloadit Assembly Status JSON. This Robot can also be used to export encoded files to Google's Firebase as demonstrated in [this blogpost](/blog/2018/12/2h-youtube-clone/).\n","type":"string"},"ssl_url_template":{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"type":"string"}],"default":"https://{HOST}/{PATH}","description":"\nThe SSL URL of the file in the result JSON. The following [Assembly variables](/docs/topics/assembly-instructions/#assembly-variables) are supported.\n"},"url_template":{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"type":"string"}],"default":"https://{HOST}/{PATH}","description":"\nThe URL of the file in the result JSON. This may include any of the following supported [Assembly variables](/docs/topics/assembly-instructions/#assembly-variables).\n"},"use":{"$ref":"#/components/schemas/Schema_47b2fd205d779e1de6bc4fd78c788d8393756436c48ec6f785f30dc6e16238aa"},"user_meta":{"$ref":"#/components/schemas/Schema_070d50917dd042191e4290744649be38025190ee43499886e5481a7d5627241d"}},"required":["credentials","robot"],"type":"object"},{"additionalProperties":false,"properties":{"delay":{"anyOf":[{"pattern":"^[0-9]+(\\.[0-9]+)?$","type":"string"},{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"minimum":0,"type":"integer"}],"default":0,"description":"\nThe delay (in milliseconds) applied to allow the page and all of its JavaScript to render before taking the screenshot.\n"},"force_accept":{"$ref":"#/components/schemas/Schema_a7b463c184f2431703a1692b1402307bb6bb726278c59f7075fd0b8d6eb2be3c"},"format":{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"enum":["jpeg","jpg","pdf","png"],"type":"string"}],"default":"png","description":"\nThe format of the resulting image.\n"},"fullpage":{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"anyOf":[{"type":"boolean"},{"enum":["false","true"],"type":"string"}]}],"default":true,"description":"\nDetermines if a screenshot of the full page should be taken or not.\n\nIf set to `true`, the `height` parameter will not have any effect, as heights of websites vary. You can control the size of the resulting image somewhat, though, by setting the `width` parameter.\n\nIf set to `false`, an image will be cropped from the top of the webpage according to your `width` and `height` parameters.\n"},"headers":{"additionalProperties":{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"type":"string"}]},"description":"\nAn object containing optional headers that will be passed along with the original request to the website. For example, this parameter can be used to pass along an authorization token along with the request.\n","type":"object"},"height":{"anyOf":[{"pattern":"^[0-9]+(\\.[0-9]+)?$","type":"string"},{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"minimum":1,"type":"integer"}],"description":"\nThe screen height that will be used, in pixels. By default this equals the length of the web page in pixels if `fullpage` is set to `true`. If `fullpage` is set to `false`, the height parameter takes effect and defaults to the value `768`.\n"},"ignore_errors":{"$ref":"#/components/schemas/Schema_866196eee82a663b71c0a383fdfb2f39a777749440b227619ea17fc8101eb5f4"},"interpolate":{"$ref":"#/components/schemas/Schema_210bc4cac49d5a8403766e579b22242786bad39b0b9ff4753e56b678e29f38d4"},"omit_background":{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"anyOf":[{"type":"boolean"},{"enum":["false","true"],"type":"string"}]}],"default":false,"description":"\nDetermines whether to preserve a transparent background in HTML pages. Useful if you're generating artwork in HTML that you want to overlay on e.g. a video.\n\nThe default of `false` fills transparent areas with a white background, for easier reading/printing.\n\nThis parameter is only used when `format` is not `pdf`.\n"},"output_meta":{"$ref":"#/components/schemas/Schema_60f6dcc23a68fee86135afddfdf2d63c170b886a6deb46563e7193f688ef4e6e"},"queue":{"$ref":"#/components/schemas/Schema_d0a30e0594348bac539404e659baaa1896ab178c82448e3cb657bb8df8a525c4"},"result":{"$ref":"#/components/schemas/Schema_e2eec9f0d3cf6892bbba08d6f0cb6582dc8dc7e3d2f71da8cbd997ad577ec0be"},"robot":{"const":"/html/convert","description":"\nA URL can be provided instead of an input HTML file, to capture a screenshot from the website referenced by the URL.\n\nUse [🤖/image/resize](/docs/robots/image-resize/) to resize or crop the screenshot as needed.\n","type":"string"},"url":{"anyOf":[{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"type":"string"}]},{"type":"null"}],"default":null,"description":"\nThe URL of the web page to be converted. Optional, as you can also upload/import HTML files and pass it to this Robot.\n"},"use":{"$ref":"#/components/schemas/Schema_47b2fd205d779e1de6bc4fd78c788d8393756436c48ec6f785f30dc6e16238aa"},"user_meta":{"$ref":"#/components/schemas/Schema_070d50917dd042191e4290744649be38025190ee43499886e5481a7d5627241d"},"wait_until":{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"enum":["commit","domcontentloaded","load","networkidle"],"type":"string"}],"default":"networkidle","description":"\nThe event to wait for before taking the screenshot. Used for loading Javascript, and images.\n\nSee [Playwright's documentation](https://playwright.dev/docs/api/class-page#page-wait-for-load-state) for more information.\n"},"width":{"anyOf":[{"pattern":"^[0-9]+(\\.[0-9]+)?$","type":"string"},{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"minimum":1,"type":"integer"}],"default":1024,"description":"\nThe screen width that will be used, in pixels. Change this to change the dimensions of the resulting image.\n"}},"required":["robot"],"type":"object"},{"additionalProperties":false,"properties":{"fail_fast":{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"anyOf":[{"type":"boolean"},{"enum":["false","true"],"type":"string"}]}],"default":false,"description":"\nDisable the internal retry mechanism, and fail immediately if a resource can't be imported. This can be useful for performance critical applications.\n"},"force_accept":{"$ref":"#/components/schemas/Schema_a7b463c184f2431703a1692b1402307bb6bb726278c59f7075fd0b8d6eb2be3c"},"force_name":{"$ref":"#/components/schemas/Schema_e2d753e6b6111506a4565bdb18eccafd67d2027839616974639f5565d695fafd"},"headers":{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"$ref":"#/components/schemas/Schema_bc9fbfc32e2939087e1b877c2b51ce63f08c8cdfdcf7adca01505a0498ab5691"},{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"items":{"additionalProperties":{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"type":"string"}]},"type":"object"},"type":"array"}]},{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"type":"string"}]}],"default":[],"description":"\nCustom headers to be sent for file import.\n\nThis is an empty array by default, such that no additional headers except the necessary ones (e.g. Host) are sent.\n\nHeaders can be specified as:\n- An array of strings in the format \"Header-Name: value\"\n- An array of objects with header names as keys and values as values\n- A JSON string that will be parsed into an object\n\nHeader names must be valid HTTP tokens. Header values may contain horizontal tabs, but other control characters, including carriage returns and line feeds, are rejected.\n\nIn an array of header strings, `\"Header-Name;\"` sends an empty header value. Each entry must be a literal header; reading headers from a file with `@filename` is not supported.\n\nThe same `headers` value is sent with every URL in this `/http/import` Step. If `url` is an\narray, `headers` is not matched to the URLs by array index. Use separate `/http/import` Steps\nwhen different URLs need different headers.\n"},"ignore_errors":{"$ref":"#/components/schemas/Schema_03e4961eba9e9b422ce714f9224b8d47a380c80d27b8342a78ba4e2702feb4db"},"import_on_errors":{"$ref":"#/components/schemas/Schema_61808f40a326596fd9674ebbd91184b0a2e04f8c67eb49fdf9f9449580271ab8"},"interpolate":{"$ref":"#/components/schemas/Schema_210bc4cac49d5a8403766e579b22242786bad39b0b9ff4753e56b678e29f38d4"},"max_file_size":{"anyOf":[{"pattern":"^[0-9]+(\\.[0-9]+)?$","type":"string"},{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"exclusiveMinimum":0,"type":"integer"}],"description":"\nMaximum allowed size in bytes for each imported file. If the remote server reports a larger file size, the import is rejected before the download starts. If the remote server does not report a size upfront, the download is aborted once this limit is exceeded.\n"},"output_meta":{"$ref":"#/components/schemas/Schema_60f6dcc23a68fee86135afddfdf2d63c170b886a6deb46563e7193f688ef4e6e"},"queue":{"$ref":"#/components/schemas/Schema_d0a30e0594348bac539404e659baaa1896ab178c82448e3cb657bb8df8a525c4"},"range":{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"type":"string"}]},{"$ref":"#/components/schemas/Schema_bc9fbfc32e2939087e1b877c2b51ce63f08c8cdfdcf7adca01505a0498ab5691"}],"description":"\nAllows you to specify one or more byte ranges to import from the file. The server must support range requests for this to work.\n\n**Single range**: Use a string like `\"0-99\"` to import bytes 0-99 (the first 100 bytes).\n\n**Multiple ranges**: Use an array like `[\"0-99\", \"200-299\"]` to import multiple separate ranges. The resulting file will contain all requested ranges concatenated together, with zero bytes (\\0) filling any gaps between non-contiguous ranges.\n\n**Range formats**:\n- `\"0-99\"`: Bytes 0 through 99 (inclusive)\n- `\"100-199\"`: Bytes 100 through 199 (inclusive)\n- `\"-100\"`: The last 100 bytes of the file\n\n**Important notes**:\n- The server must support HTTP range requests (respond with 206 Partial Content)\n- If the server doesn't support range requests, the entire file will be imported instead\n- Overlapping ranges are allowed and will be included as requested\n- The resulting file size will be the highest byte position requested, with gaps filled with zero bytes\n"},"result":{"$ref":"#/components/schemas/Schema_e2eec9f0d3cf6892bbba08d6f0cb6582dc8dc7e3d2f71da8cbd997ad577ec0be"},"return_file_stubs":{"$ref":"#/components/schemas/Schema_7d0953e667a4e84601b14c25ec998d74076b0afded4b1fe7182cba7b5a1062f7"},"robot":{"const":"/http/import","description":"\nThe result of this Robot will carry a field `import_url` in its metadata, which references the URL from which it was imported. Further conversion results that use this file will also carry this `import_url` field. This allows you to match conversion results with the original import URL that you used.\n\nThis Robot knows to interpret links to files on these services:\n\n- Dropbox\n- Google Drive\n- Google Docs\n- OneDrive\n\nInstead of downloading the HTML page previewing the file, the actual file itself will be imported.\n","type":"string"},"url":{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"pattern":"^[Hh][Tt][Tt][Pp][Ss]?:\\/\\/(?:[^ ]|[ ])","type":"string","x-transloadit-input-fidelity":"conservative"}]},{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"items":{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"pattern":"^[Hh][Tt][Tt][Pp][Ss]?:\\/\\/(?:[^ ]|[ ])","type":"string","x-transloadit-input-fidelity":"conservative"}]},"type":"array"}]}],"description":"\nThe URL from which the file to be imported can be retrieved.\n\nHTTPS URLs must present a valid certificate trusted by Transloadit and matching the requested hostname. Self-signed, expired, or hostname-mismatched certificates cause `HTTP_IMPORT_FAILURE`.\n\nYou can also specify an array of URLs or a string of `|` delimited URLs to import several files at once. Please also check the `url_delimiter` parameter for that.\n"},"url_delimiter":{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"type":"string"}],"default":"|","description":"\nProvides the delimiter that is used to split the URLs in your `url` parameter value.\n"},"user_meta":{"$ref":"#/components/schemas/Schema_070d50917dd042191e4290744649be38025190ee43499886e5481a7d5627241d"}},"required":["robot","url"],"type":"object"},{"additionalProperties":false,"properties":{"force_accept":{"$ref":"#/components/schemas/Schema_a7b463c184f2431703a1692b1402307bb6bb726278c59f7075fd0b8d6eb2be3c"},"headers":{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"$ref":"#/components/schemas/Schema_bc9fbfc32e2939087e1b877c2b51ce63f08c8cdfdcf7adca01505a0498ab5691"},{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"items":{"$ref":"#/components/schemas/Schema_8bef30e845687818c225b81030d97335d9454464b4970117e2538a5bf473186e"},"type":"array"}]},{"$ref":"#/components/schemas/Schema_8bef30e845687818c225b81030d97335d9454464b4970117e2538a5bf473186e"},{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"type":"string"}]}],"default":[],"description":"\nCustom request headers.\n\nHeaders can be specified as an array of strings in the format `\"Header-Name: value\"`, an array\nof objects, an object map, or a JSON string that will be parsed into an object/array.\n\nHeader names must be valid HTTP tokens. Header values may contain horizontal tabs, but other control characters, including carriage returns and line feeds, are rejected.\n\nIn an array of header strings, `\"Header-Name;\"` sends an empty header value. Each entry must be a literal header; reading headers from a file with `@filename` is not supported.\n"},"ignore_errors":{"$ref":"#/components/schemas/Schema_866196eee82a663b71c0a383fdfb2f39a777749440b227619ea17fc8101eb5f4"},"interpolate":{"$ref":"#/components/schemas/Schema_210bc4cac49d5a8403766e579b22242786bad39b0b9ff4753e56b678e29f38d4"},"max_response_size":{"anyOf":[{"pattern":"^[0-9]+(\\.[0-9]+)?$","type":"string"},{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"exclusiveMinimum":0,"maximum":10485760,"type":"integer"}],"default":1048576,"description":"\nMaximum accepted response size in bytes. The response should normally be a small JSON document.\n"},"max_result_file_size":{"anyOf":[{"pattern":"^[0-9]+(\\.[0-9]+)?$","type":"string"},{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"exclusiveMinimum":0,"maximum":5368709120,"type":"integer"}],"default":104857600,"description":"\nMaximum allowed size in bytes for each result file returned by URL. If the remote server reports a\nlarger file size, the result download is rejected before it starts. If the remote server does not\nreport a size upfront, the download is aborted once this limit is exceeded.\n"},"max_result_files":{"anyOf":[{"pattern":"^[0-9]+(\\.[0-9]+)?$","type":"string"},{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"exclusiveMinimum":0,"maximum":100,"type":"integer"}],"default":10,"description":"\nMaximum number of files that the endpoint may return.\n"},"method":{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"enum":["DELETE","GET","PATCH","POST","PUT"],"type":"string"}],"default":"POST","description":"\nHTTP method to use for the request.\n"},"output_meta":{"$ref":"#/components/schemas/Schema_60f6dcc23a68fee86135afddfdf2d63c170b886a6deb46563e7193f688ef4e6e"},"payload":{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"enum":["file","files","metadata","none"],"type":"string"}],"default":"none","description":"\nControls what is sent to your endpoint.\n\n- `none`: Send no request body.\n- `metadata`: Send a JSON body with Assembly metadata, fields, the previous Step, and file metadata.\n- `file`: Send multipart form data with a `payload` JSON field and the first input file as a\n `file` part.\n- `files`: Send multipart form data with a `payload` JSON field and all input files as repeated\n `files[]` parts. Useful with `bundle_steps`.\n\nThe `payload` JSON object contains `assembly`, `fields`, `previous_step`, `file`, and\n`files`. `file` is the first input file’s metadata or `null`; `files` is an array of input\nfile metadata.\n"},"queue":{"$ref":"#/components/schemas/Schema_d0a30e0594348bac539404e659baaa1896ab178c82448e3cb657bb8df8a525c4"},"result":{"$ref":"#/components/schemas/Schema_e2eec9f0d3cf6892bbba08d6f0cb6582dc8dc7e3d2f71da8cbd997ad577ec0be"},"result_download_timeout":{"anyOf":[{"pattern":"^[0-9]+(\\.[0-9]+)?$","type":"string"},{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"exclusiveMinimum":0,"maximum":600,"type":"integer"}],"default":120,"description":"\nMaximum number of seconds to spend downloading each result file returned by URL.\n"},"robot":{"const":"/http/request","description":"\nCalls an HTTP endpoint during the Assembly and expects optional JSON describing zero or more input\nfiles or result-file URLs to emit from this Step.\n\nYour endpoint must return a 2xx response. An empty body, `[]`, or `{ \"files\": [] }` means this\nStep emits no files. You can also return one file object, an array of file objects, or\n`{ \"files\": [...] }` / `{ \"files\": { \"name\": {...} } }`. Returned file objects must include\neither a `path` that matches one of the input file paths sent to your endpoint, or an HTTP(S)\n`url` that Transloadit downloads and emits as a new result file.\n","type":"string"},"timeout":{"anyOf":[{"pattern":"^[0-9]+(\\.[0-9]+)?$","type":"string"},{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"exclusiveMinimum":0,"maximum":300,"type":"integer"}],"default":60,"description":"\nMaximum number of seconds to wait for the HTTP request.\n\nThe effective timeout is the lower of this value and Transloadit’s server-side cap. The cap is 30\nseconds plus 1 second per MiB sent to your endpoint.\n"},"url":{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"description":"\nThe HTTP or HTTPS endpoint to call.\n","pattern":"^[Hh][Tt][Tt][Pp][Ss]?:\\/\\/(?:[^ ]|[ ])","type":"string","x-transloadit-input-fidelity":"conservative"}],"description":"\nThe HTTP or HTTPS endpoint to call.\n"},"use":{"$ref":"#/components/schemas/Schema_47b2fd205d779e1de6bc4fd78c788d8393756436c48ec6f785f30dc6e16238aa"},"user_meta":{"$ref":"#/components/schemas/Schema_070d50917dd042191e4290744649be38025190ee43499886e5481a7d5627241d"}},"required":["robot","url"],"type":"object"},{"additionalProperties":false,"properties":{"force_accept":{"$ref":"#/components/schemas/Schema_a7b463c184f2431703a1692b1402307bb6bb726278c59f7075fd0b8d6eb2be3c"},"format":{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"enum":["gif","png","webp"],"type":"string"}],"default":"png","description":"Format of the generated image. Defaults to PNG when not provided."},"ignore_errors":{"$ref":"#/components/schemas/Schema_866196eee82a663b71c0a383fdfb2f39a777749440b227619ea17fc8101eb5f4"},"interpolate":{"$ref":"#/components/schemas/Schema_210bc4cac49d5a8403766e579b22242786bad39b0b9ff4753e56b678e29f38d4"},"model":{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"type":"string"}],"description":"Provider-specific model to use for removing the background. Mostly intended for testing and evaluation."},"output_meta":{"$ref":"#/components/schemas/Schema_60f6dcc23a68fee86135afddfdf2d63c170b886a6deb46563e7193f688ef4e6e"},"provider":{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"enum":["auto","fal","replicate","transloadit"],"type":"string"}],"default":"auto","description":"Chooses the best provider based on your request.\n\nSelect a specific provider to override automatic selection."},"queue":{"$ref":"#/components/schemas/Schema_d0a30e0594348bac539404e659baaa1896ab178c82448e3cb657bb8df8a525c4"},"result":{"$ref":"#/components/schemas/Schema_e2eec9f0d3cf6892bbba08d6f0cb6582dc8dc7e3d2f71da8cbd997ad577ec0be"},"robot":{"const":"/image/bgremove","description":"Identifier of the [robot](https://transloadit.com/docs/robots/) to execute","type":"string"},"select":{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"enum":["background","foreground"],"type":"string"}],"description":"Region to select and keep in the image. The other region is removed."},"use":{"$ref":"#/components/schemas/Schema_47b2fd205d779e1de6bc4fd78c788d8393756436c48ec6f785f30dc6e16238aa"},"user_meta":{"$ref":"#/components/schemas/Schema_070d50917dd042191e4290744649be38025190ee43499886e5481a7d5627241d"}},"required":["robot"],"type":"object"},{"additionalProperties":false,"properties":{"categories":{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"items":{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"enum":["all","artwork","brand_logo","stock_photo","watermarked"],"type":"string"}]},"minItems":1,"type":"array"}],"default":["all"],"description":"\nWhich categories of copyrighted content to detect.\n\n- `\"stock_photo\"` — Known stock photography (Shutterstock, Getty, Adobe Stock, etc.)\n- `\"brand_logo\"` — Registered brand logos and trademarks\n- `\"artwork\"` — Famous artworks and illustrations\n- `\"watermarked\"` — Images containing visible watermarks\n- `\"all\"` — All categories\n"},"confidence_threshold":{"anyOf":[{"pattern":"^[0-9]+(\\.[0-9]+)?$","type":"string"},{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"maximum":100,"minimum":0,"type":"number"}],"default":80,"description":"\nMinimum confidence percentage (0–100) for a match to be considered a copyright concern. Matches below this threshold are still returned in results but not flagged. Higher values reduce false positives but may miss some matches.\n"},"error_msg":{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"type":"string"}],"default":"One of your files matched a known stock photo or copyrighted work","description":"\nThe error message shown to your users (such as by Uppy) when a file is declined and `error_on_decline` is set to `true`.\n"},"error_on_decline":{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"anyOf":[{"type":"boolean"},{"enum":["false","true"],"type":"string"}]}],"default":false,"description":"\nIf set to `true` and one or more files match a known stock photo or copyrighted work (above the `confidence_threshold`), the Assembly will be stopped and marked with an error. Works the same way as `/file/virusscan`'s `error_on_decline`.\n"},"force_accept":{"$ref":"#/components/schemas/Schema_a7b463c184f2431703a1692b1402307bb6bb726278c59f7075fd0b8d6eb2be3c"},"format":{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"enum":["json","meta"],"type":"string"}],"default":"json","description":"\nIn what format to return the detection results.\n\n- `\"json\"` returns a JSON file with full match details including `licenses[]`, plus summary fields `flagged`, `max_confidence`, and `confidence_threshold`.\n- `\"meta\"` does not return a file, but stores the same data object (including `licenses[]`, `flagged`, `max_confidence`, and `confidence_threshold`) inside Transloadit's file object (under `${file.meta.copyright}`) that's passed around between encoding Steps, so that you can use the values to filter on them, etc.\n"},"ignore_errors":{"$ref":"#/components/schemas/Schema_866196eee82a663b71c0a383fdfb2f39a777749440b227619ea17fc8101eb5f4"},"interpolate":{"$ref":"#/components/schemas/Schema_210bc4cac49d5a8403766e579b22242786bad39b0b9ff4753e56b678e29f38d4"},"output_meta":{"$ref":"#/components/schemas/Schema_60f6dcc23a68fee86135afddfdf2d63c170b886a6deb46563e7193f688ef4e6e"},"queue":{"$ref":"#/components/schemas/Schema_d0a30e0594348bac539404e659baaa1896ab178c82448e3cb657bb8df8a525c4"},"result":{"$ref":"#/components/schemas/Schema_e2eec9f0d3cf6892bbba08d6f0cb6582dc8dc7e3d2f71da8cbd997ad577ec0be"},"robot":{"const":"/image/copyrightdetect","description":"\nDetects known stock photos, brand logos, and watermarked images in uploaded files by performing reverse image lookups against web databases. This is best understood as \"stock photo detection\" — it identifies whether an uploaded image matches a known copyrighted work in indexed databases (Getty Images, Shutterstock, Adobe Stock, etc.).\n\nReturns a `licenses[]` array with match details including source collection, license type, confidence scores, and source URLs. Can optionally halt the Assembly when a known copyrighted work is detected, similar to how `/file/virusscan` handles malicious files.\n\nThis Robot provides a **risk signal**, not a legal determination. A match means the image was found in a stock photo or rights-managed database — it does not mean the user lacks a valid license.\n","type":"string"},"use":{"$ref":"#/components/schemas/Schema_47b2fd205d779e1de6bc4fd78c788d8393756436c48ec6f785f30dc6e16238aa"},"user_meta":{"$ref":"#/components/schemas/Schema_070d50917dd042191e4290744649be38025190ee43499886e5481a7d5627241d"}},"required":["robot"],"type":"object"},{"additionalProperties":false,"properties":{"explicit_descriptions":{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"anyOf":[{"type":"boolean"},{"enum":["false","true"],"type":"string"}]}],"default":false,"description":"\nWhether to return only explicit or only non-explicit descriptions of the provided image. Explicit descriptions include labels for NSFW content (nudity, violence, etc). If set to `false`, only non-explicit descriptions (such as human or chair) will be returned. If set to `true`, only explicit descriptions will be returned.\n\nThe possible descriptions depend on the chosen provider. The list of labels from AWS can be found [in their documentation](https://docs.aws.amazon.com/rekognition/latest/dg/moderation.html#moderation-api). GCP labels the image based on five categories, as described [in their documentation](https://cloud.google.com/vision/docs/detecting-safe-search).\n\nFor an example of how to automatically reject NSFW content and malware, please check out this [blog post](/blog/2022/07/deny-image-uploads/).\n"},"force_accept":{"$ref":"#/components/schemas/Schema_a7b463c184f2431703a1692b1402307bb6bb726278c59f7075fd0b8d6eb2be3c"},"format":{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"enum":["json","meta","text"],"type":"string"}],"default":"json","description":"\nIn what format to return the descriptions.\n\n- `\"json\"` returns a JSON file.\n- `\"meta\"` does not return a file, but stores the data inside Transloadit's file object (under `${file.meta.descriptions}`) that's passed around between encoding Steps, so that you can use the values to burn the data into videos, filter on them, etc.\n"},"granularity":{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"enum":["full","list"],"type":"string"}],"default":"full","description":"\nWhether to return a full response (`\"full\"`) including confidence percentages for each found label, or just a flat list of labels (`\"list\"`).\n"},"ignore_errors":{"$ref":"#/components/schemas/Schema_866196eee82a663b71c0a383fdfb2f39a777749440b227619ea17fc8101eb5f4"},"interpolate":{"$ref":"#/components/schemas/Schema_210bc4cac49d5a8403766e579b22242786bad39b0b9ff4753e56b678e29f38d4"},"output_meta":{"$ref":"#/components/schemas/Schema_60f6dcc23a68fee86135afddfdf2d63c170b886a6deb46563e7193f688ef4e6e"},"provider":{"$ref":"#/components/schemas/Schema_ca72aa2ec7c776cc9d7892a1460fd032ef5b94b1d7c9ffa090d548e7d5360c4e"},"queue":{"$ref":"#/components/schemas/Schema_d0a30e0594348bac539404e659baaa1896ab178c82448e3cb657bb8df8a525c4"},"result":{"$ref":"#/components/schemas/Schema_e2eec9f0d3cf6892bbba08d6f0cb6582dc8dc7e3d2f71da8cbd997ad577ec0be"},"robot":{"const":"/image/describe","description":"\nYou can use the labels that we return in your application to automatically classify images. You can also pass the labels down to other Robots to filter images that contain (or do not contain) certain content.\n","type":"string"},"use":{"$ref":"#/components/schemas/Schema_47b2fd205d779e1de6bc4fd78c788d8393756436c48ec6f785f30dc6e16238aa"},"user_meta":{"$ref":"#/components/schemas/Schema_070d50917dd042191e4290744649be38025190ee43499886e5481a7d5627241d"}},"required":["robot"],"type":"object"},{"additionalProperties":false,"properties":{"ai_preset":{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"enum":["face_restore","restore"],"type":"string"}],"default":"restore","description":"\nAI enhancement preset used when `engine` is set to `\"ai\"`:\n- `restore` — General image restoration.\n- `face_restore` — Portrait-focused face restoration.\n\nAI mode is not intended for image upscaling. For dedicated upscaling, use [🤖/image/upscale](/docs/robots/image-upscale/).\n"},"denoise":{"anyOf":[{"pattern":"^[0-9]+(\\.[0-9]+)?$","type":"string"},{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"maximum":10,"minimum":0,"type":"number"}],"default":0,"description":"\nNoise reduction strength (`0` = none, `10` = maximum). Useful for high-ISO photos.\n"},"engine":{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"enum":["ai","classic"],"type":"string"}],"default":"classic","description":"\nEnhancement engine to use.\n\n- `\"classic\"` uses ImageMagick-based adjustments and presets.\n- `\"ai\"` uses AI restoration models on Replicate (typically higher latency and cost than classic mode).\n"},"enhance":{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"enum":["auto","auto_aggressive","auto_gentle","none"],"type":"string"}],"default":"auto","description":"\nThe auto-enhancement mode. `\"auto\"` applies balanced auto-levels, gamma correction, and subtle sharpening. `\"auto_gentle\"` is more conservative (good for already-decent photos). `\"auto_aggressive\"` applies stronger normalization and contrast. `\"none\"` skips auto-enhance (useful when only applying a preset filter).\n"},"force_accept":{"$ref":"#/components/schemas/Schema_a7b463c184f2431703a1692b1402307bb6bb726278c59f7075fd0b8d6eb2be3c"},"ignore_errors":{"$ref":"#/components/schemas/Schema_866196eee82a663b71c0a383fdfb2f39a777749440b227619ea17fc8101eb5f4"},"imagemagick_stack":{"$ref":"#/components/schemas/Schema_56b30d86ea31500bf844b3c857e7e1087b090f38feb9275f6991048203c04727"},"interpolate":{"$ref":"#/components/schemas/Schema_210bc4cac49d5a8403766e579b22242786bad39b0b9ff4753e56b678e29f38d4"},"output_meta":{"$ref":"#/components/schemas/Schema_60f6dcc23a68fee86135afddfdf2d63c170b886a6deb46563e7193f688ef4e6e"},"preset":{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"enum":["bw_classic","bw_dramatic","cinematic","cool","fade","golden_hour","matte","noir","none","pastel","teal_orange","vintage","vivid","warm"],"type":"string"}],"default":"none","description":"\nA named color grading preset to apply. Applied after auto-enhancement. Use `\"none\"` to skip preset application.\n\nAvailable presets:\n- `warm` — Warm golden tones\n- `cool` — Cool blue-shifted tones\n- `vintage` — Faded retro look with warm shadows\n- `vivid` — Boosted saturation and contrast\n- `matte` — Lifted blacks for a matte film look\n- `cinematic` — Teal-and-orange cinema grading\n- `golden_hour` — Warm sunset-like glow\n- `bw_dramatic` — High-contrast black and white\n- `bw_classic` — Classic film black and white\n- `noir` — Dark, moody black and white\n- `fade` — Washed-out faded look\n- `pastel` — Soft, desaturated pastel tones\n- `teal_orange` — Complementary teal shadows and orange highlights\n"},"quality":{"anyOf":[{"pattern":"^[0-9]+(\\.[0-9]+)?$","type":"string"},{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"maximum":100,"minimum":1,"type":"integer"}],"default":92,"description":"\nQuality of the output image. A value between `1` and `100`. Defaults to `92`.\n"},"queue":{"$ref":"#/components/schemas/Schema_d0a30e0594348bac539404e659baaa1896ab178c82448e3cb657bb8df8a525c4"},"result":{"$ref":"#/components/schemas/Schema_e2eec9f0d3cf6892bbba08d6f0cb6582dc8dc7e3d2f71da8cbd997ad577ec0be"},"robot":{"const":"/image/enhance","description":"\nWith this Robot you can automatically enhance images with one click — adjusting levels, contrast, saturation, sharpness, and white balance to produce an optimally balanced image. It also supports a library of named photo filter presets (e.g. `warm`, `cool`, `vintage`, `vivid`) that apply curated color grading and tone adjustments.\n\nIt works well together with [🤖/image/resize](/docs/robots/image-resize/) — you can enhance first, then resize, or vice versa.\n\nThis Robot accepts all image types supported by ImageMagick and passes unsupported types through unchanged. `engine: \"classic\"` uses `enhance`, `preset`, `sharpen`, and `denoise`, while `engine: \"ai\"` uses `ai_preset` and `quality`; classic controls are ignored in AI mode. Output keeps the original file extension when possible. In AI mode, if the target extension is not writable by the selected `imagemagick_stack`, the file is passed through unchanged.\n","type":"string"},"sharpen":{"anyOf":[{"pattern":"^[0-9]+(\\.[0-9]+)?$","type":"string"},{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"maximum":10,"minimum":0,"type":"number"}],"default":0,"description":"\nAdditional sharpening amount (`0` = none, `10` = maximum). The `\"auto\"` enhance mode already applies subtle sharpening; this parameter adds more on top.\n"},"use":{"$ref":"#/components/schemas/Schema_47b2fd205d779e1de6bc4fd78c788d8393756436c48ec6f785f30dc6e16238aa"},"user_meta":{"$ref":"#/components/schemas/Schema_070d50917dd042191e4290744649be38025190ee43499886e5481a7d5627241d"}},"required":["robot"],"type":"object"},{"additionalProperties":false,"properties":{"crop":{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"anyOf":[{"type":"boolean"},{"enum":["false","true"],"type":"string"}]}],"default":false,"description":"\nDetermine if the detected faces should be extracted. If this option is set to `false`, then the Robot returns the input image again, but with the coordinates of all detected faces attached to `file.meta.faces` in the result JSON. If this parameter is set to `true`, the Robot will output all detected faces as images.\n"},"crop_padding":{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"pattern":"^[0-9]+(px|%)$","type":"string"}],"default":"5px","description":"\nSpecifies how much padding is added to the extracted face images if `crop` is set to `true`. Values can be in `px` (pixels) or `%` (percentage of the width and height of the particular face image).\n"},"faces":{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"enum":["each","group","max-confidence","max-size"],"type":"string"}]},{"anyOf":[{"pattern":"^[0-9]+(\\.[0-9]+)?$","type":"string"},{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"type":"integer"}]}],"default":"each","description":"\nDetermines which of the detected faces should be returned. Valid values are:\n\n- `\"each\"` — each face is returned individually.\n- `\"max-confidence\"` — only the face with the highest confidence value is returned.\n- `\"max-size\"` — only the face with the largest area is returned.\n- `\"group\"` — all detected faces are grouped together into one rectangle that contains all faces.\n- any integer — the faces are sorted by their top-left corner and the integer determines the index of the returned face. Be aware the values are zero-indexed, meaning that `faces: 0` will return the first face. If no face for a given index exists, no output is produced.\n\nFor the following examples, the input image is:\n\n\n\n
\n\n`faces: \"each\"` applied:\n\n\n\n\n
\n\n`faces: \"max-confidence\"` applied:\n\n\n\n
\n\n`faces: \"max-size\"` applied:\n\n\n\n
\n\n`faces: \"group\"` applied:\n\n\n\n
\n\n`faces: 0` applied:\n\n\n"},"force_accept":{"$ref":"#/components/schemas/Schema_a7b463c184f2431703a1692b1402307bb6bb726278c59f7075fd0b8d6eb2be3c"},"format":{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"enum":["jpg","png","preserve","tiff"],"type":"string"}],"default":"preserve","description":"\nDetermines the output format of the extracted face images if `crop` is set to `true`.\n\nThe default value `\"preserve\"` means that the input image format is re-used.\n"},"ignore_errors":{"$ref":"#/components/schemas/Schema_866196eee82a663b71c0a383fdfb2f39a777749440b227619ea17fc8101eb5f4"},"interpolate":{"$ref":"#/components/schemas/Schema_210bc4cac49d5a8403766e579b22242786bad39b0b9ff4753e56b678e29f38d4"},"min_confidence":{"anyOf":[{"pattern":"^[0-9]+(\\.[0-9]+)?$","type":"string"},{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"maximum":100,"minimum":0,"type":"integer"}],"default":70,"description":"\nSpecifies the minimum confidence that a detected face must have. Only faces which have a higher confidence value than this threshold will be included in the result.\n"},"output_meta":{"$ref":"#/components/schemas/Schema_60f6dcc23a68fee86135afddfdf2d63c170b886a6deb46563e7193f688ef4e6e"},"provider":{"$ref":"#/components/schemas/Schema_ca72aa2ec7c776cc9d7892a1460fd032ef5b94b1d7c9ffa090d548e7d5360c4e"},"queue":{"$ref":"#/components/schemas/Schema_d0a30e0594348bac539404e659baaa1896ab178c82448e3cb657bb8df8a525c4"},"result":{"$ref":"#/components/schemas/Schema_e2eec9f0d3cf6892bbba08d6f0cb6582dc8dc7e3d2f71da8cbd997ad577ec0be"},"robot":{"const":"/image/facedetect","description":"\nYou can specify padding around the extracted faces, tailoring the output for your needs.\n\nThis Robot works well together with [🤖/image/resize](/docs/robots/image-resize/) to bring the full power of resized and optimized images to your website or app.\n\n\n\n**How to improve the accuracy:**\n\n- Ensure that your pictures have the correct orientation. This Robot achieves the best performance when the faces in the image are oriented upright and not rotated.\n- If the Robot detects objects other than a face, you can use `\"faces\": \"max-confidence\"` within your Template for selecting only the detection with the highest confidence.\n- The number of returned detections can also be controlled using the `min_confidence` parameter. Increasing its value will yield less results but each with a higher confidence. Decreasing the value, on the other hand, will provide more results but may also include objects other than faces.\n\n
\n","type":"string"},"use":{"$ref":"#/components/schemas/Schema_47b2fd205d779e1de6bc4fd78c788d8393756436c48ec6f785f30dc6e16238aa"},"user_meta":{"$ref":"#/components/schemas/Schema_070d50917dd042191e4290744649be38025190ee43499886e5481a7d5627241d"}},"required":["robot"],"type":"object"},{"additionalProperties":false,"properties":{"aspect_ratio":{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"type":"string"}],"description":"Requested output aspect ratio. For Google models, width/height can also be used and orientation is derived automatically when aspect_ratio is omitted."},"force_accept":{"$ref":"#/components/schemas/Schema_a7b463c184f2431703a1692b1402307bb6bb726278c59f7075fd0b8d6eb2be3c"},"format":{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"enum":["gif","jpeg","jpg","png","svg","webp"],"type":"string"}],"description":"Output format. Defaults depend on model: png for Google and OpenAI models, svg for recraft-v3, jpeg for others. Google models currently return PNG only."},"height":{"anyOf":[{"pattern":"^[0-9]+(\\.[0-9]+)?$","type":"string"},{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"type":"number"}],"description":"Requested output height in pixels (mainly used by Google and OpenAI image models)."},"ignore_errors":{"$ref":"#/components/schemas/Schema_866196eee82a663b71c0a383fdfb2f39a777749440b227619ea17fc8101eb5f4"},"interpolate":{"$ref":"#/components/schemas/Schema_210bc4cac49d5a8403766e579b22242786bad39b0b9ff4753e56b678e29f38d4"},"model":{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"type":"string"}],"description":"The AI model to use. Defaults to `openai/gpt-image-2.5-flare`. Supported models include `flux-1.1-pro-ultra`, `flux-schnell`, `recraft-v3`, `google/nano-banana`, `google/nano-banana-2`, `google/nano-banana-pro`, `openai/gpt-image-2`, `openai/gpt-image-2.5-flare`, `openai/gpt-image-2.5-sunburst`, and `stability-ai/stable-diffusion-inpainting`. The legacy alias `gpt-image-2` is also accepted for backwards compatibility."},"num_outputs":{"anyOf":[{"pattern":"^[0-9]+(\\.[0-9]+)?$","type":"string"},{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"maximum":10,"minimum":1,"type":"integer"}],"description":"Number of output variants to generate (1-10)."},"output_meta":{"$ref":"#/components/schemas/Schema_60f6dcc23a68fee86135afddfdf2d63c170b886a6deb46563e7193f688ef4e6e"},"prompt":{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"description":"Prompt describing the desired image. For inpainting, describe what should appear in the masked/transparent region and that the rest should stay unchanged.","type":"string"}],"description":"Prompt describing the desired image. For inpainting, describe what should appear in the masked/transparent region and that the rest should stay unchanged."},"queue":{"$ref":"#/components/schemas/Schema_d0a30e0594348bac539404e659baaa1896ab178c82448e3cb657bb8df8a525c4"},"result":{"$ref":"#/components/schemas/Schema_e2eec9f0d3cf6892bbba08d6f0cb6582dc8dc7e3d2f71da8cbd997ad577ec0be"},"robot":{"const":"/image/generate","description":"Identifier of the [robot](https://transloadit.com/docs/robots/) to execute","type":"string"},"seed":{"anyOf":[{"pattern":"^[0-9]+(\\.[0-9]+)?$","type":"string"},{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"type":"number"}],"description":"Seed for the random number generator. For Google models, use an integer from 0 to 2147483647. Each output increments the seed by 1, so the final output’s seed must also fit this range. A seed does not guarantee identical images."},"style":{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"type":"string"}],"description":"Style of the generated image."},"use":{"anyOf":[{"$ref":"#/components/schemas/Schema_dce1096fff6767b5f477f31f13c4e33289b9e9f3a0fd3df2000b731877c8d4bb"},{"$ref":"#/components/schemas/Schema_93f6798a65ce5f82f9f24e57970692d0637744d29ed7af56ed96d02c14a59f79"}],"description":"\nSpecifies which Step(s) to use as input.\n\nFor inpainting, provide both the source image and mask through `use`, typically with:\n\n```json\n{\n \"use\": [\n { \"name\": \":original\", \"as\": \"image\" },\n { \"name\": \":original\", \"as\": \"mask\" }\n ]\n}\n```\n\nBest practice:\n- Tag source and mask inputs explicitly using `as` (or semantic upload field names)\n- Keep the prompt focused on what should change in the masked/transparent region\n- Leave the model choice to the robot defaults unless you have a specific need\n"},"user_meta":{"$ref":"#/components/schemas/Schema_070d50917dd042191e4290744649be38025190ee43499886e5481a7d5627241d"},"width":{"anyOf":[{"pattern":"^[0-9]+(\\.[0-9]+)?$","type":"string"},{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"type":"number"}],"description":"Requested output width in pixels (mainly used by Google and OpenAI image models)."}},"required":["prompt","robot"],"type":"object"},{"additionalProperties":false,"properties":{"face_enhance":{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"anyOf":[{"type":"boolean"},{"enum":["false","true"],"type":"string"}]}],"default":false,"description":"Enable face enhancement for better face restoration. Defaults to false."},"force_accept":{"$ref":"#/components/schemas/Schema_a7b463c184f2431703a1692b1402307bb6bb726278c59f7075fd0b8d6eb2be3c"},"ignore_errors":{"$ref":"#/components/schemas/Schema_866196eee82a663b71c0a383fdfb2f39a777749440b227619ea17fc8101eb5f4"},"interpolate":{"$ref":"#/components/schemas/Schema_210bc4cac49d5a8403766e579b22242786bad39b0b9ff4753e56b678e29f38d4"},"model":{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"enum":["nightmareai/real-esrgan","sczhou/codeformer","tencentarc/gfpgan"],"type":"string"}],"default":"nightmareai/real-esrgan","description":"The AI model to use for image upscaling. Defaults to nightmareai/real-esrgan."},"output_meta":{"$ref":"#/components/schemas/Schema_60f6dcc23a68fee86135afddfdf2d63c170b886a6deb46563e7193f688ef4e6e"},"queue":{"$ref":"#/components/schemas/Schema_d0a30e0594348bac539404e659baaa1896ab178c82448e3cb657bb8df8a525c4"},"result":{"$ref":"#/components/schemas/Schema_e2eec9f0d3cf6892bbba08d6f0cb6582dc8dc7e3d2f71da8cbd997ad577ec0be"},"robot":{"const":"/image/upscale","description":"Identifier of the [robot](https://transloadit.com/docs/robots/) to execute","type":"string"},"scale":{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"const":2,"type":"number"}]},{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"const":4,"type":"number"}]}],"default":2,"description":"Upscale factor. Defaults to 2."},"use":{"$ref":"#/components/schemas/Schema_47b2fd205d779e1de6bc4fd78c788d8393756436c48ec6f785f30dc6e16238aa"},"user_meta":{"$ref":"#/components/schemas/Schema_070d50917dd042191e4290744649be38025190ee43499886e5481a7d5627241d"}},"required":["robot"],"type":"object"},{"additionalProperties":false,"properties":{"adaptive_filtering":{"$ref":"#/components/schemas/Schema_7259bfd3c73979776529646b342688ee35f3b84b7549790c20f4249298a7c9b9"},"background":{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"pattern":"^#?[0-9a-fA-F]{3}([0-9a-fA-F]{3})?$","type":"string"}]},{"$ref":"#/components/schemas/Schema_894ca51bc217ffa7c8529a59e38dd1724955749efb7587c16084f133dcc1d688"}],"default":"#fff","description":"\nEither the hexadecimal code or [name](https://www.imagemagick.org/script/color.php#color_names) of the color used to fill the background (only shown with a border > 1).\n\nBy default, the background of transparent images is changed to white. Set to `none` or `transparent` for a transparent canvas — set `format` to `png` or `webp` to preserve alpha.\n\nFor details about how to preserve transparency across all image types, see [this demo](/demos/image-processing/properly-preserve-transparency-across-all-image-types/).\n"},"border":{"anyOf":[{"pattern":"^[0-9]+(\\.[0-9]+)?$","type":"string"},{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"type":"integer"}],"default":0,"description":"\nAn integer value which defines the gap between images on the spritesheet.\n\nA value of `10` would cause the images to have the largest gap between them, while a value of `1` would place the images side-by-side.\n\nWhen `effect` is `polaroid-stack`, this value is instead used as canvas padding so the outermost photos keep that many pixels of distance from the edge.\n\nWhen `effect` is `mosaic`, this value is used both as the outer canvas padding and as the gutter width between neighboring tiles.\n"},"cell_height":{"anyOf":[{"pattern":"^[0-9]+(\\.[0-9]+)?$","type":"string"},{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"minimum":1,"type":"integer"}],"description":"\nUniform height for each grid cell in pixels. Only applies when `direction` is `grid`.\n\nImages are resized to fit within the cell while preserving aspect ratio.\n"},"cell_width":{"anyOf":[{"pattern":"^[0-9]+(\\.[0-9]+)?$","type":"string"},{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"minimum":1,"type":"integer"}],"description":"\nUniform width for each grid cell in pixels. Only applies when `direction` is `grid`.\n\nImages are resized to fit within the cell while preserving aspect ratio.\n"},"columns":{"anyOf":[{"pattern":"^[0-9]+(\\.[0-9]+)?$","type":"string"},{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"minimum":1,"type":"integer"}],"description":"\nNumber of columns in the grid layout. Only applies when `direction` is `grid`.\n\nIf omitted, columns are calculated automatically from the number of inputs and requested rows.\n"},"coverage":{"anyOf":[{"pattern":"^[0-9]+(\\.[0-9]+)?$","type":"string"},{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"maximum":3,"minimum":0.5,"type":"number"}],"description":"\nArea-coverage multiplier for the `polaroid-stack` effect. Controls how large each polaroid is relative to the canvas and consequently how much of the canvas is covered by photos.\n\nThe default of `1.5` leaves a subtle beige border along some edges. Use `2.0`–`2.5` for edge-to-edge coverage (photos overlap more). Values below `1.0` produce smaller, more widely spaced polaroids.\n\nHas no effect on the `mosaic` style or on plain spritesheets.\n"},"direction":{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"enum":["grid","horizontal","vertical"],"type":"string"}],"default":"horizontal","description":"\nSpecifies the direction which the images are displayed.\n\nUse `grid` to arrange inputs left-to-right and top-to-bottom.\n\nOnly applies to the default spritesheet layout. Ignored when `effect` is set to `polaroid-stack` or `mosaic`, as those effects use their own layout algorithms.\n"},"effect":{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"enum":["mosaic","polaroid-stack"],"type":"string"}],"description":"\nApplies a styled collage layout instead of a plain horizontal or vertical spritesheet.\n\nCurrently supports `polaroid-stack`, which renders the inputs as overlapping instant photos on a canvas, and `mosaic`, which builds a justified tiled collage.\n"},"force_accept":{"$ref":"#/components/schemas/Schema_a7b463c184f2431703a1692b1402307bb6bb726278c59f7075fd0b8d6eb2be3c"},"format":{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"enum":["jpg","png","webp"],"type":"string"}],"default":"png","description":"The output format for the modified image."},"height":{"anyOf":[{"pattern":"^[0-9]+(\\.[0-9]+)?$","type":"string"},{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"exclusiveMinimum":0,"type":"integer"}],"description":"\nThe output canvas height in pixels.\n\nThis is mainly used by styled effects such as `polaroid-stack` and `mosaic`.\n"},"ignore_errors":{"$ref":"#/components/schemas/Schema_866196eee82a663b71c0a383fdfb2f39a777749440b227619ea17fc8101eb5f4"},"interpolate":{"$ref":"#/components/schemas/Schema_210bc4cac49d5a8403766e579b22242786bad39b0b9ff4753e56b678e29f38d4"},"output_meta":{"$ref":"#/components/schemas/Schema_60f6dcc23a68fee86135afddfdf2d63c170b886a6deb46563e7193f688ef4e6e"},"quality":{"anyOf":[{"pattern":"^[0-9]+(\\.[0-9]+)?$","type":"string"},{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"maximum":100,"minimum":1,"type":"integer"}],"default":100,"description":"\nControls the image compression for JPG, PNG, and WebP images. Please also take a look at [🤖/image/optimize](/docs/robots/image-optimize/).\n"},"queue":{"$ref":"#/components/schemas/Schema_d0a30e0594348bac539404e659baaa1896ab178c82448e3cb657bb8df8a525c4"},"result":{"$ref":"#/components/schemas/Schema_e2eec9f0d3cf6892bbba08d6f0cb6582dc8dc7e3d2f71da8cbd997ad577ec0be"},"robot":{"const":"/image/merge","description":"\nThe final result will be a spritesheet, with the images displayed horizontally, vertically, or in a grid layout.\n\nIt's recommended to use this Robot with\n[🤖/image/resize](/docs/robots/image-resize/) so your images are of a\nsimilar size before merging them.\n","type":"string"},"rows":{"anyOf":[{"pattern":"^[0-9]+(\\.[0-9]+)?$","type":"string"},{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"minimum":1,"type":"integer"}],"description":"\nNumber of rows in the grid layout. Only applies when `direction` is `grid`.\n\nIf omitted, rows are calculated automatically from the number of inputs and requested columns.\n"},"seed":{"anyOf":[{"pattern":"^[0-9]+(\\.[0-9]+)?$","type":"string"},{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"type":"integer"}],"description":"\nOptional deterministic seed used by styled effects such as `polaroid-stack` and `mosaic`.\n"},"shuffle":{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"anyOf":[{"type":"boolean"},{"enum":["false","true"],"type":"string"}]}],"default":false,"description":"\nWhether styled effects such as `polaroid-stack` and `mosaic` may shuffle the input order before laying out the canvas.\n"},"sort_by":{"$ref":"#/components/schemas/Schema_a529048b2ed32b0125d678e158645220b42861e2c3e5bf89f766bec34234c3e6"},"use":{"$ref":"#/components/schemas/Schema_47b2fd205d779e1de6bc4fd78c788d8393756436c48ec6f785f30dc6e16238aa"},"user_meta":{"$ref":"#/components/schemas/Schema_070d50917dd042191e4290744649be38025190ee43499886e5481a7d5627241d"},"width":{"anyOf":[{"pattern":"^[0-9]+(\\.[0-9]+)?$","type":"string"},{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"exclusiveMinimum":0,"type":"integer"}],"description":"\nThe output canvas width in pixels.\n\nThis is mainly used by styled effects such as `polaroid-stack` and `mosaic`.\n"}},"required":["robot"],"type":"object"},{"additionalProperties":false,"properties":{"force_accept":{"$ref":"#/components/schemas/Schema_a7b463c184f2431703a1692b1402307bb6bb726278c59f7075fd0b8d6eb2be3c"},"format":{"$ref":"#/components/schemas/Schema_446b14af1ebe5ec174a22cdaf673cc8a9d274ffbf3ec624c203ffd7addeaa9ea"},"granularity":{"$ref":"#/components/schemas/Schema_c242020da3b98956a79933f680e24b9f780508f9223377ee11ef1e890ba21ca0"},"ignore_errors":{"$ref":"#/components/schemas/Schema_866196eee82a663b71c0a383fdfb2f39a777749440b227619ea17fc8101eb5f4"},"interpolate":{"$ref":"#/components/schemas/Schema_210bc4cac49d5a8403766e579b22242786bad39b0b9ff4753e56b678e29f38d4"},"output_meta":{"$ref":"#/components/schemas/Schema_60f6dcc23a68fee86135afddfdf2d63c170b886a6deb46563e7193f688ef4e6e"},"provider":{"$ref":"#/components/schemas/Schema_9078af0c8fa2eacba340b713a60073b4ab7866926df6574f217706a3d1e36cfd"},"queue":{"$ref":"#/components/schemas/Schema_d0a30e0594348bac539404e659baaa1896ab178c82448e3cb657bb8df8a525c4"},"result":{"$ref":"#/components/schemas/Schema_e2eec9f0d3cf6892bbba08d6f0cb6582dc8dc7e3d2f71da8cbd997ad577ec0be"},"robot":{"const":"/image/ocr","description":"\nWith this Robot you can detect and extract text from images using optical character recognition (OCR).\n\nFor example, you can use the results to obtain the content of traffic signs, name tags, package labels and many more. You can also pass the text down to other Robots to filter images that contain (or do not contain) certain phrases. For images of dense documents, results may vary and be less accurate than for small pieces of text in photos.\n","type":"string"},"use":{"$ref":"#/components/schemas/Schema_47b2fd205d779e1de6bc4fd78c788d8393756436c48ec6f785f30dc6e16238aa"},"user_meta":{"$ref":"#/components/schemas/Schema_070d50917dd042191e4290744649be38025190ee43499886e5481a7d5627241d"}},"required":["robot"],"type":"object"},{"additionalProperties":false,"properties":{"fix_breaking_images":{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"anyOf":[{"type":"boolean"},{"enum":["false","true"],"type":"string"}]}],"default":true,"description":"\nIf set to `true` this parameter tries to fix images that would otherwise make the underlying tool error out and thereby break your Assemblies. This can sometimes result in a larger file size, though.\n"},"force_accept":{"$ref":"#/components/schemas/Schema_a7b463c184f2431703a1692b1402307bb6bb726278c59f7075fd0b8d6eb2be3c"},"ignore_errors":{"$ref":"#/components/schemas/Schema_866196eee82a663b71c0a383fdfb2f39a777749440b227619ea17fc8101eb5f4"},"interpolate":{"$ref":"#/components/schemas/Schema_210bc4cac49d5a8403766e579b22242786bad39b0b9ff4753e56b678e29f38d4"},"lossy":{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"anyOf":[{"type":"boolean"},{"enum":["false","true"],"type":"string"}]}],"default":false,"description":"\nWhen set to `false` (the default), only lossless PNG optimizers are used, disabling pngquant to preserve color accuracy.\n\nWhen set to `true`, both lossy and lossless PNG optimizers compete and the smallest result wins. This allows pngquant, a lossy compressor that reduces PNGs to a 256-color palette, which may cause noticeable color shifts in images with rich color palettes, subtle gradients, or brand-specific colors.\n\n> [!Note]\n> This parameter only affects PNG optimization. JPEG, GIF, WebP, and SVG optimization is unaffected.\n"},"output_meta":{"$ref":"#/components/schemas/Schema_60f6dcc23a68fee86135afddfdf2d63c170b886a6deb46563e7193f688ef4e6e"},"preserve_meta_data":{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"anyOf":[{"type":"boolean"},{"enum":["false","true"],"type":"string"}]}],"default":true,"description":"\nSpecifies if the image's metadata should be preserved during the optimization, or not. If it is not preserved, the file size is even further reduced. But be aware that this could strip a photographer's copyright information, which for obvious reasons can be frowned upon.\n"},"priority":{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"enum":["compression-ratio","conversion-speed"],"type":"string"}],"default":"compression-ratio","description":"\nProvides different algorithms for better or worse compression for your images, but that run slower or faster. The value `\"conversion-speed\"` will result in an average compression ratio of 18%. `\"compression-ratio\"` will result in an average compression ratio of 31%.\n"},"progressive":{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"anyOf":[{"type":"boolean"},{"enum":["false","true"],"type":"string"}]}],"default":false,"description":"\nInterlaces the image if set to `true`, which makes the result image load progressively in browsers. Instead of rendering the image from top to bottom, the browser will first show a low-res blurry version of the image which is then quickly replaced with the actual image as the data arrives. This greatly increases the user experience, but comes at a loss of about 10% of the file size reduction.\n"},"queue":{"$ref":"#/components/schemas/Schema_d0a30e0594348bac539404e659baaa1896ab178c82448e3cb657bb8df8a525c4"},"result":{"$ref":"#/components/schemas/Schema_e2eec9f0d3cf6892bbba08d6f0cb6582dc8dc7e3d2f71da8cbd997ad577ec0be"},"robot":{"const":"/image/optimize","description":"\nWith this Robot it's possible to reduce the file size of your JPEG, PNG, GIF, WEBP and SVG images by up to 80% for big images and 65% for small to medium sized ones — while keeping their original quality!\n\nThis Robot enables you to lower your storage and bandwidth costs, and improves your user experience and monetization by reducing the load time of image-intensive web pages.\n\nIt works well together with [🤖/image/resize](/docs/robots/image-resize/) to bring the full power of resized and optimized images to your website or app.\n\n> [!Note]\n> This Robot accepts all image types and will just pass on unsupported image types unoptimized, including JPEG XL (`.jxl`) images when no smaller optimized result can be produced. Hence, there is no need to set up [🤖/file/filter](/docs/robots/file-filter/) workflows for this.\n\n> [!Note]\n> PNG optimization uses only lossless (optipng) compressors by default. To also enable lossy compression (pngquant), set `lossy: true`. When enabled, both lossy and lossless compressors compete and the smallest result wins, which may cause color shifts in some images.\n","type":"string"},"use":{"$ref":"#/components/schemas/Schema_47b2fd205d779e1de6bc4fd78c788d8393756436c48ec6f785f30dc6e16238aa"},"user_meta":{"$ref":"#/components/schemas/Schema_070d50917dd042191e4290744649be38025190ee43499886e5481a7d5627241d"}},"required":["robot"],"type":"object"},{"additionalProperties":false,"properties":{"adaptive_filtering":{"$ref":"#/components/schemas/Schema_7259bfd3c73979776529646b342688ee35f3b84b7549790c20f4249298a7c9b9"},"alpha":{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"enum":["Activate","Background","Copy","Deactivate","Extract","Off","On","Opaque","Remove","Set","Shape","Transparent"],"type":"string"}],"description":"\nGives control of the alpha/matte channel of an image.\n"},"background":{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"pattern":"^#?[0-9a-fA-F]{3}([0-9a-fA-F]{3})?$","type":"string"}]},{"$ref":"#/components/schemas/Schema_894ca51bc217ffa7c8529a59e38dd1724955749efb7587c16084f133dcc1d688"}],"default":"#FFFFFF","description":"\nEither the hexadecimal code or [name](https://www.imagemagick.org/script/color.php#color_names) of the color used to fill the background (used for the `pad` resize strategy).\n\n**Note:** By default, the background of transparent images is changed to white. To preserve transparency, set `\"background\"` to `\"none\"`.\n"},"blur":{"anyOf":[{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"pattern":"^[0-9]+(\\.[0-9]+)?x[0-9]+(\\.[0-9]+)?$","type":"string"}]},{"type":"null"}],"default":null,"description":"\nSpecifies gaussian blur, using a value with the form `{radius}x{sigma}`. The radius value specifies the size of area the operator should look at when spreading pixels, and should typically be either `\"0\"` or at least two times the sigma value. The sigma value is an approximation of how many pixels the image is \"spread\"; think of it as the size of the brush used to blur the image. This number is a floating point value, enabling small values like `\"0.5\"` to be used.\n"},"blur_regions":{"anyOf":[{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"items":{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"additionalProperties":true,"properties":{"height":{"$ref":"#/components/schemas/Schema_19320f624651bd3d89969ac7dee179d65c506ec5417870772e7486f7753c1d74"},"width":{"$ref":"#/components/schemas/Schema_19320f624651bd3d89969ac7dee179d65c506ec5417870772e7486f7753c1d74"},"x":{"$ref":"#/components/schemas/Schema_19320f624651bd3d89969ac7dee179d65c506ec5417870772e7486f7753c1d74"},"y":{"$ref":"#/components/schemas/Schema_19320f624651bd3d89969ac7dee179d65c506ec5417870772e7486f7753c1d74"}},"required":["height","width","x","y"],"type":"object"}]},"type":"array"}]},{"type":"null"}],"default":null,"description":"\nSpecifies an array of ellipse objects that should be blurred on the image. Each object has the following keys: `x`, `y`, `width`, `height`. If `blur_regions` has a value, then the `blur` parameter is used as the strength of the blur for each region.\n"},"brightness":{"anyOf":[{"pattern":"^[0-9]+(\\.[0-9]+)?$","type":"string"},{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"minimum":0,"type":"number"}],"default":1,"description":"\nIncreases or decreases the brightness of the image by using a multiplier. For example `1.5` would increase the brightness by 50%, and `0.75` would decrease the brightness by 25%.\n"},"clip":{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"type":"string"}]},{"$ref":"#/components/schemas/Schema_a8213ce4c995e2d44b094b3ea909eddf983764d183e2903635e64aa32732520a"}],"default":false,"description":"\nApply the clipping path to other operations in the resize job, if one is present. If set to `true`, it will automatically take the first clipping path. If set to a String it finds a clipping path by that name.\n"},"clut":{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"anyOf":[{"type":"boolean"},{"enum":["false","true"],"type":"string"}]}],"default":false,"description":"\nApplies a Color Look-Up Table (CLUT) image to remap the colors of the input image using ImageMagick's `-clut` operator. When enabled, a second input file must be supplied via the `use` parameter with `\"as\": \"clut\"`.\n\nThis operation currently runs via ImageMagick convert stack (not image-resizer daemon), even if `stack: \"daemon\"` is requested.\n\nWhen using multiple inputs, you should provide your primary image as `\"as\": \"base\"`. If no explicit `base` alias is set, Transloadit will use the first non-auxiliary input (a file that is not tagged as `watermark` or `clut`) as the primary image.\n\nThe CLUT image acts as a gradient map: each pixel's color channels in the input are replaced with the corresponding color from the CLUT image, based on channel intensity. This is a powerful color grading technique widely used in photography and design workflows.\n\nExample:\n\n```json\n{\n \"steps\": {\n \":original\": {\n \"robot\": \"/upload/handle\"\n },\n \"lut_image\": {\n \"robot\": \"/upload/handle\"\n },\n \"color_graded\": {\n \"robot\": \"/image/resize\",\n \"use\": {\n \"steps\": [\n { \"name\": \":original\", \"as\": \"base\" },\n { \"name\": \"lut_image\", \"as\": \"clut\" }\n ]\n },\n \"clut\": true\n }\n }\n}\n```\n"},"colorspace":{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"enum":["CMY","CMYK","Gray","HCL","HCLp","HSB","HSI","HSL","HSV","HWB","Jzazbz","LCHab","LCHuv","LMS","Lab","Log","Luv","OHTA","OkLCH","OkLab","RGB","Rec601YCbCr","Rec709YCbCr","Transparent","Undefined","XYZ","YCC","YCbCr","YDbDr","YIQ","YPbPr","YUV","sRGB","scRGB","xyY"],"type":"string"}],"description":"\nSets the image colorspace. For details about the available values, see the [ImageMagick documentation](https://www.imagemagick.org/script/command-line-options.php#colorspace). Please note that if you were using `\"RGB\"`, we recommend using `\"sRGB\"` instead as of 2014-02-04. ImageMagick might try to find the most efficient `colorspace` based on the color of an image, and default to e.g. `\"Gray\"`. To force colors, you might have to use this parameter in combination with `type: \"TrueColor\"`.\n"},"compress":{"anyOf":[{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"enum":["BZip","Fax","Group4","JPEG","JPEG2000","LZW","Lossless","None","RLE","Zip"],"type":"string"}]},{"type":"null"}],"default":null,"description":"\nSpecifies pixel compression for when the image is written. Compression is disabled by default.\n\nPlease also take a look at [🤖/image/optimize](/docs/robots/image-optimize/).\n"},"contrast":{"anyOf":[{"pattern":"^[0-9]+(\\.[0-9]+)?$","type":"string"},{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"maximum":2,"minimum":0,"type":"number"}],"default":1,"description":"\nAdjusts the contrast of the image. A value of `1` produces no change. Values below `1` decrease contrast (with `0` being minimum contrast), and values above `1` increase contrast (with `2` being maximum contrast). This works like the `brightness` parameter.\n"},"correct_gamma":{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"anyOf":[{"type":"boolean"},{"enum":["false","true"],"type":"string"}]}],"default":false,"description":"\nPrevents gamma errors [common in many image scaling algorithms](https://www.4p8.com/eric.brasseur/gamma.html).\n"},"crop":{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"$ref":"#/components/schemas/Schema_d10c75b8416036a412d719f3270a8e7c55c3e7241fea58efd7ba559263a2a8f6"},{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"type":"string"}]}],"description":"\nSpecify an object containing coordinates for the top left and bottom right corners of the rectangle to be cropped from the original image(s). The coordinate system is rooted in the top left corner of the image. Values can be integers for absolute pixel values or strings for percentage based values.\n\nFor example:\n\n```json\n{\n \"x1\": 80,\n \"y1\": 100,\n \"x2\": \"60%\",\n \"y2\": \"80%\"\n}\n```\n\nThis will crop the area from `(80, 100)` to `(600, 800)` from a 1000×1000 pixels image, which is a square whose width is 520px and height is 700px. If `crop` is set, the width and height parameters are ignored, and the `resize_strategy` is set to `crop` automatically.\n\nYou can also use a JSON string of such an object with coordinates in similar fashion:\n\n```json\n\"{\\\"x1\\\": , \\\"y1\\\": , \\\"x2\\\": , \\\"y2\\\": }\"\n```\n\nTo crop around human faces, see [🤖/image/facedetect](/docs/robots/image-facedetect/).\n"},"density":{"anyOf":[{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"pattern":"^(?:0*[1-9][0-9]*(?:\\.[0-9]+)?|0+\\.[0-9]*[1-9][0-9]*)(?:x(?:0*[1-9][0-9]*(?:\\.[0-9]+)?|0+\\.[0-9]*[1-9][0-9]*))?$","type":"string"}]},{"type":"null"}],"default":null,"description":"\nWhile in-memory quality and file format depth specifies the color resolution, the density of an image is the spatial (space) resolution of the image. That is the density (in pixels per inch) of an image and defines how far apart (or how big) the individual pixels are. It defines the size of the image in real world terms when displayed on devices or printed.\n\nYou can set this value to a specific `width` or in the format `width`x`height`.\n\nIf your converted image is unsharp, please try increasing density.\n"},"flatten":{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"anyOf":[{"type":"boolean"},{"enum":["false","true"],"type":"string"}]}],"default":true,"description":"\nFlattens all layers onto the specified background to achieve better results from transparent formats to non-transparent formats, as explained in the [ImageMagick documentation](https://www.imagemagick.org/script/command-line-options.php#layers).\n\nTo preserve animations, GIF files are not flattened when this is set to `true`. To flatten GIF animations, use the `frame` parameter.\n"},"force_accept":{"$ref":"#/components/schemas/Schema_a7b463c184f2431703a1692b1402307bb6bb726278c59f7075fd0b8d6eb2be3c"},"format":{"anyOf":[{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"type":"string"}]},{"type":"null"}],"default":null,"description":"\nThe output format for the modified image.\n\nSome of the most important available formats are `\"jpg\"`, `\"png\"`, `\"gif\"`, `\"tiff\"`, and `\"jxl\"` for JPEG XL. For a complete list of all formats that we can write to, please check [our supported image formats list](/docs/supported-formats/image-formats/).\n\nIf `null` (default), then the input image's format will be used as the output format.\n\nIf you wish to convert to `\"pdf\"`, please consider [🤖/document/convert](/docs/robots/document-convert/) instead.\n"},"frame":{"anyOf":[{"anyOf":[{"pattern":"^[0-9]+(\\.[0-9]+)?$","type":"string"},{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"minimum":1,"type":"integer"}]},{"type":"null"}],"default":null,"description":"\nUse this parameter when dealing with animated GIF files to specify which frame of the GIF is used for the operation. Specify `1` to use the first frame, `2` to use the second, and so on. `null` means all frames.\n"},"gravity":{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"$ref":"#/components/schemas/Schema_91ebf076951a09d46d134e429dae1060e4764ff23a9611174fcaac45893a5f52"},{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"enum":["attention","entropy"],"type":"string"}]}],"default":"center","description":"\nSets crop direction for `crop` or `fillcrop` without explicit coordinates.\nContent-aware `attention` and `entropy` need libvips, `fillcrop`, `width` and `height`.\nEffects such as `sepia` or `text`, and inputs such as HEIC, can use ImageMagick.\nIt centers these crops and the Assembly reports a warning.\nCrop in a separate /image/resize Step before effects, or convert unsupported inputs to PNG first.\n"},"height":{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"$ref":"#/components/schemas/Schema_ac7d8464107dcaba338b4b8bdc2db3b974790cf626fa64c3e036a3c7fd9cab49"}],"description":"\nHeight of the new image, in pixels. If not specified, will default to the height of the input image.\n"},"hue":{"anyOf":[{"pattern":"^[0-9]+(\\.[0-9]+)?$","type":"string"},{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"minimum":0,"type":"number"}],"default":100,"description":"\nChanges the hue by rotating the color of the image. The value `100` would produce no change whereas `0` and `200` will negate the colors in the image.\n"},"ignore_errors":{"$ref":"#/components/schemas/Schema_866196eee82a663b71c0a383fdfb2f39a777749440b227619ea17fc8101eb5f4"},"imagemagick_stack":{"$ref":"#/components/schemas/Schema_56b30d86ea31500bf844b3c857e7e1087b090f38feb9275f6991048203c04727"},"interpolate":{"$ref":"#/components/schemas/Schema_210bc4cac49d5a8403766e579b22242786bad39b0b9ff4753e56b678e29f38d4"},"monochrome":{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"anyOf":[{"type":"boolean"},{"enum":["false","true"],"type":"string"}]}],"default":false,"description":"\nTransform the image to black and white. This is a shortcut for setting the colorspace to Gray and type to Bilevel.\n"},"negate":{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"anyOf":[{"type":"boolean"},{"enum":["false","true"],"type":"string"}]}],"default":false,"description":"\nReplace each pixel with its complementary color, effectively negating the image. Especially useful when testing clipping.\n"},"output_meta":{"$ref":"#/components/schemas/Schema_60f6dcc23a68fee86135afddfdf2d63c170b886a6deb46563e7193f688ef4e6e"},"preclip_alpha":{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"enum":["Activate","Background","Copy","Deactivate","Extract","Off","On","Opaque","Remove","Set","Shape","Transparent"],"type":"string"}],"description":"\nGives control of the alpha/matte channel of an image before applying the clipping path via `clip: true`.\n"},"progressive":{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"anyOf":[{"type":"boolean"},{"enum":["false","true"],"type":"string"}]}],"default":false,"description":"\nInterlaces the image if set to `true`, which makes the image load progressively in browsers. Instead of rendering the image from top to bottom, the browser will first show a low-res blurry version of the images which is then quickly replaced with the actual image as the data arrives. This greatly increases the user experience, but comes at a cost of a file size increase by around 10%.\n"},"quality":{"anyOf":[{"pattern":"^[0-9]+(\\.[0-9]+)?$","type":"string"},{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"maximum":100,"minimum":1,"type":"integer"}],"default":92,"description":"\nControls the image compression for JPG and PNG images. Please also take a look at [🤖/image/optimize](/docs/robots/image-optimize/).\n"},"queue":{"$ref":"#/components/schemas/Schema_d0a30e0594348bac539404e659baaa1896ab178c82448e3cb657bb8df8a525c4"},"resize_strategy":{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"const":"crop","description":"Cuts an area out of an image, discarding any overlapping parts. If the source image is smaller than the crop frame, it will be zoomed. This strategy is implied when you specify coordinates in the `crop` parameter, and cannot be used without it.\n\nTo crop around human faces, see [🤖/image/facedetect](https://transloadit.com/docs/robots/image-facedetect/) instead.","type":"string"}],"description":"Cuts an area out of an image, discarding any overlapping parts. If the source image is smaller than the crop frame, it will be zoomed. This strategy is implied when you specify coordinates in the `crop` parameter, and cannot be used without it.\n\nTo crop around human faces, see [🤖/image/facedetect](https://transloadit.com/docs/robots/image-facedetect/) instead."},{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"const":"fillcrop","description":"Scales the image to fit into our 100×100 target while preserving aspect ratio, while trimming away any excess surface. This means both sides will become exactly 100 pixels, at the tradeoff of destroying parts of the image.\n\nBy default the resulting image is horizontally/vertically centered to fill the target rectangle. Use the `gravity` parameter to change where to crop the image, such as `\"bottom`\" or `\"left`\".","type":"string"}],"description":"Scales the image to fit into our 100×100 target while preserving aspect ratio, while trimming away any excess surface. This means both sides will become exactly 100 pixels, at the tradeoff of destroying parts of the image.\n\nBy default the resulting image is horizontally/vertically centered to fill the target rectangle. Use the `gravity` parameter to change where to crop the image, such as `\"bottom`\" or `\"left`\"."},{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"const":"fit","description":"Uses the larger side of the original image as a base for the resize. Aspect ratio is preserved. Either side will become at most 100 pixels.\n\nFor example: resizing a 400×300 image into 100×100, would produce a 100×75 image.","type":"string"}],"description":"Uses the larger side of the original image as a base for the resize. Aspect ratio is preserved. Either side will become at most 100 pixels.\n\nFor example: resizing a 400×300 image into 100×100, would produce a 100×75 image."},{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"const":"min_fit","description":"Uses the **smaller** side of the original image as a base for the resize. After resizing, the larger side will have a larger value than specified. Aspect ratio is preserved. Either side will become at least 100 pixels.\n\nFor example: resizing a 400×300 image into 100×100, would produce a 133×100 image.","type":"string"}],"description":"Uses the **smaller** side of the original image as a base for the resize. After resizing, the larger side will have a larger value than specified. Aspect ratio is preserved. Either side will become at least 100 pixels.\n\nFor example: resizing a 400×300 image into 100×100, would produce a 133×100 image."},{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"const":"pad","description":"Scales the image to fit while preserving aspect ratio. Both sides of the resized image become exactly 100 pixels, and any remaining surface is filled with a background color.\n\nIn this example, the background color is determined by the [Assembly Variable](https://transloadit.com/docs/topics/assembly-instructions/#assembly-variables) `${file.meta.average_color}`. If you set `zoom` to `false` (default is `true`), smaller images will be centered horizontally and vertically, and have the background padding all around them.","type":"string"}],"description":"Scales the image to fit while preserving aspect ratio. Both sides of the resized image become exactly 100 pixels, and any remaining surface is filled with a background color.\n\nIn this example, the background color is determined by the [Assembly Variable](https://transloadit.com/docs/topics/assembly-instructions/#assembly-variables) `${file.meta.average_color}`. If you set `zoom` to `false` (default is `true`), smaller images will be centered horizontally and vertically, and have the background padding all around them."},{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"const":"stretch","description":"Ignores aspect ratio, resizing the image to the exact width and height specified. This may result in a stretched or distorted image.","type":"string"}],"description":"Ignores aspect ratio, resizing the image to the exact width and height specified. This may result in a stretched or distorted image."}],"default":"fit","description":"\nSee the list of available [resize strategies](/docs/topics/resize-strategies/).\n"},"result":{"$ref":"#/components/schemas/Schema_e2eec9f0d3cf6892bbba08d6f0cb6582dc8dc7e3d2f71da8cbd997ad577ec0be"},"robot":{"const":"/image/resize","description":"Identifier of the [robot](https://transloadit.com/docs/robots/) to execute","type":"string"},"rotation":{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"$ref":"#/components/schemas/Schema_30573475089cec428fa966ac94d74114e316d676d5e62f4c710cb1a87589b4f0"},{"$ref":"#/components/schemas/Schema_a8213ce4c995e2d44b094b3ea909eddf983764d183e2903635e64aa32732520a"},{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"const":"auto","type":"string"}]}],"default":true,"description":"\nDetermines whether the image should be rotated. Use any number to specify the rotation angle in degrees (e.g., `90`, `180`, `270`, `360`, or precise values like `2.9`). Use the value `true` or `\"auto\"` to auto-rotate images that are rotated incorrectly or depend on EXIF rotation settings. Otherwise, use `false` to disable auto-fixing altogether.\n"},"saturation":{"anyOf":[{"pattern":"^[0-9]+(\\.[0-9]+)?$","type":"string"},{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"minimum":0,"type":"number"}],"default":1,"description":"\nIncreases or decreases the saturation of the image by using a multiplier. For example `1.5` would increase the saturation by 50%, and `0.75` would decrease the saturation by 25%.\n"},"sepia":{"anyOf":[{"anyOf":[{"pattern":"^[0-9]+(\\.[0-9]+)?$","type":"string"},{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"maximum":99,"minimum":0,"type":"integer"}]},{"type":"null"}],"default":null,"description":"\nApplies a sepia tone effect in percent.\n"},"shave":{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"pattern":"^[0-9]+(x[0-9]+)?$","type":"string"}]},{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"minimum":0,"type":"integer"}]}],"description":"\nShave pixels from the image edges. The value should be in the format `width` or `width`x`height` to specify the number of pixels to remove from each side.\n"},"strip":{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"anyOf":[{"type":"boolean"},{"enum":["false","true"],"type":"string"}]}],"default":false,"description":"\nStrips all metadata from the image. This is useful to keep thumbnails as small as possible.\n"},"text":{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"$ref":"#/components/schemas/Schema_c438f8b930d263be20d542bba99a73157870c05b1502869f4c6c99bd1324cfa1"},{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"items":{"$ref":"#/components/schemas/Schema_c438f8b930d263be20d542bba99a73157870c05b1502869f4c6c99bd1324cfa1"},"type":"array"}]}],"description":"\nText overlays to be applied to the image. Can be either a single text object or an array of text objects. Each text object contains text rules. The following text parameters are intended to be used as properties for your text overlays. Here is an example:\n\n```json\n\"watermarked\": {\n \"use\": \"resized\",\n \"robot\": \"/image/resize\",\n \"text\": [\n {\n \"text\": \"© 2018 Transloadit.com\",\n \"size\": 12,\n \"font\": \"Ubuntu\",\n \"color\": \"#eeeeee\",\n \"valign\": \"bottom\",\n \"align\": \"right\",\n \"x_offset\": 16,\n \"y_offset\": -10\n }\n ]\n}\n```"},"transparent":{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"pattern":"^#?[0-9a-fA-F]{3}([0-9a-fA-F]{3})?$","type":"string"}]},{"$ref":"#/components/schemas/Schema_894ca51bc217ffa7c8529a59e38dd1724955749efb7587c16084f133dcc1d688"}]},{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"pattern":"^[0-9]+,[0-9]+,[0-9]+$","type":"string"}]}],"description":"\nMake this color transparent within the image. Example: `\"255,255,255\"`.\n"},"trim_whitespace":{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"anyOf":[{"type":"boolean"},{"enum":["false","true"],"type":"string"}]}],"default":false,"description":"\nThis determines if additional whitespace around the image should first be trimmed away. If you set this to `true` this parameter removes any edges that are exactly the same color as the corner pixels.\n"},"type":{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"enum":["Bilevel","ColorSeparation","ColorSeparationAlpha","Grayscale","GrayscaleAlpha","Palette","PaletteAlpha","TrueColor","TrueColorAlpha"],"type":"string"}],"description":"\nSets the image color type. For details about the available values, see the [ImageMagick documentation](https://www.imagemagick.org/script/command-line-options.php#type). If you're using `colorspace`, ImageMagick might try to find the most efficient based on the color of an image, and default to e.g. `\"Gray\"`. To force colors, you could e.g. set this parameter to `\"TrueColor\"`\n"},"use":{"$ref":"#/components/schemas/Schema_47b2fd205d779e1de6bc4fd78c788d8393756436c48ec6f785f30dc6e16238aa"},"user_meta":{"$ref":"#/components/schemas/Schema_070d50917dd042191e4290744649be38025190ee43499886e5481a7d5627241d"},"watermark_opacity":{"anyOf":[{"pattern":"^[0-9]+(\\.[0-9]+)?$","type":"string"},{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"maximum":1,"minimum":0,"type":"number"}],"default":1,"description":"\nThe opacity of the watermark, where `0.0` is fully transparent and `1.0` is fully opaque.\n\nFor example, a value of `0.5` means the watermark will be 50% transparent, allowing the underlying image to show through. This is useful for subtle branding or when you want the watermark to be less obtrusive.\n"},"watermark_position":{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"$ref":"#/components/schemas/Schema_91ebf076951a09d46d134e429dae1060e4764ff23a9611174fcaac45893a5f52"},{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"items":{"$ref":"#/components/schemas/Schema_91ebf076951a09d46d134e429dae1060e4764ff23a9611174fcaac45893a5f52"},"type":"array"}]}],"default":"center","description":"\nThe position at which the watermark is placed. The available options are `\"center\"`, `\"top\"`, `\"bottom\"`, `\"left\"`, and `\"right\"`. You can also combine options, such as `\"bottom-right\"`.\n\nAn array of possible values can also be specified, in which case one value will be selected at random, such as `[ \"center\", \"left\", \"bottom-left\", \"bottom-right\" ]`.\n\nThis setting puts the watermark in the specified corner. To use a specific pixel offset for the watermark, you will need to add the padding to the image itself.\n"},"watermark_repeat_x":{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"anyOf":[{"type":"boolean"},{"enum":["false","true"],"type":"string"}]}],"default":false,"description":"\nWhen set to `true`, the watermark will be repeated horizontally across the entire width of the image.\n\nThis is useful for creating tiled watermark patterns that cover the full image and make it more difficult to crop out the watermark.\n"},"watermark_repeat_y":{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"anyOf":[{"type":"boolean"},{"enum":["false","true"],"type":"string"}]}],"default":false,"description":"\nWhen set to `true`, the watermark will be repeated vertically across the entire height of the image.\n\nThis is useful for creating tiled watermark patterns that cover the full image. Can be combined with `watermark_repeat_x` to tile in both directions.\n"},"watermark_resize_strategy":{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"enum":["area","fit","min_fit","stretch"],"type":"string"}],"default":"fit","description":"\nAvailable values are `\"fit\"`, `\"min_fit\"`, `\"stretch\"` and `\"area\"`.\n\nTo explain how the resize strategies work, let's assume our target image size is 800×800 pixels and our watermark image is 400×300 pixels. Let's also assume, the `watermark_size` parameter is set to `\"25%\"`.\n\nFor the `\"fit\"` resize strategy, the watermark is scaled so that the longer side of the watermark takes up 25% of the corresponding image side. And the other side is scaled according to the aspect ratio of the watermark image. So with our watermark, the width is the longer side, and 25% of the image size would be 200px. Hence, the watermark would be resized to 200×150 pixels. If the `watermark_size` was set to `\"50%\"`, it would be resized to 400×300 pixels (so just left at its original size).\n\nFor the `\"min_fit\"` resize strategy, the watermark is scaled so that the shorter side of the watermark takes up 25% of the corresponding image side. And the other side is scaled according to the aspect ratio of the watermark image. So with our watermark, the height is the shorter side, and 25% of the image size would be 200px. Hence, the watermark would be resized to 267×200 pixels. If the `watermark_size` was set to `\"50%\"`, it would be resized to 533×400 pixels (so larger than its original size).\n\nFor the `\"stretch\"` resize strategy, the watermark is stretched (meaning, it is resized without keeping its aspect ratio in mind) so that both sides take up 25% of the corresponding image side. Since our image is 800×800 pixels, for a watermark size of 25% the watermark would be resized to 200×200 pixels. Its height would appear stretched, because keeping the aspect ratio in mind it would be resized to 200×150 pixels instead.\n\nFor the `\"area\"` resize strategy, the watermark is resized (keeping its aspect ratio in check) so that it covers `\"xx%\"` of the image's surface area. The value from `watermark_size` is used for the percentage area size.\n"},"watermark_size":{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"pattern":"^[0-9]+%$","type":"string"}],"description":"\nThe size of the watermark, as a percentage.\n\nFor example, a value of `\"50%\"` means that size of the watermark will be 50% of the size of image on which it is placed. The exact sizing depends on `watermark_resize_strategy`, too.\n"},"watermark_url":{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"pattern":"^[Hh][Tt][Tt][Pp][Ss]?:\\/\\/(?:[^ ]|[ ])","type":"string","x-transloadit-input-fidelity":"conservative"}],"description":"\nA URL indicating a PNG image to be overlaid above this image. Please note that you can also [supply the watermark via another Assembly Step](/docs/topics/use-parameter/#supplying-the-watermark-via-an-assembly-step). With watermarking you can add an image onto another image. This is usually used for logos.\n"},"watermark_x_offset":{"$ref":"#/components/schemas/Schema_be8d9cf87fa19191b4ae7951e8157ec31b58525767399fe496cb8d58a86d78be"},"watermark_y_offset":{"$ref":"#/components/schemas/Schema_ef358dbff7b7953b7b59de1e6075793d2495500cab96f4aeba4005431dcf0481"},"width":{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"$ref":"#/components/schemas/Schema_ac7d8464107dcaba338b4b8bdc2db3b974790cf626fa64c3e036a3c7fd9cab49"}],"description":"\nWidth of the result in pixels. If not specified, will default to the width of the original.\n"},"zoom":{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"anyOf":[{"type":"boolean"},{"enum":["false","true"],"type":"string"}]}],"default":true,"description":"\nIf this is set to `false`, smaller images will not be stretched to the desired width and height. For details about the impact of zooming for your preferred resize strategy, see the list of available [resize strategies](/docs/topics/resize-strategies/).\n"}},"required":["robot"],"type":"object"},{"additionalProperties":false,"properties":{"data_to_write":{"additionalProperties":{},"default":{},"description":"\nA key/value map defining the metadata to write into the file.\n\nValid metadata keys can be found [here](https://exiftool.org/TagNames/EXIF.html). For example: `ProcessingSoftware`.\n","type":"object"},"ffmpeg":{"$ref":"#/components/schemas/Schema_15464c9d28640e7bf8903ba6d26df07ca6adbb8f0503e291180fa8a4647ec8e5"},"ffmpeg_stack":{"$ref":"#/components/schemas/Schema_2af3b38087bd992e9cae66535831de488ac05a86fd19619f5cfd998074675a28"},"force_accept":{"$ref":"#/components/schemas/Schema_a7b463c184f2431703a1692b1402307bb6bb726278c59f7075fd0b8d6eb2be3c"},"ignore_errors":{"$ref":"#/components/schemas/Schema_866196eee82a663b71c0a383fdfb2f39a777749440b227619ea17fc8101eb5f4"},"interpolate":{"$ref":"#/components/schemas/Schema_210bc4cac49d5a8403766e579b22242786bad39b0b9ff4753e56b678e29f38d4"},"output_meta":{"$ref":"#/components/schemas/Schema_60f6dcc23a68fee86135afddfdf2d63c170b886a6deb46563e7193f688ef4e6e"},"queue":{"$ref":"#/components/schemas/Schema_d0a30e0594348bac539404e659baaa1896ab178c82448e3cb657bb8df8a525c4"},"result":{"$ref":"#/components/schemas/Schema_e2eec9f0d3cf6892bbba08d6f0cb6582dc8dc7e3d2f71da8cbd997ad577ec0be"},"robot":{"const":"/meta/write","description":"\n**Note:** This Robot currently accepts images, videos and audio files.\n","type":"string"},"use":{"$ref":"#/components/schemas/Schema_47b2fd205d779e1de6bc4fd78c788d8393756436c48ec6f785f30dc6e16238aa"},"user_meta":{"$ref":"#/components/schemas/Schema_070d50917dd042191e4290744649be38025190ee43499886e5481a7d5627241d"}},"required":["robot"],"type":"object"},{"additionalProperties":false,"properties":{"bucket":{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"type":"string"}]},"credentials":{"$ref":"#/components/schemas/Schema_0fc8e431f685c4ad9c8c57805059dc903176efb1f46c34985fbc737fec1d63af"},"files_per_page":{"$ref":"#/components/schemas/Schema_fb8110ac8e46afd357588fdb3f6e0487d14ea219ff23b237b83413793ce39f30"},"force_accept":{"$ref":"#/components/schemas/Schema_a7b463c184f2431703a1692b1402307bb6bb726278c59f7075fd0b8d6eb2be3c"},"force_name":{"$ref":"#/components/schemas/Schema_e2d753e6b6111506a4565bdb18eccafd67d2027839616974639f5565d695fafd"},"host":{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"type":"string"}]},"ignore_errors":{"$ref":"#/components/schemas/Schema_03e4961eba9e9b422ce714f9224b8d47a380c80d27b8342a78ba4e2702feb4db"},"import_on_errors":{"$ref":"#/components/schemas/Schema_61808f40a326596fd9674ebbd91184b0a2e04f8c67eb49fdf9f9449580271ab8"},"interpolate":{"$ref":"#/components/schemas/Schema_210bc4cac49d5a8403766e579b22242786bad39b0b9ff4753e56b678e29f38d4"},"key":{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"type":"string"}]},"output_meta":{"$ref":"#/components/schemas/Schema_60f6dcc23a68fee86135afddfdf2d63c170b886a6deb46563e7193f688ef4e6e"},"page_number":{"$ref":"#/components/schemas/Schema_700ca6e236bc3ce29f7390532b108f5a864258e18588a743c9d63fff1d8ecf5d"},"path":{"$ref":"#/components/schemas/Schema_29b03e33e094714044bf936cf358f56ce8a49e8051c5e450b83befe9961c4ace"},"queue":{"$ref":"#/components/schemas/Schema_d0a30e0594348bac539404e659baaa1896ab178c82448e3cb657bb8df8a525c4"},"recursive":{"$ref":"#/components/schemas/Schema_2a04346246228d68b23baff4fd26615a3dabf4b0b635cea5e60d9c76cd4a0543"},"result":{"$ref":"#/components/schemas/Schema_e2eec9f0d3cf6892bbba08d6f0cb6582dc8dc7e3d2f71da8cbd997ad577ec0be"},"return_file_stubs":{"$ref":"#/components/schemas/Schema_7d0953e667a4e84601b14c25ec998d74076b0afded4b1fe7182cba7b5a1062f7"},"robot":{"const":"/minio/import","description":"Identifier of the [robot](https://transloadit.com/docs/robots/) to execute","type":"string"},"secret":{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"type":"string"}]},"user_meta":{"$ref":"#/components/schemas/Schema_070d50917dd042191e4290744649be38025190ee43499886e5481a7d5627241d"}},"required":["path","robot"],"type":"object"},{"additionalProperties":false,"properties":{"acl":{"$ref":"#/components/schemas/Schema_6f76a4b1c0011fc02a130479c0a33b50ca4ff841292c0a355755296647ce796a"},"bucket":{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"type":"string"}]},"credentials":{"$ref":"#/components/schemas/Schema_0fc8e431f685c4ad9c8c57805059dc903176efb1f46c34985fbc737fec1d63af"},"force_accept":{"$ref":"#/components/schemas/Schema_a7b463c184f2431703a1692b1402307bb6bb726278c59f7075fd0b8d6eb2be3c"},"headers":{"additionalProperties":{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"type":"string"}]},"default":{"Content-Type":"${file.mime}"},"description":"\nAn object containing a list of headers to be set for this file in your MinIO bucket, such as `{ FileURL: \"${file.url_name}\" }`. This can also include any available [Assembly Variables](/docs/topics/assembly-instructions/#assembly-variables).\n\nObject Metadata can be specified using `x-amz-meta-*` headers. Note that these headers [do not support non-ASCII metadata values](https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html#UserMetadata).\n","type":"object"},"host":{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"type":"string"}]},"ignore_errors":{"$ref":"#/components/schemas/Schema_866196eee82a663b71c0a383fdfb2f39a777749440b227619ea17fc8101eb5f4"},"interpolate":{"$ref":"#/components/schemas/Schema_210bc4cac49d5a8403766e579b22242786bad39b0b9ff4753e56b678e29f38d4"},"key":{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"type":"string"}]},"output_meta":{"$ref":"#/components/schemas/Schema_60f6dcc23a68fee86135afddfdf2d63c170b886a6deb46563e7193f688ef4e6e"},"path":{"$ref":"#/components/schemas/Schema_9e32d2e043ddaf27be258da25a42fb43c4a65680e4582d53c4c0e1d0b76908cf"},"queue":{"$ref":"#/components/schemas/Schema_d0a30e0594348bac539404e659baaa1896ab178c82448e3cb657bb8df8a525c4"},"result":{"$ref":"#/components/schemas/Schema_e2eec9f0d3cf6892bbba08d6f0cb6582dc8dc7e3d2f71da8cbd997ad577ec0be"},"robot":{"const":"/minio/store","description":"\nThe URL to the result file will be returned in the Assembly Status JSON.\n","type":"string"},"secret":{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"type":"string"}]},"sign_urls_for":{"$ref":"#/components/schemas/Schema_f9f059c6ff209141973277001e2fe4648f4c807fbffff7d8ff70e590dae4b4ad"},"use":{"$ref":"#/components/schemas/Schema_47b2fd205d779e1de6bc4fd78c788d8393756436c48ec6f785f30dc6e16238aa"},"user_meta":{"$ref":"#/components/schemas/Schema_070d50917dd042191e4290744649be38025190ee43499886e5481a7d5627241d"}},"required":["robot"],"type":"object"},{"additionalProperties":false,"properties":{"bucket":{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"type":"string"}]},"bucket_region":{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"type":"string"}]},"credentials":{"$ref":"#/components/schemas/Schema_0b7b04f621f8efa57648a0e30bbaa6a7b8282ff61dbd25868fe21cadd873ba02"},"files_per_page":{"$ref":"#/components/schemas/Schema_fb8110ac8e46afd357588fdb3f6e0487d14ea219ff23b237b83413793ce39f30"},"force_accept":{"$ref":"#/components/schemas/Schema_a7b463c184f2431703a1692b1402307bb6bb726278c59f7075fd0b8d6eb2be3c"},"force_name":{"$ref":"#/components/schemas/Schema_e2d753e6b6111506a4565bdb18eccafd67d2027839616974639f5565d695fafd"},"ignore_errors":{"$ref":"#/components/schemas/Schema_03e4961eba9e9b422ce714f9224b8d47a380c80d27b8342a78ba4e2702feb4db"},"import_on_errors":{"$ref":"#/components/schemas/Schema_61808f40a326596fd9674ebbd91184b0a2e04f8c67eb49fdf9f9449580271ab8"},"interpolate":{"$ref":"#/components/schemas/Schema_210bc4cac49d5a8403766e579b22242786bad39b0b9ff4753e56b678e29f38d4"},"key":{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"type":"string"}]},"output_meta":{"$ref":"#/components/schemas/Schema_60f6dcc23a68fee86135afddfdf2d63c170b886a6deb46563e7193f688ef4e6e"},"page_number":{"$ref":"#/components/schemas/Schema_700ca6e236bc3ce29f7390532b108f5a864258e18588a743c9d63fff1d8ecf5d"},"path":{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"type":"string"}]},{"$ref":"#/components/schemas/Schema_bc9fbfc32e2939087e1b877c2b51ce63f08c8cdfdcf7adca01505a0498ab5691"}],"description":"\nThe path in your bucket to the specific file or directory. If the path points to a file, only this file will be imported. For example: `images/avatar.jpg`.\n\nIf it points to a directory, indicated by a trailing slash (`/`), then all files that are direct descendants to this directory will be imported. For example: `images/`.\n\nDirectories are **not** imported recursively. If you want to import files from subdirectories and sub-subdirectories, enable the `recursive` parameter.\n\nIf you want to import all files from the root directory, please use `/` as the value here. In this case, make sure all your objects belong to a path. If you have objects in the root of your bucket that aren't prefixed with `/`, you'll receive an error: `A client error (NoSuchKey) occurred when calling the GetObject operation: The specified key does not exist.`\n\nYou can also use an array of path strings here to import multiple paths in the same Robot's Step.\n"},"queue":{"$ref":"#/components/schemas/Schema_d0a30e0594348bac539404e659baaa1896ab178c82448e3cb657bb8df8a525c4"},"range":{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"type":"string"}]},{"$ref":"#/components/schemas/Schema_bc9fbfc32e2939087e1b877c2b51ce63f08c8cdfdcf7adca01505a0498ab5691"}],"description":"\nAllows you to specify one or more byte ranges to import from the file. S3 must support range requests for this to work.\n\n**Single range**: Use a string like `\"0-99\"` to import bytes 0-99 (the first 100 bytes).\n\n**Multiple ranges**: Use an array like `[\"0-99\", \"200-299\"]` to import multiple separate ranges. The resulting file will contain all requested ranges concatenated together, with zero bytes (\\0) filling any gaps between non-contiguous ranges.\n\n**Range formats**:\n- `\"0-99\"`: Bytes 0 through 99 (inclusive)\n- `\"100-199\"`: Bytes 100 through 199 (inclusive)\n- `\"-100\"`: The last 100 bytes of the file\n\n**Important notes**:\n- S3 supports range requests by default\n- Overlapping ranges are allowed and will be included as requested\n- The resulting file size will be the highest byte position requested, with gaps filled with zero bytes\n- Each range is fetched in a separate request to ensure compatibility with S3\n"},"recursive":{"$ref":"#/components/schemas/Schema_2a04346246228d68b23baff4fd26615a3dabf4b0b635cea5e60d9c76cd4a0543"},"result":{"$ref":"#/components/schemas/Schema_e2eec9f0d3cf6892bbba08d6f0cb6582dc8dc7e3d2f71da8cbd997ad577ec0be"},"return_file_stubs":{"$ref":"#/components/schemas/Schema_7d0953e667a4e84601b14c25ec998d74076b0afded4b1fe7182cba7b5a1062f7"},"robot":{"const":"/s3/import","description":"\nIf you are new to Amazon S3, see our tutorial on [using your own S3 bucket](/docs/faq/how-to-set-up-an-amazon-s3-bucket/).\n\nThe URL to the result file in your S3 bucket will be returned in the Assembly Status JSON.\n\n> [!Warning]\n> **Use DNS-compliant bucket names**. Your bucket name [must be DNS-compliant](https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucketnamingrules.html) and must not contain uppercase letters. Any non-alphanumeric characters in the file names will be replaced with an underscore, and spaces will be replaced with dashes. If your existing S3 bucket contains uppercase letters or is otherwise not DNS-compliant, rewrite the result URLs using the Robot’s `url_prefix` parameter.\n\n\n\n## Limit access\n\nYou will also need to add permissions to your bucket so that Transloadit can access it properly. Here is an example IAM policy that you can use. Following the [principle of least privilege](https://en.wikipedia.org/wiki/Principle_of_least_privilege), it contains the **minimum required permissions** to import a file from your S3 bucket using Transloadit. You may require more permissions (especially viewing permissions) depending on your application.\n\nPlease change `{BUCKET_NAME}` in the values for `Sid` and `Resource` accordingly. Also, this policy will grant the minimum required permissions to all your users. We advise you to create a separate Amazon IAM user, and use its User ARN (can be found in the \"Summary\" tab of a user [here](https://console.aws.amazon.com/iam/home#users)) for the `Principal` value. More information about this can be found [here](https://docs.aws.amazon.com/AmazonS3/latest/dev/AccessPolicyLanguage_UseCases_s3_a.html).\n\n```json\n{\n \"Version\": \"2012-10-17\",\n \"Statement\": [\n {\n \"Sid\": \"AllowTransloaditToImportFilesIn{BUCKET_NAME}Bucket\",\n \"Effect\": \"Allow\",\n \"Action\": [\"s3:GetBucketLocation\", \"s3:ListBucket\"],\n \"Resource\": [\"arn:aws:s3:::{BUCKET_NAME}\", \"arn:aws:s3:::{BUCKET_NAME}/*\"]\n }\n ]\n}\n```\n\nThe `Sid` value is just an identifier for you to recognize the rule later. You can name it anything you like.\n\nThe policy needs to be separated into two parts, because the `ListBucket` action requires permissions on the bucket while the other actions require permissions on the objects in the bucket. When targeting the objects there's a trailing slash and an asterisk in the `Resource` parameter, whereas when the policy targets the bucket, the slash and the asterisk are omitted.\n\nIn order to build proper result URLs we need to know the region in which your S3 bucket resides. For this we require the `GetBucketLocation` permission. Figuring out your bucket's region this way will also slow down your Assemblies. To make this much faster and to also not require the `GetBucketLocation` permission, we have added the `bucket_region` parameter to the /s3/store and /s3/import Robots. We recommend using them at all times.\n\nPlease keep in mind that if you use bucket encryption you may also need to add `\"sts:*\"` and `\"kms:*\"` to the bucket policy. Please read [here](https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html) and [here](https://aws.amazon.com/blogs/security/how-to-restrict-amazon-s3-bucket-access-to-a-specific-iam-role/) in case you run into trouble with our example bucket policy.\n","type":"string"},"secret":{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"type":"string"}]},"user_meta":{"$ref":"#/components/schemas/Schema_070d50917dd042191e4290744649be38025190ee43499886e5481a7d5627241d"}},"required":["path","robot"],"type":"object"},{"additionalProperties":false,"properties":{"acl":{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"enum":["bucket-default","private","public","public-read"],"type":"string"}],"default":"public-read","description":"\nThe ACL used for this file. The default remains `\"public-read\"`, which can conflict with S3 Block Public Access and disabled ACLs. For modern private buckets, explicitly set `\"bucket-default\"` to omit the generated ACL header, and do not supply ACL/grant headers in `headers`. `\"private\"` still sends an ACL.\n"},"bucket":{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"type":"string"}]},"bucket_region":{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"type":"string"}]},"check_integrity":{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"anyOf":[{"type":"boolean"},{"enum":["false","true"],"type":"string"}]}],"default":false,"description":"\nCalculate and submit the file's checksum in order for S3 to verify its integrity after uploading, which can help with occasional file corruption issues.\n\nEnabling this option adds to the overall execution time, as integrity checking can be CPU intensive, especially for larger files.\n"},"credentials":{"$ref":"#/components/schemas/Schema_0b7b04f621f8efa57648a0e30bbaa6a7b8282ff61dbd25868fe21cadd873ba02"},"force_accept":{"$ref":"#/components/schemas/Schema_a7b463c184f2431703a1692b1402307bb6bb726278c59f7075fd0b8d6eb2be3c"},"headers":{"additionalProperties":{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"type":"string"}]},"default":{"Content-Type":"${file.mime}"},"description":"\nAn object containing a list of headers to be set for this file on S3, such as `{ FileURL: \"${file.url_name}\" }`. This can also include any available [Assembly Variables](/docs/topics/assembly-instructions/#assembly-variables). You can find a list of available headers [here](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectPUT.html).\n\nObject Metadata can be specified using `x-amz-meta-*` headers. Note that these headers [do not support non-ASCII metadata values](https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html#UserMetadata).\n","type":"object"},"host":{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"type":"string"}],"default":"s3.amazonaws.com","description":"\nThe host of the storage service used. This only needs to be set when the storage service used is not Amazon S3, but has a compatible API (such as hosteurope.de). The default protocol used is HTTP, for anything else the protocol needs to be explicitly specified. For example, prefix the host with `https://` or `s3://` to use either respective protocol.\n"},"ignore_errors":{"$ref":"#/components/schemas/Schema_866196eee82a663b71c0a383fdfb2f39a777749440b227619ea17fc8101eb5f4"},"interpolate":{"$ref":"#/components/schemas/Schema_210bc4cac49d5a8403766e579b22242786bad39b0b9ff4753e56b678e29f38d4"},"key":{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"type":"string"}]},"no_vhost":{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"anyOf":[{"type":"boolean"},{"enum":["false","true"],"type":"string"}]}],"default":false,"description":"\nSet to `true` if you use a custom host and run into access denied errors.\n"},"output_meta":{"$ref":"#/components/schemas/Schema_60f6dcc23a68fee86135afddfdf2d63c170b886a6deb46563e7193f688ef4e6e"},"path":{"$ref":"#/components/schemas/Schema_9e32d2e043ddaf27be258da25a42fb43c4a65680e4582d53c4c0e1d0b76908cf"},"queue":{"$ref":"#/components/schemas/Schema_d0a30e0594348bac539404e659baaa1896ab178c82448e3cb657bb8df8a525c4"},"result":{"$ref":"#/components/schemas/Schema_e2eec9f0d3cf6892bbba08d6f0cb6582dc8dc7e3d2f71da8cbd997ad577ec0be"},"robot":{"const":"/s3/store","description":"\nIf you are new to Amazon S3, see our tutorial on [using your own S3 bucket](/docs/faq/how-to-set-up-an-amazon-s3-bucket/).\n\nThe URL to the result file in your S3 bucket will be returned in the Assembly Status JSON. A returned URL does not make a private object public or grant read access. If your S3 bucket has versioning enabled, the version ID of the file will be returned within `meta.version_id`.\n\n> [!Warning]\n> **Configure private buckets explicitly.** The Robot’s default `acl` is still `\"public-read\"`. For a private bucket, set `acl: \"bucket-default\"` and do not supply ACL or grant headers. This omits the generated ACL header and works with [Bucket owner enforced Object Ownership](https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html), where ACLs are disabled. Keep S3 Block Public Access enabled. Setting `acl: \"private\"` still sends an ACL and is not equivalent to omitting it.\n\n> [!Warning]\n> **Use DNS-compliant bucket names.** Follow AWS’s [bucket naming rules](https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucketnamingrules.html). The `url_prefix` parameter changes returned URLs; it does not change the bucket or its access permissions.\n\n\n\n## Limit access\n\nUse a dedicated AWS identity with access limited to the destination bucket and object prefix. Do not use [AWS root access keys](https://docs.aws.amazon.com/IAM/latest/UserGuide/root-user-best-practices.html). Store its access key ID, secret access key, bucket name and region as `key`, `secret`, `bucket` and `bucket_region` in Template Credentials, then reference their name with `credentials`. Trusted backend integrations can instead supply those parameters directly; do not expose AWS secrets in browser instructions.\n\nThe following is an [identity-based IAM policy](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_principal.html), attached to that dedicated identity, not a bucket policy. It intentionally has no `Principal`. Replace `{BUCKET_NAME}` and use a Robot `path` beginning with `uploads/`, or adapt both the policy prefix and the path together.\n\nThis example covers uploads and failed multipart-upload cleanup with an explicit `bucket_region`, `acl: \"bucket-default\"`, no ACL/grant headers, no tags and S3-managed encryption (SSE-S3). Existing bucket policies, organization controls or endpoint policies can still deny access.\n\n```json\n{\n \"Version\": \"2012-10-17\",\n \"Statement\": [\n {\n \"Sid\": \"UploadAndAbortWithinPrefix\",\n \"Effect\": \"Allow\",\n \"Action\": [\"s3:PutObject\", \"s3:AbortMultipartUpload\"],\n \"Resource\": \"arn:aws:s3:::{BUCKET_NAME}/uploads/*\"\n }\n ]\n}\n```\n\nThe uploader uses either `PutObject` or `CreateMultipartUpload`, `UploadPart` and `CompleteMultipartUpload`; failed multipart uploads can trigger `AbortMultipartUpload`. AWS maps the successful upload operations to `s3:PutObject`. Write access can **overwrite an existing object key**; it is not add-only. Choose unique object paths and consider versioning for recovery.\n\nAdd permissions only for features you use, following AWS’s [operation permission reference](https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-policy-actions.html):\n\n- Without an explicit `bucket_region`, region discovery can require `s3:GetBucketLocation` and fallback `s3:ListBucket` on the bucket ARN, `arn:aws:s3:::{BUCKET_NAME}`, without an object suffix. Supplying the correct region avoids these discovery requests.\n- ACL or grant headers require `s3:PutObjectAcl`; tags require `s3:PutObjectTagging` on the allowed object prefix. `bucket-default` does not remove ACL/grant headers you supply in `headers`.\n- Downloading private results requires separate read authorization. Even a URL generated with `sign_urls_for` needs the signing identity to have the appropriate read permissions.\n\nS3 applies its [bucket encryption configuration](https://docs.aws.amazon.com/AmazonS3/latest/userguide/default-bucket-encryption.html) when no encryption override is sent. You can request SSE-KMS through `headers`, using `x-amz-server-side-encryption: aws:kms` and `x-amz-server-side-encryption-aws-kms-key-id`. When either bucket default encryption or request headers select [SSE-KMS](https://docs.aws.amazon.com/AmazonS3/latest/userguide/UsingKMSEncryption.html), the uploading identity needs `kms:GenerateDataKey` on the relevant key, plus `kms:Decrypt` for multipart uploads. For a customer-managed key, grant these permissions with a compatible KMS key policy; the base S3 policy above does not include them. Do not add blanket `kms:*` or `sts:*` grants.\n\nShort-lived AWS credentials are a matching set of `key`, `secret` and `session_token`. Have a trusted backend obtain and refresh all three, then supply them together when it creates the Assembly. It can pass them directly in Robot instructions or save and update them together through the [Template Credentials API](/docs/api/template-credentials-post/). Keep all three out of browser instructions; replacing only the session token does not refresh expired access keys. This Robot passes the supplied credentials to S3; it does not assume a role or refresh expired credentials. Keep temporary credentials valid for the upload.\n","type":"string"},"secret":{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"type":"string"}]},"session_token":{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"type":"string"}],"description":"\nThe session token belonging to the temporary AWS access key ID and secret access key supplied for this upload. The Robot does not assume a role or refresh these credentials; they must remain valid for the upload.\n"},"sign_urls_for":{"anyOf":[{"pattern":"^[0-9]+(\\.[0-9]+)?$","type":"string"},{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"minimum":0,"type":"integer"}],"description":"\nThis parameter provides signed URLs in the result JSON (in the `signed_url` and `signed_ssl_url` properties). The number that you set this parameter to is the URL expiry time in seconds. If this parameter is not used, no URL signing is done.\n"},"tags":{"additionalProperties":{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"type":"string"}]},"default":{},"description":"\nObject tagging allows you to categorize storage. You can associate up to 10 tags with an object. Tags that are associated with an object must have unique tag keys.\n","type":"object"},"url_prefix":{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"type":"string"}],"default":"http://{bucket}.s3.amazonaws.com/","description":"\nThe URL prefix used for the returned URL, such as `\"http://my.cdn.com/some/path/\"`.\n"},"use":{"$ref":"#/components/schemas/Schema_47b2fd205d779e1de6bc4fd78c788d8393756436c48ec6f785f30dc6e16238aa"},"user_meta":{"$ref":"#/components/schemas/Schema_070d50917dd042191e4290744649be38025190ee43499886e5481a7d5627241d"}},"required":["robot"],"type":"object"},{"additionalProperties":false,"properties":{"force_accept":{"$ref":"#/components/schemas/Schema_a7b463c184f2431703a1692b1402307bb6bb726278c59f7075fd0b8d6eb2be3c"},"ignore_errors":{"$ref":"#/components/schemas/Schema_866196eee82a663b71c0a383fdfb2f39a777749440b227619ea17fc8101eb5f4"},"interpolate":{"$ref":"#/components/schemas/Schema_210bc4cac49d5a8403766e579b22242786bad39b0b9ff4753e56b678e29f38d4"},"output_meta":{"$ref":"#/components/schemas/Schema_60f6dcc23a68fee86135afddfdf2d63c170b886a6deb46563e7193f688ef4e6e"},"queue":{"$ref":"#/components/schemas/Schema_d0a30e0594348bac539404e659baaa1896ab178c82448e3cb657bb8df8a525c4"},"result":{"$ref":"#/components/schemas/Schema_e2eec9f0d3cf6892bbba08d6f0cb6582dc8dc7e3d2f71da8cbd997ad577ec0be"},"robot":{"const":"/script/run","description":"\nThis Robot allows you to run arbitrary `JavaScript` as part of the Assembly\nexecution process. The Robot is invoked automatically when there are Assembly\nInstructions containing `${...}`:\n\n```json\n{\n \"robot\": \"/image/resize\",\n \"width\": \"${Math.max(file.meta.width, file.meta.height)}\"\n}\n```\n\nYou can also invoke this Robot directly, leaving out the `${...}`:\n\n```json\n{\n \"robot\": \"/script/run\",\n \"script\": \"Math.max(file.meta.width, file.meta.height)\"\n}\n```\n\nWhen accessing arrays, the syntax is the same as in any JavaScript program:\n\n```json\n{\n \"robot\": \"/image/resize\",\n \"width\": \"${file.meta.faces[0].width * 2}\"\n}\n```\n\nCompared to only accessing an Assembly Variable:\n\n```json\n{\n \"robot\": \"/image/resize\",\n \"width\": \"${file.meta.faces[0].width}\"\n}\n```\n\nFor more information, see [Dynamic Evaluation](/docs/topics/dynamic-evaluation/).\n","type":"string"},"script":{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"description":"\nA string of JavaScript to evaluate. It has access to all JavaScript features available in a modern browser environment.\n\nThe script is expected to return a `JSON.stringify`-able value in the same tick, so no `await` or callbacks are allowed (yet).\n\nIf the script does not finish within 1000ms it times out with an error. The return value or error is exported as `file.meta.result`. If there was an error, `file.meta.isError` is `true`. Note that the Assembly will not crash in this case. If you need it to crash, you can check this value with a [🤖/file/filter](/docs/robots/file-filter/) Step, setting `error_on_decline` to `true`.\n\nYou can check whether evaluating this script was free by inspecting `file.meta.isFree`. It is recommended to do this during development as to not see sudden unexpected costs in production.\n","type":"string"}],"description":"\nA string of JavaScript to evaluate. It has access to all JavaScript features available in a modern browser environment.\n\nThe script is expected to return a `JSON.stringify`-able value in the same tick, so no `await` or callbacks are allowed (yet).\n\nIf the script does not finish within 1000ms it times out with an error. The return value or error is exported as `file.meta.result`. If there was an error, `file.meta.isError` is `true`. Note that the Assembly will not crash in this case. If you need it to crash, you can check this value with a [🤖/file/filter](/docs/robots/file-filter/) Step, setting `error_on_decline` to `true`.\n\nYou can check whether evaluating this script was free by inspecting `file.meta.isFree`. It is recommended to do this during development as to not see sudden unexpected costs in production.\n"},"use":{"$ref":"#/components/schemas/Schema_47b2fd205d779e1de6bc4fd78c788d8393756436c48ec6f785f30dc6e16238aa"},"user_meta":{"$ref":"#/components/schemas/Schema_070d50917dd042191e4290744649be38025190ee43499886e5481a7d5627241d"}},"required":["robot","script"],"type":"object"},{"additionalProperties":false,"properties":{"credentials":{"$ref":"#/components/schemas/Schema_e00528555b01ba9d12a79a7f6dd4925c61c1970776ac19f9311820ad362c38ad"},"force_accept":{"$ref":"#/components/schemas/Schema_a7b463c184f2431703a1692b1402307bb6bb726278c59f7075fd0b8d6eb2be3c"},"force_name":{"$ref":"#/components/schemas/Schema_e2d753e6b6111506a4565bdb18eccafd67d2027839616974639f5565d695fafd"},"host":{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"type":"string"}]},"ignore_errors":{"$ref":"#/components/schemas/Schema_03e4961eba9e9b422ce714f9224b8d47a380c80d27b8342a78ba4e2702feb4db"},"import_on_errors":{"$ref":"#/components/schemas/Schema_61808f40a326596fd9674ebbd91184b0a2e04f8c67eb49fdf9f9449580271ab8"},"interpolate":{"$ref":"#/components/schemas/Schema_210bc4cac49d5a8403766e579b22242786bad39b0b9ff4753e56b678e29f38d4"},"output_meta":{"$ref":"#/components/schemas/Schema_60f6dcc23a68fee86135afddfdf2d63c170b886a6deb46563e7193f688ef4e6e"},"path":{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"description":"\nThe path on your SFTP server where to search for files. If the path points to a directory, only direct descendants of this directory are imported by default.\n","type":"string"}],"description":"\nThe path on your SFTP server where to search for files. If the path points to a directory, only direct descendants of this directory are imported by default.\n"},"port":{"$ref":"#/components/schemas/Schema_54b7efa14685483f18a4ce6218bf13b9d3acda9c88f6de43b469c7cae2b8ee42"},"public_key":{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"type":"string"}]},"queue":{"$ref":"#/components/schemas/Schema_d0a30e0594348bac539404e659baaa1896ab178c82448e3cb657bb8df8a525c4"},"recursive":{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"anyOf":[{"type":"boolean"},{"enum":["false","true"],"type":"string"}]}],"default":false,"description":"\nSetting this to `true` will enable importing files from subdirectories and sub-subdirectories (etc.) of the given path.\n"},"result":{"$ref":"#/components/schemas/Schema_e2eec9f0d3cf6892bbba08d6f0cb6582dc8dc7e3d2f71da8cbd997ad577ec0be"},"robot":{"const":"/sftp/import","description":"Identifier of the [robot](https://transloadit.com/docs/robots/) to execute","type":"string"},"user":{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"type":"string"}]},"user_meta":{"$ref":"#/components/schemas/Schema_070d50917dd042191e4290744649be38025190ee43499886e5481a7d5627241d"}},"required":["path","robot"],"type":"object"},{"additionalProperties":false,"properties":{"credentials":{"$ref":"#/components/schemas/Schema_e00528555b01ba9d12a79a7f6dd4925c61c1970776ac19f9311820ad362c38ad"},"file_chmod":{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"pattern":"([0-7]{3}|auto)","type":"string"}],"default":"auto","description":"\nThis optional parameter controls how an uploaded file's permission bits are set. You can use any string format that the `chmod` command would accept, such as `\"755\"`. If you don't specify this option, the file's permission bits aren't changed at all, meaning it's up to your server's configuration (e.g. umask).\n "},"force_accept":{"$ref":"#/components/schemas/Schema_a7b463c184f2431703a1692b1402307bb6bb726278c59f7075fd0b8d6eb2be3c"},"host":{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"type":"string"}]},"ignore_errors":{"$ref":"#/components/schemas/Schema_866196eee82a663b71c0a383fdfb2f39a777749440b227619ea17fc8101eb5f4"},"interpolate":{"$ref":"#/components/schemas/Schema_210bc4cac49d5a8403766e579b22242786bad39b0b9ff4753e56b678e29f38d4"},"output_meta":{"$ref":"#/components/schemas/Schema_60f6dcc23a68fee86135afddfdf2d63c170b886a6deb46563e7193f688ef4e6e"},"path":{"$ref":"#/components/schemas/Schema_35cf890db619e90c290459ad1bb9111a20064bbab0881cc1ebedd82c75b6e871"},"port":{"$ref":"#/components/schemas/Schema_54b7efa14685483f18a4ce6218bf13b9d3acda9c88f6de43b469c7cae2b8ee42"},"public_key":{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"type":"string"}]},"queue":{"$ref":"#/components/schemas/Schema_d0a30e0594348bac539404e659baaa1896ab178c82448e3cb657bb8df8a525c4"},"result":{"$ref":"#/components/schemas/Schema_e2eec9f0d3cf6892bbba08d6f0cb6582dc8dc7e3d2f71da8cbd997ad577ec0be"},"robot":{"const":"/sftp/store","description":"Identifier of the [robot](https://transloadit.com/docs/robots/) to execute","type":"string"},"ssl_url_template":{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"type":"string"}],"default":"https://{HOST}/{PATH}","description":"\n The SSL URL of the file in the result JSON. The following [Assembly variables](/docs/topics/assembly-instructions/#assembly-variables) are supported.\n"},"url_template":{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"type":"string"}],"default":"http://host/path","description":"\nThe URL of the file in the result JSON. This may include any of the following supported [Assembly variables](/docs/topics/assembly-instructions/#assembly-variables).\n"},"use":{"$ref":"#/components/schemas/Schema_47b2fd205d779e1de6bc4fd78c788d8393756436c48ec6f785f30dc6e16238aa"},"user":{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"type":"string"}]},"user_meta":{"$ref":"#/components/schemas/Schema_070d50917dd042191e4290744649be38025190ee43499886e5481a7d5627241d"}},"required":["robot"],"type":"object"},{"additionalProperties":false,"properties":{"force_accept":{"$ref":"#/components/schemas/Schema_a7b463c184f2431703a1692b1402307bb6bb726278c59f7075fd0b8d6eb2be3c"},"format":{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"enum":["json","meta","srt","text","webvtt"],"type":"string"}],"default":"json","description":"\nOutput format for the transcription.\n\n- `\"text\"` outputs a plain text file that you can store and process.\n- `\"json\"` outputs a JSON file containing timestamped words. When `speaker_labels` is enabled, words can include `speaker` labels and the JSON can also include grouped `segments` by speaker.\n- `\"srt\"` and `\"webvtt\"` output subtitle files of those respective file types, which can be stored separately or used in other encoding Steps.\n- `\"meta\"` does not return a file, but stores the data inside Transloadit's file object (under `${file.meta.transcription.text}`, `${file.meta.transcription.words}`, and, when speaker labels are available, `${file.meta.transcription.segments}`) that's passed around between encoding Steps, so that you can use the values to burn the data into videos, filter on them, etc.\n"},"granularity":{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"enum":["full","list"],"type":"string"}],"default":"full","description":"\nBoth `\"full\"` and `\"list\"` currently return the same complete transcription response. `\"list\"` remains accepted for backward compatibility.\n"},"ignore_errors":{"$ref":"#/components/schemas/Schema_866196eee82a663b71c0a383fdfb2f39a777749440b227619ea17fc8101eb5f4"},"interpolate":{"$ref":"#/components/schemas/Schema_210bc4cac49d5a8403766e579b22242786bad39b0b9ff4753e56b678e29f38d4"},"max_speakers":{"anyOf":[{"pattern":"^[0-9]+(\\.[0-9]+)?$","type":"string"},{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"maximum":10,"minimum":1,"type":"integer"}],"default":10,"description":"\nThe maximum number of speakers to detect when `speaker_labels` is enabled.\n"},"output_meta":{"$ref":"#/components/schemas/Schema_60f6dcc23a68fee86135afddfdf2d63c170b886a6deb46563e7193f688ef4e6e"},"provider":{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"enum":["auto","aws","gcp","replicate"],"type":"string"}],"default":"auto","description":"\nChooses the best provider based on your request.\n\nSet this to `\"aws\"`, `\"gcp\"`, or `\"replicate\"` to force a specific provider.\nWhen set to `\"auto\"`, Transloadit uses `\"replicate\"` by default and uses `\"aws\"` when\n`speaker_labels` is enabled.\n"},"queue":{"$ref":"#/components/schemas/Schema_d0a30e0594348bac539404e659baaa1896ab178c82448e3cb657bb8df8a525c4"},"result":{"$ref":"#/components/schemas/Schema_e2eec9f0d3cf6892bbba08d6f0cb6582dc8dc7e3d2f71da8cbd997ad577ec0be"},"robot":{"const":"/speech/transcribe","description":"\nYou can use the text that we return in your application, or you can pass the text down to other Robots to filter audio or video files that contain (or do not contain) certain content, or burn the text into images or video for example.\n\nAnother common use case is automatically subtitling videos, or making audio searchable.\n\nSet `speaker_labels` to `true` when you want JSON or meta transcription output to distinguish\nrecurring speakers:\n\n```json\n{\n \"steps\": {\n \"transcribed\": {\n \"use\": \":original\",\n \"robot\": \"/speech/transcribe\",\n \"provider\": \"aws\",\n \"format\": \"json\",\n \"speaker_labels\": true,\n \"max_speakers\": 3\n }\n }\n}\n```\n\nSpeaker labels are currently supported by the `aws` and `gcp` providers. If you enable\n`speaker_labels` without setting `provider`, Transloadit uses `aws` for that Step. Labels\nare normalized as `speaker_1`, `speaker_2`, and so on:\n\n```json\n{\n \"text\": \"Hello there. Hi!\",\n \"words\": [\n { \"text\": \"Hello\", \"startTime\": 0, \"endTime\": 0.5, \"speaker\": \"speaker_1\" },\n { \"text\": \"there\", \"startTime\": 0.6, \"endTime\": 1, \"speaker\": \"speaker_1\" },\n { \"text\": \"Hi!\", \"startTime\": 1.2, \"endTime\": 1.8, \"speaker\": \"speaker_2\" }\n ],\n \"segments\": [\n { \"text\": \"Hello there\", \"startTime\": 0, \"endTime\": 1, \"speaker\": \"speaker_1\" },\n { \"text\": \"Hi!\", \"startTime\": 1.2, \"endTime\": 1.8, \"speaker\": \"speaker_2\" }\n ]\n}\n```\n","type":"string"},"source_language":{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"type":"string"}],"default":"en-US","description":"\nSets the spoken language for the `\"aws\"` and `\"gcp\"` providers. The transcription stays in the spoken language; this parameter does not translate speech.\n\nThe language should be specified in the [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) format, such as `\"en-GB\"`, `\"de-DE\"` or `\"fr-FR\"`. Please also consult the list of supported languages for [the `gcp` provider](https://cloud.google.com/speech-to-text/docs/languages) and [the `aws` provider](https://docs.aws.amazon.com/transcribe/latest/dg/what-is-transcribe.html).\n"},"speaker_labels":{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"anyOf":[{"type":"boolean"},{"enum":["false","true"],"type":"string"}]}],"default":false,"description":"\nWhen enabled, Transloadit asks the transcription provider to distinguish different speakers. JSON and meta output can then include `speaker` labels such as `\"speaker_1\"` on individual words, plus grouped `segments` by speaker. Text, SRT, and WebVTT output behavior is unchanged.\n\nSpeaker labels identify recurring voices, not real person names. Accuracy depends on audio quality, background noise, overlapping speech, and the number of speakers.\n"},"target_language":{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"type":"string"}],"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"},"use":{"$ref":"#/components/schemas/Schema_47b2fd205d779e1de6bc4fd78c788d8393756436c48ec6f785f30dc6e16238aa"},"user_meta":{"$ref":"#/components/schemas/Schema_070d50917dd042191e4290744649be38025190ee43499886e5481a7d5627241d"}},"required":["robot"],"type":"object"},{"additionalProperties":false,"properties":{"bucket":{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"type":"string"}]},"bucket_region":{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"type":"string"}],"description":"\nThe region where the bucket is located.\n"},"credentials":{"$ref":"#/components/schemas/Schema_f01dfdccbdda8bceb4a464b16d4b008f08c1677f849c441face2bfbf1c91bf05"},"files_per_page":{"$ref":"#/components/schemas/Schema_fb8110ac8e46afd357588fdb3f6e0487d14ea219ff23b237b83413793ce39f30"},"force_accept":{"$ref":"#/components/schemas/Schema_a7b463c184f2431703a1692b1402307bb6bb726278c59f7075fd0b8d6eb2be3c"},"force_name":{"$ref":"#/components/schemas/Schema_e2d753e6b6111506a4565bdb18eccafd67d2027839616974639f5565d695fafd"},"host":{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"type":"string"}]},"ignore_errors":{"$ref":"#/components/schemas/Schema_03e4961eba9e9b422ce714f9224b8d47a380c80d27b8342a78ba4e2702feb4db"},"import_on_errors":{"$ref":"#/components/schemas/Schema_61808f40a326596fd9674ebbd91184b0a2e04f8c67eb49fdf9f9449580271ab8"},"interpolate":{"$ref":"#/components/schemas/Schema_210bc4cac49d5a8403766e579b22242786bad39b0b9ff4753e56b678e29f38d4"},"key":{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"type":"string"}]},"output_meta":{"$ref":"#/components/schemas/Schema_60f6dcc23a68fee86135afddfdf2d63c170b886a6deb46563e7193f688ef4e6e"},"page_number":{"$ref":"#/components/schemas/Schema_700ca6e236bc3ce29f7390532b108f5a864258e18588a743c9d63fff1d8ecf5d"},"path":{"$ref":"#/components/schemas/Schema_29b03e33e094714044bf936cf358f56ce8a49e8051c5e450b83befe9961c4ace"},"queue":{"$ref":"#/components/schemas/Schema_d0a30e0594348bac539404e659baaa1896ab178c82448e3cb657bb8df8a525c4"},"recursive":{"$ref":"#/components/schemas/Schema_8305335b6eafa6a9a8c0e5d531016c79ff3ffd63f98546b464a7fd0b9473ba0f"},"result":{"$ref":"#/components/schemas/Schema_e2eec9f0d3cf6892bbba08d6f0cb6582dc8dc7e3d2f71da8cbd997ad577ec0be"},"return_file_stubs":{"$ref":"#/components/schemas/Schema_7d0953e667a4e84601b14c25ec998d74076b0afded4b1fe7182cba7b5a1062f7"},"robot":{"const":"/supabase/import","description":"\nThe URL to the result file will be returned in the Assembly Status JSON.\n","type":"string"},"secret":{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"type":"string"}]},"user_meta":{"$ref":"#/components/schemas/Schema_070d50917dd042191e4290744649be38025190ee43499886e5481a7d5627241d"}},"required":["path","robot"],"type":"object"},{"additionalProperties":false,"properties":{"bucket":{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"type":"string"}]},"bucket_region":{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"type":"string"}],"description":"\nThe region where the bucket is located.\n"},"credentials":{"$ref":"#/components/schemas/Schema_f01dfdccbdda8bceb4a464b16d4b008f08c1677f849c441face2bfbf1c91bf05"},"force_accept":{"$ref":"#/components/schemas/Schema_a7b463c184f2431703a1692b1402307bb6bb726278c59f7075fd0b8d6eb2be3c"},"headers":{"additionalProperties":{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"type":"string"}]},"default":{"Content-Type":"${file.mime}"},"description":"\nAn object containing a list of headers to be set for this file in your Supabase Storage bucket, such as `{ FileURL: \"${file.url_name}\" }`. This can also include any available [Assembly Variables](/docs/topics/assembly-instructions/#assembly-variables).\n\nObject Metadata can be specified using `x-amz-meta-*` headers. Note that these headers [do not support non-ASCII metadata values](https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html#UserMetadata).\n","type":"object"},"host":{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"type":"string"}]},"ignore_errors":{"$ref":"#/components/schemas/Schema_866196eee82a663b71c0a383fdfb2f39a777749440b227619ea17fc8101eb5f4"},"interpolate":{"$ref":"#/components/schemas/Schema_210bc4cac49d5a8403766e579b22242786bad39b0b9ff4753e56b678e29f38d4"},"key":{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"type":"string"}]},"output_meta":{"$ref":"#/components/schemas/Schema_60f6dcc23a68fee86135afddfdf2d63c170b886a6deb46563e7193f688ef4e6e"},"path":{"$ref":"#/components/schemas/Schema_9e32d2e043ddaf27be258da25a42fb43c4a65680e4582d53c4c0e1d0b76908cf"},"queue":{"$ref":"#/components/schemas/Schema_d0a30e0594348bac539404e659baaa1896ab178c82448e3cb657bb8df8a525c4"},"result":{"$ref":"#/components/schemas/Schema_e2eec9f0d3cf6892bbba08d6f0cb6582dc8dc7e3d2f71da8cbd997ad577ec0be"},"robot":{"const":"/supabase/store","description":"Identifier of the [robot](https://transloadit.com/docs/robots/) to execute","type":"string"},"secret":{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"type":"string"}]},"use":{"$ref":"#/components/schemas/Schema_47b2fd205d779e1de6bc4fd78c788d8393756436c48ec6f785f30dc6e16238aa"},"user_meta":{"$ref":"#/components/schemas/Schema_070d50917dd042191e4290744649be38025190ee43499886e5481a7d5627241d"}},"required":["robot"],"type":"object"},{"additionalProperties":false,"properties":{"bucket":{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"type":"string"}]},"credentials":{"$ref":"#/components/schemas/Schema_479ba1b1c1b9832d49a7c2bed1726873de44fbe0e6095d87466df559303afcf5"},"files_per_page":{"$ref":"#/components/schemas/Schema_fb8110ac8e46afd357588fdb3f6e0487d14ea219ff23b237b83413793ce39f30"},"force_accept":{"$ref":"#/components/schemas/Schema_a7b463c184f2431703a1692b1402307bb6bb726278c59f7075fd0b8d6eb2be3c"},"force_name":{"$ref":"#/components/schemas/Schema_e2d753e6b6111506a4565bdb18eccafd67d2027839616974639f5565d695fafd"},"host":{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"type":"string"}],"description":"\nThe S3-compatible object storage endpoint for the OpenStack Swift service. This is required when supplying dynamic credentials directly instead of using Template Credentials.\n"},"ignore_errors":{"$ref":"#/components/schemas/Schema_03e4961eba9e9b422ce714f9224b8d47a380c80d27b8342a78ba4e2702feb4db"},"import_on_errors":{"$ref":"#/components/schemas/Schema_61808f40a326596fd9674ebbd91184b0a2e04f8c67eb49fdf9f9449580271ab8"},"interpolate":{"$ref":"#/components/schemas/Schema_210bc4cac49d5a8403766e579b22242786bad39b0b9ff4753e56b678e29f38d4"},"key":{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"type":"string"}]},"output_meta":{"$ref":"#/components/schemas/Schema_60f6dcc23a68fee86135afddfdf2d63c170b886a6deb46563e7193f688ef4e6e"},"page_number":{"$ref":"#/components/schemas/Schema_700ca6e236bc3ce29f7390532b108f5a864258e18588a743c9d63fff1d8ecf5d"},"path":{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"type":"string"}]},{"$ref":"#/components/schemas/Schema_bc9fbfc32e2939087e1b877c2b51ce63f08c8cdfdcf7adca01505a0498ab5691"}],"description":"\nThe path in your container to the specific file or directory. If the path points to a file, only this file will be imported. For example: `images/avatar.jpg`.\n\nIf it points to a directory, indicated by a trailing slash (`/`), then all files that are direct descendants of this directory will be imported. For example: `images/`.\n\nDirectories are **not** imported recursively. If you want to import files from subdirectories and sub-subdirectories, enable the `recursive` parameter.\n\nIf you want to import all files from the root directory, please use `/` as the value here. In this case, make sure all your objects belong to a path. If you have objects in the root of your container that aren't prefixed with `/`, you'll receive an error: `A client error (NoSuchKey) occurred when calling the GetObject operation: The specified key does not exist.`\n\nYou can also use an array of path strings here to import multiple paths in the same Robot's Step.\n"},"queue":{"$ref":"#/components/schemas/Schema_d0a30e0594348bac539404e659baaa1896ab178c82448e3cb657bb8df8a525c4"},"recursive":{"$ref":"#/components/schemas/Schema_2a04346246228d68b23baff4fd26615a3dabf4b0b635cea5e60d9c76cd4a0543"},"result":{"$ref":"#/components/schemas/Schema_e2eec9f0d3cf6892bbba08d6f0cb6582dc8dc7e3d2f71da8cbd997ad577ec0be"},"return_file_stubs":{"$ref":"#/components/schemas/Schema_7d0953e667a4e84601b14c25ec998d74076b0afded4b1fe7182cba7b5a1062f7"},"robot":{"const":"/swift/import","description":"Identifier of the [robot](https://transloadit.com/docs/robots/) to execute","type":"string"},"secret":{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"type":"string"}]},"user_meta":{"$ref":"#/components/schemas/Schema_070d50917dd042191e4290744649be38025190ee43499886e5481a7d5627241d"}},"required":["path","robot"],"type":"object"},{"additionalProperties":false,"properties":{"acl":{"$ref":"#/components/schemas/Schema_6f76a4b1c0011fc02a130479c0a33b50ca4ff841292c0a355755296647ce796a"},"bucket":{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"type":"string"}]},"credentials":{"$ref":"#/components/schemas/Schema_479ba1b1c1b9832d49a7c2bed1726873de44fbe0e6095d87466df559303afcf5"},"force_accept":{"$ref":"#/components/schemas/Schema_a7b463c184f2431703a1692b1402307bb6bb726278c59f7075fd0b8d6eb2be3c"},"headers":{"additionalProperties":{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"type":"string"}]},"default":{"Content-Type":"${file.mime}"},"description":"\nAn object containing a list of headers to be set for this file in your OpenStack Swift container, such as `{ FileURL: \"${file.url_name}\" }`. This can also include any available [Assembly Variables](/docs/topics/assembly-instructions/#assembly-variables).\n\nObject Metadata can be specified using `x-amz-meta-*` headers. Note that these headers [do not support non-ASCII metadata values](https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html#UserMetadata).\n","type":"object"},"host":{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"type":"string"}],"description":"\nThe S3-compatible object storage endpoint for the OpenStack Swift service. This is required when supplying dynamic credentials directly instead of using Template Credentials.\n"},"ignore_errors":{"$ref":"#/components/schemas/Schema_866196eee82a663b71c0a383fdfb2f39a777749440b227619ea17fc8101eb5f4"},"interpolate":{"$ref":"#/components/schemas/Schema_210bc4cac49d5a8403766e579b22242786bad39b0b9ff4753e56b678e29f38d4"},"key":{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"type":"string"}]},"output_meta":{"$ref":"#/components/schemas/Schema_60f6dcc23a68fee86135afddfdf2d63c170b886a6deb46563e7193f688ef4e6e"},"path":{"$ref":"#/components/schemas/Schema_9e32d2e043ddaf27be258da25a42fb43c4a65680e4582d53c4c0e1d0b76908cf"},"queue":{"$ref":"#/components/schemas/Schema_d0a30e0594348bac539404e659baaa1896ab178c82448e3cb657bb8df8a525c4"},"result":{"$ref":"#/components/schemas/Schema_e2eec9f0d3cf6892bbba08d6f0cb6582dc8dc7e3d2f71da8cbd997ad577ec0be"},"robot":{"const":"/swift/store","description":"\nThe URL to the result file in your OpenStack Swift container will be returned in the Assembly Status JSON.","type":"string"},"secret":{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"type":"string"}]},"sign_urls_for":{"$ref":"#/components/schemas/Schema_6561742ad8531818ad835d63fdd348612b329189814a3953875b261e98fcb035"},"use":{"$ref":"#/components/schemas/Schema_47b2fd205d779e1de6bc4fd78c788d8393756436c48ec6f785f30dc6e16238aa"},"user_meta":{"$ref":"#/components/schemas/Schema_070d50917dd042191e4290744649be38025190ee43499886e5481a7d5627241d"}},"required":["robot"],"type":"object"},{"additionalProperties":false,"properties":{"force_accept":{"$ref":"#/components/schemas/Schema_a7b463c184f2431703a1692b1402307bb6bb726278c59f7075fd0b8d6eb2be3c"},"ignore_errors":{"$ref":"#/components/schemas/Schema_866196eee82a663b71c0a383fdfb2f39a777749440b227619ea17fc8101eb5f4"},"interpolate":{"$ref":"#/components/schemas/Schema_210bc4cac49d5a8403766e579b22242786bad39b0b9ff4753e56b678e29f38d4"},"output_meta":{"$ref":"#/components/schemas/Schema_60f6dcc23a68fee86135afddfdf2d63c170b886a6deb46563e7193f688ef4e6e"},"prompt":{"anyOf":[{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"type":"string"}]},{"type":"null"}],"description":"\nWhich text to speak. You can also set this to `null` and supply an input text file.\n"},"provider":{"$ref":"#/components/schemas/Schema_ca72aa2ec7c776cc9d7892a1460fd032ef5b94b1d7c9ffa090d548e7d5360c4e"},"queue":{"$ref":"#/components/schemas/Schema_d0a30e0594348bac539404e659baaa1896ab178c82448e3cb657bb8df8a525c4"},"result":{"$ref":"#/components/schemas/Schema_e2eec9f0d3cf6892bbba08d6f0cb6582dc8dc7e3d2f71da8cbd997ad577ec0be"},"robot":{"const":"/text/speak","description":"\nYou can use the audio that we return in your application, or you can pass the audio down to other Robots to add a voice track to a video for example.\n\nAnother common use case is making your product accessible to people with a reading disability.\n","type":"string"},"ssml":{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"anyOf":[{"type":"boolean"},{"enum":["false","true"],"type":"string"}]}],"default":false,"description":"\nSupply [Speech Synthesis Markup Language](https://en.wikipedia.org/wiki/Speech_Synthesis_Markup_Language) instead of raw text, in order to gain more control over how your text is voiced, including rests and pronounciations.\n\nPlease see the supported syntaxes for [AWS](https://docs.aws.amazon.com/polly/latest/dg/supportedtags.html) and [GCP](https://cloud.google.com/text-to-speech/docs/ssml).\n"},"target_language":{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"type":"string"}],"default":"en-US","description":"\nThe written language of the document. This will also be the language of the spoken text.\n\nThe language should be specified in the [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) format, such as `\"en-GB\"`, `\"de-DE\"` or `\"fr-FR\"`. Please consult the list of supported languages and voices.\n"},"use":{"$ref":"#/components/schemas/Schema_47b2fd205d779e1de6bc4fd78c788d8393756436c48ec6f785f30dc6e16238aa"},"user_meta":{"$ref":"#/components/schemas/Schema_070d50917dd042191e4290744649be38025190ee43499886e5481a7d5627241d"},"voice":{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"enum":["female-1","female-2","female-3","female-child-1","male-1","male-child-1"],"type":"string"}],"default":"female-1","description":"\nThe gender to be used for voice synthesis. Please consult the list of supported languages and voices.\n"}},"required":["robot"],"type":"object"},{"additionalProperties":false,"properties":{"force_accept":{"$ref":"#/components/schemas/Schema_a7b463c184f2431703a1692b1402307bb6bb726278c59f7075fd0b8d6eb2be3c"},"ignore_errors":{"$ref":"#/components/schemas/Schema_866196eee82a663b71c0a383fdfb2f39a777749440b227619ea17fc8101eb5f4"},"interpolate":{"$ref":"#/components/schemas/Schema_210bc4cac49d5a8403766e579b22242786bad39b0b9ff4753e56b678e29f38d4"},"output_meta":{"$ref":"#/components/schemas/Schema_60f6dcc23a68fee86135afddfdf2d63c170b886a6deb46563e7193f688ef4e6e"},"provider":{"$ref":"#/components/schemas/Schema_ca72aa2ec7c776cc9d7892a1460fd032ef5b94b1d7c9ffa090d548e7d5360c4e"},"queue":{"$ref":"#/components/schemas/Schema_d0a30e0594348bac539404e659baaa1896ab178c82448e3cb657bb8df8a525c4"},"result":{"$ref":"#/components/schemas/Schema_e2eec9f0d3cf6892bbba08d6f0cb6582dc8dc7e3d2f71da8cbd997ad577ec0be"},"robot":{"const":"/text/translate","description":"\nYou can use the text that we return in your application, or you can pass the text down to other Robots to add a translated subtitle track to a video for example.\n\n> [!Note]\n> **This Robot accepts only files with a `text/*` MIME-type,** including plain text and Markdown. For documents in other formats, use [🤖/document/convert](/docs/robots/document-convert/) to first convert them into a compatible text format before proceeding.\n","type":"string"},"source_language":{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"$ref":"#/components/schemas/Schema_48846cc3bf660fc66a1844289636009a40a68d2eae08d688bd0eaf2c75be7433"}],"default":"en","description":"\nThe desired language to translate from.\n\nBy default, both providers will detect this automatically, but there are cases where specifying the source language prevents ambiguities.\n\nIf the exact language can't be found, a generic variant can be fallen back to. For example, if you specify `\"en-US\"`, \"en\" will be used instead. Please consult the list of supported languages for each provider.\n"},"target_language":{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"$ref":"#/components/schemas/Schema_48846cc3bf660fc66a1844289636009a40a68d2eae08d688bd0eaf2c75be7433"}],"default":"en","description":"\nThe desired language to translate to.\n\nIf the exact language can't be found, a generic variant can be fallen back to. For example, if you specify `\"en-US\"`, \"en\" will be used instead. Please consult the list of supported languages for each provider.\n"},"use":{"$ref":"#/components/schemas/Schema_47b2fd205d779e1de6bc4fd78c788d8393756436c48ec6f785f30dc6e16238aa"},"user_meta":{"$ref":"#/components/schemas/Schema_070d50917dd042191e4290744649be38025190ee43499886e5481a7d5627241d"}},"required":["robot"],"type":"object"},{"additionalProperties":false,"properties":{"credentials":{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"type":"string"}]},{"$ref":"#/components/schemas/Schema_bc9fbfc32e2939087e1b877c2b51ce63f08c8cdfdcf7adca01505a0498ab5691"}],"description":"Names of template credentials to make available to the robot. When using your own AI provider keys, Transloadit charges a 30% markup (minimum $0.0005 per request)."},"force_accept":{"$ref":"#/components/schemas/Schema_a7b463c184f2431703a1692b1402307bb6bb726278c59f7075fd0b8d6eb2be3c"},"format":{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"enum":["json","meta","text"],"type":"string"}],"default":"json"},"ignore_errors":{"$ref":"#/components/schemas/Schema_866196eee82a663b71c0a383fdfb2f39a777749440b227619ea17fc8101eb5f4"},"interpolate":{"$ref":"#/components/schemas/Schema_210bc4cac49d5a8403766e579b22242786bad39b0b9ff4753e56b678e29f38d4"},"mcp_servers":{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"items":{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"additionalProperties":true,"properties":{"allowed_tools":{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"items":{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"type":"string"}]},"type":"array"}],"description":"Optional allowlist of tool names to expose from this MCP server. If omitted, all tools exposed by the server are available to the model."},"auth":{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"enum":["transloadit"],"type":"string"}]},"headers":{"additionalProperties":{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"type":"string"}]},"type":"object"},"type":{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"enum":["http","sse"],"type":"string"}]},"url":{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"type":"string"}]}},"required":["type","url"],"type":"object"}]},"type":"array"}],"description":"The MCP servers to use for tool calling. You can use any MCP server reachable from your environment. Use `headers` to pass server-specific auth (for example `Authorization: Bearer `). For Transloadit's MCP server: Bearer tokens minted via `/token` satisfy Signature Authentication (signature checks apply only to key/secret requests). `auth: \"transloadit\"` is reserved for API2-managed auth to Transloadit-hosted MCP servers."},"messages":{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"type":"string"}]},{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"items":{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"anyOf":[{"anyOf":[{"additionalProperties":true,"properties":{"content":{"type":"string"},"experimental_providerMetadata":{},"providerOptions":{"$ref":"#/components/schemas/Schema_b04b5b7b31379eeb62ed83ac96b9f63cee596ead79111fef3fb0b0c9c5daf236"},"role":{"const":"system","type":"string"}},"required":["content","providerOptions","role"],"type":"object"},{"additionalProperties":true,"properties":{"content":{"type":"string"},"experimental_providerMetadata":{"$ref":"#/components/schemas/Schema_b04b5b7b31379eeb62ed83ac96b9f63cee596ead79111fef3fb0b0c9c5daf236"},"providerOptions":{"not":{}},"role":{"const":"system","type":"string"}},"required":["content","role"],"type":"object"},{"additionalProperties":true,"properties":{"content":{"type":"string"},"experimental_providerMetadata":{"$ref":"#/components/schemas/Schema_b04b5b7b31379eeb62ed83ac96b9f63cee596ead79111fef3fb0b0c9c5daf236"},"providerOptions":{"type":"null"},"role":{"const":"system","type":"string"}},"required":["content","providerOptions","role"],"type":"object"}]},{"anyOf":[{"additionalProperties":true,"properties":{"content":{"$ref":"#/components/schemas/Schema_31383ce8a17e7fd91b6ce6f73c717c5f1cc2566572a021956e9d19d8adcce115"},"experimental_providerMetadata":{},"providerOptions":{"$ref":"#/components/schemas/Schema_b04b5b7b31379eeb62ed83ac96b9f63cee596ead79111fef3fb0b0c9c5daf236"},"role":{"const":"user","type":"string"}},"required":["content","providerOptions","role"],"type":"object"},{"additionalProperties":true,"properties":{"content":{"$ref":"#/components/schemas/Schema_31383ce8a17e7fd91b6ce6f73c717c5f1cc2566572a021956e9d19d8adcce115"},"experimental_providerMetadata":{"$ref":"#/components/schemas/Schema_b04b5b7b31379eeb62ed83ac96b9f63cee596ead79111fef3fb0b0c9c5daf236"},"providerOptions":{"not":{}},"role":{"const":"user","type":"string"}},"required":["content","role"],"type":"object"},{"additionalProperties":true,"properties":{"content":{"$ref":"#/components/schemas/Schema_31383ce8a17e7fd91b6ce6f73c717c5f1cc2566572a021956e9d19d8adcce115"},"experimental_providerMetadata":{"$ref":"#/components/schemas/Schema_b04b5b7b31379eeb62ed83ac96b9f63cee596ead79111fef3fb0b0c9c5daf236"},"providerOptions":{"type":"null"},"role":{"const":"user","type":"string"}},"required":["content","providerOptions","role"],"type":"object"}]},{"anyOf":[{"additionalProperties":true,"properties":{"content":{"$ref":"#/components/schemas/Schema_7dc4ae103441fca5fb76bc40a593999f65fb8afc1061010fdd2e79963d8703f6"},"experimental_providerMetadata":{},"providerOptions":{"$ref":"#/components/schemas/Schema_b04b5b7b31379eeb62ed83ac96b9f63cee596ead79111fef3fb0b0c9c5daf236"},"role":{"const":"assistant","type":"string"}},"required":["content","providerOptions","role"],"type":"object"},{"additionalProperties":true,"properties":{"content":{"$ref":"#/components/schemas/Schema_7dc4ae103441fca5fb76bc40a593999f65fb8afc1061010fdd2e79963d8703f6"},"experimental_providerMetadata":{"$ref":"#/components/schemas/Schema_b04b5b7b31379eeb62ed83ac96b9f63cee596ead79111fef3fb0b0c9c5daf236"},"providerOptions":{"not":{}},"role":{"const":"assistant","type":"string"}},"required":["content","role"],"type":"object"},{"additionalProperties":true,"properties":{"content":{"$ref":"#/components/schemas/Schema_7dc4ae103441fca5fb76bc40a593999f65fb8afc1061010fdd2e79963d8703f6"},"experimental_providerMetadata":{"$ref":"#/components/schemas/Schema_b04b5b7b31379eeb62ed83ac96b9f63cee596ead79111fef3fb0b0c9c5daf236"},"providerOptions":{"type":"null"},"role":{"const":"assistant","type":"string"}},"required":["content","providerOptions","role"],"type":"object"}]},{"anyOf":[{"additionalProperties":true,"properties":{"content":{"$ref":"#/components/schemas/Schema_fabb2852b06e3649616f400bfad1a559c443979f014f42891783fee36fb0847b"},"experimental_providerMetadata":{},"providerOptions":{"$ref":"#/components/schemas/Schema_b04b5b7b31379eeb62ed83ac96b9f63cee596ead79111fef3fb0b0c9c5daf236"},"role":{"const":"tool","type":"string"}},"required":["content","providerOptions","role"],"type":"object"},{"additionalProperties":true,"properties":{"content":{"$ref":"#/components/schemas/Schema_fabb2852b06e3649616f400bfad1a559c443979f014f42891783fee36fb0847b"},"experimental_providerMetadata":{"$ref":"#/components/schemas/Schema_b04b5b7b31379eeb62ed83ac96b9f63cee596ead79111fef3fb0b0c9c5daf236"},"providerOptions":{"not":{}},"role":{"const":"tool","type":"string"}},"required":["content","role"],"type":"object"},{"additionalProperties":true,"properties":{"content":{"$ref":"#/components/schemas/Schema_fabb2852b06e3649616f400bfad1a559c443979f014f42891783fee36fb0847b"},"experimental_providerMetadata":{"$ref":"#/components/schemas/Schema_b04b5b7b31379eeb62ed83ac96b9f63cee596ead79111fef3fb0b0c9c5daf236"},"providerOptions":{"type":"null"},"role":{"const":"tool","type":"string"}},"required":["content","providerOptions","role"],"type":"object"}]}]}]},"type":"array"}]}],"description":"The prompt, or message history to send to the LLM."},"model":{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"enum":["anthropic/claude-4-opus-20250514","anthropic/claude-4-sonnet-20250514","anthropic/claude-fable-5","anthropic/claude-fable-5-1","anthropic/claude-opus-4-20250514","anthropic/claude-opus-4-5","anthropic/claude-opus-4-6","anthropic/claude-opus-4-7","anthropic/claude-opus-4-8","anthropic/claude-opus-5","anthropic/claude-opus-5-5","anthropic/claude-sonnet-4-20250514","anthropic/claude-sonnet-4-5","anthropic/claude-sonnet-4-6","anthropic/claude-sonnet-5","anthropic/claude-sonnet-5-5","google/gemini-2.5-pro","moonshot/kimi-k2","openai/chatgpt-4o-latest","openai/gpt-4.1-2025-04-14","openai/gpt-4o-audio-preview","openai/gpt-5.2","openai/gpt-5.2-2025-12-11","openai/gpt-5.2-chat-latest","openai/gpt-5.2-pro","openai/gpt-5.4","openai/gpt-5.4-mini","openai/gpt-5.4-nano","openai/gpt-5.5","openai/gpt-5.6-sol","openai/gpt-6-astra","openai/gpt-6.1-sol","openai/gpt-audio","openai/gpt-audio-2025-08-28","openai/o3-2025-04-16"],"type":"string"}]},{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"const":"auto","type":"string"}]}],"default":"auto","description":"The model to use. Transloadit can pick the best model for the job if you set this to \"auto\"."},"output_meta":{"$ref":"#/components/schemas/Schema_60f6dcc23a68fee86135afddfdf2d63c170b886a6deb46563e7193f688ef4e6e"},"queue":{"$ref":"#/components/schemas/Schema_d0a30e0594348bac539404e659baaa1896ab178c82448e3cb657bb8df8a525c4"},"reasoning_effort":{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"enum":["high","low","medium","xhigh"],"type":"string"}],"description":"Controls how much effort the model spends on reasoning. Higher values produce more thorough responses but cost more tokens. Applies to models that support extended thinking (OpenAI o-series, GPT-5.x, GPT-6, Anthropic Claude with thinking). If omitted, the model default is used."},"result":{"$ref":"#/components/schemas/Schema_e2eec9f0d3cf6892bbba08d6f0cb6582dc8dc7e3d2f71da8cbd997ad577ec0be"},"return_messages":{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"enum":["all","last"],"type":"string"}],"default":"last"},"robot":{"const":"/ai/chat","description":"## Analyze files with an LLM\n\nConnect an input Step explicitly with `use`. Text files are read into the conversation automatically. PDFs require a PDF-capable model; PNG and JPEG inputs require an image-capable model. Convert other document formats to PDF first, and transcribe audio or video to text before using the recording workflows. Provider capabilities alone do not establish support through this Robot.\n\nFor OCR or transcription pipelines, choose `format: \"text\"` on the upstream Step, then reference that Step with `use` on `/ai/chat`. You do not need to interpolate the file contents into `messages`.\n\nThe `schema` parameter must be a **string containing JSON Schema**, not an inline object. Use `format: \"json\"` with a serialized schema for structured fields, or `format: \"text\"` for an answer file. Set `result: true` to expose that file in Assembly Status and download its `ssl_url` to read the answer. Result URLs are temporary; add an export Step for durable storage.\n\nSupply a matching AI provider Template Credential with `credentials`, or use billed `test_credentials: true` for testing. These are separate from Transloadit request authentication. The example below uses a Template Credential named `my_anthropic_credentials` and exposes its JSON file with `result: true`. `model: \"auto\"` resolves to a configured default; select an explicitly supported PDF-capable model when passing a PDF.\n\nStart with the [complete file-processing examples](/guides/ai-file-processing-workflows/) for invoice JSON, PDF questions, recording summaries, and image descriptions. For a longer invoice application walkthrough, see the [document intelligence pipeline](/blog/2026/01/ai-document-intelligence-pipeline/).","type":"string"},"schema":{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"type":"string"}],"description":"The JSON Schema that the LLM should output"},"system_message":{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"type":"string"}],"description":"Set the system/developer prompt, if the model allows it. If this prompt contains literal documentation or code examples with `${...}` syntax, set `interpolate.system_message` to `false`."},"test_credentials":{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"anyOf":[{"type":"boolean"},{"enum":["false","true"],"type":"string"}]}],"description":"Use Transloadit-provided credentials for testing. Usage is billed at provider cost plus a 30% markup (minimum $0.0005 per request)."},"use":{"$ref":"#/components/schemas/Schema_47b2fd205d779e1de6bc4fd78c788d8393756436c48ec6f785f30dc6e16238aa"},"user_meta":{"$ref":"#/components/schemas/Schema_070d50917dd042191e4290744649be38025190ee43499886e5481a7d5627241d"}},"required":["messages","robot"],"type":"object"},{"additionalProperties":false,"properties":{"bucket":{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"type":"string"}]},"bucket_region":{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"type":"string"}],"description":"The region of your Tigris bucket. This is optional as it can often be derived."},"credentials":{"$ref":"#/components/schemas/Schema_da4b2552b052756e5ae8eeb99dbf1e091e37dde4c980cbfaf0851697963fe691"},"files_per_page":{"$ref":"#/components/schemas/Schema_fb8110ac8e46afd357588fdb3f6e0487d14ea219ff23b237b83413793ce39f30"},"force_accept":{"$ref":"#/components/schemas/Schema_a7b463c184f2431703a1692b1402307bb6bb726278c59f7075fd0b8d6eb2be3c"},"force_name":{"$ref":"#/components/schemas/Schema_e2d753e6b6111506a4565bdb18eccafd67d2027839616974639f5565d695fafd"},"host":{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"type":"string"}]},"ignore_errors":{"$ref":"#/components/schemas/Schema_03e4961eba9e9b422ce714f9224b8d47a380c80d27b8342a78ba4e2702feb4db"},"import_on_errors":{"$ref":"#/components/schemas/Schema_61808f40a326596fd9674ebbd91184b0a2e04f8c67eb49fdf9f9449580271ab8"},"interpolate":{"$ref":"#/components/schemas/Schema_210bc4cac49d5a8403766e579b22242786bad39b0b9ff4753e56b678e29f38d4"},"key":{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"type":"string"}]},"output_meta":{"$ref":"#/components/schemas/Schema_60f6dcc23a68fee86135afddfdf2d63c170b886a6deb46563e7193f688ef4e6e"},"page_number":{"$ref":"#/components/schemas/Schema_700ca6e236bc3ce29f7390532b108f5a864258e18588a743c9d63fff1d8ecf5d"},"path":{"$ref":"#/components/schemas/Schema_29b03e33e094714044bf936cf358f56ce8a49e8051c5e450b83befe9961c4ace"},"queue":{"$ref":"#/components/schemas/Schema_d0a30e0594348bac539404e659baaa1896ab178c82448e3cb657bb8df8a525c4"},"recursive":{"$ref":"#/components/schemas/Schema_2a04346246228d68b23baff4fd26615a3dabf4b0b635cea5e60d9c76cd4a0543"},"result":{"$ref":"#/components/schemas/Schema_e2eec9f0d3cf6892bbba08d6f0cb6582dc8dc7e3d2f71da8cbd997ad577ec0be"},"return_file_stubs":{"$ref":"#/components/schemas/Schema_7d0953e667a4e84601b14c25ec998d74076b0afded4b1fe7182cba7b5a1062f7"},"robot":{"const":"/tigris/import","description":"Identifier of the [robot](https://transloadit.com/docs/robots/) to execute","type":"string"},"secret":{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"type":"string"}]},"user_meta":{"$ref":"#/components/schemas/Schema_070d50917dd042191e4290744649be38025190ee43499886e5481a7d5627241d"}},"required":["path","robot"],"type":"object"},{"additionalProperties":false,"properties":{"acl":{"$ref":"#/components/schemas/Schema_6f76a4b1c0011fc02a130479c0a33b50ca4ff841292c0a355755296647ce796a"},"bucket":{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"type":"string"}]},"bucket_region":{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"type":"string"}],"description":"The region of your Tigris bucket. This is optional as it can often be derived."},"credentials":{"$ref":"#/components/schemas/Schema_da4b2552b052756e5ae8eeb99dbf1e091e37dde4c980cbfaf0851697963fe691"},"force_accept":{"$ref":"#/components/schemas/Schema_a7b463c184f2431703a1692b1402307bb6bb726278c59f7075fd0b8d6eb2be3c"},"headers":{"additionalProperties":{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"type":"string"}]},"default":{"Content-Type":"${file.mime}"},"description":"\nAn object containing a list of headers to be set for this file on Tigris, such as `{ FileURL: \"${file.url_name}\" }`. This can also include any available [Assembly Variables](/docs/topics/assembly-instructions/#assembly-variables).\n\nObject Metadata can be specified using `x-amz-meta-*` headers. Note that these headers [do not support non-ASCII metadata values](https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html#UserMetadata).\n","type":"object"},"host":{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"type":"string"}]},"ignore_errors":{"$ref":"#/components/schemas/Schema_866196eee82a663b71c0a383fdfb2f39a777749440b227619ea17fc8101eb5f4"},"interpolate":{"$ref":"#/components/schemas/Schema_210bc4cac49d5a8403766e579b22242786bad39b0b9ff4753e56b678e29f38d4"},"key":{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"type":"string"}]},"output_meta":{"$ref":"#/components/schemas/Schema_60f6dcc23a68fee86135afddfdf2d63c170b886a6deb46563e7193f688ef4e6e"},"path":{"$ref":"#/components/schemas/Schema_9e32d2e043ddaf27be258da25a42fb43c4a65680e4582d53c4c0e1d0b76908cf"},"queue":{"$ref":"#/components/schemas/Schema_d0a30e0594348bac539404e659baaa1896ab178c82448e3cb657bb8df8a525c4"},"result":{"$ref":"#/components/schemas/Schema_e2eec9f0d3cf6892bbba08d6f0cb6582dc8dc7e3d2f71da8cbd997ad577ec0be"},"robot":{"const":"/tigris/store","description":"\nThe URL to the result file will be returned in the Assembly Status JSON.\n","type":"string"},"secret":{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"type":"string"}]},"sign_urls_for":{"$ref":"#/components/schemas/Schema_f9f059c6ff209141973277001e2fe4648f4c807fbffff7d8ff70e590dae4b4ad"},"use":{"$ref":"#/components/schemas/Schema_47b2fd205d779e1de6bc4fd78c788d8393756436c48ec6f785f30dc6e16238aa"},"user_meta":{"$ref":"#/components/schemas/Schema_070d50917dd042191e4290744649be38025190ee43499886e5481a7d5627241d"}},"required":["robot"],"type":"object"},{"additionalProperties":false,"properties":{"enable_hipaa_compliance":{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"anyOf":[{"type":"boolean"},{"enum":["false","true"],"type":"string"}]}],"default":false,"description":"When enabled, use the HIPAA-compliant Smart CDN pricing profile for this delivery step (20% lower price factor). When disabled, the non-HIPAA baseline price factor applies."},"force_accept":{"$ref":"#/components/schemas/Schema_a7b463c184f2431703a1692b1402307bb6bb726278c59f7075fd0b8d6eb2be3c"},"ignore_errors":{"$ref":"#/components/schemas/Schema_866196eee82a663b71c0a383fdfb2f39a777749440b227619ea17fc8101eb5f4"},"interpolate":{"$ref":"#/components/schemas/Schema_210bc4cac49d5a8403766e579b22242786bad39b0b9ff4753e56b678e29f38d4"},"output_meta":{"$ref":"#/components/schemas/Schema_60f6dcc23a68fee86135afddfdf2d63c170b886a6deb46563e7193f688ef4e6e"},"queue":{"$ref":"#/components/schemas/Schema_d0a30e0594348bac539404e659baaa1896ab178c82448e3cb657bb8df8a525c4"},"result":{"$ref":"#/components/schemas/Schema_e2eec9f0d3cf6892bbba08d6f0cb6582dc8dc7e3d2f71da8cbd997ad577ec0be"},"robot":{"const":"/tlcdn/deliver","description":"\nWhen you want Transloadit to transform files on the fly, this Robot can cache and deliver the results close to your end-user, saving on latency and encoding volume. The use of this Robot is implicit when you use the tlcdn.com domain.\n","type":"string"},"user_meta":{"$ref":"#/components/schemas/Schema_070d50917dd042191e4290744649be38025190ee43499886e5481a7d5627241d"}},"required":["robot"],"type":"object"},{"additionalProperties":false,"properties":{"conflict_strategy":{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"enum":["error","overwrite","rename"],"type":"string"}],"default":"error","description":"\nChooses how to handle an existing destination. By default, an occupied path fails. Select\n`rename` to allocate a different filename, or `overwrite` to create a new version of the\nexisting asset. Always save the returned asset identity, version and final path.\n"},"force_accept":{"$ref":"#/components/schemas/Schema_a7b463c184f2431703a1692b1402307bb6bb726278c59f7075fd0b8d6eb2be3c"},"ignore_errors":{"$ref":"#/components/schemas/Schema_866196eee82a663b71c0a383fdfb2f39a777749440b227619ea17fc8101eb5f4"},"interpolate":{"$ref":"#/components/schemas/Schema_210bc4cac49d5a8403766e579b22242786bad39b0b9ff4753e56b678e29f38d4"},"output_meta":{"$ref":"#/components/schemas/Schema_60f6dcc23a68fee86135afddfdf2d63c170b886a6deb46563e7193f688ef4e6e"},"path":{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"type":"string"}],"default":"${file.url_name}","description":"\nSets the destination path inside your Transloadit Storage workspace, relative to its root: a\nfilename, or folders and a filename such as `website/hero.jpg`. Folders that do not exist yet\nare created.\n"},"queue":{"$ref":"#/components/schemas/Schema_d0a30e0594348bac539404e659baaa1896ab178c82448e3cb657bb8df8a525c4"},"result":{"$ref":"#/components/schemas/Schema_e2eec9f0d3cf6892bbba08d6f0cb6582dc8dc7e3d2f71da8cbd997ad577ec0be"},"robot":{"const":"/transloadit/store","description":"\nStores each input privately in Transloadit Storage.\n\nAfter `ASSEMBLY_COMPLETED`, save the stored result from `results[producingStep][i]` with\nyour application's owner or project record. Keep its `workspace`, `asset_id`, `version_id` and returned `path`.\nA Step storing `:original` reports in `results[':original']`.\n\nCollisions fail by default; explicit renaming can change the final path. Use the asset and version\nIDs with 🤖/transloadit/import to reuse exact retained bytes after a native catalog rename or overwrite.\nA path selects the current location; an asset ID without a version selects its current bytes.\nDeleting an asset or removing a retained version makes that reference unavailable.\n","type":"string"},"use":{"$ref":"#/components/schemas/Schema_47b2fd205d779e1de6bc4fd78c788d8393756436c48ec6f785f30dc6e16238aa"},"user_meta":{"$ref":"#/components/schemas/Schema_070d50917dd042191e4290744649be38025190ee43499886e5481a7d5627241d"}},"required":["robot"],"type":"object"},{"additionalProperties":false,"properties":{"credentials":{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"type":"string"}],"description":"\nCreate Template Credentials for this Robot in your [Transloadit account](/c/template-credentials/) and use the name of the Template Credentials as this parameter's value. For this Robot, use the HTTP template, which allows request headers to be passed along to the destination server.\n"},"endpoint":{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"description":"\nThe URL of the Tus-compatible server, which you're uploading files to.\n","pattern":"^[Hh][Tt][Tt][Pp][Ss]?:\\/\\/(?:[^ ]|[ ])","type":"string","x-transloadit-input-fidelity":"conservative"}],"description":"\nThe URL of the Tus-compatible server, which you're uploading files to.\n"},"force_accept":{"$ref":"#/components/schemas/Schema_a7b463c184f2431703a1692b1402307bb6bb726278c59f7075fd0b8d6eb2be3c"},"headers":{"additionalProperties":{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"type":"string"}]},"default":{},"description":"\nOptional extra headers outside of the Template Credentials can be passed along within this parameter.\n\nAlthough, we recommend to exclusively use Template Credentials, this may be necessary if you're looking to use dynamic credentials, which isn't a feature supported by Template Credentials.\n","type":"object"},"ignore_errors":{"$ref":"#/components/schemas/Schema_866196eee82a663b71c0a383fdfb2f39a777749440b227619ea17fc8101eb5f4"},"interpolate":{"$ref":"#/components/schemas/Schema_210bc4cac49d5a8403766e579b22242786bad39b0b9ff4753e56b678e29f38d4"},"metadata":{"additionalProperties":{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"type":"string"}]},"default":{"basename":"example","extension":"png","filename":"example.png"},"description":"\nMetadata to pass along to destination. Includes some file info by default.\n","type":"object"},"output_meta":{"$ref":"#/components/schemas/Schema_60f6dcc23a68fee86135afddfdf2d63c170b886a6deb46563e7193f688ef4e6e"},"queue":{"$ref":"#/components/schemas/Schema_d0a30e0594348bac539404e659baaa1896ab178c82448e3cb657bb8df8a525c4"},"result":{"$ref":"#/components/schemas/Schema_e2eec9f0d3cf6892bbba08d6f0cb6582dc8dc7e3d2f71da8cbd997ad577ec0be"},"robot":{"const":"/tus/store","description":"Identifier of the [robot](https://transloadit.com/docs/robots/) to execute","type":"string"},"ssl_url_template":{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"type":"string"}],"description":"\nThe SSL URL of the file in the Assembly Status JSON. The following [Assembly Variables](/docs/topics/assembly-instructions/#assembly-variables) are supported. If this is not specified, the upload URL specified by the destination server will be used instead, as long as it starts with `https`.\n"},"url_template":{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"type":"string"}],"description":"\nThe URL of the file in the Assembly Status JSON. The following [Assembly Variables](/docs/topics/assembly-instructions/#assembly-variables) are supported. If this is not specified, the upload URL specified by the destination server will be used instead.\n"},"use":{"$ref":"#/components/schemas/Schema_47b2fd205d779e1de6bc4fd78c788d8393756436c48ec6f785f30dc6e16238aa"},"user_meta":{"$ref":"#/components/schemas/Schema_070d50917dd042191e4290744649be38025190ee43499886e5481a7d5627241d"}},"required":["endpoint","robot"],"type":"object"},{"additionalProperties":false,"properties":{"force_accept":{"$ref":"#/components/schemas/Schema_a7b463c184f2431703a1692b1402307bb6bb726278c59f7075fd0b8d6eb2be3c"},"ignore_errors":{"$ref":"#/components/schemas/Schema_866196eee82a663b71c0a383fdfb2f39a777749440b227619ea17fc8101eb5f4"},"interpolate":{"$ref":"#/components/schemas/Schema_210bc4cac49d5a8403766e579b22242786bad39b0b9ff4753e56b678e29f38d4"},"output_meta":{"$ref":"#/components/schemas/Schema_60f6dcc23a68fee86135afddfdf2d63c170b886a6deb46563e7193f688ef4e6e"},"queue":{"$ref":"#/components/schemas/Schema_d0a30e0594348bac539404e659baaa1896ab178c82448e3cb657bb8df8a525c4"},"result":{"$ref":"#/components/schemas/Schema_e2eec9f0d3cf6892bbba08d6f0cb6582dc8dc7e3d2f71da8cbd997ad577ec0be"},"robot":{"const":"/upload/handle","description":"\nTransloadit handles file uploads by default, so specifying this Robot is optional.\n\nIt can still be a good idea to define this Robot, though. It makes your Assembly Instructions explicit, and allows you to configure exactly how uploads should be handled. For example, you can extract specific metadata from the uploaded files.\n\nThere are **3 important constraints** when using this Robot:\n\n1. Don’t define a `use` parameter, unlike with other Robots.\n2. Use it only once in a single set of Assembly Instructions.\n3. Name the Step as `:original`.\n","type":"string"},"user_meta":{"$ref":"#/components/schemas/Schema_070d50917dd042191e4290744649be38025190ee43499886e5481a7d5627241d"}},"required":["robot"],"type":"object"},{"additionalProperties":false,"properties":{"audio_group":{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"anyOf":[{"type":"boolean"},{"enum":["false","true"],"type":"string"}]}],"default":false,"description":"\nWhen set to `true` and using the `\"hls\"` technique, audio-only input files are treated as alternate audio renditions instead of standalone stream variants. This enables players to offer audio track selection (e.g. for multiple languages). Audio-only files are listed as `#EXT-X-MEDIA:TYPE=AUDIO` entries in the multivariant playlist, and video variants reference them via the `AUDIO` attribute.\n\nWhen enabled, video inputs only include their video stream in the output segments (any muxed audio is excluded). Provide audio separately as audio-only input files.\n\nThis option is only supported for the `\"hls\"` technique and has no effect when using `\"dash\"`.\n"},"closed_captions":{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"anyOf":[{"type":"boolean"},{"enum":["false","true"],"type":"string"}]}],"default":true,"description":"\nDetermines whether you want closed caption support when using the `\"hls\"` technique.\n"},"ffmpeg":{"$ref":"#/components/schemas/Schema_15464c9d28640e7bf8903ba6d26df07ca6adbb8f0503e291180fa8a4647ec8e5"},"ffmpeg_stack":{"$ref":"#/components/schemas/Schema_2af3b38087bd992e9cae66535831de488ac05a86fd19619f5cfd998074675a28"},"force_accept":{"$ref":"#/components/schemas/Schema_a7b463c184f2431703a1692b1402307bb6bb726278c59f7075fd0b8d6eb2be3c"},"height":{"$ref":"#/components/schemas/Schema_1f5747f817d177d1a6318f567b28020a1c25097714b44829504283838cf33b39"},"hls_playlist_name":{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"type":"string"}],"description":"\nOnly used when `technique` is `\"cmaf\"`. Defines the filename for the generated HLS master playlist. The default is `\"playlist.m3u8\"`.\n"},"ignore_errors":{"$ref":"#/components/schemas/Schema_866196eee82a663b71c0a383fdfb2f39a777749440b227619ea17fc8101eb5f4"},"interpolate":{"$ref":"#/components/schemas/Schema_210bc4cac49d5a8403766e579b22242786bad39b0b9ff4753e56b678e29f38d4"},"output_meta":{"$ref":"#/components/schemas/Schema_60f6dcc23a68fee86135afddfdf2d63c170b886a6deb46563e7193f688ef4e6e"},"playlist_name":{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"type":"string"}],"description":"\nThe filename for the generated manifest/playlist file. The default is `\"playlist.mpd\"` if your `technique` is `\"dash\"`, and `\"playlist.m3u8\"` if your `technique` is `\"hls\"`.\nFor `\"cmaf\"`, this value names the MPEG-Dash manifest and defaults to `\"playlist.mpd\"`.\n"},"preset":{"$ref":"#/components/schemas/Schema_8ae0b8fbf79b68fb3deaf6da0348e39fc3fa033f61c4544fbb4b4e6cd48fb3b5"},"queue":{"$ref":"#/components/schemas/Schema_d0a30e0594348bac539404e659baaa1896ab178c82448e3cb657bb8df8a525c4"},"result":{"$ref":"#/components/schemas/Schema_e2eec9f0d3cf6892bbba08d6f0cb6582dc8dc7e3d2f71da8cbd997ad577ec0be"},"robot":{"const":"/video/adaptive","description":"\nThis Robot accepts all types of video files and audio files. Do not forget to use Step bundling in your `use` parameter to make the Robot work on several input files at once.\n\nThis Robot is normally used in combination with [🤖/video/encode](/docs/robots/video-encode/). We have implemented video and audio encoding presets specifically for MPEG-Dash and HTTP Live Streaming support. These presets are prefixed with `\"dash/\"` and `\"hls/\"`. [View a HTTP Live Streaming demo here](/demos/video-encoding/implement-http-live-streaming/).\n\n### Required CORS settings for MPEG-Dash and HTTP Live Streaming\n\nPlaying back MPEG-Dash Manifest or HLS playlist files requires a proper CORS setup on the server-side. The file-serving server should be configured to add the following header fields to responses:\n\n```\nAccess-Control-Allow-Origin: *\nAccess-Control-Allow-Methods: GET\nAccess-Control-Allow-Headers: *\n```\n\nIf the files are stored in an Amazon S3 Bucket, you can use the following [CORS definition](https://docs.aws.amazon.com/AmazonS3/latest/userguide/ManageCorsUsing.html) to ensure the CORS header fields are set correctly:\n\n```json\n[\n {\n \"AllowedHeaders\": [\"*\"],\n \"AllowedMethods\": [\"GET\"],\n \"AllowedOrigins\": [\"*\"],\n \"ExposeHeaders\": []\n }\n]\n```\n\nTo set up CORS for your S3 bucket:\n\n1. Visit \n1. Click on your bucket\n1. Click \"Permissions\"\n1. Edit \"Cross-origin resource sharing (CORS)\"\n\n### Storing Segments and Playlist files\n\nThe Robot gives its result files (segments, initialization segments, MPD manifest files and M3U8 playlist files) the right metadata property `relative_path`, so that you can store them easily using one of our storage Robots.\n\nIn the `path` parameter of the storage Robot of your choice, use the Assembly Variable `${file.meta.relative_path}` to store files in the proper paths to make the playlist files work.\n","type":"string"},"segment_duration":{"anyOf":[{"pattern":"^[0-9]+(\\.[0-9]+)?$","type":"string"},{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"type":"integer"}],"default":10,"description":"\nThe duration for each segment in seconds.\n"},"technique":{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"enum":["cmaf","dash","hls"],"type":"string"}],"default":"dash","description":"\nDetermines which streaming technique should be used. Supports `\"dash\"` for MPEG-Dash, `\"hls\"` for HTTP Live Streaming and `\"cmaf\"` for FFmpeg-based CMAF output with both MPEG-Dash and HLS manifests that reference the same fMP4 segments.\n"},"use":{"$ref":"#/components/schemas/Schema_47b2fd205d779e1de6bc4fd78c788d8393756436c48ec6f785f30dc6e16238aa"},"user_meta":{"$ref":"#/components/schemas/Schema_070d50917dd042191e4290744649be38025190ee43499886e5481a7d5627241d"},"width":{"$ref":"#/components/schemas/Schema_3d1cd815592582c496b313ba416ab0870a5b847fedc48c1e411c39a5ef1d45f4"}},"required":["robot"],"type":"object"},{"additionalProperties":false,"properties":{"ffmpeg":{"$ref":"#/components/schemas/Schema_15464c9d28640e7bf8903ba6d26df07ca6adbb8f0503e291180fa8a4647ec8e5"},"ffmpeg_stack":{"$ref":"#/components/schemas/Schema_2af3b38087bd992e9cae66535831de488ac05a86fd19619f5cfd998074675a28"},"force_accept":{"$ref":"#/components/schemas/Schema_a7b463c184f2431703a1692b1402307bb6bb726278c59f7075fd0b8d6eb2be3c"},"ignore_errors":{"$ref":"#/components/schemas/Schema_866196eee82a663b71c0a383fdfb2f39a777749440b227619ea17fc8101eb5f4"},"interpolate":{"$ref":"#/components/schemas/Schema_210bc4cac49d5a8403766e579b22242786bad39b0b9ff4753e56b678e29f38d4"},"method":{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"enum":["extract","insert"],"type":"string"}],"default":"extract","description":"\nWhat should be done with the video file. A value of `\"extract\"` means video artwork will be extracted. A value of `\"insert\"` means the provided image will be inserted as video artwork.\n"},"output_meta":{"$ref":"#/components/schemas/Schema_60f6dcc23a68fee86135afddfdf2d63c170b886a6deb46563e7193f688ef4e6e"},"preset":{"$ref":"#/components/schemas/Schema_edecfbd5df4587f3777dedbf28e7de13ac7093ec263b82ed52f21f398e96aef1"},"queue":{"$ref":"#/components/schemas/Schema_d0a30e0594348bac539404e659baaa1896ab178c82448e3cb657bb8df8a525c4"},"result":{"$ref":"#/components/schemas/Schema_e2eec9f0d3cf6892bbba08d6f0cb6582dc8dc7e3d2f71da8cbd997ad577ec0be"},"robot":{"const":"/video/artwork","description":"\nThis Robot extracts or inserts cover artwork in video files.\n\nFor extraction, it uses the image format embedded within the video file — most often, this is JPEG. If you need the image in a different format, pipe the result into [🤖/image/resize](/docs/robots/image-resize/).\n\nFor insertion, provide both a video file (as `\"video\"`) and an image file (as `\"image\"`) via the `use` parameter, and set `method` to `\"insert\"`. The image will be embedded as the cover artwork of the video file.\n","type":"string"},"use":{"$ref":"#/components/schemas/Schema_47b2fd205d779e1de6bc4fd78c788d8393756436c48ec6f785f30dc6e16238aa"},"user_meta":{"$ref":"#/components/schemas/Schema_070d50917dd042191e4290744649be38025190ee43499886e5481a7d5627241d"}},"required":["robot"],"type":"object"},{"additionalProperties":false,"properties":{"audio_fade_seconds":{"anyOf":[{"pattern":"^[0-9]+(\\.[0-9]+)?$","type":"string"},{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"type":"number"}],"default":1,"description":"\nWhen used this adds an audio fade in and out effect between each section of your concatenated video. The float value is used so if you want an audio delay effect of 500 milliseconds between each video section you would select `0.5`, however, integer values can also be represented.\n\nThis parameter does not add an audio fade effect at the beginning or end of your video. If you want to do so, create an additional [🤖/video/encode](/docs/robots/video-encode/) Step and use our `ffmpeg` parameter as shown in this [demo](/demos/audio-encoding/ffmpeg-fade-in-and-out/).\n\nPlease note this parameter is independent of adding video fades between sections.\n"},"chapter_markers":{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"anyOf":[{"type":"boolean"},{"enum":["false","true"],"type":"string"}]}],"default":false,"description":"\nWhen set to `true`, the concatenated video will contain chapter markers at the positions where the input videos are joined. Each chapter will be titled with the basename of the corresponding input video file.\n\nThis is useful for navigation in video players that support chapter-based seeking.\n"},"ffmpeg":{"$ref":"#/components/schemas/Schema_15464c9d28640e7bf8903ba6d26df07ca6adbb8f0503e291180fa8a4647ec8e5"},"ffmpeg_stack":{"$ref":"#/components/schemas/Schema_2af3b38087bd992e9cae66535831de488ac05a86fd19619f5cfd998074675a28"},"force_accept":{"$ref":"#/components/schemas/Schema_a7b463c184f2431703a1692b1402307bb6bb726278c59f7075fd0b8d6eb2be3c"},"height":{"$ref":"#/components/schemas/Schema_1f5747f817d177d1a6318f567b28020a1c25097714b44829504283838cf33b39"},"ignore_errors":{"$ref":"#/components/schemas/Schema_866196eee82a663b71c0a383fdfb2f39a777749440b227619ea17fc8101eb5f4"},"interpolate":{"$ref":"#/components/schemas/Schema_210bc4cac49d5a8403766e579b22242786bad39b0b9ff4753e56b678e29f38d4"},"output_meta":{"$ref":"#/components/schemas/Schema_60f6dcc23a68fee86135afddfdf2d63c170b886a6deb46563e7193f688ef4e6e"},"preset":{"$ref":"#/components/schemas/Schema_8ae0b8fbf79b68fb3deaf6da0348e39fc3fa033f61c4544fbb4b4e6cd48fb3b5"},"queue":{"$ref":"#/components/schemas/Schema_d0a30e0594348bac539404e659baaa1896ab178c82448e3cb657bb8df8a525c4"},"result":{"$ref":"#/components/schemas/Schema_e2eec9f0d3cf6892bbba08d6f0cb6582dc8dc7e3d2f71da8cbd997ad577ec0be"},"robot":{"const":"/video/concat","description":"\n> [!Note]\n> Input videos may have differing dimensions and streams - the Robot can handle this fine. It will pre-transcode the input videos if necessary before concatenation at no additional cost.\n\nIt’s possible to concatenate a virtually infinite number of video files using [🤖/video/concat](/docs/robots/video-concat/).\n","type":"string"},"sort_by":{"$ref":"#/components/schemas/Schema_a529048b2ed32b0125d678e158645220b42861e2c3e5bf89f766bec34234c3e6"},"transition":{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"enum":["crossfade","fade_to_black","none"],"type":"string"}],"default":"none","description":"\nSpecifies the transition effect to apply between concatenated video clips.\n\n- `\"none\"` (default): No transition effect. Videos are joined end-to-end.\n- `\"crossfade\"`: Applies a crossfade transition where the end of one clip gradually blends into the beginning of the next clip. Both video and audio are crossfaded.\n- `\"fade_to_black\"`: Applies a fade-to-black transition where each clip fades out to black before the next clip fades in from black.\n\nWhen using `\"crossfade\"` or `\"fade_to_black\"`, the `transition_duration` parameter controls how long the transition lasts. Note that crossfade transitions will reduce the total output duration since clips overlap during the transition.\n"},"transition_duration":{"anyOf":[{"pattern":"^[0-9]+(\\.[0-9]+)?$","type":"string"},{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"type":"number"}],"default":1,"description":"\nThe duration of the transition effect in seconds. Only applies when `transition` is set to `\"crossfade\"` or `\"fade_to_black\"`.\n\nFor example, a value of `1.0` creates a 1-second transition between clips. The value can be a float for sub-second precision (e.g., `0.5` for 500 milliseconds) and must be greater than `0` whenever transitions are enabled.\n\nFor crossfade transitions, this is the overlap duration where both clips are visible. For fade_to_black transitions, this is the total time for the fade out and fade in (half for each). The applied transition is capped at half of the shorter clip in each transition pair.\n"},"use":{"$ref":"#/components/schemas/Schema_47b2fd205d779e1de6bc4fd78c788d8393756436c48ec6f785f30dc6e16238aa"},"user_meta":{"$ref":"#/components/schemas/Schema_070d50917dd042191e4290744649be38025190ee43499886e5481a7d5627241d"},"video_fade_seconds":{"anyOf":[{"pattern":"^[0-9]+(\\.[0-9]+)?$","type":"string"},{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"type":"number"}],"default":1,"description":"\nWhen used this adds a video fade in and out effect between each section of your concatenated video. The float value is used so if you want a video delay effect of 500 milliseconds between each video section you would select `0.5`, however, integer values can also be represented.\n\nThis parameter does not add a video fade effect at the beginning or end of your video. If you want to do so, create an additional [🤖/video/encode](/docs/robots/video-encode/) Step and use our `ffmpeg` parameter as shown in this [demo](/demos/video-encoding/concatenate-fade-effect/).\n\nPlease note this parameter is independent of adding audio fades between sections.\n"},"width":{"$ref":"#/components/schemas/Schema_3d1cd815592582c496b313ba416ab0870a5b847fedc48c1e411c39a5ef1d45f4"}},"required":["robot"],"type":"object"},{"additionalProperties":false,"properties":{"background":{"$ref":"#/components/schemas/Schema_ab6cb202a13202fba4568f38be6c2eb66d85fa4f009d0c2e5c0374caa3720092"},"chunk_duration":{"$ref":"#/components/schemas/Schema_61e4aff610f3824ac8dd05bda1b6369c1adee454f621b634fec0fc92e9d47fca"},"crop":{"$ref":"#/components/schemas/Schema_51c0c37ad30682e643ed8c42b6549dcdc58c0a40bc20a80edffd90f306774799"},"ffmpeg":{"$ref":"#/components/schemas/Schema_15464c9d28640e7bf8903ba6d26df07ca6adbb8f0503e291180fa8a4647ec8e5"},"ffmpeg_stack":{"$ref":"#/components/schemas/Schema_2af3b38087bd992e9cae66535831de488ac05a86fd19619f5cfd998074675a28"},"font_color":{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"type":"string"}]},"font_size":{"$ref":"#/components/schemas/Schema_30573475089cec428fa966ac94d74114e316d676d5e62f4c710cb1a87589b4f0"},"force_accept":{"$ref":"#/components/schemas/Schema_a7b463c184f2431703a1692b1402307bb6bb726278c59f7075fd0b8d6eb2be3c"},"height":{"$ref":"#/components/schemas/Schema_1f5747f817d177d1a6318f567b28020a1c25097714b44829504283838cf33b39"},"hint":{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"anyOf":[{"type":"boolean"},{"enum":["false","true"],"type":"string"}]}],"default":false,"description":"\nEnables hinting for mp4 files, for RTP/RTSP streaming.\n"},"ignore_errors":{"$ref":"#/components/schemas/Schema_866196eee82a663b71c0a383fdfb2f39a777749440b227619ea17fc8101eb5f4"},"interpolate":{"$ref":"#/components/schemas/Schema_210bc4cac49d5a8403766e579b22242786bad39b0b9ff4753e56b678e29f38d4"},"output_meta":{"$ref":"#/components/schemas/Schema_60f6dcc23a68fee86135afddfdf2d63c170b886a6deb46563e7193f688ef4e6e"},"preset":{"$ref":"#/components/schemas/Schema_8ae0b8fbf79b68fb3deaf6da0348e39fc3fa033f61c4544fbb4b4e6cd48fb3b5"},"queue":{"$ref":"#/components/schemas/Schema_d0a30e0594348bac539404e659baaa1896ab178c82448e3cb657bb8df8a525c4"},"resize_strategy":{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"enum":["crop","fillcrop","fit","min_fit","pad","stretch"],"type":"string"}],"default":"pad","description":"\nSee the [available resize strategies](/docs/topics/resize-strategies/).\n"},"result":{"$ref":"#/components/schemas/Schema_e2eec9f0d3cf6892bbba08d6f0cb6582dc8dc7e3d2f71da8cbd997ad577ec0be"},"robot":{"const":"/video/encode","description":"\nThe /video/encode Robot is a versatile tool for video processing that handles transcoding, resizing, and watermarking. It supports various formats including modern standards like HEVC (H.265), and provides features such as presets for common devices, custom FFmpeg parameters for powerusers, watermark positioning, and more.\n\n## Adding text overlays with FFmpeg\n\nYou can add text overlays to videos using FFmpeg's `drawtext` filter through this Robot's `ffmpeg` parameter. Here are two examples — one with the default font and one with a custom font family name:\n\n```json\n{\n \"steps\": {\n \":original\": {\n \"robot\": \"/upload/handle\"\n },\n \"text_overlay_default\": {\n \"use\": \":original\",\n \"robot\": \"/video/encode\",\n \"preset\": \"empty\",\n \"ffmpeg_stack\": \"v7\",\n \"ffmpeg\": {\n \"codec:a\": \"copy\",\n \"vf\": \"drawtext=text='My text overlay':fontcolor=white:fontsize=24:box=1:boxcolor=black@0.5:boxborderw=5:x=(w-text_w)/2:y=(h-text_h)/2\"\n },\n \"result\": true\n },\n \"text_overlay_custom\": {\n \"use\": \":original\",\n \"robot\": \"/video/encode\",\n \"preset\": \"empty\",\n \"ffmpeg_stack\": \"v7\",\n \"ffmpeg\": {\n \"codec:a\": \"copy\",\n \"vf\": \"drawtext=font='Times New Roman':text='My text overlay':fontcolor=white:fontsize=24:box=1:boxcolor=black@0.5:boxborderw=5:x=(w-text_w)/2:y=(h-text_h)/2\"\n },\n \"result\": true\n }\n }\n}\n```\n\n**Notes:**\n\n- Use the `font` attribute to reference a font by family name with FFmpeg's `drawtext`\n- FFmpeg font family names typically do not contain dashes (e.g. `Times New Roman`), while\n ImageMagick uses dashed names (e.g. `Times-New-Roman`).\n- File-loading `drawtext` options such as `textfile` and `fontfile` are not supported. Use\n inline `text` and a font family name instead.\n- Preserve the source audio by setting `\"codec:a\": \"copy\"`.\n- Position text with the `x` and `y` expressions. The example above centers the text.\n\nSee the [live text overlay demo](/demos/video-encoding/add-text-overlay/).\n","type":"string"},"rotate":{"$ref":"#/components/schemas/Schema_1adc8fb22e78059aab386774d662e8df48ee3b04618a700b5c57c977233c2da2"},"segment":{"$ref":"#/components/schemas/Schema_5f01fb4b01d66fe04acae4dc72c06c3e596b90bfdb69032701207eeaf3b20dac"},"segment_duration":{"$ref":"#/components/schemas/Schema_770e432acf7b380989fa1175d6e236099b20eba3f78c8e91975f0754af64cece"},"segment_name":{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"type":"string"}],"default":"","description":"\nThe name used for the final segment. Available variables are `${segment_prefix}`, `${segment_number}` and `${segment_id}` (which is a UUIDv4 without dashes).\n"},"segment_prefix":{"$ref":"#/components/schemas/Schema_25236cdbef40391d3c1398240835c11c3a6eb2794a27384c226f4c36b04fe3ac"},"segment_time_delta":{"anyOf":[{"pattern":"^[0-9]+(\\.[0-9]+)?$","type":"string"},{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"type":"number"}],"description":"\nDelta to apply to segment duration. This is optional and allows fine-tuning of segment boundaries.\n"},"text_background_color":{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"type":"string"}]},"turbo":{"$ref":"#/components/schemas/Schema_5676da196f6b41f1c255b8817b30a3d853734c39f57c633f8d302e2f045e4774"},"use":{"$ref":"#/components/schemas/Schema_47b2fd205d779e1de6bc4fd78c788d8393756436c48ec6f785f30dc6e16238aa"},"user_meta":{"$ref":"#/components/schemas/Schema_070d50917dd042191e4290744649be38025190ee43499886e5481a7d5627241d"},"watermark_duration":{"$ref":"#/components/schemas/Schema_67e7c93d5767738dbd2a81db5abd268abb0b8cf57ac4413d17abd2af92b33601"},"watermark_opacity":{"anyOf":[{"pattern":"^[0-9]+(\\.[0-9]+)?$","type":"string"},{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"maximum":1,"minimum":0,"type":"number"}],"default":1,"description":"\nThe opacity of the watermark. Valid values are between `0` (invisible) and `1.0` (full visibility).\n"},"watermark_position":{"$ref":"#/components/schemas/Schema_34ea758dabb194a79bded7219bcc96870a03f1cc1f15c677263bc8b9fe6e21bc"},"watermark_resize_strategy":{"$ref":"#/components/schemas/Schema_bf85e496648760c51005fdb6400e54d4bcecbc6ac94262104cfe8dff90f6231c"},"watermark_size":{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"pattern":"^[0-9]+%$","type":"string"}],"description":"\nThe size of the watermark, as a percentage, such as `\"50%\"`. How the watermark is resized greatly depends on the `watermark_resize_strategy`.\n"},"watermark_start_time":{"anyOf":[{"pattern":"^[0-9]+(\\.[0-9]+)?$","type":"string"},{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"type":"number"}],"default":0,"description":"\nThe delay in seconds from the start of the video for the watermark to appear. By default the watermark is immediately shown.\n"},"watermark_url":{"$ref":"#/components/schemas/Schema_eb011f0e79199be8d971b4a81664e6348a59004fad86f313a1be55725503600d"},"watermark_x_offset":{"$ref":"#/components/schemas/Schema_be8d9cf87fa19191b4ae7951e8157ec31b58525767399fe496cb8d58a86d78be"},"watermark_y_offset":{"$ref":"#/components/schemas/Schema_ef358dbff7b7953b7b59de1e6075793d2495500cab96f4aeba4005431dcf0481"},"width":{"$ref":"#/components/schemas/Schema_3d1cd815592582c496b313ba416ab0870a5b847fedc48c1e411c39a5ef1d45f4"},"zoom":{"$ref":"#/components/schemas/Schema_91a0439dbbd92cd45383cfadc493423b2037036823521cb4160c86b270240132"}},"required":["robot"],"type":"object"},{"additionalProperties":false,"properties":{"aspect_ratio":{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"type":"string"}],"description":"Aspect ratio of the generated video."},"camera_motion":{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"type":"string"}],"description":"Camera movement type (e.g., pan-left, pan-right, zoom-in, zoom-out, orbit, static, dolly, crane)."},"duration":{"anyOf":[{"pattern":"^[0-9]+(\\.[0-9]+)?$","type":"string"},{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"type":"number"}],"description":"Duration of the generated video in seconds."},"force_accept":{"$ref":"#/components/schemas/Schema_a7b463c184f2431703a1692b1402307bb6bb726278c59f7075fd0b8d6eb2be3c"},"format":{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"enum":["gif","mp4"],"type":"string"}],"description":"Format of the generated video."},"fps":{"anyOf":[{"pattern":"^[0-9]+(\\.[0-9]+)?$","type":"string"},{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"type":"number"}],"description":"Frames per second of the output video."},"height":{"anyOf":[{"pattern":"^[0-9]+(\\.[0-9]+)?$","type":"string"},{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"type":"number"}],"description":"Height of the generated video."},"ignore_errors":{"$ref":"#/components/schemas/Schema_866196eee82a663b71c0a383fdfb2f39a777749440b227619ea17fc8101eb5f4"},"interpolate":{"$ref":"#/components/schemas/Schema_210bc4cac49d5a8403766e579b22242786bad39b0b9ff4753e56b678e29f38d4"},"model":{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"type":"string"}],"description":"The AI model to use for video generation. Defaults to minimax/video-01."},"motion_amount":{"anyOf":[{"pattern":"^[0-9]+(\\.[0-9]+)?$","type":"string"},{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"type":"number"}],"description":"Controls the intensity of motion in the generated video."},"negative_prompt":{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"type":"string"}],"description":"Describes what should be avoided in the generated video."},"num_outputs":{"anyOf":[{"pattern":"^[0-9]+(\\.[0-9]+)?$","type":"string"},{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"maximum":10,"minimum":1,"type":"integer"}],"description":"Number of video variants to generate."},"output_meta":{"$ref":"#/components/schemas/Schema_60f6dcc23a68fee86135afddfdf2d63c170b886a6deb46563e7193f688ef4e6e"},"prompt":{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"description":"The prompt describing the desired video content.","type":"string"}],"description":"The prompt describing the desired video content."},"queue":{"$ref":"#/components/schemas/Schema_d0a30e0594348bac539404e659baaa1896ab178c82448e3cb657bb8df8a525c4"},"reference_strength":{"anyOf":[{"pattern":"^[0-9]+(\\.[0-9]+)?$","type":"string"},{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"type":"number"}],"description":"How closely the output should follow the reference input (0.0 - 1.0)."},"result":{"$ref":"#/components/schemas/Schema_e2eec9f0d3cf6892bbba08d6f0cb6582dc8dc7e3d2f71da8cbd997ad577ec0be"},"robot":{"const":"/video/generate","description":"Identifier of the [robot](https://transloadit.com/docs/robots/) to execute","type":"string"},"seed":{"anyOf":[{"pattern":"^[0-9]+(\\.[0-9]+)?$","type":"string"},{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"type":"number"}],"description":"Seed for the random number generator."},"style":{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"type":"string"}],"description":"Style of the generated video."},"use":{"$ref":"#/components/schemas/Schema_47b2fd205d779e1de6bc4fd78c788d8393756436c48ec6f785f30dc6e16238aa"},"user_meta":{"$ref":"#/components/schemas/Schema_070d50917dd042191e4290744649be38025190ee43499886e5481a7d5627241d"},"width":{"anyOf":[{"pattern":"^[0-9]+(\\.[0-9]+)?$","type":"string"},{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"type":"number"}],"description":"Width of the generated video."}},"required":["prompt","robot"],"type":"object"},{"additionalProperties":false,"properties":{"audio_delay":{"anyOf":[{"pattern":"^[0-9]+(\\.[0-9]+)?$","type":"string"},{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"type":"number"}],"default":0,"description":"\nWhen merging a video and an audio file, and when merging images and an audio file to generate a video, this is the desired delay in seconds for the audio file to start playing. Imagine you merge a video file without sound and an audio file, but you wish the audio to start playing after 5 seconds and not immediately, then this is the parameter to use.\n"},"background":{"$ref":"#/components/schemas/Schema_ab6cb202a13202fba4568f38be6c2eb66d85fa4f009d0c2e5c0374caa3720092"},"duration":{"anyOf":[{"$ref":"#/components/schemas/Schema_30573475089cec428fa966ac94d74114e316d676d5e62f4c710cb1a87589b4f0"},{"type":"null"}],"default":null,"description":"\nWhen merging images to generate a video or when merging audio and video this is the desired target duration in seconds. The float value can take one decimal digit. If you want all images to be displayed exactly once, then you can set the duration according to this formula: `duration = numberOfImages / framerate`. This also works for the inverse framerate values like `1/5`.\n\nIf you set this value to `null` (default), then the duration of the input audio file will be used when merging images with an audio file.\n\nWhen merging audio files and video files, the duration of the longest video or audio file is used by default.\n"},"ffmpeg":{"$ref":"#/components/schemas/Schema_15464c9d28640e7bf8903ba6d26df07ca6adbb8f0503e291180fa8a4647ec8e5"},"ffmpeg_stack":{"$ref":"#/components/schemas/Schema_2af3b38087bd992e9cae66535831de488ac05a86fd19619f5cfd998074675a28"},"force_accept":{"$ref":"#/components/schemas/Schema_a7b463c184f2431703a1692b1402307bb6bb726278c59f7075fd0b8d6eb2be3c"},"framerate":{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"anyOf":[{"pattern":"^[0-9]+(\\.[0-9]+)?$","type":"string"},{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"minimum":1,"type":"integer"}]},{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"pattern":"^[0-9]+(?:\\/[0-9]+)?$","type":"string"}]}],"default":"1/5","description":"\nWhen merging images to generate a video this is the input framerate. A value of \"1/5\" means each image is given 5 seconds before the next frame appears (the inverse of a framerate of \"5\"). Likewise for \"1/10\", \"1/20\", etc. A value of \"5\" means there are 5 frames per second.\n"},"height":{"$ref":"#/components/schemas/Schema_1f5747f817d177d1a6318f567b28020a1c25097714b44829504283838cf33b39"},"ignore_errors":{"$ref":"#/components/schemas/Schema_866196eee82a663b71c0a383fdfb2f39a777749440b227619ea17fc8101eb5f4"},"image_durations":{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"items":{"$ref":"#/components/schemas/Schema_30573475089cec428fa966ac94d74114e316d676d5e62f4c710cb1a87589b4f0"},"type":"array"}],"default":[],"description":"\nWhen merging images to generate a video this allows you to define how long (in seconds) each image will be shown inside of the video. So if you pass 3 images and define `[2.4, 5.6, 9]` the first image will be shown for 2.4s, the second image for 5.6s and the last one for 9s. The `duration` parameter will automatically be set to the sum of the image_durations, so `17` in our example. It can still be overwritten, though, in which case the last image will be shown until the defined duration is reached.\n"},"image_url":{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"pattern":"^[Hh][Tt][Tt][Pp][Ss]?:\\/\\/(?:[^ ]|[ ])","type":"string","x-transloadit-input-fidelity":"conservative"}],"description":"\nThe URL of an image to be merged with the audio or video. When this parameter is provided, the robot will download the image from the URL and merge it with the other media.\n"},"interpolate":{"$ref":"#/components/schemas/Schema_210bc4cac49d5a8403766e579b22242786bad39b0b9ff4753e56b678e29f38d4"},"loop":{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"anyOf":[{"type":"boolean"},{"enum":["false","true"],"type":"string"}]}],"default":false,"description":"\nDetermines whether the shorter media file should be looped to match the duration of the longer one. For example, if you merge a 1-minute video with a 3-minute audio file and enable this option, the video will play three times in a row to match the audio length.\n"},"output_meta":{"$ref":"#/components/schemas/Schema_60f6dcc23a68fee86135afddfdf2d63c170b886a6deb46563e7193f688ef4e6e"},"preset":{"$ref":"#/components/schemas/Schema_8ae0b8fbf79b68fb3deaf6da0348e39fc3fa033f61c4544fbb4b4e6cd48fb3b5"},"queue":{"$ref":"#/components/schemas/Schema_d0a30e0594348bac539404e659baaa1896ab178c82448e3cb657bb8df8a525c4"},"replace_audio":{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"anyOf":[{"type":"boolean"},{"enum":["false","true"],"type":"string"}]}],"default":false,"description":"\nDetermines whether the audio of the video should be replaced with a provided audio file.\n"},"resize_strategy":{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"enum":["crop","fillcrop","fit","min_fit","pad","stretch"],"type":"string"}],"default":"pad","description":"\nIf the given width/height parameters are bigger than the input image's dimensions, then the `resize_strategy` determines how the image will be resized to match the provided width/height. See the [available resize strategies](/docs/topics/resize-strategies/).\n"},"result":{"$ref":"#/components/schemas/Schema_e2eec9f0d3cf6892bbba08d6f0cb6582dc8dc7e3d2f71da8cbd997ad577ec0be"},"robot":{"const":"/video/merge","description":"Identifier of the [robot](https://transloadit.com/docs/robots/) to execute","type":"string"},"sort_by":{"$ref":"#/components/schemas/Schema_a529048b2ed32b0125d678e158645220b42861e2c3e5bf89f766bec34234c3e6"},"transition":{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"enum":["crossfade","fade_to_black","none"],"type":"string"}],"default":"none","description":"\nThe type of transition effect to apply between concatenated video clips. Only applies when concatenating multiple videos (using `video_1`, `video_2`, etc. or `pre_roll`/`post_roll` inputs).\n\n- `\"none\"` — No transition effect. Videos are joined end-to-end.\n- `\"crossfade\"` — A gradual blend from one clip to the next (both video and audio).\n- `\"fade_to_black\"` — The current clip fades out to black, then the next clip fades in from black.\n"},"transition_duration":{"anyOf":[{"pattern":"^[0-9]+(\\.[0-9]+)?$","type":"string"},{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"type":"number"}],"default":1,"description":"\nThe duration of the transition effect in seconds. Only applies when `transition` is not `\"none\"`. Supports float values (e.g., `0.5` for a 500ms transition) and must be greater than `0` whenever transitions are enabled. The applied transition is automatically capped at half of the shorter clip in each transition pair to prevent overlapping transitions.\n"},"use":{"$ref":"#/components/schemas/Schema_47b2fd205d779e1de6bc4fd78c788d8393756436c48ec6f785f30dc6e16238aa"},"user_meta":{"$ref":"#/components/schemas/Schema_070d50917dd042191e4290744649be38025190ee43499886e5481a7d5627241d"},"vstack":{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"anyOf":[{"type":"boolean"},{"enum":["false","true"],"type":"string"}]}],"default":false,"description":"\nStacks the input media vertically. All streams need to have the same pixel format and width - so consider using a [/video/encode](/docs/robots/video-encode/) Step before using this parameter to enforce this.\n"},"width":{"$ref":"#/components/schemas/Schema_3d1cd815592582c496b313ba416ab0870a5b847fedc48c1e411c39a5ef1d45f4"}},"required":["robot"],"type":"object"},{"additionalProperties":false,"properties":{"asset":{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"type":"string"}],"description":"Controls which file is generated. For example, if the parameter is unset, a multivariant playlist referencing the variants is generated."},"asset_param_name":{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"type":"string"}],"default":"asset","description":"Specifies from which URL parameter the asset parameter value is taken and which URL parameter to use when generating playlist files."},"enabled_variants":{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"type":"string"}]},{"$ref":"#/components/schemas/Schema_bc9fbfc32e2939087e1b877c2b51ce63f08c8cdfdcf7adca01505a0498ab5691"}],"description":"Specifies which variants, defined in the variants parameter, are enabled. Non-enabled variants will not be included in the multivariant playlist."},"force_accept":{"$ref":"#/components/schemas/Schema_a7b463c184f2431703a1692b1402307bb6bb726278c59f7075fd0b8d6eb2be3c"},"ignore_errors":{"$ref":"#/components/schemas/Schema_866196eee82a663b71c0a383fdfb2f39a777749440b227619ea17fc8101eb5f4"},"interpolate":{"$ref":"#/components/schemas/Schema_210bc4cac49d5a8403766e579b22242786bad39b0b9ff4753e56b678e29f38d4"},"output_meta":{"$ref":"#/components/schemas/Schema_60f6dcc23a68fee86135afddfdf2d63c170b886a6deb46563e7193f688ef4e6e"},"queue":{"$ref":"#/components/schemas/Schema_d0a30e0594348bac539404e659baaa1896ab178c82448e3cb657bb8df8a525c4"},"result":{"$ref":"#/components/schemas/Schema_e2eec9f0d3cf6892bbba08d6f0cb6582dc8dc7e3d2f71da8cbd997ad577ec0be"},"robot":{"const":"/video/ondemand","description":"Identifier of the [robot](https://transloadit.com/docs/robots/) to execute","type":"string"},"segment_duration":{"anyOf":[{"pattern":"^[0-9]+(\\.[0-9]+)?$","type":"string"},{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"type":"number"}],"default":6,"description":"The duration of each segment in seconds."},"sign_urls_for":{"anyOf":[{"pattern":"^[0-9]+(\\.[0-9]+)?$","type":"string"},{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"type":"number"}],"default":0,"description":"When signing URLs is enabled, the URLs in the generated playlist files will be signed. This parameter specifies the duration (in seconds) that the signed URLs will remain valid. Use the modern `sig` + `exp` format for new integrations. Legacy `s` signatures are deprecated. Shorter expirations reduce the replay window, but they also reduce cache reuse and can increase segment re-generation and latency."},"use":{"$ref":"#/components/schemas/Schema_47b2fd205d779e1de6bc4fd78c788d8393756436c48ec6f785f30dc6e16238aa"},"user_meta":{"$ref":"#/components/schemas/Schema_070d50917dd042191e4290744649be38025190ee43499886e5481a7d5627241d"},"variants":{"additionalProperties":{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"additionalProperties":false,"properties":{"background":{"$ref":"#/components/schemas/Schema_ab6cb202a13202fba4568f38be6c2eb66d85fa4f009d0c2e5c0374caa3720092"},"chunk_duration":{"$ref":"#/components/schemas/Schema_61e4aff610f3824ac8dd05bda1b6369c1adee454f621b634fec0fc92e9d47fca"},"crop":{"$ref":"#/components/schemas/Schema_51c0c37ad30682e643ed8c42b6549dcdc58c0a40bc20a80edffd90f306774799"},"ffmpeg":{"$ref":"#/components/schemas/Schema_15464c9d28640e7bf8903ba6d26df07ca6adbb8f0503e291180fa8a4647ec8e5"},"ffmpeg_stack":{"$ref":"#/components/schemas/Schema_2af3b38087bd992e9cae66535831de488ac05a86fd19619f5cfd998074675a28"},"height":{"$ref":"#/components/schemas/Schema_1f5747f817d177d1a6318f567b28020a1c25097714b44829504283838cf33b39"},"hint":{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"anyOf":[{"type":"boolean"},{"enum":["false","true"],"type":"string"}]}],"default":false,"description":"\nEnables hinting for mp4 files, for RTP/RTSP streaming.\n"},"preset":{"$ref":"#/components/schemas/Schema_8ae0b8fbf79b68fb3deaf6da0348e39fc3fa033f61c4544fbb4b4e6cd48fb3b5"},"resize_strategy":{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"enum":["crop","fillcrop","fit","min_fit","pad","stretch"],"type":"string"}],"default":"pad","description":"\nSee the [available resize strategies](/docs/topics/resize-strategies/).\n"},"rotate":{"$ref":"#/components/schemas/Schema_1adc8fb22e78059aab386774d662e8df48ee3b04618a700b5c57c977233c2da2"},"segment":{"$ref":"#/components/schemas/Schema_5f01fb4b01d66fe04acae4dc72c06c3e596b90bfdb69032701207eeaf3b20dac"},"segment_duration":{"$ref":"#/components/schemas/Schema_770e432acf7b380989fa1175d6e236099b20eba3f78c8e91975f0754af64cece"},"segment_name":{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"type":"string"}],"default":"","description":"\nThe name used for the final segment. Available variables are `${segment_prefix}`, `${segment_number}` and `${segment_id}` (which is a UUIDv4 without dashes).\n"},"segment_prefix":{"$ref":"#/components/schemas/Schema_25236cdbef40391d3c1398240835c11c3a6eb2794a27384c226f4c36b04fe3ac"},"segment_time_delta":{"anyOf":[{"pattern":"^[0-9]+(\\.[0-9]+)?$","type":"string"},{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"type":"number"}],"description":"\nDelta to apply to segment duration. This is optional and allows fine-tuning of segment boundaries.\n"},"turbo":{"$ref":"#/components/schemas/Schema_5676da196f6b41f1c255b8817b30a3d853734c39f57c633f8d302e2f045e4774"},"watermark_duration":{"$ref":"#/components/schemas/Schema_67e7c93d5767738dbd2a81db5abd268abb0b8cf57ac4413d17abd2af92b33601"},"watermark_opacity":{"anyOf":[{"pattern":"^[0-9]+(\\.[0-9]+)?$","type":"string"},{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"maximum":1,"minimum":0,"type":"number"}],"default":1,"description":"\nThe opacity of the watermark. Valid values are between `0` (invisible) and `1.0` (full visibility).\n"},"watermark_position":{"$ref":"#/components/schemas/Schema_34ea758dabb194a79bded7219bcc96870a03f1cc1f15c677263bc8b9fe6e21bc"},"watermark_resize_strategy":{"$ref":"#/components/schemas/Schema_bf85e496648760c51005fdb6400e54d4bcecbc6ac94262104cfe8dff90f6231c"},"watermark_size":{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"pattern":"^[0-9]+%$","type":"string"}],"description":"\nThe size of the watermark, as a percentage, such as `\"50%\"`. How the watermark is resized greatly depends on the `watermark_resize_strategy`.\n"},"watermark_start_time":{"anyOf":[{"pattern":"^[0-9]+(\\.[0-9]+)?$","type":"string"},{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"type":"number"}],"default":0,"description":"\nThe delay in seconds from the start of the video for the watermark to appear. By default the watermark is immediately shown.\n"},"watermark_url":{"$ref":"#/components/schemas/Schema_eb011f0e79199be8d971b4a81664e6348a59004fad86f313a1be55725503600d"},"watermark_x_offset":{"$ref":"#/components/schemas/Schema_be8d9cf87fa19191b4ae7951e8157ec31b58525767399fe496cb8d58a86d78be"},"watermark_y_offset":{"$ref":"#/components/schemas/Schema_ef358dbff7b7953b7b59de1e6075793d2495500cab96f4aeba4005431dcf0481"},"width":{"$ref":"#/components/schemas/Schema_3d1cd815592582c496b313ba416ab0870a5b847fedc48c1e411c39a5ef1d45f4"},"zoom":{"$ref":"#/components/schemas/Schema_91a0439dbbd92cd45383cfadc493423b2037036823521cb4160c86b270240132"}},"type":"object"}]},"description":"Defines the variants the video player can choose from. The keys are the names of the variant as they will appear in the generated playlists and URLs.","type":"object"}},"required":["robot","variants"],"type":"object"},{"additionalProperties":false,"properties":{"ffmpeg":{"$ref":"#/components/schemas/Schema_15464c9d28640e7bf8903ba6d26df07ca6adbb8f0503e291180fa8a4647ec8e5"},"ffmpeg_stack":{"$ref":"#/components/schemas/Schema_2af3b38087bd992e9cae66535831de488ac05a86fd19619f5cfd998074675a28"},"force_accept":{"$ref":"#/components/schemas/Schema_a7b463c184f2431703a1692b1402307bb6bb726278c59f7075fd0b8d6eb2be3c"},"height":{"$ref":"#/components/schemas/Schema_1f5747f817d177d1a6318f567b28020a1c25097714b44829504283838cf33b39"},"ignore_errors":{"$ref":"#/components/schemas/Schema_866196eee82a663b71c0a383fdfb2f39a777749440b227619ea17fc8101eb5f4"},"interpolate":{"$ref":"#/components/schemas/Schema_210bc4cac49d5a8403766e579b22242786bad39b0b9ff4753e56b678e29f38d4"},"output_meta":{"$ref":"#/components/schemas/Schema_60f6dcc23a68fee86135afddfdf2d63c170b886a6deb46563e7193f688ef4e6e"},"preset":{"$ref":"#/components/schemas/Schema_8ae0b8fbf79b68fb3deaf6da0348e39fc3fa033f61c4544fbb4b4e6cd48fb3b5"},"queue":{"$ref":"#/components/schemas/Schema_d0a30e0594348bac539404e659baaa1896ab178c82448e3cb657bb8df8a525c4"},"result":{"$ref":"#/components/schemas/Schema_e2eec9f0d3cf6892bbba08d6f0cb6582dc8dc7e3d2f71da8cbd997ad577ec0be"},"robot":{"const":"/video/split","description":"\nSplits a video into multiple segments based on an array of from/to durations. Each segment produces a separate output file. This is useful for cutting a video into parts, for example to insert ads later via [🤖/video/concat](/docs/robots/video-concat/).\n","type":"string"},"segments":{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"description":"\nAn array of objects, each specifying a segment to extract from the input video. Each object must have a `from` and `to` key indicating the start and end time of the segment.\n\nTimes can be specified as numbers (seconds) or as timecode strings (e.g. `\"00:01:30.000\"`).\n","items":{"$ref":"#/components/schemas/Schema_9681caa0aa6542ed2a643b183b7c36d228a47074be0dabdc585931c16610f02c"},"minItems":1,"type":"array"}]},"use":{"$ref":"#/components/schemas/Schema_47b2fd205d779e1de6bc4fd78c788d8393756436c48ec6f785f30dc6e16238aa"},"user_meta":{"$ref":"#/components/schemas/Schema_070d50917dd042191e4290744649be38025190ee43499886e5481a7d5627241d"},"width":{"$ref":"#/components/schemas/Schema_3d1cd815592582c496b313ba416ab0870a5b847fedc48c1e411c39a5ef1d45f4"}},"required":["robot","segments"],"type":"object"},{"additionalProperties":false,"properties":{"bold":{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"anyOf":[{"type":"boolean"},{"enum":["false","true"],"type":"string"}]}],"default":false,"description":"\nSpecifies whether the subtitle text should be bold. Only applies to burned subtitles.\n"},"border_color":{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"pattern":"^#?[0-9a-fA-F]{6}([0-9a-fA-F]{2})?$","type":"string"}],"default":"40000000","description":"\nThe color for the subtitle border. The first two hex digits specify the alpha value of the color.\n"},"border_style":{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"enum":["box","outline","shadow"],"type":"string"}],"default":"outline","description":"\nSpecifies the style of the subtitle. Use the `border_color` parameter to specify the color of the border.\n"},"ffmpeg":{"$ref":"#/components/schemas/Schema_15464c9d28640e7bf8903ba6d26df07ca6adbb8f0503e291180fa8a4647ec8e5"},"ffmpeg_stack":{"$ref":"#/components/schemas/Schema_2af3b38087bd992e9cae66535831de488ac05a86fd19619f5cfd998074675a28"},"font":{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"type":"string"}],"default":"Arial","description":"\nThe font family to use. Also includes boldness and style of the font.\n\n[Here](/docs/supported-formats/fonts/) is a list of all supported fonts.\n"},"font_color":{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"pattern":"^#?[0-9a-fA-F]{3}([0-9a-fA-F]{3})?$","type":"string"}]},{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"pattern":"^#?[0-9a-fA-F]{6}([0-9a-fA-F]{2})?$","type":"string"}]}],"default":"FFFFFF","description":"\nThe color of the subtitle text in `\"rgb\"`, `\"rrggbb\"`, or `\"aarrggbb\"` format. If 8 hex digits are provided, the first two specify the alpha value of the color (`\"00\"` is fully opaque, `\"ff\"` is fully transparent).\n"},"font_size":{"anyOf":[{"pattern":"^[0-9]+(\\.[0-9]+)?$","type":"string"},{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"minimum":1,"type":"integer"}],"default":16,"description":"\nSpecifies the size of the text.\n"},"force_accept":{"$ref":"#/components/schemas/Schema_a7b463c184f2431703a1692b1402307bb6bb726278c59f7075fd0b8d6eb2be3c"},"height":{"$ref":"#/components/schemas/Schema_1f5747f817d177d1a6318f567b28020a1c25097714b44829504283838cf33b39"},"ignore_errors":{"$ref":"#/components/schemas/Schema_866196eee82a663b71c0a383fdfb2f39a777749440b227619ea17fc8101eb5f4"},"interpolate":{"$ref":"#/components/schemas/Schema_210bc4cac49d5a8403766e579b22242786bad39b0b9ff4753e56b678e29f38d4"},"italic":{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"anyOf":[{"type":"boolean"},{"enum":["false","true"],"type":"string"}]}],"default":false,"description":"\nSpecifies whether the subtitle text should be italic. Only applies to burned subtitles.\n"},"keep_subtitles":{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"anyOf":[{"type":"boolean"},{"enum":["false","true"],"type":"string"}]}],"default":false,"description":"\nSpecifies if existing subtitles in the input file should be kept or be replaced by the new subtitle. Only used if the subtitles are external. Set this to `true` when chaining multiple `/video/subtitle` Steps to add several subtitle streams (e.g. different languages) to the same video.\n"},"language":{"anyOf":[{"anyOf":[{"not":{}},{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"type":"string"}]}]},{"type":"null"}],"description":"\nSpecifies the language of the subtitle stream using a three-letter language code (e.g. `\"eng\"`, `\"deu\"`, `\"spa\"`). Only used if the subtitles are external. When adding multiple subtitle streams, set a different language for each stream so that video players can offer language selection.\n"},"name":{"anyOf":[{"anyOf":[{"not":{}},{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"type":"string"}]}]},{"type":"null"}],"description":"\nSpecifies a human-readable name for the subtitle track (e.g. `\"English\"`, `\"Deutsch\"`, `\"Español\"`). Only used if the subtitles are external. This name is displayed in video player subtitle menus alongside the language.\n"},"outline_width":{"anyOf":[{"anyOf":[{"not":{}},{"anyOf":[{"pattern":"^[0-9]+(\\.[0-9]+)?$","type":"string"},{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"maximum":10,"minimum":0,"type":"integer"}]}]},{"type":"null"}],"description":"\nSpecifies the width of the text outline in pixels. Only applies to burned subtitles with `\"outline\"` or `\"box\"` border styles. If not specified, the default width is used.\n"},"output_meta":{"$ref":"#/components/schemas/Schema_60f6dcc23a68fee86135afddfdf2d63c170b886a6deb46563e7193f688ef4e6e"},"position":{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"enum":["bottom","bottom-left","bottom-right","center","left","right","top","top-left","top-right"],"type":"string"}],"default":"bottom","description":"\nSpecifies the position of the subtitles.\n"},"preset":{"$ref":"#/components/schemas/Schema_8ae0b8fbf79b68fb3deaf6da0348e39fc3fa033f61c4544fbb4b4e6cd48fb3b5"},"queue":{"$ref":"#/components/schemas/Schema_d0a30e0594348bac539404e659baaa1896ab178c82448e3cb657bb8df8a525c4"},"result":{"$ref":"#/components/schemas/Schema_e2eec9f0d3cf6892bbba08d6f0cb6582dc8dc7e3d2f71da8cbd997ad577ec0be"},"robot":{"const":"/video/subtitle","description":"\nThis Robot supports both SRT and VTT subtitle files.\n","type":"string"},"subtitles_type":{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"enum":["burn","burned","external"],"type":"string"}],"default":"external","description":"\nDetermines if subtitles are added as a separate stream to the video (value `\"external\"`) that then can be switched on and off in your video player, or if they should be burned directly into the video (value `\"burned\"` or `\"burn\"`) so that they become part of the video stream.\n"},"use":{"$ref":"#/components/schemas/Schema_47b2fd205d779e1de6bc4fd78c788d8393756436c48ec6f785f30dc6e16238aa"},"user_meta":{"$ref":"#/components/schemas/Schema_070d50917dd042191e4290744649be38025190ee43499886e5481a7d5627241d"},"width":{"$ref":"#/components/schemas/Schema_3d1cd815592582c496b313ba416ab0870a5b847fedc48c1e411c39a5ef1d45f4"}},"required":["robot"],"type":"object"},{"additionalProperties":false,"properties":{"background":{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"pattern":"^#?[0-9a-fA-F]{6}([0-9a-fA-F]{2})?$","type":"string"}],"default":"#00000000","description":"\nThe background color of the resulting thumbnails in the `\"rrggbbaa\"` format (red, green, blue, alpha) when used with the `\"pad\"` resize strategy. The default color is black.\n"},"count":{"anyOf":[{"pattern":"^[0-9]+(\\.[0-9]+)?$","type":"string"},{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"maximum":999,"minimum":1,"type":"integer"}],"default":8,"description":"\nThe number of thumbnails to be extracted. As some videos have incorrect durations, the actual number of thumbnails generated may be less in rare cases. The maximum number of thumbnails we currently allow is 999.\n\nThe thumbnails are taken at regular intervals, determined by dividing the video duration by the count. For example, a count of 3 will produce thumbnails at 25%, 50% and 75% through the video.\n\nTo extract thumbnails for specific timestamps, use the `offsets` parameter.\n"},"ffmpeg":{"$ref":"#/components/schemas/Schema_15464c9d28640e7bf8903ba6d26df07ca6adbb8f0503e291180fa8a4647ec8e5"},"ffmpeg_stack":{"$ref":"#/components/schemas/Schema_2af3b38087bd992e9cae66535831de488ac05a86fd19619f5cfd998074675a28"},"force_accept":{"$ref":"#/components/schemas/Schema_a7b463c184f2431703a1692b1402307bb6bb726278c59f7075fd0b8d6eb2be3c"},"format":{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"enum":["jpeg","jpg","png"],"type":"string"}],"default":"jpeg","description":"\nThe format of the extracted thumbnail. Supported values are `\"jpg\"`, `\"jpeg\"` and `\"png\"`. Even if you specify the format to be `\"jpeg\"` the resulting thumbnails will have a `\"jpg\"` file extension.\n"},"height":{"anyOf":[{"pattern":"^[0-9]+(\\.[0-9]+)?$","type":"string"},{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"maximum":1080,"minimum":1,"type":"integer"}],"description":"\nThe height of the thumbnail, in pixels. Defaults to the original height of the video.\n"},"ignore_errors":{"$ref":"#/components/schemas/Schema_866196eee82a663b71c0a383fdfb2f39a777749440b227619ea17fc8101eb5f4"},"input_codec":{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"type":"string"}],"description":"\nSpecifies the input codec to use when decoding the video. This is useful for videos with special codecs that require specific decoders.\n"},"interpolate":{"$ref":"#/components/schemas/Schema_210bc4cac49d5a8403766e579b22242786bad39b0b9ff4753e56b678e29f38d4"},"offsets":{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"items":{"$ref":"#/components/schemas/Schema_30573475089cec428fa966ac94d74114e316d676d5e62f4c710cb1a87589b4f0"},"type":"array"}]},{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"items":{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"pattern":"^[0-9]+%$","type":"string"}]},"type":"array"}]}],"default":[],"description":"\nAn array of offsets representing seconds of the file duration, such as `[ 2, 45, 120 ]`. Millisecond durations of a file can also be used by using decimal place values. For example, an offset from 1250 milliseconds would be represented with `1.25`. Offsets can also be percentage values such as `[ \"2%\", \"50%\", \"75%\" ]`.\n\nThis option cannot be used with the `count` parameter, and takes precedence if both are specified. Out-of-range offsets are silently ignored.\n\nWhen `smart` is `true`, smart selection ignores `offsets` and uses `count` to select from its own candidate timestamps. If no smart candidates can be extracted, the Robot falls back to standard extraction, where `offsets` takes precedence. Use `smart: false` to consistently extract the specified timestamps.\n"},"output_meta":{"$ref":"#/components/schemas/Schema_60f6dcc23a68fee86135afddfdf2d63c170b886a6deb46563e7193f688ef4e6e"},"queue":{"$ref":"#/components/schemas/Schema_d0a30e0594348bac539404e659baaa1896ab178c82448e3cb657bb8df8a525c4"},"resize_strategy":{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"enum":["crop","fillcrop","fit","min_fit","pad","stretch"],"type":"string"}],"default":"pad","description":"\nOne of the [available resize strategies](/docs/topics/resize-strategies/).\n"},"result":{"$ref":"#/components/schemas/Schema_e2eec9f0d3cf6892bbba08d6f0cb6582dc8dc7e3d2f71da8cbd997ad577ec0be"},"robot":{"const":"/video/thumbs","description":"\nSet `smart: true` to select strong preview images with AI instead of taking frames only at regular intervals. The Robot scores candidate frames for clarity, brightness, composition, faces, expressions, action, and visual interest, then returns the best `count` frames in chronological order. Smart results include `file.meta.smart_score` and `file.meta.smart_reasons`. If AI scoring is unavailable, the Assembly continues with the candidate frames in fallback order and includes a warning. No AI credentials are required.\n\n## AI pricing\n\nRegular `/video/thumbs` processing charges still apply. AI frame analysis is billed separately at the underlying provider cost plus a 50% Transloadit markup. The exact AI charge varies with the number of candidate frames, the internally selected model and provider pricing, and the image payload size.\n\n`smart_max_candidates` is the main cost and latency control. The Robot analyzes up to three candidates per requested thumbnail, capped by `smart_max_candidates`, but never fewer than `count`. With the defaults of `count: 8` and `smart_max_candidates: 20`, it analyzes 20 frames and returns the best 8. Lower the candidate limit to reduce AI cost and latency; raise it to give the AI more frames to choose from.\n\n> [!Note]\n> Use `count` with smart selection. To consistently extract exact timestamps with `offsets`, set `smart: false`.\n\n> [!Note]\n> Even though thumbnails are extracted from videos in parallel, we sort the thumbnails before adding them to the Assembly results. So the order in which they appear there reflects the order in which they appear in the video. You can also make sure by checking the `thumb_index` meta key.\n\nFor an upload-to-poster Template, SDK usage, and publication checks, see the [HTML video workflow guide](/guides/html-video-production-checklist/#html-video-production-checklist-section-6). The [video and S3 demo](/demos/file-exporting/store-encoding-and-thumbnails-on-s3/) includes a recorded input and extracted frames.\n","type":"string"},"rotate":{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"const":0,"type":"number"}]},{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"const":90,"type":"number"}]},{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"const":180,"type":"number"}]},{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"const":270,"type":"number"}]},{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"const":360,"type":"number"}]}],"default":0,"description":"\nForces the video to be rotated by the specified degree integer. Currently, only multiples of 90 are supported. We automatically correct the orientation of many videos when the orientation is provided by the camera. This option is only useful for videos requiring rotation because it was not detected by the camera.\n"},"smart":{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"anyOf":[{"type":"boolean"},{"enum":["false","true"],"type":"string"}]}],"default":false,"description":"\nWhen set to `true`, enables AI-powered smart thumbnail selection. Instead of returning thumbnails at regular intervals, the Robot will analyze candidate frames and select the most visually appealing ones.\n\nThe AI evaluates frames based on:\n- Visual clarity (avoiding blurry or dark frames)\n- Composition quality\n- Face presence and expressions\n- Action and motion (avoiding transition frames)\n- Overall visual interest\n\nRegular `/video/thumbs` processing charges still apply. AI frame analysis is billed separately at the underlying provider cost plus a 50% Transloadit markup. You do not need to provide AI credentials.\n\nSmart mode generates its own regularly spaced candidate timestamps; use `smart: false` with `offsets` when you need specified timestamps. Selected smart thumbnails are returned in chronological order, not score order. Inspect `meta.thumb_offset`, `meta.smart_score`, and `meta.smart_reasons` when evaluating the selection.\n\nIf AI scoring fails, the Robot selects extracted candidates in chronological order and records a fallback reason. With no candidates, it attempts standard extraction. Both fallbacks add an Assembly warning. A completed Assembly does not guarantee a representative or publication-safe poster; check that outputs exist and apply your application’s review policy.\n"},"smart_max_candidates":{"anyOf":[{"pattern":"^[0-9]+(\\.[0-9]+)?$","type":"string"},{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"maximum":100,"minimum":2,"type":"integer"}],"default":20,"description":"\nThe maximum size of the candidate pool when `smart` is `true`. The Robot analyzes up to three candidates per requested thumbnail, capped by this value, but it will never analyze fewer candidates than the requested `count`.\n\nA higher number may yield better results but increases processing time and AI cost. With the defaults of `count: 8` and `smart_max_candidates: 20`, the Robot analyzes 20 frames and returns the best 8 in chronological order.\n\nThis parameter is only used when `smart` is `true`.\n"},"use":{"$ref":"#/components/schemas/Schema_47b2fd205d779e1de6bc4fd78c788d8393756436c48ec6f785f30dc6e16238aa"},"user_meta":{"$ref":"#/components/schemas/Schema_070d50917dd042191e4290744649be38025190ee43499886e5481a7d5627241d"},"width":{"anyOf":[{"pattern":"^[0-9]+(\\.[0-9]+)?$","type":"string"},{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"maximum":1920,"minimum":1,"type":"integer"}],"description":"\nThe width of the thumbnail, in pixels. Defaults to the original width of the video.\n"}},"required":["robot"],"type":"object"},{"additionalProperties":false,"properties":{"credentials":{"$ref":"#/components/schemas/Schema_ff500423b78c329151c169aeb34426a68588363f1686c1a5d1c35c7b0c5437fa"},"files_per_page":{"anyOf":[{"pattern":"^[0-9]+(\\.[0-9]+)?$","type":"string"},{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"exclusiveMinimum":0,"maximum":100,"type":"integer"}],"default":20,"description":"The number of files to import per page. Maximum is 100 as per Vimeo API limits."},"force_accept":{"$ref":"#/components/schemas/Schema_a7b463c184f2431703a1692b1402307bb6bb726278c59f7075fd0b8d6eb2be3c"},"force_name":{"$ref":"#/components/schemas/Schema_e2d753e6b6111506a4565bdb18eccafd67d2027839616974639f5565d695fafd"},"ignore_errors":{"$ref":"#/components/schemas/Schema_03e4961eba9e9b422ce714f9224b8d47a380c80d27b8342a78ba4e2702feb4db"},"import_on_errors":{"$ref":"#/components/schemas/Schema_61808f40a326596fd9674ebbd91184b0a2e04f8c67eb49fdf9f9449580271ab8"},"interpolate":{"$ref":"#/components/schemas/Schema_210bc4cac49d5a8403766e579b22242786bad39b0b9ff4753e56b678e29f38d4"},"output_meta":{"$ref":"#/components/schemas/Schema_60f6dcc23a68fee86135afddfdf2d63c170b886a6deb46563e7193f688ef4e6e"},"page_number":{"anyOf":[{"pattern":"^[0-9]+(\\.[0-9]+)?$","type":"string"},{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"exclusiveMinimum":0,"type":"integer"}],"default":1,"description":"The page number to import from. Vimeo API uses pagination for large result sets."},"path":{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"type":"string"}]},{"$ref":"#/components/schemas/Schema_bc9fbfc32e2939087e1b877c2b51ce63f08c8cdfdcf7adca01505a0498ab5691"}],"default":"me/videos","description":"\nThe Vimeo API path to import from. The most common paths are:\n- `me/videos`: Your own videos\n- `me/likes`: Videos you've liked\n- `me/albums/:album_id/videos`: Videos from a specific album\n- `me/channels/:channel_id/videos`: Videos from a specific channel\n- `me/groups/:group_id/videos`: Videos from a specific group\n- `me/portfolios/:portfolio_id/videos`: Videos from a specific portfolio\n- `me/watchlater`: Videos in your watch later queue\n\nYou can also use an array of path strings here to import multiple paths in the same Robot's Step.\n"},"queue":{"$ref":"#/components/schemas/Schema_d0a30e0594348bac539404e659baaa1896ab178c82448e3cb657bb8df8a525c4"},"rendition":{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"enum":["1080p","240p","360p","540p","720p","source"],"type":"string"}],"default":"720p","description":"The quality of the video to import."},"result":{"$ref":"#/components/schemas/Schema_e2eec9f0d3cf6892bbba08d6f0cb6582dc8dc7e3d2f71da8cbd997ad577ec0be"},"robot":{"const":"/vimeo/import","description":"Identifier of the [robot](https://transloadit.com/docs/robots/) to execute","type":"string"},"user_meta":{"$ref":"#/components/schemas/Schema_070d50917dd042191e4290744649be38025190ee43499886e5481a7d5627241d"}},"required":["robot"],"type":"object"},{"additionalProperties":false,"properties":{"acl":{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"enum":["anybody","contacts","disable","nobody","password","unlisted","users"],"type":"string"}],"default":"anybody","description":"\nControls access permissions for the video. Here are the valid values:\n\n- `\"anybody\"` — anyone can access the video.\n- `\"contacts\"` — only those who follow the owner on Vimeo can access the video.\n- `\"disable\"` — the video is embeddable, but it's hidden on Vimeo and can't be played.\n- `\"nobody\"` — no one except the owner can access the video.\n- `\"password\"` — only those with the password can access the video.\n- `\"unlisted\"` — only those with the private link can access the video.\n- `\"users\"` — only Vimeo members can access the video.\n"},"credentials":{"$ref":"#/components/schemas/Schema_ff500423b78c329151c169aeb34426a68588363f1686c1a5d1c35c7b0c5437fa"},"description":{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"description":"\nThe description of the video to be displayed on Vimeo.\n","type":"string"}],"description":"\nThe description of the video to be displayed on Vimeo.\n"},"downloadable":{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"anyOf":[{"type":"boolean"},{"enum":["false","true"],"type":"string"}]}],"default":false,"description":"\nWhether or not the video can be downloaded from the Vimeo website.\n\nOnly set this to `true` if you have unlocked this feature in your Vimeo accounting by upgrading to their \"Pro\" plan. If you use it while on their Freemium plan, the Vimeo API will return an `\"Invalid parameter supplied\"` error.\n"},"folder_id":{"anyOf":[{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"type":"string"}]},{"type":"null"}],"default":null,"description":"\nThe ID of the folder to which the video is uploaded.\n\nWhen visiting one of your folders, the URL is similar to `https://vimeo.com/manage/folders/xxxxxxxx`. The folder_id would be `\"xxxxxxxx\"`.\n"},"folder_uri":{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"type":"string"}],"description":"\nDeprecated. Please use `folder_id` instead. The URI of the folder to which the video is uploaded.\n"},"force_accept":{"$ref":"#/components/schemas/Schema_a7b463c184f2431703a1692b1402307bb6bb726278c59f7075fd0b8d6eb2be3c"},"ignore_errors":{"$ref":"#/components/schemas/Schema_866196eee82a663b71c0a383fdfb2f39a777749440b227619ea17fc8101eb5f4"},"interpolate":{"$ref":"#/components/schemas/Schema_210bc4cac49d5a8403766e579b22242786bad39b0b9ff4753e56b678e29f38d4"},"output_meta":{"$ref":"#/components/schemas/Schema_60f6dcc23a68fee86135afddfdf2d63c170b886a6deb46563e7193f688ef4e6e"},"password":{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"type":"string"}],"description":"\nThe password to access the video if `acl` is `\"password\"`.\n"},"queue":{"$ref":"#/components/schemas/Schema_d0a30e0594348bac539404e659baaa1896ab178c82448e3cb657bb8df8a525c4"},"result":{"$ref":"#/components/schemas/Schema_e2eec9f0d3cf6892bbba08d6f0cb6582dc8dc7e3d2f71da8cbd997ad577ec0be"},"robot":{"const":"/vimeo/store","description":"\n## Getting started\n\nSince Vimeo works with OAuth, you will need to generate [Template Credentials](https://transloadit.com/c/template-credentials/) to use this Robot.\n\nTo change the `title` or `description` per video, we recommend to [inject variables into your Template](/docs/topics/templates/).\n\n> [!Warning]\n> Vimeo's API limits the number of concurrent uploads per minute based on your Vimeo account plan. To see how many videos can be uploaded at once based on your plan, click the following [link](https://developer.vimeo.com/guidelines/rate-limiting#table-1).\n\nNote that this Robot only accepts videos.\n","type":"string"},"showcases":{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"items":{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"type":"string"}]},"type":"array"}],"default":[],"description":"\nAn array of string IDs of showcases that you want to add the video to. The IDs can be found when browsing Vimeo. For example `https://vimeo.com/manage/showcases/[SHOWCASE_ID]/info`.\n"},"title":{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"description":"\nThe title of the video to be displayed on Vimeo.\n","type":"string"}],"description":"\nThe title of the video to be displayed on Vimeo.\n"},"use":{"$ref":"#/components/schemas/Schema_47b2fd205d779e1de6bc4fd78c788d8393756436c48ec6f785f30dc6e16238aa"},"user_meta":{"$ref":"#/components/schemas/Schema_070d50917dd042191e4290744649be38025190ee43499886e5481a7d5627241d"}},"required":["description","robot","title"],"type":"object"},{"additionalProperties":false,"properties":{"bucket":{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"type":"string"}]},"bucket_region":{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"type":"string"}],"description":"\nThe region where the bucket is located.\n"},"credentials":{"$ref":"#/components/schemas/Schema_e7f76bc0019770ddc43271041ddff4141f276907f477fc7d8e4823eaf41072cc"},"files_per_page":{"$ref":"#/components/schemas/Schema_fb8110ac8e46afd357588fdb3f6e0487d14ea219ff23b237b83413793ce39f30"},"force_accept":{"$ref":"#/components/schemas/Schema_a7b463c184f2431703a1692b1402307bb6bb726278c59f7075fd0b8d6eb2be3c"},"force_name":{"$ref":"#/components/schemas/Schema_e2d753e6b6111506a4565bdb18eccafd67d2027839616974639f5565d695fafd"},"host":{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"type":"string"}]},"ignore_errors":{"$ref":"#/components/schemas/Schema_03e4961eba9e9b422ce714f9224b8d47a380c80d27b8342a78ba4e2702feb4db"},"import_on_errors":{"$ref":"#/components/schemas/Schema_61808f40a326596fd9674ebbd91184b0a2e04f8c67eb49fdf9f9449580271ab8"},"interpolate":{"$ref":"#/components/schemas/Schema_210bc4cac49d5a8403766e579b22242786bad39b0b9ff4753e56b678e29f38d4"},"key":{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"type":"string"}]},"output_meta":{"$ref":"#/components/schemas/Schema_60f6dcc23a68fee86135afddfdf2d63c170b886a6deb46563e7193f688ef4e6e"},"page_number":{"$ref":"#/components/schemas/Schema_700ca6e236bc3ce29f7390532b108f5a864258e18588a743c9d63fff1d8ecf5d"},"path":{"$ref":"#/components/schemas/Schema_29b03e33e094714044bf936cf358f56ce8a49e8051c5e450b83befe9961c4ace"},"queue":{"$ref":"#/components/schemas/Schema_d0a30e0594348bac539404e659baaa1896ab178c82448e3cb657bb8df8a525c4"},"recursive":{"$ref":"#/components/schemas/Schema_8305335b6eafa6a9a8c0e5d531016c79ff3ffd63f98546b464a7fd0b9473ba0f"},"result":{"$ref":"#/components/schemas/Schema_ca159bf04e5ff3004e76aa992115890f7a332c46f90913826648557e7fc86b82"},"return_file_stubs":{"$ref":"#/components/schemas/Schema_7d0953e667a4e84601b14c25ec998d74076b0afded4b1fe7182cba7b5a1062f7"},"robot":{"const":"/wasabi/import","description":"Identifier of the [robot](https://transloadit.com/docs/robots/) to execute","type":"string"},"secret":{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"type":"string"}]},"user_meta":{"$ref":"#/components/schemas/Schema_070d50917dd042191e4290744649be38025190ee43499886e5481a7d5627241d"}},"required":["path","robot"],"type":"object"},{"additionalProperties":false,"properties":{"acl":{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"enum":["private","public-read"],"type":"string"}],"default":"private","description":"\nThe permissions used for this file.\n"},"bucket":{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"type":"string"}]},"bucket_region":{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"type":"string"}],"description":"\nThe region where the bucket is located.\n"},"credentials":{"$ref":"#/components/schemas/Schema_e7f76bc0019770ddc43271041ddff4141f276907f477fc7d8e4823eaf41072cc"},"force_accept":{"$ref":"#/components/schemas/Schema_a7b463c184f2431703a1692b1402307bb6bb726278c59f7075fd0b8d6eb2be3c"},"headers":{"additionalProperties":{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"type":"string"}]},"default":{"Content-Type":"${file.mime}"},"description":"\nAn object containing a list of headers to be set for this file in your Wasabi bucket, such as `{ FileURL: \"${file.url_name}\" }`. This can also include any available [Assembly Variables](/docs/topics/assembly-instructions/#assembly-variables).\n\nObject Metadata can be specified using `x-amz-meta-*` headers. Note that these headers [do not support non-ASCII metadata values](https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html#UserMetadata).\n","type":"object"},"host":{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"type":"string"}]},"ignore_errors":{"$ref":"#/components/schemas/Schema_866196eee82a663b71c0a383fdfb2f39a777749440b227619ea17fc8101eb5f4"},"interpolate":{"$ref":"#/components/schemas/Schema_210bc4cac49d5a8403766e579b22242786bad39b0b9ff4753e56b678e29f38d4"},"key":{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"type":"string"}]},"output_meta":{"$ref":"#/components/schemas/Schema_60f6dcc23a68fee86135afddfdf2d63c170b886a6deb46563e7193f688ef4e6e"},"path":{"$ref":"#/components/schemas/Schema_9e32d2e043ddaf27be258da25a42fb43c4a65680e4582d53c4c0e1d0b76908cf"},"queue":{"$ref":"#/components/schemas/Schema_d0a30e0594348bac539404e659baaa1896ab178c82448e3cb657bb8df8a525c4"},"result":{"$ref":"#/components/schemas/Schema_e2eec9f0d3cf6892bbba08d6f0cb6582dc8dc7e3d2f71da8cbd997ad577ec0be"},"robot":{"const":"/wasabi/store","description":"\nThe URL to the result file will be returned in the Assembly Status JSON.\n","type":"string"},"secret":{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"type":"string"}]},"sign_urls_for":{"$ref":"#/components/schemas/Schema_6561742ad8531818ad835d63fdd348612b329189814a3953875b261e98fcb035"},"use":{"$ref":"#/components/schemas/Schema_47b2fd205d779e1de6bc4fd78c788d8393756436c48ec6f785f30dc6e16238aa"},"user_meta":{"$ref":"#/components/schemas/Schema_070d50917dd042191e4290744649be38025190ee43499886e5481a7d5627241d"}},"required":["robot"],"type":"object"},{"additionalProperties":false,"properties":{"category":{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"description":"\nThe category to which this video will be assigned.\n","pattern":"^(?:[aA][uU][tT][oO][sS] & [vV][eE][hH][iI][cC][lL][eE][sS]|[cC][oO][mM][eE][dD][yY]|[eE][dD][uU][cC][aA][tT][iI][oO][nN]|[eE][nN][tT][eE][rR][tT][aA][iI][nN][mM][eE][nN][tT]|[fF][iI][lL][mM] & [aA][nN][iI][mM][aA][tT][iI][oO][nN]|[gG][aA][mM][iI][nN][gG]|[hH][oO][wW][tT][oO] & [sS][tT][yY][lL][eE]|[mM][uU][sS][iI][cC]|[nN][eE][wW][sS] & [pP][oO][lL][iI][tT][iI][cC][sS]|[pP][eE][oO][pP][lL][eE] & [bB][lL][oO][gG][sS]|[pP][eE][tT][sS] & [aA][nN][iI][mM][aA][lL][sS]|[sS][cC][iI][eE][nN][cC][eE] & [tT][eE][cC][hH][nN][oO][lL][oO][gG][yY]|[sS][pP][oO][rR][tT][sS]|[tT][rR][aA][vV][eE][lL] & [eE][vV][eE][nN][tT][sS])$","type":"string"}],"description":"\nThe category to which this video will be assigned.\n"},"credentials":{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"description":"\nThe authentication Template credentials used for your YouTube account. You can generate them on the [Template Credentials page](/c/template-credentials/). Simply add the name of your YouTube channel, and you will be redirected to a Google verification page. Accept the presented permissions and you will be good to go.\n","type":"string"}],"description":"\nThe authentication Template credentials used for your YouTube account. You can generate them on the [Template Credentials page](/c/template-credentials/). Simply add the name of your YouTube channel, and you will be redirected to a Google verification page. Accept the presented permissions and you will be good to go.\n"},"description":{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"description":"\nThe description of the video to be displayed on YouTube. This can be up to 5000 characters, including `\\n` for new-lines.\n","type":"string"}],"description":"\nThe description of the video to be displayed on YouTube. This can be up to 5000 characters, including `\\n` for new-lines.\n"},"force_accept":{"$ref":"#/components/schemas/Schema_a7b463c184f2431703a1692b1402307bb6bb726278c59f7075fd0b8d6eb2be3c"},"ignore_errors":{"$ref":"#/components/schemas/Schema_866196eee82a663b71c0a383fdfb2f39a777749440b227619ea17fc8101eb5f4"},"interpolate":{"$ref":"#/components/schemas/Schema_210bc4cac49d5a8403766e579b22242786bad39b0b9ff4753e56b678e29f38d4"},"keywords":{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"description":"\nTags used to describe the video, separated by commas. These tags will also be displayed on YouTube.\n","type":"string"}],"description":"\nTags used to describe the video, separated by commas. These tags will also be displayed on YouTube.\n"},"output_meta":{"$ref":"#/components/schemas/Schema_60f6dcc23a68fee86135afddfdf2d63c170b886a6deb46563e7193f688ef4e6e"},"queue":{"$ref":"#/components/schemas/Schema_d0a30e0594348bac539404e659baaa1896ab178c82448e3cb657bb8df8a525c4"},"result":{"$ref":"#/components/schemas/Schema_e2eec9f0d3cf6892bbba08d6f0cb6582dc8dc7e3d2f71da8cbd997ad577ec0be"},"robot":{"const":"/youtube/store","description":"\n## Getting started\n\nSince YouTube works with OAuth, you will need to generate [Template Credentials](/c/template-credentials/) to use this Robot.\n\nTo change the `title`, `description`, `category`, or `keywords` per video, we recommend to [inject variables into your Template](/docs/topics/templates/).\n\nNote that this Robot only accepts videos.\n\n## Adding a thumbnail image to your video\n\nYou can add a custom thumbnail to your video on YouTube by using our `\"as\"` syntax for the `\"use\"` parameter to supply both a video and an image to the step:\n\n```json\n\"exported\": {\n \"use\": [\n { \"name\": \"video_encode_step\", \"as\": \"video\" },\n { \"name\": \"image_resize_step\", \"as\": \"image\" },\n ],\n ...\n},\n```\n\nIf you encounter an error such as \"The authenticated user doesn’t have permissions to upload and set custom video thumbnails\", you should go to your YouTube account and try adding a custom thumbnail to one of your existing videos. You’ll be prompted to add your phone number. Once you’ve added it, the error should go away.\n","type":"string"},"title":{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"description":"\nThe title of the video to be displayed on YouTube.\n\nNote that since the YouTube API requires titles to be within 80 characters, longer titles may be truncated.\n","maxLength":80,"type":"string"}],"description":"\nThe title of the video to be displayed on YouTube.\n\nNote that since the YouTube API requires titles to be within 80 characters, longer titles may be truncated.\n"},"use":{"$ref":"#/components/schemas/Schema_47b2fd205d779e1de6bc4fd78c788d8393756436c48ec6f785f30dc6e16238aa"},"user_meta":{"$ref":"#/components/schemas/Schema_070d50917dd042191e4290744649be38025190ee43499886e5481a7d5627241d"},"visibility":{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"description":"\nDefines the visibility of the uploaded video.\n","enum":["private","public","unlisted"],"type":"string"}],"description":"\nDefines the visibility of the uploaded video.\n"}},"required":["category","credentials","description","keywords","robot","title","visibility"],"type":"object"}]},"description":"Contains Assembly Instructions.","type":"object","x-transloadit-description-id":"assemblyInstructions","x-transloadit-schema-id":"sha256:97aad3d37f5046edcb335db4458316ce19e3edbaf9c9f74754f078aae9e99450"},"Schema_98821d3fb80b8da19ecd734f66fdce4852dd42c3933f85148896f6e4b1232881":{"anyOf":[{"description":"Elapsed delivery time in seconds, including automatic retry attempts and the delays between them.","type":"number","x-transloadit-description-id":"assemblyNotificationDuration"},{"type":"null"}],"description":"Elapsed delivery time in seconds, including automatic retry attempts and the delays between them.","x-transloadit-description-id":"assemblyNotificationDuration","x-transloadit-schema-id":"sha256:98821d3fb80b8da19ecd734f66fdce4852dd42c3933f85148896f6e4b1232881"},"Schema_995e384a38585760bf60a96e9933b8db3ca61882b133cf6952963495d3926235":{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"type":"string"}],"description":"\nPlease create your associated Template Credentials in your Transloadit account and use the name of your Template Credentials as this parameter's value. They will contain the values for your Dropbox access token.\n","x-transloadit-schema-id":"sha256:995e384a38585760bf60a96e9933b8db3ca61882b133cf6952963495d3926235"},"Schema_996716d855dbed98c66aed68a18187ca6af0a3239d643c4c607922f044569190":{"additionalProperties":true,"properties":{"credentials":{"items":{"additionalProperties":false,"properties":{"account_id":{"type":"string"},"content":{"anyOf":[{"additionalProperties":{},"type":"object"},{"items":{},"type":"array"},{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"null"}]},"created":{"anyOf":[{"anyOf":[{"type":"number"},{"type":"string"}]},{"type":"null"}]},"deleted":{"anyOf":[{"anyOf":[{"type":"number"},{"type":"string"}]},{"type":"null"}]},"id":{"type":"string"},"modified":{"anyOf":[{"anyOf":[{"type":"number"},{"type":"string"}]},{"type":"null"}]},"name":{"type":"string"},"stringified":{"type":"string"},"type":{"type":"string"}},"required":["account_id","content","created","deleted","id","modified","name","stringified","type"],"type":"object"},"type":"array"},"message":{"minLength":1,"type":"string"},"ok":{"const":"TEMPLATE_CREDENTIALS_FOUND","type":"string"}},"required":["credentials","message","ok"],"type":"object","x-transloadit-schema-id":"sha256:996716d855dbed98c66aed68a18187ca6af0a3239d643c4c607922f044569190"},"Schema_99943d2e7b4618d495632120f0b3afd3ff05ace6e91949c68286cce98ebd441d":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The total number of bytes that this Assembly processed that count towards your usage\nbill. The sum of `bytes_usage` of all of your Assemblies equal your total monthly\nusage.","x-transloadit-description-id":"assemblyStatusResponseBytesUsage","x-transloadit-schema-id":"sha256:99943d2e7b4618d495632120f0b3afd3ff05ace6e91949c68286cce98ebd441d"},"Schema_999c9f288a40aadd242801a55205a4b03aee8015882cc2ddfb32f6c82d917cb9":{"description":"Not to be confused with dominant color, that counts a single most occurring pixel color and has\nlimited use cases. The average color is calculated by first scaling the input image to 1 pixel.","type":["null","string"],"x-transloadit-description-id":"assemblyStatusMetaAverageColor","x-transloadit-schema-id":"sha256:999c9f288a40aadd242801a55205a4b03aee8015882cc2ddfb32f6c82d917cb9"},"Schema_9a0a76f0af9f4fb579969fc5942e87b2ef0569e89b34cfa832137b2dd9a6b07e":{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"type":"string"}],"description":"\nPlease create your associated Template Credentials in your Transloadit account and use the name of your [Template Credentials](/c/template-credentials/) as this parameter's value. They will contain the values for your DigitalOcean Space, Key, Secret and Region.\n\nWhile we recommend to use Template Credentials at all times, some use cases demand dynamic credentials for which using Template Credentials is too unwieldy because of their static nature. If you have this requirement, feel free to use the following parameters instead: `\"space\"`, `\"region\"` (for example: `\"fra1\"` or `\"nyc3\"`), `\"key\"`, `\"secret\"`.\n","x-transloadit-schema-id":"sha256:9a0a76f0af9f4fb579969fc5942e87b2ef0569e89b34cfa832137b2dd9a6b07e"},"Schema_9a564b45babfab238f659d4b00dce08c3beff7bec4004a2b3e88d3d04dc499c4":{"anyOf":[{"additionalProperties":true,"description":"The requested DAM resource was not found.","properties":{"error":{"const":"DAM_RESOURCE_NOT_FOUND","type":"string"},"http_code":{"const":404,"type":"number"},"message":{"description":"Human-readable explanation of the error. Its wording can vary; use the `error` code when handling a specific failure.","type":"string","x-transloadit-description-id":"api2ErrorMessage"}},"required":["error"],"type":"object","x-transloadit-description-id":"api2ErrorDamResourceNotFound"},{"allOf":[{"$ref":"#/components/schemas/Schema_cb07bdaec8a57b18babcb0842531069c047ea76747de30cb3433ec3ab53763cb"}]}],"x-transloadit-schema-id":"sha256:9a564b45babfab238f659d4b00dce08c3beff7bec4004a2b3e88d3d04dc499c4"},"Schema_9b86f9302aa0a4c52f7a64bcdae9a755b8e4199db9c3272c5552aaf0026fcd93":{"additionalProperties":false,"properties":{"message":{"minLength":1,"type":"string"},"ok":{"const":"DAM_ENTRY_MOVED","type":"string"},"path":{"minLength":1,"type":"string"}},"required":["message","ok","path"],"type":"object","x-transloadit-schema-id":"sha256:9b86f9302aa0a4c52f7a64bcdae9a755b8e4199db9c3272c5552aaf0026fcd93"},"Schema_9c510c8b82d350f15a96c981172e9e157a9d62193e3ddf9a410bf1f489b03a64":{"additionalProperties":true,"properties":{"content-disposition":{"minLength":1,"type":"string"},"content-type":{"pattern":"^[a-z]+\\/[a-z0-9+.-]+$","type":"string"},"last-modified":{"minLength":1,"type":"string"},"tus-resumable":{"const":"1.0.0","type":"string"},"x-content-type-options":{"const":"nosniff","type":"string"}},"required":["content-disposition","content-type","last-modified","tus-resumable","x-content-type-options"],"type":"object","x-transloadit-schema-id":"sha256:9c510c8b82d350f15a96c981172e9e157a9d62193e3ddf9a410bf1f489b03a64"},"Schema_9c58bf823764e09502b1738a56fe64b3da52850f52ccd3f76e632a0f835ad405":{"anyOf":[{"anyOf":[{"type":"string"},{"type":"number"},{"additionalProperties":true,"properties":{"confidence_threshold":{"type":"number"},"flagged":{"type":"boolean"},"licenses":{"items":{},"type":"array"},"max_confidence":{"type":"number"}},"required":["confidence_threshold","flagged","licenses","max_confidence"],"type":"object"}]},{"type":"null"}],"description":"The copyright metadata field.","x-transloadit-description-id":"assemblyStatusMetaCopyright","x-transloadit-schema-id":"sha256:9c58bf823764e09502b1738a56fe64b3da52850f52ccd3f76e632a0f835ad405"},"Schema_9d51ab8cf7b7d84e4e24a4efb39e4d2d6358671a251b1cc544c6007f6fa55960":{"additionalProperties":true,"properties":{"message":{"minLength":1,"type":"string"},"ok":{"const":"TEMPLATE_CREDENTIALS_TYPES_FOUND","type":"string"},"types":{"additionalProperties":{"additionalProperties":true,"properties":{"fields":{"additionalProperties":{"additionalProperties":true,"properties":{"requiredOnCreate":{"type":"boolean"},"requiredOnUpdate":{"type":"boolean"}},"type":"object"},"type":"object"},"providers":{"items":{"type":"string"},"type":"array"}},"required":["fields"],"type":"object"},"type":"object"}},"required":["message","ok","types"],"type":"object","x-transloadit-schema-id":"sha256:9d51ab8cf7b7d84e4e24a4efb39e4d2d6358671a251b1cc544c6007f6fa55960"},"Schema_9e32d2e043ddaf27be258da25a42fb43c4a65680e4582d53c4c0e1d0b76908cf":{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"type":"string"}],"default":"${unique_prefix}/${file.url_name}","description":"\nThe path at which the file is to be stored. This may include any available [Assembly variables](/docs/topics/assembly-instructions/#assembly-variables). The path must not be a directory.\n","x-transloadit-schema-id":"sha256:9e32d2e043ddaf27be258da25a42fb43c4a65680e4582d53c4c0e1d0b76908cf"},"Schema_9e6cbcbaa4b94736822983983a33d21b68b5dc374cb5a1d5c778cc9477a9fa5e":{"anyOf":[{"additionalProperties":true,"description":"Could not load Assembly statistics.","properties":{"error":{"const":"ASSEMBLY_STATS_ERROR","type":"string"},"http_code":{"const":500,"type":"number"},"message":{"description":"Human-readable explanation of the error. Its wording can vary; use the `error` code when handling a specific failure.","type":"string","x-transloadit-description-id":"api2ErrorMessage"}},"required":["error"],"type":"object","x-transloadit-description-id":"api2ErrorAssemblyStatsError"},{"allOf":[{"$ref":"#/components/schemas/Schema_cb07bdaec8a57b18babcb0842531069c047ea76747de30cb3433ec3ab53763cb"}]}],"x-transloadit-schema-id":"sha256:9e6cbcbaa4b94736822983983a33d21b68b5dc374cb5a1d5c778cc9477a9fa5e"},"Schema_a433d309f81e26af9c0fca8fd57913f2795e553cf098114cf41d088d28b07169":{"additionalProperties":false,"properties":{"auth":{"additionalProperties":false,"description":"Contains the Transloadit API key and signature-authentication metadata for an Assembly replay.","properties":{"expires":{"description":"ISO 8601 expiration timestamp in the future. Required when a request is signed or requires signature authentication; bearer-authenticated requests may omit it.","type":"string","x-transloadit-description-id":"signatureAuthExpires"},"key":{"description":"Transloadit API key used to authenticate requests","type":"string","x-transloadit-description-id":"signatureAuthKey"}},"required":["expires","key"],"type":"object","x-transloadit-description-id":"assemblyReplayAuth"},"fields":{"additionalProperties":{},"description":"Values merged on top of the original Assembly fields and made available as Assembly Variables in the replay.","type":"object","x-transloadit-description-id":"assemblyReplayFields"},"nonce":{"anyOf":[{"type":"string"},{"type":"integer"}],"description":"Unique, random value included in signed request params to make each signature unique and prevent accidental signature reuse.","x-transloadit-description-id":"requestNonce"},"notify_url":{"description":"Overrides the notification URL for the replayed Assembly. An omitted, null, or empty value does not override the inherited URL. By default, or when the original Assembly has no Template, the URL from the original merged Assembly Instructions is reevaluated using the replay’s fields and Assembly Variables. With `reparse_template: 1` and an original Template, the URL comes from the original Assembly Status instead of the Template’s current `notify_url`. Supply an explicit URL to choose the destination.","type":["null","string"],"x-transloadit-description-id":"assemblyReplayNotifyUrl"},"reparse_template":{"description":"Specify `1` to fetch and reparse the Template used by the original Assembly, which is useful if the Template changed in the meantime. Specify `0`, or omit this property, to reuse the original merged Assembly Instructions.","enum":[0,1],"type":"number","x-transloadit-description-id":"reparseTemplate"},"steps":{"anyOf":[{"additionalProperties":{"$ref":"#/components/schemas/Schema_e9cd789e59923ef8186b2a620d3348a856461f1009b5cd69551d1a25f47eb029"},"type":"object"},{"items":{"$ref":"#/components/schemas/Schema_e9cd789e59923ef8186b2a620d3348a856461f1009b5cd69551d1a25f47eb029"},"type":"array"}],"description":"Replay step overrides. Object-form steps are the normal Assembly shape; array-form steps are accepted for legacy replay compatibility and normalized before execution.","x-transloadit-description-id":"replaySteps"}},"required":["auth"],"type":"object","x-transloadit-schema-id":"sha256:a433d309f81e26af9c0fca8fd57913f2795e553cf098114cf41d088d28b07169"},"Schema_a529048b2ed32b0125d678e158645220b42861e2c3e5bf89f766bec34234c3e6":{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"enum":["auto","basename","import_order"],"type":"string"}],"default":"basename","description":"\nControls how bundled inputs are ordered when no explicit numbered alias for the input type is used. Numbered aliases end with a numeric suffix such as `_1`.\n\nThe default `\"basename\"` keeps the legacy natural basename sorting behavior.\n\nSet this to `\"import_order\"` to preserve the order of array-based import steps when all input files carry complete import order metadata. `\"auto\"` has the same import-order preference with natural basename sorting as fallback.\n","x-transloadit-schema-id":"sha256:a529048b2ed32b0125d678e158645220b42861e2c3e5bf89f766bec34234c3e6"},"Schema_a5345e8de1c4a63908fa71e0ea4cfbff275562b82e222c7a389606e16db872ce":{"additionalProperties":false,"properties":{"assembly_status_expiry":{"description":"Controls how long the Assembly Status is retained for Assemblies created from this Template.","enum":["1day","30days","7days","90days","NoSave"],"type":"string","x-transloadit-description-id":"templateAssemblyStatusExpiry"},"auth":{"additionalProperties":false,"description":"Contains the Transloadit API key and signature-authentication metadata for a Template request.","properties":{"expires":{"description":"ISO 8601 expiration timestamp in the future. Required when a request is signed or requires signature authentication; bearer-authenticated requests may omit it.","type":"string","x-transloadit-description-id":"signatureAuthExpires"},"key":{"description":"Transloadit API key used to authenticate requests","type":"string","x-transloadit-description-id":"signatureAuthKey"}},"required":["expires","key"],"type":"object","x-transloadit-description-id":"templateAuth"},"name":{"description":"Name of this Template. Use 3–200 lowercase Latin letters, numbers, or dashes. The name `tmp` and service-reserved names are unavailable.","maxLength":200,"minLength":3,"pattern":"^(?:[a-su-z0-9-][a-z0-9-]{2,199}|t[a-ln-z0-9-][a-z0-9-]{1,198}|tm[a-oq-z0-9-][a-z0-9-]{0,197}|tmp[a-z0-9-]{1,197})$","type":"string","x-transloadit-description-id":"templateName"},"nonce":{"anyOf":[{"type":"string"},{"type":"integer"}],"description":"Unique, random value included in signed request params to make each signature unique and prevent accidental signature reuse.","x-transloadit-description-id":"requestNonce"},"require_signature_auth":{"default":0,"description":"Use `1` to require a valid signature when creating Assemblies from this Template with an Auth Key. Valid bearer tokens bypass this signature requirement; their scopes and audience still apply. This setting does not add authentication to Assembly status, cancellation or upload capability URLs. See [Signature Authentication](/docs/api/authentication/).","enum":[0,1],"type":"number","x-transloadit-description-id":"requireSignatureAuth"},"template":{"anyOf":[{"additionalProperties":false,"description":"Structured Assembly Instructions stored in this Template.","properties":{"allow_steps_override":{"description":"Set this to false in a stored Template to disallow overriding its Steps at runtime. The Template may then be used with `template_id`, or direct `steps` may be supplied without it, but not both. A value supplied only while creating an Assembly does not control this policy.","type":"boolean","x-transloadit-description-id":"allowStepsOverride"},"auth":{"additionalProperties":false,"description":"Optional authentication and upload constraints for an Assembly. The API key may be omitted for bearer-authenticated requests or when only upload constraints are stored in a Template.","properties":{"expires":{"description":"ISO 8601 expiration timestamp in the future. Required when a request is signed or requires signature authentication; bearer-authenticated requests may omit it.","type":"string","x-transloadit-description-id":"signatureAuthExpires"},"key":{"description":"Transloadit API key used to authenticate requests","type":"string","x-transloadit-description-id":"signatureAuthKey"},"max_number_of_files":{"description":"Maximum number of input files allowed per Assembly. If the number of uploaded or imported files exceeds this limit, the Assembly will be stopped with an error. This is useful for preventing abuse when Signature Authentication credentials are exposed.","minimum":1,"type":"integer","x-transloadit-description-id":"signatureAuthMaxNumberOfFiles"},"max_size":{"description":"Maximum total expected upload size in bytes for the Assembly, including request-body overhead. This is not a per-file limit and does not guarantee rejection before a resumable transfer starts.","type":"number","x-transloadit-description-id":"signatureAuthMaxSize"},"referer":{"description":"Regular expression matched against a supplied HTTP Referer. Invalid expressions and expressions that exceed the evaluation time limit are rejected. Missing Referer headers pass this check; use Signature Authentication to authenticate requests.","type":"string","x-transloadit-description-id":"signatureAuthReferer"}},"type":"object","x-transloadit-description-id":"assemblyOptionalAuth"},"emit_execution_progress":{"description":"Set to true to publish real-time Assembly execution-progress events. This is ignored for URL Transform Assemblies.","type":"boolean","x-transloadit-description-id":"assemblyEmitExecutionProgress"},"exiftool_stack":{"description":"Ignored when stored in a Template. To select the ExifTool stack for metadata extraction, set `exiftool_stack` in the top-level Assembly request params instead.","type":"string","x-transloadit-description-id":"storedTemplateExifToolStack"},"ffmpeg_stack":{"description":"Ignored when stored in a Template. To select the FFmpeg stack for metadata extraction, set `ffmpeg_stack` in the top-level Assembly request params instead.","type":"string","x-transloadit-description-id":"storedTemplateFfmpegStack"},"fields":{"additionalProperties":{},"description":"An object of string keyed values (name -> value) that can be used as Assembly Variables, just like additional form fields can. You can use anything that is JSON stringifyable as a value","type":"object","x-transloadit-description-id":"fields"},"imagemagick_stack":{"description":"Ignored when stored in a Template. To select the ImageMagick stack for metadata extraction, set `imagemagick_stack` in the top-level Assembly request params instead.","type":"string","x-transloadit-description-id":"storedTemplateImageMagickStack"},"mediainfo_stack":{"description":"Ignored when stored in a Template. To select the MediaInfo stack for metadata extraction, set `mediainfo_stack` in the top-level Assembly request params instead.","type":"string","x-transloadit-description-id":"storedTemplateMediaInfoStack"},"mplayer_stack":{"description":"Ignored when stored in a Template. To select the MPlayer stack for metadata extraction, set `mplayer_stack` in the top-level Assembly request params instead.","type":"string","x-transloadit-description-id":"storedTemplateMplayerStack"},"notification_payload":{"description":"Controls the size of the payload sent in Assembly notifications. Notification replays reuse filters supplied in the original Assembly request; filters defined only in a Template are not preserved on replay. An empty array (default) sends the complete Assembly Status. Add `\"without_params\"` so the top-level raw Assembly instruction fields `params`, `template`, and `merged_params` are omitted. Add `\"without_result_meta_data\"` so `meta` is omitted from each file in `results`. Add `\"without_results\"` so the top-level `results` object is omitted. Add `\"without_upload_meta_data\"` so `meta` is omitted from each file in `uploads`. Add `\"without_uploads\"` so the top-level `uploads` array is omitted. Filtering is applied before serialization, so using these options reduces memory use and helps avoid oversized-payload or OOM failures on large Assemblies.","items":{"enum":["without_params","without_result_meta_data","without_results","without_upload_meta_data","without_uploads"],"type":"string"},"type":"array","x-transloadit-description-id":"notificationPayload"},"notify_url":{"description":"Transloadit can send a Pingback to your server when the Assembly is completed. We’ll send the Assembly Status as a JSON string in the `transloadit` field of an `application/x-www-form-urlencoded` POST request to the URL supplied here. Use `notification_payload` to reduce the payload size (e.g. `without_uploads`, `without_results`, `without_params`). Notification replays reuse only filters supplied in the original Assembly request, not filters defined only in a Template.","type":["null","string"],"x-transloadit-description-id":"notifyUrl"},"quiet":{"description":"Set this to true to minimize the initial Assembly-creation response. A successful response includes only ok and assembly_id; an error response retains error, http_code, message, reason and assembly_id when available. This is response minimization, not access control: anyone with the returned Assembly ID can still retrieve the full Assembly Status, including fields and results, without additional authentication. Treat Assembly IDs and status URLs as secret capabilities. The full Assembly Status is still sent to notify_url when configured.","type":"boolean","x-transloadit-description-id":"quiet"},"redirect_url":{"description":"URL to redirect a browser upload to after the upload completes. The Assembly ID and status URL are appended as query parameters while preserving any existing query parameters and fragment.","type":"string","x-transloadit-description-id":"assemblyRedirectUrl"},"response_headers":{"additionalProperties":true,"description":"Custom response headers emitted by an Assembly. CORS overrides belong in `cors`; other top-level keys are emitted as custom headers.","properties":{"cors":{"additionalProperties":true,"properties":{"Access-Control-Allow-Credentials":{"type":"boolean"},"Access-Control-Allow-Headers":{"type":"string"},"Access-Control-Allow-Methods":{"type":"string"},"Access-Control-Allow-Origin":{"type":"string"},"Access-Control-Allow-Private-Network":{"type":"boolean"},"Access-Control-Allow-Public-Network":{"type":"boolean"},"Access-Control-Expose-Headers":{"type":"string"},"Access-Control-Max-Age":{"type":"number"}},"type":"object"}},"type":"object","x-transloadit-description-id":"assemblyResponseHeaders"},"steps":{"allOf":[{"$ref":"#/components/schemas/Schema_97aad3d37f5046edcb335db4458316ce19e3edbaf9c9f74754f078aae9e99450"}],"description":"Contains Assembly Instructions.","x-transloadit-description-id":"assemblyInstructions"},"template_id":{"description":"Ignored when stored in a Template. Templates do not inherit Instructions from another Template. Put the Steps directly in this Template and select it using `template_id` in the top-level Assembly request params.","type":"string","x-transloadit-description-id":"storedTemplateId"},"usage_tags":{"description":"Usage tags recorded on an Assembly.","type":"string","x-transloadit-description-id":"assemblyUsageTags"}},"type":"object","x-transloadit-description-id":"templateContentObject"},{"description":"JSON-encoded Assembly Instructions retained for client compatibility.","pattern":"^[\\x09-\\x0D\\x20\\xA0
]*\\{(?:[^\\x00]|\\x00)*\\}[\\x09-\\x0D\\x20\\xA0
]*$","type":"string","x-transloadit-description-id":"templateContentJson","x-transloadit-input-fidelity":"conservative"}],"description":"Assembly Instructions stored in this Template. Prefer the structured JSON object; a JSON-encoded string remains accepted for compatibility.","x-transloadit-description-id":"template"},"transcoding_result_expiry":{"description":"Controls how long transcoding results are retained for Assemblies created from this Template.","enum":["1day","NoSave"],"type":"string","x-transloadit-description-id":"templateTranscodingResultExpiry"}},"required":["auth","name","template"],"type":"object","x-transloadit-schema-id":"sha256:a5345e8de1c4a63908fa71e0ea4cfbff275562b82e222c7a389606e16db872ce"},"Schema_a6d783a32061a00331d38b029a83933e29f4362644da01b15aee18c3de5ec710":{"anyOf":[{"additionalProperties":false,"properties":{"additional_gb":{"minimum":0,"type":"number"},"additional_gb_fee":{"type":"number"},"address_1":{"type":["null","string"]},"address_2":{"type":["null","string"]},"bill_limit":{"type":"number"},"city":{"type":["null","string"]},"company":{"type":["null","string"]},"country":{"type":["null","string"]},"country_id":{"type":["null","string"]},"coupon_discount":{"anyOf":[{"anyOf":[{"type":"number"},{"pattern":"^-?(?:0|[1-9][0-9]*)(?:\\.[0-9]+)?$","type":"string"}]},{"type":"null"}]},"coupon_discount_percent":{"anyOf":[{"anyOf":[{"type":"number"},{"pattern":"^-?(?:0|[1-9][0-9]*)(?:\\.[0-9]+)?$","type":"string"}]},{"type":"null"}]},"created":{"anyOf":[{"minLength":1,"type":"string"},{"type":"null"}]},"credit":{"anyOf":[{"anyOf":[{"type":"number"},{"pattern":"^-?(?:0|[1-9][0-9]*)(?:\\.[0-9]+)?$","type":"string"}]},{"type":"null"}]},"currency":{"type":["null","string"]},"email":{"type":["null","string"]},"final_sub_total":{"type":"number"},"invoice_id":{"type":"null"},"is_prorated":{"type":"boolean"},"month":{"pattern":"^[0-9]{4}-(?:0[1-9]|1[0-2])$","type":"string"},"ok":{"const":"BILL_FOUND","type":"string"},"plan":{"$ref":"#/components/schemas/Schema_41f6da0544dc3df7613439ed2ec7eb539b34ef6992e411749dd9672b2899f525"},"po_number":{"type":["null","string"]},"reverse_charge_vat":{"type":"boolean"},"reward_discount":{"anyOf":[{"anyOf":[{"type":"number"},{"pattern":"^-?(?:0|[1-9][0-9]*)(?:\\.[0-9]+)?$","type":"string"}]},{"type":"null"}]},"reward_discount_percent":{"anyOf":[{"anyOf":[{"type":"number"},{"pattern":"^-?(?:0|[1-9][0-9]*)(?:\\.[0-9]+)?$","type":"string"}]},{"type":"null"}]},"robots":{"additionalProperties":{"additionalProperties":true,"properties":{"gb":{"minimum":0,"type":"number"}},"required":["gb"],"type":"object"},"type":"object"},"signup_discount":{"anyOf":[{"anyOf":[{"type":"number"},{"pattern":"^-?(?:0|[1-9][0-9]*)(?:\\.[0-9]+)?$","type":"string"}]},{"type":"null"}]},"signup_discount_percent":{"anyOf":[{"anyOf":[{"type":"number"},{"pattern":"^-?(?:0|[1-9][0-9]*)(?:\\.[0-9]+)?$","type":"string"}]},{"type":"null"}]},"state":{"type":["null","string"]},"sub_total":{"type":"number"},"tiers":{},"to":{"type":["null","string"]},"to_contact_email_address":{"type":["null","string"]},"total":{"type":"number"},"used_gb":{"minimum":0,"type":"number"},"vat":{"type":"number"},"vat_id":{"type":["null","string"]},"vat_rate":{"type":"number"},"zip":{"type":["null","string"]}},"required":["created","credit","invoice_id","is_prorated","month","ok","plan","robots","sub_total","total"],"type":"object"},{"additionalProperties":false,"properties":{"additional_gb":{"minimum":0,"type":"number"},"additional_gb_fee":{"type":"number"},"address_1":{"type":["null","string"]},"address_2":{"type":["null","string"]},"bill_limit":{"type":"number"},"city":{"type":["null","string"]},"company":{"type":["null","string"]},"country":{"type":["null","string"]},"country_id":{"type":["null","string"]},"coupon_discount":{"anyOf":[{"anyOf":[{"type":"number"},{"pattern":"^-?(?:0|[1-9][0-9]*)(?:\\.[0-9]+)?$","type":"string"}]},{"type":"null"}]},"coupon_discount_percent":{"anyOf":[{"anyOf":[{"type":"number"},{"pattern":"^-?(?:0|[1-9][0-9]*)(?:\\.[0-9]+)?$","type":"string"}]},{"type":"null"}]},"created":{"anyOf":[{"minLength":1,"type":"string"},{"type":"null"}]},"credit":{"anyOf":[{"anyOf":[{"type":"number"},{"pattern":"^-?(?:0|[1-9][0-9]*)(?:\\.[0-9]+)?$","type":"string"}]},{"type":"null"}]},"currency":{"type":["null","string"]},"custom_expenses":{},"email":{"type":["null","string"]},"final_sub_total":{"type":"number"},"invoice_id":{"anyOf":[{"type":"string"},{"type":"number"}]},"is_prorated":{"type":"boolean"},"month":{"pattern":"^[0-9]{4}-(?:0[1-9]|1[0-2])$","type":"string"},"ok":{"const":"BILL_FOUND","type":"string"},"plan":{"$ref":"#/components/schemas/Schema_41f6da0544dc3df7613439ed2ec7eb539b34ef6992e411749dd9672b2899f525"},"po_number":{"type":["null","string"]},"reverse_charge_vat":{"type":"boolean"},"reward_discount":{"anyOf":[{"anyOf":[{"type":"number"},{"pattern":"^-?(?:0|[1-9][0-9]*)(?:\\.[0-9]+)?$","type":"string"}]},{"type":"null"}]},"reward_discount_percent":{"anyOf":[{"anyOf":[{"type":"number"},{"pattern":"^-?(?:0|[1-9][0-9]*)(?:\\.[0-9]+)?$","type":"string"}]},{"type":"null"}]},"robots":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"null"},{"items":{},"type":"array"},{"additionalProperties":{},"type":"object"}]},"signup_discount":{"anyOf":[{"anyOf":[{"type":"number"},{"pattern":"^-?(?:0|[1-9][0-9]*)(?:\\.[0-9]+)?$","type":"string"}]},{"type":"null"}]},"signup_discount_percent":{"anyOf":[{"anyOf":[{"type":"number"},{"pattern":"^-?(?:0|[1-9][0-9]*)(?:\\.[0-9]+)?$","type":"string"}]},{"type":"null"}]},"state":{"type":["null","string"]},"sub_total":{"type":"number"},"tiers":{},"to":{"type":["null","string"]},"to_contact_email_address":{"type":["null","string"]},"total":{"type":"number"},"used_gb":{"minimum":0,"type":"number"},"vat":{"type":"number"},"vat_id":{"type":["null","string"]},"vat_rate":{"type":"number"},"zip":{"type":["null","string"]}},"required":["created","credit","invoice_id","is_prorated","month","ok","plan","robots","sub_total","total"],"type":"object"},{"additionalProperties":false,"properties":{"error":{"const":"BILL_NOT_FOUND","type":"string"},"http_code":{"const":200,"type":"number"},"message":{"type":"string"},"reason":{"type":"string"}},"required":["error","http_code","message","reason"],"type":"object"}],"x-transloadit-schema-id":"sha256:a6d783a32061a00331d38b029a83933e29f4362644da01b15aee18c3de5ec710"},"Schema_a742cc0d1951a03f84d05d6e8333f208b82c4a8a18f977adbc62aa0e8a1cc30b":{"anyOf":[{"additionalProperties":true,"description":"The DAM mutation conflicts with an existing resource.","properties":{"error":{"const":"DAM_MUTATION_CONFLICT","type":"string"},"http_code":{"const":409,"type":"number"},"message":{"description":"Human-readable explanation of the error. Its wording can vary; use the `error` code when handling a specific failure.","type":"string","x-transloadit-description-id":"api2ErrorMessage"}},"required":["error"],"type":"object","x-transloadit-description-id":"api2ErrorDamMutationConflict"},{"allOf":[{"$ref":"#/components/schemas/Schema_cb07bdaec8a57b18babcb0842531069c047ea76747de30cb3433ec3ab53763cb"}]}],"x-transloadit-schema-id":"sha256:a742cc0d1951a03f84d05d6e8333f208b82c4a8a18f977adbc62aa0e8a1cc30b"},"Schema_a7b463c184f2431703a1692b1402307bb6bb726278c59f7075fd0b8d6eb2be3c":{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"anyOf":[{"type":"boolean"},{"enum":["false","true"],"type":"string"}]}],"default":false,"description":"Force a Robot to accept a file type it would have ignored.\n\nBy default, Robots ignore files they are not familiar with.\n[🤖/video/encode](/docs/robots/video-encode/), for\nexample, will happily ignore input images.\n\nWith the `force_accept` parameter set to `true`, you can force Robots to accept all files thrown at them.\nThis will typically lead to errors and should only be used for debugging or combatting edge cases.\n","x-transloadit-schema-id":"sha256:a7b463c184f2431703a1692b1402307bb6bb726278c59f7075fd0b8d6eb2be3c"},"Schema_a8213ce4c995e2d44b094b3ea909eddf983764d183e2903635e64aa32732520a":{"anyOf":[{"pattern":"^\\$\\{[^\\n\\r
]+\\}$","type":"string"},{"anyOf":[{"type":"boolean"},{"enum":["false","true"],"type":"string"}]}],"x-transloadit-schema-id":"sha256:a8213ce4c995e2d44b094b3ea909eddf983764d183e2903635e64aa32732520a"},"Schema_a8973c25bd6af940d3d33b4cf66cd5e99c7c3d30e99223ce51cc0fd830d9ee3d":{"pattern":"^0*(?:0|(?:[1-9][0-9]{0,14}|[1-8][0-9]{15}|900[0-6][0-9]{12}|9007[0-0][0-9]{11}|90071[0-8][0-9]{10}|900719[0-8][0-9]{9}|9007199[0-1][0-9]{8}|90071992[0-4][0-9]{7}|900719925[0-3][0-9]{6}|9007199254[0-6][0-9]{5}|90071992547[0-3][0-9]{4}|9007199254740[0-8][0-9]{2}|90071992547409[0-8][0-9]{1}|900719925474099[0-0]|9007199254740991))$","type":"string","x-transloadit-schema-id":"sha256:a8973c25bd6af940d3d33b4cf66cd5e99c7c3d30e99223ce51cc0fd830d9ee3d"},"Schema_a8ae24f9c8d680e21e0004af41cfda5b0a653f81098f242606641ef844a3080b":{"additionalProperties":true,"properties":{"count":{"minimum":0,"type":"integer"},"items":{"items":{"additionalProperties":true,"properties":{"account_id":{"type":["null","string"]},"bytes_expected":{"description":"The number of bytes that this Assembly expects to be uploaded.","type":"number","x-transloadit-description-id":"assemblyStatusResponseBytesExpected"},"bytes_received":{"description":"The number of bytes that have been uploaded to this Assembly so far. This is\nprimarily used by clients to display upload progress.","type":"number","x-transloadit-description-id":"assemblyStatusResponseBytesReceived"},"bytes_usage":{"anyOf":[{"type":"number"},{"type":"null"}]},"created":{"type":"string"},"created_ts":{"type":"number"},"error":{"type":["null","string"]},"execution_duration":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The time taken by Transloadit to execute this Assembly, in seconds.","x-transloadit-description-id":"assemblyStatusResponseExecutionDuration"},"execution_start":{"type":["null","string"]},"files":{"type":["null","string"]},"id":{"type":"string"},"instance":{"type":["null","string"]},"notify_url":{"type":["null","string"]},"num_input_files":{"anyOf":[{"type":"number"},{"type":"null"}]},"ok":{"type":["null","string"]},"parent_id":{"type":["null","string"]},"redirect_url":{"type":["null","string"]},"region":{"type":["null","string"]},"template_id":{"type":["null","string"]},"template_name":{"type":["null","string"]},"upload_duration":{"description":"The time taken by the uploader to upload files, in seconds.","type":"number","x-transloadit-description-id":"assemblyStatusResponseUploadDuration"},"warning_count":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["created","id"],"type":"object"},"type":"array"}},"required":["count","items"],"type":"object","x-transloadit-schema-id":"sha256:a8ae24f9c8d680e21e0004af41cfda5b0a653f81098f242606641ef844a3080b"},"Schema_aaffd6133c1b02e4a7843e6e815412ab247da8c154d4f13cd0267992d2a8dea9":{"additionalProperties":false,"properties":{"assembly_id":{"description":"Restricts results to one Assembly ID.","pattern":"^[a-z0-9]{32}$","type":"string","x-transloadit-description-id":"assembliesAssemblyId"},"auth":{"additionalProperties":false,"description":"Contains the Transloadit API key and signature-authentication metadata for an Assembly list request.","properties":{"expires":{"description":"ISO 8601 expiration timestamp in the future. Required when a request is signed or requires signature authentication; bearer-authenticated requests may omit it.","type":"string","x-transloadit-description-id":"signatureAuthExpires"},"key":{"description":"Transloadit API key used to authenticate requests","type":"string","x-transloadit-description-id":"signatureAuthKey"}},"required":["expires","key"],"type":"object","x-transloadit-description-id":"assembliesListAuth"},"fromdate":{"description":"Specifies the minimum Assembly UTC creation date/time. Only Assemblies after this time are returned. Use the format `Y-m-d H:i:s`. Defaults to seven days before the request. Exact Assembly ID lookups have no default lower bound.","type":"string","x-transloadit-description-id":"assembliesFromDate"},"keywords":{"anyOf":[{"pattern":"^(?:[\\x09-\\x0D\\x20\\xA0
]*|[\\x09-\\x0D\\x20\\xA0
]*[^\\x09-\\x0D\\x20\\xA0
](?:[\\x09-\\x0D\\x20\\xA0
]|[^\\x09-\\x0D\\x20\\xA0
])+[^\\x09-\\x0D\\x20\\xA0
][\\x09-\\x0D\\x20\\xA0
]*)$","type":"string"},{"items":{"type":"string"},"type":"array"}],"description":"Specifies one search expression directly or as a string array whose items are joined with commas. Nonblank rendered expressions must contain at least three characters after trimming. It matches an Assembly ID or six-character ID prefix, a recognized error code, or (when Assembly field search is enabled for the Workspace) an exact custom field name or value. If a recognized error code also matches a custom field name or value, only Assemblies matching both are returned. Defaults to no keyword filter.","x-transloadit-description-id":"assemblyKeywords"},"nonce":{"anyOf":[{"type":"string"},{"type":"integer"}],"description":"Unique, random value included in signed request params to make each signature unique and prevent accidental signature reuse.","x-transloadit-description-id":"requestNonce"},"order":{"description":"Specifies the sort direction. Defaults to `desc`.","enum":["asc","desc"],"type":"string","x-transloadit-description-id":"assembliesOrder"},"page":{"default":1,"description":"Specifies the current page within the current pagination. Defaults to `1`. The derived offset `(page - 1) * pagesize` must remain a safe integer.","maximum":9007199254740991,"minimum":1,"type":"integer","x-transloadit-description-id":"assembliesPage"},"pagesize":{"default":50,"description":"Specifies how many Assemblies to return per API request. Defaults to `50`.","maximum":5000,"minimum":1,"type":"integer","x-transloadit-description-id":"assembliesPageSize"},"region":{"anyOf":[{"pattern":"^[\\x09-\\x0D\\x20\\xA0
]*$","type":"string"},{"pattern":"^[\\x09-\\x0D\\x20\\xA0
]*[A-Za-z0-9._-]{1,30}[\\x09-\\x0D\\x20\\xA0
]*$","type":"string"}],"description":"Restricts results to a region. Omission, a whitespace-only value, or `all` includes every region.","x-transloadit-description-id":"assembliesRegion"},"sort":{"description":"Specifies the field used to sort results. Defaults to `created_ts`.","enum":["created","created_ts","updated"],"type":"string","x-transloadit-description-id":"assembliesSort"},"template_id":{"description":"Restricts results to a Template ID or name. Use `no_template` for Assemblies without a Template. Omission or `all` includes every Template.","type":"string","x-transloadit-description-id":"assembliesTemplateId"},"todate":{"description":"Specifies the maximum Assembly UTC creation date/time. Only Assemblies before this time are returned. Use the format `Y-m-d H:i:s`.","type":"string","x-transloadit-description-id":"assembliesToDate"},"type":{"description":"Specifies the types of Assemblies to retrieve. Defaults to `all`.","enum":["all","canceled","completed","executing","expired","failed","fixable","problematic","request_aborted","uploading"],"type":"string","x-transloadit-description-id":"assembliesType"}},"required":["auth"],"type":"object","x-transloadit-schema-id":"sha256:aaffd6133c1b02e4a7843e6e815412ab247da8c154d4f13cd0267992d2a8dea9"},"Schema_ab455aff2816601f4986e12cb640981fed0db3bd1b22cfc53195f7d94d6293df":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"null"},{"items":{"$ref":"#/components/schemas/Schema_ab455aff2816601f4986e12cb640981fed0db3bd1b22cfc53195f7d94d6293df"},"type":"array"},{"additionalProperties":{"$ref":"#/components/schemas/Schema_ab455aff2816601f4986e12cb640981fed0db3bd1b22cfc53195f7d94d6293df"},"type":"object"}],"x-transloadit-schema-id":"sha256:ab455aff2816601f4986e12cb640981fed0db3bd1b22cfc53195f7d94d6293df"},"Schema_ab6cb202a13202fba4568f38be6c2eb66d85fa4f009d0c2e5c0374caa3720092":{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"pattern":"^#?[0-9a-fA-F]{6}([0-9a-fA-F]{2})?$","type":"string"}],"default":"#00000000","description":"\nThe background color of the resulting video in the `\"rrggbbaa\"` format (red, green, blue, alpha) when used with the `\"pad\"` resize strategy. The default color is black.\n","x-transloadit-schema-id":"sha256:ab6cb202a13202fba4568f38be6c2eb66d85fa4f009d0c2e5c0374caa3720092"},"Schema_ac7d8464107dcaba338b4b8bdc2db3b974790cf626fa64c3e036a3c7fd9cab49":{"anyOf":[{"maximum":25000,"minimum":1,"type":"integer"},{"pattern":"^[\\x09-\\x0D\\x20\\xA0
]*\\+?0*(?:[1-9][0-9]{0,3}|1[0-9]{4}|2[0-4][0-9]{3}|25000)(?:[^0-9x][^x]*)?$","type":"string"}],"x-transloadit-schema-id":"sha256:ac7d8464107dcaba338b4b8bdc2db3b974790cf626fa64c3e036a3c7fd9cab49"},"Schema_acdda8455918771eb5b7d58d00e895c1326672fa85d67ad42497973e3292f5b8":{"additionalProperties":{"items":{"additionalProperties":true,"properties":{"as":{"anyOf":[{"anyOf":[{"type":"string"},{"items":{"type":"string"},"type":"array"}]},{"type":"null"}]},"asset_id":{"$ref":"#/components/schemas/Schema_ea4fbaa6b619d555b449bce20f35f0d31fdbffec9451bb442e1f8fafe5d53aa4"},"asset_version":{"description":"Numeric revision of the stored asset. Use `version_id`, not this number, to select exact retained bytes.","type":"number","x-transloadit-description-id":"assemblyStatusFileAssetVersion"},"basename":{"description":"The name of the file without the extension.","type":["null","string"],"x-transloadit-description-id":"assemblyStatusFileBasename"},"cost":{"anyOf":[{"type":"number"},{"type":"null"}]},"duration":{"anyOf":[{"type":"number"},{"type":"null"}]},"duration_human":{"type":["null","string"]},"execTime":{"anyOf":[{"type":"number"},{"type":"null"}]},"exec_time":{"anyOf":[{"type":"number"},{"type":"null"}]},"ext":{"$ref":"#/components/schemas/Schema_20714a1e88ff0ab94e9cc51f51d49cf13c83b2aff23f6f8cf7cb83bbee003d89"},"field":{"description":"The name of the form field used to submit this file.","type":["null","string"],"x-transloadit-description-id":"assemblyStatusFileField"},"filepath":{"type":["null","string"]},"forcedFileExt":{"type":"string"},"from_batch_import":{"type":"boolean"},"has_alpha":{"description":"Whether this stored image version has an alpha channel, when known.","type":"boolean","x-transloadit-description-id":"assemblyStatusFileHasAlpha"},"height":{"anyOf":[{"type":"number"},{"type":"null"}]},"hls_url":{"type":"string"},"id":{"description":"A random and unique ID used internally by Transloadit to track the file.","type":"string","x-transloadit-description-id":"assemblyStatusFileId"},"import_url":{"type":"string"},"ios_url":{"type":"string"},"is_temp_url":{"type":"boolean"},"is_tus_file":{"type":"boolean"},"md5hash":{"type":["null","string"]},"meta":{"anyOf":[{"additionalProperties":true,"properties":{"album":{"anyOf":[{"anyOf":[{"type":"string"},{"type":"number"}]},{"type":"null"}]},"aperture":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The aperture setting for this image, such as `5.7`.","x-transloadit-description-id":"assemblyStatusMetaAperture"},"archive_directory":{"type":["null","string"]},"artist":{"anyOf":[{"anyOf":[{"type":"string"},{"type":"number"}]},{"type":"null"}],"description":"Many applications that produce audio write additional information into the audio file such as\n`artist`, `year`, `album`, `genre`.","x-transloadit-description-id":"assemblyStatusMetaArtist"},"aspect_ratio":{"anyOf":[{"type":"number"},{"type":"string"},{"type":"null"}],"description":"The aspect ratio of the image, which is its width divided by its height. Will be 0 if for some\nreason the image height is 0.","x-transloadit-description-id":"assemblyStatusMetaAspectRatio"},"audio_bitrate":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The audio bit rate in bits per second across all channels, such as `128000`.","x-transloadit-description-id":"assemblyStatusMetaAudioBitrate"},"audio_channel_layout":{"type":["null","string"]},"audio_channels":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The number of audio channels, typically `2` for stereo.","x-transloadit-description-id":"assemblyStatusMetaAudioChannels"},"audio_codec":{"description":"The audio codec, such as `\"faad\"`. See the [supported audio codecs](/docs/supported-formats/).","type":["null","string"],"x-transloadit-description-id":"assemblyStatusMetaAudioCodec"},"audio_profile":{"type":["null","string"]},"audio_sample_format":{"type":["null","string"]},"audio_samplerate":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The audio sample rate in hertz, such as `44100`.","x-transloadit-description-id":"assemblyStatusMetaAudioSamplerate"},"author":{"anyOf":[{"anyOf":[{"type":"string"},{"type":"number"}]},{"type":"null"}],"description":"The author that took the image. Some cameras populate this field as opposed to `creator`.","x-transloadit-description-id":"assemblyStatusMetaAuthor"},"average_color":{"$ref":"#/components/schemas/Schema_999c9f288a40aadd242801a55205a4b03aee8015882cc2ddfb32f6c82d917cb9"},"band":{"type":["null","string"]},"bandwidth":{"anyOf":[{"type":"number"},{"type":"null"}]},"beats_per_minute":{"anyOf":[{"type":"number"},{"type":"null"}]},"bit_depth":{"anyOf":[{"type":"number"},{"type":"null"}]},"character_count":{"anyOf":[{"type":"number"},{"type":"null"}]},"character_count_with_spaces":{"anyOf":[{"type":"number"},{"type":"null"}]},"city":{"description":"The city in which this image was taken, such as `\"Berlin\"`.","type":["null","string"],"x-transloadit-description-id":"assemblyStatusMetaCity"},"closed_captions":{"type":["boolean","null"]},"cmd":{"anyOf":[{"type":"string"},{"items":{"anyOf":[{"type":"string"},{"type":"number"}]},"type":"array"}]},"codecs":{"type":["null","string"]},"colorprimaries":{"type":["null","string"]},"colorspace":{"$ref":"#/components/schemas/Schema_59548aeadc018a947ea5f8baf2a1739106845dba53418f042e990d0da44a8dfc"},"colortransfer":{"type":["null","string"]},"comment":{"type":["null","string"]},"copyright":{"$ref":"#/components/schemas/Schema_9c58bf823764e09502b1738a56fe64b3da52850f52ccd3f76e632a0f835ad405"},"copyright_notice":{"anyOf":[{"anyOf":[{"type":"string"},{"type":"number"}]},{"type":"null"}],"description":"The copyright notice metadata field.","x-transloadit-description-id":"assemblyStatusMetaCopyrightNotice"},"country":{"description":"The country in which this image was taken, such as `\"Germany\"`.","type":["null","string"],"x-transloadit-description-id":"assemblyStatusMetaCountry"},"country_code":{"description":"The country code of the country in which this image was taken, such as `\"de\"`.","type":["null","string"],"x-transloadit-description-id":"assemblyStatusMetaCountryCode"},"create_date":{"anyOf":[{"anyOf":[{"anyOf":[{"type":"string"},{"type":"number"}]},{"items":{"anyOf":[{"type":"string"},{"type":"number"}]},"type":"array"}]},{"type":"null"}]},"creator":{"anyOf":[{"anyOf":[{"type":"string"},{"type":"number"},{"items":{"type":"string"},"type":"array"}]},{"type":"null"}],"description":"The creator that took the image.","x-transloadit-description-id":"assemblyStatusMetaCreator"},"date_file_created":{"$ref":"#/components/schemas/Schema_28e9d3e97c829700b536a22ac3e94af53ba589a7f0483ae66053586b445e3e67"},"date_file_modified":{"$ref":"#/components/schemas/Schema_e84930fb947da4a6250522f526ec7fb3a9f2af15d6f5e9387deb1ef4464760c5"},"date_recorded":{"$ref":"#/components/schemas/Schema_221f591ba5aa2bd8b2234b296a6f47ecfadad32831f932564981de37ddbb8d64"},"description":{"anyOf":[{"anyOf":[{"type":"string"},{"type":"number"}]},{"type":"null"}],"description":"A description of this image, such as `\"This tree is very old.\"`.","x-transloadit-description-id":"assemblyStatusMetaDescription"},"descriptions":{"items":{"anyOf":[{"type":"string"},{"additionalProperties":true,"properties":{"confidence":{"type":"number"},"name":{"type":"string"}},"required":["confidence","name"],"type":"object"}]},"type":"array"},"device_name":{"anyOf":[{"anyOf":[{"type":"string"},{"type":"number"}]},{"type":"null"}],"description":"The name of the device that recorded the media, such as `\"iPhone 3GS\"`.","x-transloadit-description-id":"assemblyStatusMetaDeviceName"},"device_software":{"anyOf":[{"anyOf":[{"type":"string"},{"type":"number"}]},{"type":"null"}],"description":"The software version of the device that recorded the media, such as `\"3.1.2\"`.","x-transloadit-description-id":"assemblyStatusMetaDeviceSoftware"},"device_vendor":{"description":"The manufacturer of the device that recorded the media, such as `\"Apple\"`.","type":["null","string"],"x-transloadit-description-id":"assemblyStatusMetaDeviceVendor"},"disc":{"anyOf":[{"anyOf":[{"type":"string"},{"type":"number"}]},{"type":"null"}]},"dominant_colors":{"$ref":"#/components/schemas/Schema_72ccb0a44b1e565ea5e2fe4c78d74b1ff0ed2e77b02c8ea011f4822b52e7bd1c"},"duration":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The length of the audio file in seconds.","x-transloadit-description-id":"assemblyStatusMetaDuration"},"encoder":{"type":["null","string"]},"encoding_level":{"type":["null","string"]},"encoding_profile":{"type":["null","string"]},"ends_at":{"type":["null","string"]},"exitCode":{"anyOf":[{"type":"number"},{"type":"null"}]},"exitSignal":{"type":["null","string"]},"exposure_compensation":{"anyOf":[{"anyOf":[{"type":"number"},{"type":"string"}]},{"type":"null"}],"description":"The exposure compensation for this image, such as `\"+4/3\"`.","x-transloadit-description-id":"assemblyStatusMetaExposureCompensation"},"exposure_mode":{"description":"The exposure mode for this image, such as `\"Auto\"`.","type":["null","string"],"x-transloadit-description-id":"assemblyStatusMetaExposureMode"},"exposure_time":{"anyOf":[{"anyOf":[{"type":"number"},{"type":"string"}]},{"type":"null"}],"description":"The exposure time for this image, such as `\"1/30\"`.","x-transloadit-description-id":"assemblyStatusMetaExposureTime"},"f_number":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The f-number for this image, such as `5.6`.","x-transloadit-description-id":"assemblyStatusMetaFNumber"},"faces":{"$ref":"#/components/schemas/Schema_8487d0e12453112ed39e75778476ded0f3ed8d298232989948a2717cd876b510"},"field_order":{"$ref":"#/components/schemas/Schema_c70424852e520d7cdce5aae55902166f4b14ea27ea9c9ba9a5386e9fa82cc1d6"},"flash":{"description":"The flash settings for this image, such as `\"Off, Did not fire\"`.","type":["null","string"],"x-transloadit-description-id":"assemblyStatusMetaFlash"},"focal_length":{"description":"The focal length for this image, such as `\"55.0 mm\"`.","type":["null","string"],"x-transloadit-description-id":"assemblyStatusMetaFocalLength"},"frame_count":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The number of frames in an animated GIF file. This is `1` by default for all other image types.","x-transloadit-description-id":"assemblyStatusMetaFrameCount"},"framerate":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The frame rate of the video, such as `29.5`.","x-transloadit-description-id":"assemblyStatusMetaFramerate"},"genre":{"anyOf":[{"anyOf":[{"type":"string"},{"type":"number"}]},{"type":"null"}]},"has_alpha":{"description":"Whether the original image has an alpha channel, including fully opaque alpha-channel images. Returned together with thumbhash; absence means unknown.","type":"boolean","x-transloadit-description-id":"assemblyStatusMetaHasAlpha"},"has_alpha_channel":{"type":["boolean","null"]},"has_artwork":{"type":["boolean","null"]},"has_clipping_path":{"description":"Is `true` if the image contains a clipping path, `false` otherwise.","type":"boolean","x-transloadit-description-id":"assemblyStatusMetaHasClippingPath"},"has_transparency":{"$ref":"#/components/schemas/Schema_4fdf6ef1979b9cbe0906cc3ce47c7ed08a7edfc1a03e0d8fed2e57d8649ddaf1"},"height":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The height of the media in pixels.","x-transloadit-description-id":"assemblyStatusMetaHeight"},"interlace_detection":{"$ref":"#/components/schemas/Schema_49686d9490285d08562b73ccfe3d4dee8a00389586ed4b6122c24a4111c6c22d"},"interlaced":{"$ref":"#/components/schemas/Schema_fbf959fa885d3246a26d6969bd942cd608e858932256050cf4e1efb4ba5763ce"},"iso":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The ISO value for this image, such as `800`.","x-transloadit-description-id":"assemblyStatusMetaIso"},"keywords":{"$ref":"#/components/schemas/Schema_39173f453da53f30ce065784b2c78eb4a8ab20ab6257e736f3309b038272507f"},"latitude":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The latitude at which the media was recorded, such as `52.5374`.","x-transloadit-description-id":"assemblyStatusMetaLatitude"},"light_value":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The light value for this image, such as `6.9`.","x-transloadit-description-id":"assemblyStatusMetaLightValue"},"line_count":{"anyOf":[{"type":"number"},{"type":"null"}]},"location":{"description":"The location at which this image was taken, which is usually the street, such as `\"Zingster Str.\n32\"`.","type":["null","string"],"x-transloadit-description-id":"assemblyStatusMetaLocation"},"longitude":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The longitude at which the media was recorded, such as `13.4034`.","x-transloadit-description-id":"assemblyStatusMetaLongitude"},"lyrics":{"type":["null","string"]},"mean_volume":{"$ref":"#/components/schemas/Schema_2bddcc7bb0567b6ae92d65cc2888d8c51615a44366a5d51022f8dabcbc7130e8"},"metering_mode":{"description":"The metering mode for this image, such as `\"Multi-segment\"`.","type":["null","string"],"x-transloadit-description-id":"assemblyStatusMetaMeteringMode"},"modify_date":{"anyOf":[{"anyOf":[{"anyOf":[{"type":"string"},{"type":"number"}]},{"items":{"anyOf":[{"type":"string"},{"type":"number"}]},"type":"array"}]},{"type":"null"}]},"num_audio_streams":{"anyOf":[{"type":"number"},{"type":"null"}]},"num_subtitles":{"anyOf":[{"type":"number"},{"type":"null"}]},"num_video_streams":{"anyOf":[{"type":"number"},{"type":"null"}]},"orientation":{"anyOf":[{"anyOf":[{"type":"string"},{"type":"number"}]},{"type":"null"}]},"overall_bitrate":{"anyOf":[{"type":"number"},{"type":"null"}]},"page_count":{"anyOf":[{"type":"number"},{"type":"null"}]},"page_size":{"type":["null","string"]},"paragraph_count":{"anyOf":[{"type":"number"},{"type":"null"}]},"performer":{"type":["null","string"]},"pixel_format":{"type":["null","string"]},"previousStep":{"type":"string"},"producer":{"type":["null","string"]},"reason":{"type":"string"},"recognized_text":{"$ref":"#/components/schemas/Schema_0862c00c4e0751b789b855a35c3ce6c8bf90839f7e0e0cfd9bd5654e297de97b"},"reference_count":{"anyOf":[{"type":"number"},{"type":"null"}]},"relative_path":{"type":["null","string"]},"resolution":{"type":["null","string"]},"rights":{"anyOf":[{"anyOf":[{"type":"string"},{"type":"number"}]},{"type":"null"}]},"rotation":{"anyOf":[{"type":"number"},{"type":"null"}]},"seekable":{"description":"Whether the format of the video supports seeking, such as `true`.","type":["boolean","null"],"x-transloadit-description-id":"assemblyStatusMetaSeekable"},"segment_index":{"anyOf":[{"type":"number"},{"type":"null"}]},"shutter_speed":{"anyOf":[{"anyOf":[{"type":"number"},{"type":"string"}]},{"type":"null"}],"description":"The shutter speed for this image, such as `\"1/32\"`.","x-transloadit-description-id":"assemblyStatusMetaShutterSpeed"},"starts_at":{"type":["null","string"]},"state":{"anyOf":[{"anyOf":[{"type":"string"},{"type":"number"}]},{"type":"null"}],"description":"The state in which this image was taken, such as `\"Berlin\"`.","x-transloadit-description-id":"assemblyStatusMetaState"},"stderr":{"type":"string"},"stdout":{"type":"string"},"step":{"type":"string"},"storage_url":{"type":"string"},"streams":{"anyOf":[{"additionalProperties":true,"properties":{"audio":{"items":{},"type":"array"},"subtitle":{"items":{},"type":"array"},"video":{"items":{},"type":"array"}},"type":"object"},{"type":"null"}]},"svgViewBoxHeight":{"anyOf":[{"type":"number"},{"type":"null"}]},"svgViewBoxWidth":{"anyOf":[{"type":"number"},{"type":"null"}]},"thumb_index":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The index of the current thumbnail starting at 0. This key is only present for results of\n[🤖/video/thumbs](/docs/robots/video-thumbs/).","x-transloadit-description-id":"assemblyStatusMetaThumbIndex"},"thumb_offset":{"$ref":"#/components/schemas/Schema_bc749a53a25fc1063924427ed7f3e031f7f91a7427f838180b47c745582d0e83"},"thumbhash":{"$ref":"#/components/schemas/Schema_0ea4eb8d6377702d52ca8099d657558fcd9648b5abd6568717b4d994ba4a6fca"},"time_base":{"type":["null","string"]},"title":{"anyOf":[{"anyOf":[{"type":"string"},{"type":"number"}]},{"type":"null"}],"description":"The title of this image, such as `\"Tree\"`.","x-transloadit-description-id":"assemblyStatusMetaTitle"},"track":{"anyOf":[{"anyOf":[{"type":"string"},{"type":"number"}]},{"type":"null"}]},"turbo":{"type":["boolean","null"]},"version_id":{"type":"string"},"video_bitrate":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The video bit rate of the video, such as `500000`.","x-transloadit-description-id":"assemblyStatusMetaVideoBitrate"},"video_codec":{"description":"The video codec of the video, such as `\"ffh264\"`.","type":["null","string"],"x-transloadit-description-id":"assemblyStatusMetaVideoCodec"},"white_balance":{"description":"The white balance setting for this image, such as `\"Manual\"`.","type":["null","string"],"x-transloadit-description-id":"assemblyStatusMetaWhiteBalance"},"width":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The width of the media in pixels. For video whose display ratio differs from its pixel ratio, this is the intended display width.","x-transloadit-description-id":"assemblyStatusMetaWidth"},"word_count":{"anyOf":[{"type":"number"},{"type":"null"}]},"xp_comment":{"type":["null","string"]},"xp_keywords":{"anyOf":[{"anyOf":[{"type":"string"},{"type":"number"}]},{"type":"null"}]},"xp_subject":{"anyOf":[{"anyOf":[{"type":"string"},{"type":"number"}]},{"type":"null"}]},"xp_title":{"anyOf":[{"anyOf":[{"type":"string"},{"type":"number"}]},{"type":"null"}]},"year":{"anyOf":[{"anyOf":[{"type":"string"},{"type":"number"}]},{"type":"null"}]}},"type":"object"},{"type":"null"}],"description":"An object containing additional metadata extracted from the file, as shown below. Repeated date tags can be returned as lists of their original values. Check the value’s type before using it as a single timestamp.","x-transloadit-description-id":"assemblyStatusFileMeta"},"mime":{"description":"The determined MIME type for this file.","type":["null","string"],"x-transloadit-description-id":"assemblyStatusFileMime"},"name":{"$ref":"#/components/schemas/Schema_cf34f340bc7bf6960489f12206fdbc8accd247b62ebb50a691e7366d14e1641a"},"original_basename":{"type":["null","string"]},"original_id":{"$ref":"#/components/schemas/Schema_82b82f844a9d0f4274a6d334e8aba4f914533926796eb96a51dcba18915e4a8e"},"original_md5hash":{"type":["null","string"]},"original_name":{"type":["null","string"]},"original_path":{"type":["null","string"]},"path":{"type":["null","string"]},"playlists":{"items":{"additionalProperties":true,"properties":{"content":{"type":"string"},"meta":{"additionalProperties":true,"properties":{"aspect_ratio":{"type":"number"},"audio_channels":{"type":"number"},"audio_codec":{"type":"string"},"audio_samplerate":{"type":"number"},"date_file_modified":{"type":"string"},"duration":{"type":"number"},"encoding_level":{"type":"string"},"encoding_profile":{"type":"string"},"framerate":{"type":"number"},"has_alpha_channel":{"type":"boolean"},"has_artwork":{"type":"boolean"},"height":{"type":"number"},"num_audio_streams":{"type":"number"},"overall_bitrate":{"type":"number"},"relative_path":{"type":"string"},"seekable":{"type":"boolean"},"version_id":{"type":"string"},"video_codec":{"type":"string"},"width":{"type":"number"}},"type":"object"},"name":{"anyOf":[{"type":"string"},{"type":"number"}]},"relative_path":{"type":"string"},"stream":{"type":"string"}},"type":"object"},"type":"array"},"preview":{"type":["null","string"]},"queue":{"type":["null","string"]},"queueTime":{"anyOf":[{"type":"number"},{"type":"null"}]},"queue_time":{"anyOf":[{"type":"number"},{"type":"null"}]},"remote_path":{"type":"string"},"sha256":{"description":"Lowercase SHA-256 checksum of the stored bytes, when available.","pattern":"^[a-f0-9]{64}$","type":"string","x-transloadit-description-id":"assemblyStatusFileSha256"},"signed_ssl_url":{"type":"string"},"signed_url":{"type":"string"},"size":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The size of the file, in bytes.","x-transloadit-description-id":"assemblyStatusFileSize"},"size_human":{"type":["null","string"]},"ssl_url":{"type":["null","string"]},"streaming_url":{"type":"string"},"thumbhash":{"$ref":"#/components/schemas/Schema_07e3c7f49387418d6c2cde66ece62087468146d49408a766b5866535f24bcbf1"},"tus_upload_url":{"type":["null","string"]},"type":{"$ref":"#/components/schemas/Schema_eba2b8ae2c68e14f5f8503411ddbf6762207bcdf4d42d8ea33764d7202e26386"},"url":{"$ref":"#/components/schemas/Schema_ef0161cd21eec2fe3d980b6a024a464fd5ba8da86e5eaf9f91bbc29f68545e3f"},"user_meta":{"anyOf":[{"additionalProperties":{},"type":"object"},{"type":"null"}]},"version_id":{"$ref":"#/components/schemas/Schema_76209e57578923a608782b4d21f58198393f30d2e11f67fd09fc8f84977ed260"},"vimeo":{"additionalProperties":true,"properties":{"title":{"type":"string"},"uri":{"type":"string"}},"required":["title","uri"],"type":"object"},"width":{"anyOf":[{"type":"number"},{"type":"null"}]},"workspace":{"$ref":"#/components/schemas/Schema_1866cd4f41bfae6407385f271b41fb4a50547222f99d79fbc854e92054beaff1"}},"type":"object"},"type":"array"},"description":"The result files that Transloadit has produced so far. Each key is the name of the Step that produced a file. Storage Robots do not produce files, so their Step names are omitted. When an `error` occurs, this object may contain partial results.","type":"object","x-transloadit-description-id":"assemblyStatusResponseResults","x-transloadit-schema-id":"sha256:acdda8455918771eb5b7d58d00e895c1326672fa85d67ad42497973e3292f5b8"},"Schema_ad51c2302b6f6e6b4a5a4f89e2eb8ec6b1439d2931ec56ee670bcf0231502e1a":{"anyOf":[{"pattern":"\\$\\{[^\\n\\r
]+\\}","type":"string"},{"type":"string"}],"description":"\nPlease create your associated Template Credentials in your Transloadit account and use the name of your [Template Credentials](/c/template-credentials/) as this parameter's value. They will contain the values for your Azure Container, Account and Key.\n\nWhile we recommend to use Template Credentials at all times, some use cases demand dynamic credentials for which using Template Credentials is too unwieldy because of their static nature. If you have this requirement, feel free to use the following parameters instead: `\"account\"`, `\"key\"`, `\"container\"`.\n","x-transloadit-schema-id":"sha256:ad51c2302b6f6e6b4a5a4f89e2eb8ec6b1439d2931ec56ee670bcf0231502e1a"},"Schema_ade574c727e61bf4212a7bab355c2e9e5b7c692564acf70e0269b8e18f0e71fb":{"additionalProperties":false,"properties":{"auth":{"additionalProperties":false,"description":"Contains the Transloadit API key and signature-authentication metadata for a Template Credentials request.","properties":{"expires":{"description":"ISO 8601 expiration timestamp in the future. Required when a request is signed or requires signature authentication; bearer-authenticated requests may omit it.","type":"string","x-transloadit-description-id":"signatureAuthExpires"},"key":{"description":"Transloadit API key used to authenticate requests","type":"string","x-transloadit-description-id":"signatureAuthKey"}},"required":["expires","key"],"type":"object","x-transloadit-description-id":"templateCredentialsAuth"},"content":{"anyOf":[{"additionalProperties":{},"type":"object"},{"type":"string"}],"description":"Key and value pairs for this credential type. Pass a JSON object or a JSON-encoded string that decodes to an object. See [supported credential types](/docs/api/template-credentials-types-get/) for their fields and [updating credentials](/docs/api/template-credentials-credentials-id-put/) for preservation and secret-rotation behavior.","x-transloadit-description-id":"templateCredentialsContent"},"name":{"description":"Name of the Template Credentials. Must be between 3 and 255 characters and contain only letters, digits, dashes, underscores, and dots.","pattern":"^[A-Za-zK0-9._-]{3,255}$","type":"string","x-transloadit-description-id":"templateCredentialsName"},"nonce":{"anyOf":[{"type":"string"},{"type":"integer"}],"description":"Unique, random value included in signed request params to make each signature unique and prevent accidental signature reuse.","x-transloadit-description-id":"requestNonce"},"type":{"description":"The service these credentials belong to. On update, resend the existing type unchanged. To use a different service, create another Template Credential.","enum":["ai","azure","backblaze","box","cloudflare","companion","digitalocean","dropbox","ftp","google","http","mega","minio","rackspace","s3","sftp","supabase","swift","tigris","vimeo","wasabi","youtube"],"type":"string","x-transloadit-description-id":"templateCredentialsType"}},"required":["auth","content","name","type"],"type":"object","x-transloadit-schema-id":"sha256:ade574c727e61bf4212a7bab355c2e9e5b7c692564acf70e0269b8e18f0e71fb"},"Schema_b019f1a21f6e67971385b79a80b27dc74bace871419a217f78f51bd940b22d00":{"additionalProperties":false,"properties":{"asset_ids":{"items":{"description":"Case-sensitive, canonical 22-character Base64URL DAM identifier.","pattern":"^[A-Za-z0-9_-]{21}[AQgw]$","type":"string","x-transloadit-description-id":"damId"},"maxItems":100,"minItems":1,"type":"array","uniqueItems":true},"auth":{"additionalProperties":false,"description":"Contains the Transloadit API key and signature-authentication metadata for a DAM mutation.","properties":{"expires":{"description":"ISO 8601 expiration timestamp in the future. Required when a request is signed or requires signature authentication; bearer-authenticated requests may omit it.","type":"string","x-transloadit-description-id":"signatureAuthExpires"},"key":{"description":"Transloadit API key used to authenticate requests","type":"string","x-transloadit-description-id":"signatureAuthKey"}},"required":["expires","key"],"type":"object","x-transloadit-description-id":"damMutationAuth"},"destination_folder_id":{"anyOf":[{"description":"Case-sensitive, canonical 22-character Base64URL DAM identifier.","pattern":"^[A-Za-z0-9_-]{21}[AQgw]$","type":"string","x-transloadit-description-id":"damId"},{"type":"null"}],"description":"Destination folder ID for all selected assets. Set to `null` to move them to the root. This field is required.","x-transloadit-description-id":"damAssetsBulkMoveDestination"},"nonce":{"anyOf":[{"type":"string"},{"type":"integer"}],"description":"Unique, random value included in signed request params to make each signature unique and prevent accidental signature reuse.","x-transloadit-description-id":"requestNonce"}},"required":["asset_ids","auth","destination_folder_id"],"type":"object","x-transloadit-schema-id":"sha256:b019f1a21f6e67971385b79a80b27dc74bace871419a217f78f51bd940b22d00"},"Schema_b04b5b7b31379eeb62ed83ac96b9f63cee596ead79111fef3fb0b0c9c5daf236":{"additionalProperties":{"additionalProperties":{"$ref":"#/components/schemas/Schema_ab455aff2816601f4986e12cb640981fed0db3bd1b22cfc53195f7d94d6293df"},"type":"object"},"type":"object","x-transloadit-schema-id":"sha256:b04b5b7b31379eeb62ed83ac96b9f63cee596ead79111fef3fb0b0c9c5daf236"},"Schema_b1c43384500c1774cd05e2a61ec5c61e12cd7bcf2bf59b5d0cc415cb574bfa04":{"additionalProperties":false,"properties":{"auth":{"additionalProperties":false,"description":"Contains the Transloadit API key and signature-authentication metadata for an Assembly Stats request.","properties":{"expires":{"description":"ISO 8601 expiration timestamp in the future. Required when a request is signed or requires signature authentication; bearer-authenticated requests may omit it.","type":"string","x-transloadit-description-id":"signatureAuthExpires"},"key":{"description":"Transloadit API key used to authenticate requests","type":"string","x-transloadit-description-id":"signatureAuthKey"}},"required":["expires","key"],"type":"object","x-transloadit-description-id":"assemblyStatsAuth"},"nonce":{"anyOf":[{"type":"string"},{"type":"integer"}],"description":"Unique, random value included in signed request params to make each signature unique and prevent accidental signature reuse.","x-transloadit-description-id":"requestNonce"},"region":{"description":"Region to include, or `all` for every region.","minLength":1,"type":"string","x-transloadit-description-id":"statsRegion"},"since":{"description":"Date and time at which the statistics window begins, at most 91 days ago. ISO 8601 is recommended; API2 also preserves date strings accepted by its existing parser. A longer lookback is rejected with the endpoint’s invalid-time error.","minLength":1,"type":"string","x-transloadit-description-id":"statsSince"},"template_id":{"description":"Template ID to include, or `all` for pre-aggregated totals across Templates. Omission, null, an empty string, or `no_template` includes Assemblies created without a Template.","type":["null","string"],"x-transloadit-description-id":"assemblyStatsTemplateId"}},"required":["auth","region","since"],"type":"object","x-transloadit-schema-id":"sha256:b1c43384500c1774cd05e2a61ec5c61e12cd7bcf2bf59b5d0cc415cb574bfa04"},"Schema_b25ac90e330240b3fcc5006abd16617a891e6b7a088e6d1773af47c1bea2047f":{"anyOf":[{"additionalProperties":true,"description":"Bad parameters.","properties":{"error":{"const":"ASSEMBLY_LIST_ERROR","type":"string"},"http_code":{"const":400,"type":"number"},"message":{"description":"Human-readable explanation of the error. Its wording can vary; use the `error` code when handling a specific failure.","type":"string","x-transloadit-description-id":"api2ErrorMessage"}},"required":["error"],"type":"object","x-transloadit-description-id":"api2ErrorAssemblyListError"},{"allOf":[{"$ref":"#/components/schemas/Schema_cb07bdaec8a57b18babcb0842531069c047ea76747de30cb3433ec3ab53763cb"}]}],"x-transloadit-schema-id":"sha256:b25ac90e330240b3fcc5006abd16617a891e6b7a088e6d1773af47c1bea2047f"},"Schema_b2e283538c4e607989f814842d7e5731dbf4015ee0b6ce2127466b40abe570a5":{"description":"Selects the ImageMagick stack for metadata extraction in this Assembly. This does not select the processing stack for Robot Steps. Set `imagemagick_stack` on the relevant Robot Step to select its processing stack.","type":"string","x-transloadit-description-id":"assemblyImageMagickStack","x-transloadit-schema-id":"sha256:b2e283538c4e607989f814842d7e5731dbf4015ee0b6ce2127466b40abe570a5"},"Schema_b3eaec12886d230ec9fd45da6b2e8da7fe928e64efe0174ece3c5e2f4ad443d5":{"additionalProperties":false,"properties":{"assembly_id":{"description":"Restricts results to one Assembly ID.","pattern":"^[a-z0-9]{32}$","type":"string","x-transloadit-description-id":"assembliesAssemblyId"},"auth":{"additionalProperties":false,"description":"Contains the Transloadit API key and signature-authentication metadata for an Assembly list request.","properties":{"expires":{"description":"ISO 8601 expiration timestamp in the future. Required when a request is signed or requires signature authentication; bearer-authenticated requests may omit it.","type":"string","x-transloadit-description-id":"signatureAuthExpires"},"key":{"description":"Transloadit API key used to authenticate requests","type":"string","x-transloadit-description-id":"signatureAuthKey"}},"type":"object","x-transloadit-description-id":"assembliesListAuth"},"fromdate":{"description":"Specifies the minimum Assembly UTC creation date/time. Only Assemblies after this time are returned. Use the format `Y-m-d H:i:s`. Defaults to seven days before the request. Exact Assembly ID lookups have no default lower bound.","type":"string","x-transloadit-description-id":"assembliesFromDate"},"keywords":{"anyOf":[{"pattern":"^(?:[\\x09-\\x0D\\x20\\xA0
]*|[\\x09-\\x0D\\x20\\xA0
]*[^\\x09-\\x0D\\x20\\xA0
](?:[\\x09-\\x0D\\x20\\xA0
]|[^\\x09-\\x0D\\x20\\xA0
])+[^\\x09-\\x0D\\x20\\xA0
][\\x09-\\x0D\\x20\\xA0
]*)$","type":"string"},{"items":{"type":"string"},"type":"array"}],"description":"Specifies one search expression directly or as a string array whose items are joined with commas. Nonblank rendered expressions must contain at least three characters after trimming. It matches an Assembly ID or six-character ID prefix, a recognized error code, or (when Assembly field search is enabled for the Workspace) an exact custom field name or value. If a recognized error code also matches a custom field name or value, only Assemblies matching both are returned. Defaults to no keyword filter.","x-transloadit-description-id":"assemblyKeywords"},"nonce":{"anyOf":[{"type":"string"},{"type":"integer"}],"description":"Unique, random value included in signed request params to make each signature unique and prevent accidental signature reuse.","x-transloadit-description-id":"requestNonce"},"order":{"description":"Specifies the sort direction. Defaults to `desc`.","enum":["asc","desc"],"type":"string","x-transloadit-description-id":"assembliesOrder"},"page":{"default":1,"description":"Specifies the current page within the current pagination. Defaults to `1`. The derived offset `(page - 1) * pagesize` must remain a safe integer.","maximum":9007199254740991,"minimum":1,"type":"integer","x-transloadit-description-id":"assembliesPage"},"pagesize":{"default":50,"description":"Specifies how many Assemblies to return per API request. Defaults to `50`.","maximum":5000,"minimum":1,"type":"integer","x-transloadit-description-id":"assembliesPageSize"},"region":{"anyOf":[{"pattern":"^[\\x09-\\x0D\\x20\\xA0
]*$","type":"string"},{"pattern":"^[\\x09-\\x0D\\x20\\xA0
]*[A-Za-z0-9._-]{1,30}[\\x09-\\x0D\\x20\\xA0
]*$","type":"string"}],"description":"Restricts results to a region. Omission, a whitespace-only value, or `all` includes every region.","x-transloadit-description-id":"assembliesRegion"},"sort":{"description":"Specifies the field used to sort results. Defaults to `created_ts`.","enum":["created","created_ts","updated"],"type":"string","x-transloadit-description-id":"assembliesSort"},"template_id":{"description":"Restricts results to a Template ID or name. Use `no_template` for Assemblies without a Template. Omission or `all` includes every Template.","type":"string","x-transloadit-description-id":"assembliesTemplateId"},"todate":{"description":"Specifies the maximum Assembly UTC creation date/time. Only Assemblies before this time are returned. Use the format `Y-m-d H:i:s`.","type":"string","x-transloadit-description-id":"assembliesToDate"},"type":{"description":"Specifies the types of Assemblies to retrieve. Defaults to `all`.","enum":["all","canceled","completed","executing","expired","failed","fixable","problematic","request_aborted","uploading"],"type":"string","x-transloadit-description-id":"assembliesType"}},"type":"object","x-transloadit-schema-id":"sha256:b3eaec12886d230ec9fd45da6b2e8da7fe928e64efe0174ece3c5e2f4ad443d5"},"Schema_b54f48fb2e4d0bf53206494c64de3ea8f644cbce7badf257a3b4b3e543b55c87":{"description":"A canonical unsigned base-10 byte count in the signed 64-bit range, without zero padding or a plus sign.","pattern":"^(?:0|[1-9][0-9]{0,17}|[1-8][0-9]{18}|9[0-1][0-9]{17}|92[0-1][0-9]{16}|922[0-2][0-9]{15}|9223[0-2][0-9]{14}|92233[0-6][0-9]{13}|922337[0-1][0-9]{12}|92233720[0-2][0-9]{10}|922337203[0-5][0-9]{9}|9223372036[0-7][0-9]{8}|92233720368[0-4][0-9]{7}|922337203685[0-3][0-9]{6}|9223372036854[0-6][0-9]{5}|92233720368547[0-6][0-9]{4}|922337203685477[0-4][0-9]{3}|9223372036854775[0-7][0-9]{2}|922337203685477580[0-6]|9223372036854775807)$","type":"string","x-transloadit-description-id":"tusCanonicalByteCount","x-transloadit-schema-id":"sha256:b54f48fb2e4d0bf53206494c64de3ea8f644cbce7badf257a3b4b3e543b55c87"},"Schema_b5ef7605301d603a3ab8fb61bd98035e4122ba7cd615748f1a4530a0c260931a":{"anyOf":[{"additionalProperties":true,"properties":{"cache-control":{"const":"no-store","type":"string"},"content-length":{"$ref":"#/components/schemas/Schema_b54f48fb2e4d0bf53206494c64de3ea8f644cbce7badf257a3b4b3e543b55c87"},"tus-resumable":{"const":"1.0.0","type":"string"},"upload-concat":{"$ref":"#/components/schemas/Schema_e8ee92bc15ed8461f1105f4905d570b69c97b11ab8856df69fcce70debe33a94"},"upload-defer-length":{"not":{}},"upload-length":{"$ref":"#/components/schemas/Schema_b54f48fb2e4d0bf53206494c64de3ea8f644cbce7badf257a3b4b3e543b55c87"},"upload-metadata":{"$ref":"#/components/schemas/Schema_05bfded8bff85d456673951be6fccc1bc4f149589a64fb7d239467051b736eee"},"upload-offset":{"$ref":"#/components/schemas/Schema_b54f48fb2e4d0bf53206494c64de3ea8f644cbce7badf257a3b4b3e543b55c87"},"x-content-type-options":{"const":"nosniff","type":"string"}},"required":["cache-control","content-length","tus-resumable","upload-length","upload-offset","x-content-type-options"],"type":"object"},{"additionalProperties":true,"properties":{"cache-control":{"const":"no-store","type":"string"},"content-length":{"not":{}},"tus-resumable":{"const":"1.0.0","type":"string"},"upload-concat":{"$ref":"#/components/schemas/Schema_e8ee92bc15ed8461f1105f4905d570b69c97b11ab8856df69fcce70debe33a94"},"upload-defer-length":{"const":"1","type":"string"},"upload-length":{"not":{}},"upload-metadata":{"$ref":"#/components/schemas/Schema_05bfded8bff85d456673951be6fccc1bc4f149589a64fb7d239467051b736eee"},"upload-offset":{"$ref":"#/components/schemas/Schema_b54f48fb2e4d0bf53206494c64de3ea8f644cbce7badf257a3b4b3e543b55c87"},"x-content-type-options":{"const":"nosniff","type":"string"}},"required":["cache-control","tus-resumable","upload-defer-length","upload-offset","x-content-type-options"],"type":"object"}],"x-transloadit-schema-id":"sha256:b5ef7605301d603a3ab8fb61bd98035e4122ba7cd615748f1a4530a0c260931a"},"Schema_b62f335230de45049d7f8c872c603400d9c3390e829ea06b146da44f2d1905d6":{"additionalProperties":false,"properties":{"auth":{"additionalProperties":false,"description":"Contains the Transloadit API key and signature-authentication metadata for an Auth Keys request.","properties":{"expires":{"description":"ISO 8601 expiration timestamp in the future. Required when a request is signed or requires signature authentication; bearer-authenticated requests may omit it.","type":"string","x-transloadit-description-id":"signatureAuthExpires"},"key":{"description":"Transloadit API key used to authenticate requests","type":"string","x-transloadit-description-id":"signatureAuthKey"}},"type":"object","x-transloadit-description-id":"authKeysAuth"},"auth_key":{"description":"Custom Auth Key value. API2 generates one when omitted. Characters outside Unicode’s Basic Multilingual Plane, including most emoji, are not supported.","maxLength":64,"pattern":"^[\u0000--]*$","type":"string","x-transloadit-description-id":"authKeyCustomValue"},"can_show_auth_secret":{"anyOf":[{"type":"boolean"},{"const":0,"type":"number"},{"const":1,"type":"number"}],"description":"Whether the generated secret may be revealed once after creation. Defaults to false. The creation response itself includes the secret regardless of this setting; store it securely.","x-transloadit-description-id":"authKeyCanShowSecret"},"description":{"description":"Human-readable Auth Key description. Characters outside Unicode’s Basic Multilingual Plane, including most emoji, are not supported.","maxLength":255,"pattern":"^[\u0000--]*$","type":"string","x-transloadit-description-id":"authKeyDescription"},"is_allowed_for_smartcdn":{"anyOf":[{"type":"boolean"},{"const":0,"type":"number"},{"const":1,"type":"number"}],"description":"Whether this Auth Key can authenticate Smart CDN URLs in addition to ordinary API requests and bearer-token issuance. Each operation still requires its own scope. On creation, omission defaults to false. On update, omission keeps the current value; send false explicitly to disable Smart CDN use.","x-transloadit-description-id":"authKeySmartCdnAllowed"},"nonce":{"anyOf":[{"type":"string"},{"type":"integer"}],"description":"Unique, random value included in signed request params to make each signature unique and prevent accidental signature reuse.","x-transloadit-description-id":"requestNonce"},"scope":{"description":"Comma-separated Auth Key scopes. Duplicate scopes are normalized by API2.","pattern":"^(?:[\\x09-\\x0D\\x20\\xA0
]*,)*[\\x09-\\x0D\\x20\\xA0
]*(?:read|write|auth_keys:write|auth_keys:read|assemblies:write|assemblies:read|assembly_notifications:write|dam:read|dam:write|template_credentials:read|template_credentials:write|billing:read|queues:read|smart_cdn:sign|templates:read|templates:write|storage_grants:write)[\\x09-\\x0D\\x20\\xA0
]*(?:,[\\x09-\\x0D\\x20\\xA0
]*(?:(?:read|write|auth_keys:write|auth_keys:read|assemblies:write|assemblies:read|assembly_notifications:write|dam:read|dam:write|template_credentials:read|template_credentials:write|billing:read|queues:read|smart_cdn:sign|templates:read|templates:write|storage_grants:write)[\\x09-\\x0D\\x20\\xA0
]*)?)*$","type":"string","x-transloadit-description-id":"authKeyScopes"},"signature_algo":{"anyOf":[{"description":"HMAC algorithm used to sign requests with this Auth Key. On creation, ordinary API keys default to `sha384`. Smart CDN keys accept only `sha256` or `null` and default to `null`. On update, omission keeps the current value, except that enabling Smart CDN resets an incompatible algorithm to `null`.","enum":["sha1","sha256","sha384"],"type":"string","x-transloadit-description-id":"authKeySignatureAlgorithm"},{"type":"null"}],"description":"HMAC algorithm used to sign requests with this Auth Key. On creation, ordinary API keys default to `sha384`. Smart CDN keys accept only `sha256` or `null` and default to `null`. On update, omission keeps the current value, except that enabling Smart CDN resets an incompatible algorithm to `null`.","x-transloadit-description-id":"authKeySignatureAlgorithm"}},"required":["scope"],"type":"object","x-transloadit-schema-id":"sha256:b62f335230de45049d7f8c872c603400d9c3390e829ea06b146da44f2d1905d6"},"Schema_b736e077f16daefe161b737933dc42c15027ce02d7bdb410497f29799a2151aa":{"additionalProperties":{},"description":"A key/value map of additional form fields for integrations that cannot use `