Get Asset by Render ID

v1.0.0

A render may generate more than one file, such as a video, thumbnail and poster image. When the assets are created the only known id is the render id returned by the original , status request or webhook. This endpoint lets you look up one or more assets by the render id.

base URL:

Output

{
  "type": "object",
  "description": "The response returned by the Serve API [get asset by render id](#get-asset-by-render-id) request. The response  is an array of asset resources, including video, image, audio, thumbnail and poster image. The response follows  the [json:api](https://jsonapi.org/) specification.",
  "properties": {
    "data": {
      "type": "array",
      "description": "An array of asset resources grouped by render id.",
      "items": {
        "type": "object",
        "description": "The type of resource (an asset) and attributes of the asset.",
        "properties": {
          "attributes": {
            "type": "object",
            "description": "The asset attributes including render id, url, filename, file size, etc...",
            "properties": {
              "created": {
                "type": "string",
                "description": "The time the asset was created."
              },
              "filename": {
                "type": "string",
                "description": "The asset file name."
              },
              "id": {
                "type": "string",
                "description": "The unique id of the hosted asset in UUID format."
              },
              "owner": {
                "type": "string",
                "description": "The owner id of the render task."
              },
              "region": {
                "type": "string",
                "description": "The region the asset is hosted, currently only `au` (Australia)."
              },
              "renderId": {
                "type": "string",
                "description": "The original render id that created the asset in UUID format. Multiple assets can share the same render id."
              },
              "status": {
                "type": "string",
                "description": "The status of the asset. <ul>\n  <li>`importing` - the asset is being copied to the hosting service</li>\n  <li>`ready` - the asset is ready to be served to users</li>\n  <li>`failed` - the asset failed to copy or delete</li>\n  <li>`deleted` - the asset has been deleted</li>\n</ul>",
                "enum": [
                  "importing",
                  "ready",
                  "failed",
                  "deleted"
                ]
              },
              "updated": {
                "type": "string",
                "description": "The time the asset status was last updated."
              },
              "url": {
                "type": "string",
                "description": "The asset file name."
              }
            }
          },
          "type": {
            "type": "string",
            "description": "The type of resource, in this case it is an assets."
          }
        }
      }
    }
  }
}