Skip to content
Getting Started
/
/
/
Get Template URL

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
    • Metadata Admin API endpoints for managing Attributes, Groups, and Templates
  • We've made some performance improvements to most endpoints
Find out more about Tenovos
Download OpenAPI description
Download OpenAPI spec (YAML)
Download OpenAPI spec (JSON)
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

Get Templates

Request

For customers with the Adaptive Template templates feature, use this endpoint to return a list of all available templates in the system.

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

frominteger<= 10000required

The beginning index of the search. A value greater than 0 will offset the search.

Default 0
Example: 0
limitinteger or null[ 1 .. 100 ]required

The maximum number of templates to return per page.

Default 50
Example: 50
searchTermArray of strings or null

List of search terms with AND operation by default

Example: ["*"]
sortByArray of objects or null(Search_sortBy)required

The metadata attribute and order to sort by.

sortBy[].​metadataDefinitionSearchFieldstring

Sort the result set according to specified attributes by metadata search field name

Example: "lastUpdatedEpoch"
sortBy[].​orderstring

Sort Order

Enum"asc""desc"
Example: "desc"
operationstringrequired

Indicates whether to apply an AND conditions or an OR condition between search terms

Example: "AND"
curl -i -X POST \
  https://api.uat.tenovos.io/v1/template \
  -H 'Authorization: string' \
  -H 'Content-Type: application/json' \
  -H 'X-API-Key: YOUR_API_KEY_HERE' \
  -d '{
    "from": 0,
    "limit": 50,
    "searchTerm": [
      "*"
    ],
    "sortBy": [
      {
        "metadataDefinitionSearchField": "lastUpdatedEpoch",
        "order": "desc"
      }
    ],
    "operation": "AND"
  }'

Responses

The Response Body is a JSON object.

Bodyapplication/jsonArray [
childProductIdsArray of strings(uuid)
renditionsDocumentobject
avamTagsArray of strings
lockTypeArray of strings
objectTypestring
digitalAssetIdsArray of strings
fileStatestring
technicalMetadataDocumentobject
customerIdstring

Unique Identifier for the Tenovos Cusotmer

lastUpdatedEpochinteger(int64)
metadataTemplateIdstring
objectIdstring
metadataDocumentobject
metadataStatestring
lastUpdatedBystring(uuid)

Unique Identifier of the Tenovos user who last updated the template.

originalFileIdstring(uuid)
securityTemplateIdsArray of strings(uuid)
currentVersionstring

Indicates whether or not this template/asset is the latest version available

Enum"Y""N"
Example: "Y"
versionNumberinteger(int64)
filenamestring
createdEpochinteger(int64)
technicalMetadataTextstring
createdBystring(uuid)

Unique Identifier of the Tenovos user who created the template/asset

AITagsArray of strings
fileIdstring(uuid)
securityTemplateDenormalizedArray of objects

Contains an array of objects, one for each Tenovos user group assigned permissions on the Security Template applied to the asset, identified by user goup id, and includes an array of persmission identifiers for each user group.

]
Response
application/json
[
  {
    "childProductIds": [ … ],
    "renditionsDocument": { … },
    "avamTags": [ … ],
    "lockType": [ … ],
    "objectType": "string",
    "digitalAssetIds": [ … ],
    "fileState": "string",
    "technicalMetadataDocument": { … },
    "customerId": "string",
    "lastUpdatedEpoch": 0,
    "metadataTemplateId": "string",
    "objectId": "string",
    "metadataDocument": { … },
    "metadataState": "string",
    "lastUpdatedBy": "9eca4444-bb39-4c34-8088-e204f5c15d34",
    "originalFileId": "1ebf63d7-819a-4a33-a1cd-00df81f55bd3",
    "securityTemplateIds": [ … ],
    "currentVersion": "Y",
    "versionNumber": 0,
    "filename": "string",
    "createdEpoch": 0,
    "technicalMetadataText": "string",
    "createdBy": "25a02396-1048-48f9-bf93-102d2fb7895e",
    "AITags": [ … ],
    "fileId": "a1c6a2ab-4b01-4253-b4c9-70e04b3b48fc",
    "securityTemplateDenormalized": [ … ]
  }
]

Get Template URL

Request

Returns a secure URL to open the template in a web browser using template identifier.

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

templateIdstring(uuid)
curl -i -X POST \
  https://api.uat.tenovos.io/v1/template/launch \
  -H 'Authorization: string' \
  -H 'Content-Type: application/json' \
  -H 'X-API-Key: YOUR_API_KEY_HERE' \
  -d '{
    "templateId": "196100ac-4eec-4fb6-a7f7-86c8b584771d"
  }'

Responses

The Response Body is a JSON object.

Bodyapplication/json
urlstring(url)
Example: "https://templates.tenovos.io/launch?jobName=somejob&deleteJob=true&externalLaunch=true"
Response
application/json
{
  "url": "https://templates.tenovos.io/launch?jobName=somejob&deleteJob=true&externalLaunch=true"
}

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

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 ATTRIBUTES

Invoke the Metadata Attributes API to retrieve Metadata Attributes, and to create, read, update, and delete Metadata Attribute definitions. Metadata Attributes come in varying types, including Text, Date, Controlled Vocabulary, Tabular, and Cascading, and can be assigned to Metadata Groups and Templates.

Admin Endpoints (NEW!): Create, read, update, and delete Metadata Attributes. These endpoints require the Metadata Management admin privilege.

Operations

METADATA GROUPS

Invoke the Metadata Groups API to create, read, update, and delete Metadata Groups. A Metadata Group organizes related Metadata Attributes together for use within a Metadata Template.

Admin Endpoints (NEW!): These endpoints require the Metadata Management admin privilege.

Operations

METADATA TEMPLATES

Invoke the Metadata Templates API to create, read, update, and delete Metadata Templates, and to apply Metadata definition changes. A Metadata Template defines a set of Metadata Attributes that, when assigned to an Asset, become available for population on that Asset.

Admin Endpoints (NEW!): Create, read, update, and delete Metadata Templates. These endpoints require the Metadata Management admin privilege.

Operations

METADATA VOCABULARIES

Invoke the Controlled Vocabularies API to create, retrieve, update, and delete Controlled Vocabularies used to constrain the values available to a Metadata Attribute.

Operations

METADATA CASCADES

Invoke the Metadata Cascades API to create, retrieve, update, and delete Cascading Attributes, a Metadata Attribute type whose available values depend on the value selected in a parent Attribute.

Operations

METADATA TABLES

Invoke the Metadata Tables API to create, retrieve, update, and delete Tabular Attributes, a Metadata Attribute type that stores structured, multi-column data on an Asset.

Operations

REQUESTS

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

Operations

SECURITY ROLES

Invoke the Security Roles API to retrieve, create, update, and delete Security Roles, and to retrieve the Permissions and Privileges that can be assigned to a Role to control what a user can see and do across the platform.

Operations

SECURITY TEMPLATES

Invoke the Security Templates API to retrieve, create, update, and delete Security Templates. A Security Template combines Security Roles and User Groups to define access to Assets and other objects in the platform.

Operations

SECURITY GROUPS

Invoke the Security User Groups API to retrieve, create, update, and delete Security User Groups used to organize users for the purpose of assigning security access.

Operations

USERS

Invoke the User API to retrieve User profile information.

Operations

STORY BOARDS

Invoke the Story Boards API to retrieve and manage Story Boards. Story Boards are curated content experiences that combine collections, saved searches, and other content blocks into a single shareable view.

Coming Soon: Additional endpoints for creating, updating, and deleting Story Boards.

Operations

WEBHOOKS

Tenovos Webhook Subscriptions

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

Operations

RIGHTS MANAGEMENT

Invoke the Rights Management API to manage rights-management associations between Projects, Agreements, Entities, and Rights.

Operations

PROOFING

Operations