Asset ingestion
Create an asset, upload its file in resumable chunks, and publish it. After the file is uploaded you can enrich the asset - see the Asset enrichment section - before publishing. Retrieval of the asset during ingestion uses Get asset in the General endpoints section.
Create asset
IMPORTANT NOTE
These APIs do not replace the existing v4 APIs yet, and currently only applies to newly uploaded assets still in Draft state (before publishing). Cannot be yet used for Assets that are in Asset Bank and Waiting room.
Creates an empty container, this is the first step to start the file upload and any asset enrichment.
post
https://{your-bynder-domain}/api/1/asset/assets
Body
application/json
Body
application/json
CreateAssetInput
copyrightstring
descriptionstring
namestring
originstring
timeStampPublishedstring(date-time)
Response
application/json
Response
application/json
Asset
activeVersionobject
Show Child Parameters
advancedRightsobject
Show Child Parameters
assetIdstring
assetStatusstring
copyrightstring
descriptionstring
embargosarray[object]
Show Child Parameters
moduleCodestring
Allowed values:BGBSIBWF
namestring
originstring
portalIdstring
timeStampCreatedstring(date-time)
timeStampModifiedstring(date-time)
timeStampPublishedstring(date-time)
userCreatedIdstring
userModifiedIdstring
post/api/1/asset/assets
Authentication
Body
{}
application/json
Create upload url
IMPORTANT NOTE
These APIs do not replace the existing v4 APIs yet, and currently only applies to newly uploaded assets still in Draft state (before publishing). Cannot be yet used for Assets that are in Asset Bank and Waiting room.
To start uploading a file as an asset, a signed upload url has to be created, which can be used to start uploading the file. Take the generated assetId from the previous {create Asset} as input in the path.
post
https://{your-bynder-domain}/api/1/asset/assets/{assetId}/upload-url
Path Parameters
assetIdstringrequired
Response
application/json
Response
application/json
UploadUrl
storageObjectIdstring
uploadUrlstring
post/api/1/asset/assets/{assetId}/upload-url
Authentication
Path Parameters
application/json
Upload file chunks
IMPORTANT NOTE
These APIs do not replace the existing v4 APIs yet, and currently only applies to newly uploaded assets still in Draft state (before publishing). Cannot be yet used for Assets that are in Asset Bank and Waiting room.
The request target is the Location response header returned by Upload file initialization. Carry the relevant header information across calls as shown below. After the last chunk is uploaded, the file is automatically finalized.
The
Location Header ValueURL is a placeholder for theLocationheader from the previous call.
patch
{Location Header Value}/
Headers
tus-resumablestringrequired
Default:1.0.0
upload-offsetstringrequired
The combined length of the previously uploaded chunks. This value can be taken from the Upload-Offset response header of each preceding chunk request.
content-typestringrequired
Default:application/offset+octet-stream
fileidstringrequired
filenamestringrequired
reasonstringrequired
Body
application/offset+octet-stream
Body
application/offset+octet-stream
string(binary)
Response
Response
Chunk accepted.
patch/
Authentication
Headers
Body
No file selected
Invalid URL value 'Location Header Value/'
- missing protocol
- missing protocol
Upload file initialization
IMPORTANT NOTE
These APIs do not replace the existing v4 APIs yet, and currently only applies to newly uploaded assets still in Draft state (before publishing). Cannot be yet used for Assets that are in Asset Bank and Waiting room.
This step actually starts uploading the file. Send this request to the signed uploadUrl returned by Create upload url. This initializes a resumable (tus) upload. Any file namings have to be base64 encoded/decoded.
The response headers - in particular the Location header - are required for the next call, Upload file chunks.
The
{uploadUrl}path parameter is a placeholder for the signed URL from the previous step.
post
{uploadUrl}/
Headers
tus-resumablestringrequired
Default:1.0.0
upload-lengthstringrequired
Total size of the file to upload, in bytes.
upload-metadatastringrequired
Comma-separated key <base64-value> pairs, e.g. filename ZXhhbXBsZS5wbmc=.
fileidstringrequired
filenamestringrequired
authorizationstringrequired
content-lengthstringrequired
Response
Response
Upload initialized. Use the returned Location header for the chunk uploads.
post/
Authentication
Headers
Invalid URL value 'uploadUrl/'
- missing protocol
- missing protocol