Retrieve list of Assemblies

Retrieves a list of Assemblies for your account. They are sorted by creation date descending.

GET query components

• Passing signature is required. For more information, please check Signature Authentication.
• Passing params is required. It should contain a JSON encoded object with the keys as shown in the table below.

Supported keys inside the params field

• auth — required

  object

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

  If you enable Signature Authentication, you must also set an expiry date for the request in the expires property:

  

  {
    "key": "23c96d084c744219a2ce156772ec3211",
    "expires": "2009-08-28T01:02:03.000Z"
  }
  

  We strongly recommend including the nonce property — a randomly generated, unique value per request that prevents duplicate processing upon retries, can aid in debugging, and avoids attack vectors such as signature key reuse:

  

  {
    // …
    "nonce": "04ac6cb6-df43-41fb-a7fd-e5dd711a64e1"
  }
  

  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.

  This can be set as part of the Assembly request or as part of the Template.

  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 🤖/file/filter.

• page

  number (default: 1)

  Specifies the current page, within the current pagination

• pagesize

  number (default: 50)

  Specifies how many Assemblies to be received per API request, which is useful for pagination.

• type — required

  all | uploading | executing | canceled | completed | failed | request_aborted

  Specifies the types of Assemblies to be retrieved.

• fromdate — required

  string

  Specifies the minimum Assembly UTC creation date/time. Only Assemblies after this time will be retrieved. Use the format Y-m-d H:i:s.

• todate

  string (default: "NOW()")

  Specifies the maximum Assembly UTC creation date/time. Only Assemblies before this time will be retrieved. Use the format Y-m-d H:i:s.

• keywords — required

  Array<string>

  Specifies keywords to be matched in the Assembly Status. The Assembly fields checked include the id, redirect_url, fields, and notify_url, as well as error messages and files used.

Response

Here’s an example response body:

{
  "items": [
    {
      "id": "195c60855fda4fb9a3b2f848374ca4e1",
      "parent_id": null,
      "account_id": "7c91e50845204dea9ed4791f7d8440f1",
      "template_id": "40b0efc6b37f432dbe9485017b52a7b7",
      "instance": "tam.transloadit.com",
      "notify_url": null,
      "redirect_url": null,
      "files": "[\"Saturn as seen from the Cas....jpg\"]",
      "region": "eu-west-1",
      "warning_count": 0,
      "execution_duration": 2.337,
      "execution_start": "2023-02-11T16:04:24.000Z",
      "ok": "ASSEMBLY_COMPLETED",
      "error": null,
      "created": "2023-02-11T16:04:22.000Z",
      "created_ts": 1676131462,
      "template_name": "my-template-1676131432311"
    },
    {
      "id": "72fc13f46db84fa1969d913ca8763de1",
      "parent_id": null,
      "account_id": "7c91e50845204dea9ed4791f7d8440f1",
      "template_id": "40b0efc6b37f432dbe9485017b52a7b7",
      "instance": "tam.transloadit.com",
      "notify_url": null,
      "redirect_url": null,
      "files": "[\"green grass fiels.jpg\",\"Morning Dew.jpg\",\"green leaf plant.jpg\"]",
      "region": "eu-west-1",
      "warning_count": 0,
      "execution_duration": 6.275,
      "execution_start": "2023-02-11T16:04:06.000Z",
      "ok": "ASSEMBLY_COMPLETED",
      "error": null,
      "created": "2023-02-11T16:04:04.000Z",
      "created_ts": 1676131444,
      "template_name": "my-template-1676131432311"
    }
  ],
  // …
  "count": 50
}

We either return the error code ASSEMBLY_LIST_ERROR or a JSON list of found Assemblies.