1.0.0OAS 3.1

The Asset API lets you ingest, enrich, and manage assets. Endpoints are grouped by the stage of the asset lifecycle: ingestion (create → upload → publish), enrichment (metadata, tags, embargoes, rights, relations), and general retrieval/management.

API Base URL
  • Server 1:https://{your-bynder-domain}
Security
httpAuth (http)

Provide your bearer token in the Authorization header when making requests to protected resources.

Example: Authorization: Bearer 123

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

CreateAssetInput

copyrightstring
descriptionstring
namestring
originstring
timeStampPublishedstring(date-time)

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

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

UploadUrl

storageObjectIdstring
uploadUrlstring
post/api/1/asset/assets/{assetId}/upload-url
 
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 Value URL is a placeholder for the Location header 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
string(binary)

Response

Chunk accepted.

patch/

Body

No file selected
 
Invalid URL value 'Location Header Value/'
- missing protocol