Skip to content
Getting Started
/
/
/
Generate Temporary Asset...

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

(NEW!) Asset History

Request

COMING SOON!

This endpoint returns a complete history of all events

Security
ApiKeyAuth or BasicAuth
Path
idstring or null

The id parameter can be used to filter response results based on a specific resource in Tenovos, such as the unique id of an Asset, Collection, Story Board, etc. When used to filter event history, only event types and events specifically associated to the resource provided will be returned. This mean event types such as user.created, security.template.created, etc., will be filtered out any time this parameter is provided.

A 36-character UUID representing the resource.

Example: b84ac1dc-30ed-4741-8f8d-47ef2635950b
Query
userIdstring or null

The userId parameter can be used to filter response results based on a specific User in Tenovos. When used to filter event history, only events specifically associated to the User ID provided will be returned.

A 36-character UUID representing the User.

Example: userId=cd0caff5-2756-4d7c-a43d-a926a81fa9b8
eventTypestring or null

The event type parameter can be used to filter response results based on the type of event. For a full list of available types, please refer to the Event Types page for an up-to-date list of available values.

Example: eventType=asset.created
startDatestring or null

The start of the date range for event history. If not specified, the previous 12 months of events will be returned.

Format: Full datetime (YYYY-MM-DDTHH:mm:ssZ) for compatibility. Must be URL-encoded if using the full datetime.

Example: startDate=2024-10-12T15:27:59Z
endDatestring or null

The end of the date range for event history. If not specified, the previous 12 months of events will be returned.

Format: Full datetime (YYYY-MM-DDTHH:mm:ssZ) for compatibility. Must be URL-encoded if using the full datetime.

Example: endDate=2024-11-09T08:14:56Z
limitnumber or null

The limit parameter can be used to limit the response results for each request. When used for event history, the minimum recommended pageSize is 100. Based on the limiting scope of your query parameters, pageSize can be increased to 1000.

Example: limit=500
cursorstring or null

Provides the cursor for the next result set. Can be either the response value for nextCursor or prevCursor depending on the desired pagination direction.

Example: cursor=eyJvZmZzZXQiOjIwMH0
curl -i -X GET \
  'https://api.uat.tenovos.io/v1/asset/b84ac1dc-30ed-4741-8f8d-47ef2635950b/history?userId=cd0caff5-2756-4d7c-a43d-a926a81fa9b8&eventType=asset.created&startDate=2024-10-12T15%3A27%3A59Z&endDate=2024-11-09T08%3A14%3A56Z&limit=500&cursor=eyJvZmZzZXQiOjIwMH0' \
  -H 'X-API-Key: YOUR_API_KEY_HERE'

Responses

Successful Request. Event Types Retrieved Successfully.

Bodyapplication/json
totalinteger

total number of results based on query parameters provided.

Example: 798054
limitnumber

Reflects the value provided (or the default) for the total number of results to limit the response size per request.

Example: 100
nextCursorstring

Provides the cursor for the next page of results. If no more pages exist, this field can be null or omitted.

Example: "eyJvZmZzZXQiOjIwMH0"
prevCursorstring

Provides the cursor for the previous page of results. If no previous page exists, i.e., current response is the first page, this field can be null or omitted.

Example: "kmFvYmBzZXQiOjIwNJ0"
eventsArray of objects[ 0 .. 100 ] items
Response
application/json
{
  "total": 798054,
  "limit": 100,
  "nextCursor": "eyJvZmZzZXQiOjIwMH0",
  "prevCursor": "kmFvYmBzZXQiOjIwNJ0",
  "events": [
    { … }
  ]
}

Generate Temporary Asset Preview Link

Request

Exposes Asset's pre-signed urls with expiration time given in seconds

Asset being exposed needs to have a Security Template with Download permission and User must have a role with the Download privilege.

Average Response Time: 785ms

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 array.

Array [
idstring(uuid)

The Asset Object ID or the File ID of the asset.

Example: "497f6eca-6276-4993-bfeb-53cbbbba6f08"
identifierstring

Type of identifier

Enum"objectId""fileId"
Example: "objectId"
componentsArray of AssetExposeRefRendition (object) or AssetExposeRefObject (object)

Array of Objects for generating urls based on properties rendition or object with expiration time in seconds.

]
curl -i -X POST \
  https://api.uat.tenovos.io/v1/asset/expose \
  -H 'Authorization: string' \
  -H 'Content-Type: application/json' \
  -H 'X-API-Key: YOUR_API_KEY_HERE' \
  -d '[
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "identifier": "objectId",
      "components": [
        {
          "componentType": "rendition",
          "componentRef": [
            "imageThumb"
          ],
          "expiration": 3000
        }
      ]
    }
  ]'

Responses

Successful operation

Bodyapplication/jsonArray [
idstring(uuid)
identifierstring
Enum"objectId""fileId"
Example: "objectId"
componentsArray of AssetExposeRenditionResponse (object) or AssetExposeObjectResponse (object)
]
Response
application/json
[
  {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "identifier": "objectId",
    "components": [ … ]
  }
]

Share a selection of Assets.

Request

Share a selection of Assets to a user specified by Email address.

The user sharing the Assets must be granted the Download Security Template permission on the Assets being shared.

Average Response Time: 195ms

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 is a JSON object

senderobject(AssetShareSender)

Sender information to use in the email

shareUsersArray of objects(AssetShareRecipient)

A list of users to share assets with

assetsArray of strings(uuid)

List of Asset object IDs to be shared

shareMessagestring

An email message.

Example: "A message from sender to recipient"
curl -i -X POST \
  https://api.uat.tenovos.io/v1/asset/share \
  -H 'Authorization: string' \
  -H 'Content-Type: application/json' \
  -H 'X-API-Key: YOUR_API_KEY_HERE' \
  -d '{
    "sender": {
      "name": "John"
    },
    "shareUsers": [
      {
        "email": "user@example.com",
        "name": "Jeff"
      }
    ],
    "assets": [
      "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ],
    "shareMessage": "A message from sender to recipient"
  }'

Responses

Successful operation

Bodyapplication/json
messagestring
Example: "Message sent successfully"
statusstring

status of the request, success or failure

Response
application/json
{
  "message": "Message sent successfully"
}

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