Skip to content
Getting Started
/
API v1.5 Documentation
/
/ASSETS

API Endpoint Reference (1.5)

Tenovos has introduced version 1.5 to provide non-breaking improvements over previous versions.

Key Changes:

  • Authentication Standards now include OAuth2 code flow.
  • Client ID is no longer required to be passed when requesting an Authorization token using our Standard Auth from v1.4
  • New endpoints have been added and will continue to be added until v2 is generally available to all customers.
    • Adaptive Template endpoints
    • A new Get Asset endpoint with a simplified Response
    • A new Create Asset endpoint with simplified payloads for the Request and Response
    • A new Update Asset endpoint with simplified payloads for the Request and Response
  • We've made some performance improvements to most endpoints
Find out more about Tenovos
Download OpenAPI description
v1.5.json
v1.5.yaml
Overview
E-mail
product@tenovos.com
License
Tenovos Active Story Management
Terms of Service
Languages
Servers
https://api.uat.tenovos.io/v1
https://api.tenovos.io/v1

ACTIONS

Invoke the Action API to retrieve information about invoked Actions.

Operations

ADAPTIVE TEMPLATES

Invoke the API to retrieve information about invoked Actions.

Operations

ASSETS

Invoke the Asset API to create, retrieve, manipulate, and share Assets. This API also provides operations to manage Asset relationships and download Asset content.

Operations

Create Asset

Request

Use this endpoint to perform one of the following operations:

  1. Create a new Asset
  2. Create a new Version of an existing Asset
  3. Create a new Metadata-only Asset

Once the new Asset or Asset Version is created, a new Object ID is returned to identify the new Asset / Asset Version.

When a new Asset is created, the Asset is considered a metadata-only asset until a corresponding content file is uploaded. The Asset's content file size must be less than or equal to 5GB.

After invoking the Create Asset service, the response shall include a signed URL to upload the content file. The upload should be performed using a PUT request with the file content attached as binary data in the request body.

After creating an asset greater than 100MB, multiple presigned URLs will be returned. You must upload file chunks of 100MB to each one.

You must call the /asset/complete endpoint to complete or cancel a multi-part file upload, otherwise the file will not be available to Tenovos.

The user submitting the request to create an Asset must have the Upload Security Role Privilege and be granted access to at least one Security Template to assign to the new Asset.

Average Response Time: 1077ms (varies based on metadata)

Security
ApiKeyAuth or BasicAuth
Headers
X-API-Keystringrequired

Customer-specific API key required to invoke API.

Authorizationstringrequired

Provided by Authentication Token creation operation

Content-Typestringrequired
Value"application/json"
Bodyapplication/jsonrequired

The Request Body must be a JSON object. To create a new version instead of new asset, pass an additional property originalFileId as part of the JSON object.

originalFileIdstring(uuid)= 36 characters

ID of the file. When provided a new version will be created.

Example: "ea6eb24d-adef-4080-bd02-f64f567c437f"
metadataTemplateIdstring(uuid)= 36 charactersrequired

ID of metadata template to apply.

Example: "ea6eb24d-adef-4080-bd02-f64f567c437f"
metadataArray of MetadataStringValue (object) or MetadataRestrictedVocabularyValue (object) or MetadataDateValue (object) or MetadataMultiValue (object) or MetadataGridValue (object)(MetadataDocument)required

Array of metadata attributes

Any of:

Defines a text attribute

metadata[].​metadataDefinitionIdstring(uuid)

Definition ID

Example: "dfeb57c1-b149-4b15-920f-3f40ff0b959a"
metadata[].​metadataDefinitionValuestring
Example: "Photo"
securityTemplateIdsArray of strings(uuid)required

Array of Security Template IDs

Example: ["7d6f4e30-f423-11e9-8071-89c0c4052141"]
filenamestringrequired

Asset file name.

contentPathstring

S3 path to the file. Required only for Federated files.

skipTranscodeboolean

Flag to skip content transformation. Required only for Federated files.

filesizenumber

Size of file in bytes

curl -i -X POST \
  https://api.uat.tenovos.io/v1/asset \
  -H 'Authorization: string' \
  -H 'Content-Type: application/json' \
  -H 'X-API-Key: YOUR_API_KEY_HERE' \
  -d '{
    "metadataTemplateId": "ea6eb24d-adef-4080-bd02-f64f567c437f",
    "metadata": [
      {
        "metadataDefinitionId": "dfeb57c1-b149-4b15-920f-3f40ff0b959a",
        "metadataDefinitionValue": "Photo"
      },
      {
        "metadataDefinitionId": "dfeb57c1-b149-4b15-920f-3f40ff3423ad",
        "metadataDefinitionValue": {
          "valueId": "3fa85f64-5717-4562-b3fc-2c963f66aea6"
        }
      },
      {
        "metadataDefinitionId": "3229e863-022b-4365-afe6-e9aa3807c386",
        "metadataDefinitionValue": "02/10/2021"
      },
      {
        "metadataDefinitionId": "3229e863-022b-4365-afe6-e9aa3807c386",
        "metadataDefinitionValue": [
          {
            "valueId": "7d6f4e30-f423-11e9-8071-89c0c4052141"
          }
        ]
      },
      {
        "metadataDefinitionId": "3229e863-022b-4365-afe6-e9aa3807c386",
        "metadataDefinitionTableValue": [
          [
            {
              "metadataDefinitionId": "dfeb57c1-b149-4b15-920f-3f40ff0b959a",
              "metadataDefinitionValue": "Photo"
            },
            {
              "metadataDefinitionId": "dfeb57c1-b149-4b15-920f-3f40ff3423ad1",
              "metadataDefinitionValue": {
                "valueId": "3fa85f64-5717-4562-b3fc-2c963f66ada6"
              }
            },
            {
              "metadataDefinitionId": "3229e863-022b-4365-afe6-e9aa3807c386",
              "metadataDefinitionValue": "02/10/2021"
            }
          ]
        ]
      }
    ],
    "securityTemplateIds": [
      "7d6f4e30-f423-11e9-8071-89c0c4052141"
    ],
    "filename": "apples.jpg"
  }'

Responses

The Response Body is a JSON object

Bodyapplication/json
statusstring

Response Status indicator returned by Tenovos

Example: "success"
messagestring

Message indicated whether the asset was successfully created or not.

Example: "Asset created successfully"
dataobject
Response
application/json
{
  "status": "success",
  "message": "Asset created successfully",
  "data": {
    "objectId": "2dee909b-6b2b-4da8-96c3-af90fc1662ec",
    "filename": "hooli-logo.jpg",
    "fileId": "0fcb5eb4-5e0e-4ffa-8780-9206a0f833f1",
    "originalFileId": "0fcb5eb4-5e0e-4ffa-8780-9206a0f833f1",
    "uploadId": "gR5XHJZpuDv8UizdpSGuwONje0GbMHnCWXS5zTTVkyVINURV6iraWLhpM7Sy7oy65utAgPcm2FfM4fRp4oVga4ggEzD811aS1tke_F0iIIXX1kV7m6UouytsNE0oL8fzo2Zr2JCqwRyhFTXp98zjdQ",
    "urls": [ … ]
  }
}

Bulk Edit Assets

Request

Perform metadata edits and/or reassign Security Templates to one or more Assets. Assets are identified by Object ID. If multiple Assets are specified, the same metadata and/or security edits will be applied to all Assets in the request.

Each Metadata Attribute is identified by a Metadata Definition ID.

The user performing the bulk edit must have the Edit Metadata permission granted on each Asset being edited.

Average Response Time: 605ms

Security
ApiKeyAuth or BasicAuth
Headers
X-API-Keystringrequired

Customer-specific API key required to invoke API.

Authorizationstringrequired

Provided by Authentication Token creation operation

Content-Typestringrequired
Value"application/json"
Bodyapplication/jsonrequired

The Request Body must be a JSON object. The object must contain metadata and/or securityTemplateIds as well as an array of objectIds.

metadataTemplateIdstring(uuid)= 36 charactersrequired

Metadata Template ID to assign to the edited Assets.

Example: "ea6eb24d-adef-4080-bd02-f64f567c437f"
metadataDocumentArray of AssetBulkEditStringValue (object) or AssetBulkEditDateValue (object) or AssetBulkEditRestrictedVocabularyValue (object) or AssetBulkEditMultiValue (object) or AssetBulkEditGridValue (object)

An array of metadata attribute operations

objectIdsArray of strings(uuid)required

An array of Asset Object IDs

Example: ["e55bdb0c-022b-475d-9e26-9d74552e1e81"]
securityTemplateIdsArray of strings(uuid)

An array of Security Template IDs.

Example: ["a7099f22-4585-4533-88b4-a5e9dff928bc"]
securityTemplateOpstring

Operation to either replace or append to the currently assigned list of Security Template IDs with the provided list of Security Template IDs.

Enum"replace""append"
curl -i -X PATCH \
  https://api.uat.tenovos.io/v1/asset \
  -H 'Authorization: string' \
  -H 'Content-Type: application/json' \
  -H 'X-API-Key: YOUR_API_KEY_HERE' \
  -d '{
    "metadataTemplateId": "ea6eb24d-adef-4080-bd02-f64f567c437f",
    "metadataDocument": [
      {
        "metadataDefinitionId": "dfeb57c1-b149-4b15-920f-3f40ff0b959a",
        "metadataDefinitionValue": "Photo",
        "operation": "replace"
      }
    ],
    "objectIds": [
      "e55bdb0c-022b-475d-9e26-9d74552e1e81"
    ],
    "securityTemplateIds": [
      "a7099f22-4585-4533-88b4-a5e9dff928bc"
    ],
    "securityTemplateOp": "replace"
  }'

Responses

Successful operation

Bodyapplication/json
jobIdstring(uuid)

Job ID of the submitted Bulk Edit Job.

Example: "5fa57655-c56c-47d3-a409-751fd5fd9735"
collectionIdstring(uuid)

Collection ID of the Collection containing the Assets being bulk edited.

Example: "7c6a6a3b-cac0-4218-be3b-515e0f9cb967"
Response
application/json
{
  "jobId": "5fa57655-c56c-47d3-a409-751fd5fd9735",
  "collectionId": "7c6a6a3b-cac0-4218-be3b-515e0f9cb967"
}

Get Asset

Request

Retrieve an Asset's details and metadata by specifying an Object ID or File ID in the request path.

The user requesting the Asset must have view access to the Asset in order to retrieve the Asset.

Average Response Time: 451ms (Get asset by fileId)

Average Response Time: 2973ms (Get asset by objectId)

Security
ApiKeyAuth or BasicAuth
Path
idstring(uuid)= 36 charactersrequired

Asset Object ID or File ID

Headers
X-API-Keystringrequired

Customer-specific API key required to invoke API.

Authorizationstringrequired

Provided by Authentication Token creation operation

curl -i -X GET \
  'https://api.uat.tenovos.io/v1/asset/{id}' \
  -H 'Authorization: string' \
  -H 'X-API-Key: YOUR_API_KEY_HERE'

Responses

Returns JSON object

Bodyapplication/json
createdBystring(uuid)

User ID who created this Asset

Example: "7d675ef0-f423-11e9-8071-89c0c405214e"
createdEpochinteger

Creation time in milliseconds

Example: 1608745510614
currentVersionstring

Current version flag

Enum"Y""N"
Example: "Y"
customerIdstring

Customer ID of Created By User's Account

Example: "123203455"
fileIdstring(uuid)

Asset File ID

filenamestring

Asset content file name

Example: "adventure-alps-beautiful-landscape-2444403.jpg"
fileStatestring

Asset content file state

Enum"available""recycle bin"
lastUpdatedBystring(uuid)

User ID who last updated the asset

Example: "7d675ef0-f423-11e9-8071-89c0c40133ds"
lastUpdatedEpochinteger

Last update time in milliseconds

Example: 1612333543954
metadataArray of MetadataStringValue (object) or MetadataRestrictedVocabularyValue (object) or MetadataDateValue (object) or MetadataMultiValue (object) or MetadataGridValue (object)(MetadataDocument)

Array of metadata attributes

metadataDenormalizedobject

Metadata document is a flat list of metadata attributes and values, where values are either in text values or foreign keys / referential values

metadataStatestring

Asset metadata state

Enum"available""recycle bin"
Example: "available"
metadataTemplateIdstring(uuid)

Metadata Template ID

Example: "ea6eb24d-adef-4380-bd02-f64f567c437f"
objectIdstring(uuid)

Asset Object ID

Example: "e6f4bd5e-9bea-43cb-b15e-22582fa5322e"
objectTypestring

Asset Object type

Value"Asset"
Example: "Asset"
originalFileIdstring(uuid)

The ID of the original version of the file

Example: "003391e4-e78a-4186-b2d7-b5d4fcbe445d"
renditionsobject(renditions)
securityTemplateIdsArray of strings(uuid)

List of Security Template IDs

Example: ["7d6f4e30-f423-11e9-8071-89c0c4052156"]
securityDenormalizedArray of objects(AssetSecurityDenormalized)
technicalMetadataobject(AssetTechnicalMetadata)

Technical metadata about the asset

presignedURLstring

The URL to download the file. Populated for download requests.

linkTypestring
relationshipIdstring(uuid)
secondaryIdstring
versionNumberintegerDeprecated

Asset version number

Response
application/json
{
  "createdBy": "7d675ef0-f423-11e9-8071-89c0c405214e",
  "createdEpoch": 1608745510614,
  "currentVersion": "Y",
  "customerId": "123203455",
  "fileId": "a1c6a2ab-4b01-4253-b4c9-70e04b3b48fc",
  "filename": "adventure-alps-beautiful-landscape-2444403.jpg",
  "fileState": "available",
  "lastUpdatedBy": "7d675ef0-f423-11e9-8071-89c0c40133ds",
  "lastUpdatedEpoch": 1612333543954,
  "metadata": [
    { … }
  ],
  "metadataDenormalized": {},
  "metadataState": "available",
  "metadataTemplateId": "ea6eb24d-adef-4380-bd02-f64f567c437f",
  "objectId": "e6f4bd5e-9bea-43cb-b15e-22582fa5322e",
  "objectType": "Asset",
  "originalFileId": "003391e4-e78a-4186-b2d7-b5d4fcbe445d",
  "renditions": {
    "width": 1920,
    "height": 1080,
    "imageThumb": "https://env.content.tenovos.io/1588091945181/445c273a-235f-4d3b-8397-567f02f312e0/35c8cc9b-0aab-43aa-b220-7829f821836a-200x200.png",
    "imagePreview": "https://env.content.tenovos.io/1588091945181/445c273a-235f-4d3b-8397-567f02f312e0/35c8cc9b-0aab-43aa-b220-7829f821836a-700x700.png",
    "imagePreviewLarge": "https://env.content.tenovos.io/1588091945181/445c273a-235f-4d3b-8397-567f02f312e0/35c8cc9b-0aab-43aa-b220-7829f821836a-1000x1000.png",
    "mezzaninePreview": "https://env.content.tenovos.io/1588091945181/445c273a-235f-4d3b-8397-567f02f312e0/gilfoyle_anton-3000x3000.png",
    "imagePreviewExtraLarge": "https://env.content.tenovos.io/1588091945181/445c273a-235f-4d3b-8397-567f02f312e0/35c8cc9b-0aab-43aa-b220-7829f821836a-5000x5000.png"
  },
  "securityTemplateIds": [
    "7d6f4e30-f423-11e9-8071-89c0c4052156"
  ],
  "securityDenormalized": [
    { … }
  ],
  "technicalMetadata": {
    "tenovos_metadata": { … },
    "image_metadata": { … }
  },
  "versionNumber": 0,
  "presignedURL": "string",
  "linkType": "string",
  "relationshipId": "928dd5b8-3ead-4528-bdef-9c0b867a5d7d",
  "secondaryId": "string"
}

AUTHENTICATION

Invoke the Authentication API to generate, refresh, and revoke access tokens. An access token is required to perform any authorized API operation.

Operations

CDN (Coming Soon!)

Tenovos Content Delivery Network (CDN) - Coming Soon!

Tenovos CDN: Pull Zone Overview

Tenovos CDN provides global content acceleration and optimization through a pull zone architecture, ensuring that your assets are delivered to end users with maximum speed, reliability, and efficiency. A Content Delivery Network (CDN) works by caching static content—such as images, videos, and other media—on servers distributed across the globe. When an asset is requested, the CDN serves it from the nearest edge location, reducing load times and offloading traffic from the origin server, which in this case is Tenovos DAM.

A pull zone is the core mechanism that powers this system. It automatically fetches content from the origin the first time it is requested, then caches it at the edge. Subsequent requests are served directly from the CDN cache, improving response times and reducing bandwidth consumption.

Through the Tenovos CDN API, you can create, update, and manage pull zones programmatically. Pull zones support advanced features such as global edge caching, cache purging, bandwidth controls, and real-time performance statistics like cache hit rate and geographic request distribution. Optional optimization settings allow you to enhance performance further by enabling image compression, WebP and AVIF support, and content minification.

With just a few API calls, you can fully integrate high-performance content delivery into your Tenovos workflows—no complex infrastructure required.

Operations

COLLECTIONS

Invoke the Collection API to create, retrieve, edit, and delete Collections. Collections are used to group and catalog related Assets for quick access and consumption. Collections can be configured as:

  • private: Visible only to the user who created the Collection.
  • secured: Visible to users with.

When retrieving the Assets within a Collection, the requesting user will only see the Assets that the user has access to view. For example, a librarian may see all Assets within a Collection, but a general consumer user may only see a portion of those Assets, due to limited security access.

Operations

METADATA

Invoke the Metadata API to retrieve Metadata Template to be applied to Assets during Asset creation. A Metadata Template defines a set of Metadata Attributes of varying types, including Text, Date, Controlled Vocabulary, Tabular, and Cascading Attributes. When a Metadata Template is assigned to a new Asset, the corresponding Metadata Attributes will be available for population on the Asset.

Operations

REQUESTS

Invoke these API's to create new Requests and manage existing Requests.

Operations

SECURITY

Invoke the Metadata API to retrieve Security Template information to be applied to Assets during Asset creation or edit.

Operations

PEOPLE

Invoke the User API to retrieve User profile information.

Operations

WEBHOOKS

Tenovos Webhook Subscriptions

For more information about our Webhooks, see the Webhook section of our Developer Portal

Operations

PROOFING

Operations