643 matches
Other/Shotstack
The Serve API is used to interact with, and delete hosted assets including videos, images, audio files, thumbnails and poster images. Use this endpoint to fetch an asset by asset id. Note that an asset id is unique for each asset and different from the render id.
base URL:
{
"type": "object",
"description": "The response returned by the Serve API [get asset](#get-asset) request. Includes details of a hosted video, image, audio file, thumbnail or poster image. The response follows the [json:api](https://jsonapi.org/) specification.",
"properties": {
"data": {
"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."
}
}
}
}
}