Process (bulk)
POST/api/v1/assets/content/original/reprocess
The asset batch processing API is useful in the following scenarios:-
- process multiple assets to apply updated watermark
- process multiple assets to create a specific conversion, transcode or addon
warning
This API is available for users with the ADMIN or MANAGER role. Users with other roles get 403.
REQUEST JSON BODY
{
"ids": [
"7204fbc866d94805ad3fab3e1a194abd"
],
"conversions": ["smart_imaging"],
"transcodes": ["480p-video"],
"addons": ["STORYBOARD"]
}
Note:
- A maximum of 100 assets can be re-processed in one API call.
- At least one of
conversions,transcodesoraddonsmust be non-empty, otherwise the request is rejected with400. Any of the three may be omitted. - Unknown keys in
conversions,transcodesoraddonsand keys that do not apply to the file type are ignored. - Every id must exist and be accessible to the caller; one that is not fails the whole request. Use Estimate Process (bulk) first to find ids that would be skipped.
- On a plan billed in credits, the video part of the batch (transcodes, storyboard, clip preview) must be covered by the credit balance. If it is not, the request is refused with
402and nothing is queued. Image AI addons (IMAGE_ANALYSIS,FACE_RECOGNITION) are charged as each one runs and are not checked up front.
| Parameter | Description |
|---|---|
ids | Asset Ids of assets that should be re-processed |
conversions | (optional) List of conversion keys such as deepzoom. See Asset Processing API for keys |
transcodes | (optional) List of transcode keys such as 480p-video. See Asset Processing API for keys |
addons | (optional) List of addon keys such as STORYBOARD. Addon must be available and enabled in the caller's account. See the Addons API for keys |
HTTP RESPONSE
200 with an empty body when the batch is queued. Video progress is reported per asset on the Jobs API.
Request
Responses
- 200
- 400
- 401
- 402
- 403
- 500
Batch queued. Empty body.
Invalid request — more than 100 ids, nothing requested, or an id that does not exist
Unauthorized - Invalid or missing authentication
Not enough credits for the video part of the batch. Nothing is queued.
Forbidden - role is not ADMIN or MANAGER, or an asset is not accessible
Internal server error