Flag of Ukraine

Retrieve a Template

GET https://api2.transloadit.com/template_credentials/{CREDENTIALS_ID}?signature={SIGNATURE}&params={PARAMS}

GET query components

  • Passing signature is required. For more information please check Signature Authentication.
  • Passing params is required. It should be first JSON encoded and then URL Encoded with the keys as shown in the table below.

Supported keys inside the params query component

  • auth

    Objectrequired

    Contains at least your Transloadit Auth Key in the key property.

    If you enable Signature Authentication, you'll also set an expiry date for the request in the expires property like so:

    {
      "key": "23c96d084c744219a2ce156772ec3211",
      "expires": "2022/01/01 16:53:14+00:00"
    }
    

    The referer property is a regular expression to match against the HTTP referer of this upload, such as "example\.org". Specify this key to make sure that uploads only come from your domain.

    Uploads without a referer will always pass (as they are turned off for some browsers) making this useful in just a handful of use cases. For details about regular expressions, see Mozilla's RegExp documentation.

    The max_size property can be used to set a maximum size that an upload can have in bytes, such as 1048576 (1 MB). Specify this to prevent users from uploading excessively large files.

    When using this key, make sure that it is specified as a hidden max_size form field, since setting max_size in a Template will have no effect.

    The file size is checked as soon as the upload is started and if it exceeds the maximum size, the entire upload process is canceled and the Assembly will error out, even if it contains files that do not exceed the max_size limitation.

    If you want to just ignore the files that exceed a certain size, but process all others, then please use our /file/filter Robot.

Response

Here’s an example response body:

On success this request returns a JSON response with the success code TEMPLATE_FOUND and the Template ID. On error it contains a JSON response including an error field that contains an error status code and a reason field that contains details on what went wrong.
Uppy
20% off any plan for the Uppy community
Use the UPPY20 code when upgrading.
Sign up
tus
20% off any plan for the tus community
Use the TUS20 code when upgrading.
Sign up
Product Hunt
20% off any plan for Product Hunters
Use the PRH20 code when upgrading.
Sign up