Getting Started

API v1.5 Documentation

API Endpoint Reference (1.5)
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude
Connect to Cursor
Install MCP server on Cursor
Connect to VS Code
Install MCP server on VS Code

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

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/json

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": [
    "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  ],
  "renditionsDocument": {
    "fpo": "https://tenant.tenovos.io/1623232044386/74216a5c-386d-47d6-854c-dc28535116cf/Template_Store_Asset_1-fpo.png",
    "aiRendition": "https://tenant.tenovos.io/1623232044386/74216a5c-386d-47d6-854c-dc28535116cf/aiRendition.png",
    "imagePreviewLarge": "https://tenant.tenovos.io/1623232044386/74216a5c-386d-47d6-854c-dc28535116cf/09789d41-0b7b-4c13-b060-41b5e479f844-1000x1000.png",
    "imageThumb": "https://tenant.tenovos.io/1623232044386/74216a5c-386d-47d6-854c-dc28535116cf/09789d41-0b7b-4c13-b060-41b5e479f844-200x200.png",
    "imagePreview": "https://tenant.tenovos.io/1623232044386/74216a5c-386d-47d6-854c-dc28535116cf/09789d41-0b7b-4c13-b060-41b5e479f844-700x700.png",
    "mezzaninePreview": "https://tenant.tenovos.io/1623232044386/74216a5c-386d-47d6-854c-dc28535116cf/Template_Store_Asset_1-3000x3000.png",
    "height": 1080,
    "width": 1920
  },
  "avamTags": [
    "string"
  ],
  "lockType": [
    "string"
  ],
  "objectType": "string",
  "digitalAssetIds": [
    "string"
  ],
  "fileState": "string",
  "technicalMetadataDocument": {
    "image_metadata": {},
    "tenovos_metadata": { … }
  },
  "customerId": "string",
  "lastUpdatedEpoch": 0,
  "metadataTemplateId": "string",
  "objectId": "string",
  "metadataDocument": {
    "system_created_epoch": "string",
    "template_title": "string",
    "description": "string",
    "system_content_type": "string",
    "system_is_federated": "string",
    "system_security_templates": [ … ],
    "title": "string",
    "system_metadata_templates": "string",
    "web2print_template_name": "string",
    "system_mime_type": "string",
    "web2print_job_name": "string",
    "system_checksum": "string",
    "system_last_updated_by": "string",
    "system_skip_transcode": "string",
    "system_created_date": 0,
    "system_created_by": "string",
    "web2print_job_xml": "string",
    "web2printlink": "string",
    "system_match": "string",
    "system_last_updated_date": 0
  },
  "metadataState": "string",
  "lastUpdatedBy": "9eca4444-bb39-4c34-8088-e204f5c15d34",
  "originalFileId": "1ebf63d7-819a-4a33-a1cd-00df81f55bd3",
  "securityTemplateIds": [
    "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  ],
  "currentVersion": "Y",
  "versionNumber": 0,
  "filename": "string",
  "createdEpoch": 0,
  "technicalMetadataText": "string",
  "createdBy": "25a02396-1048-48f9-bf93-102d2fb7895e",
  "AITags": [
    "string"
  ],
  "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

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 '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

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

SEARCH

Search for Collections by Collection name.

Perform Asset searches using keywords or Attribute-specific search terms using the Keyword Search endpoint.

Perform a scan on all assets based on search criteria using a cursor to page through the entire result set of assets.

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

API Endpoint Reference (1.5)
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude
Connect to Cursor
Install MCP server on Cursor
Connect to VS Code
Install MCP server on VS Code

ACTIONS

ADAPTIVE TEMPLATES

Get Templates

Request

Responses

Was this helpful?

Get Template URL

Request

Responses

Was this helpful?

ASSETS

AUTHENTICATION

CDN (Coming Soon!)

COLLECTIONS

METADATA

SEARCH

REQUESTS

SECURITY

PEOPLE

WEBHOOKS

PROOFING

API Endpoint Reference (1.5)CopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from ClaudeConnect to CursorInstall MCP server on CursorConnect to VS CodeInstall MCP server on VS Code

ACTIONS

ADAPTIVE TEMPLATES

Get Templates

RequestExpand all

Responses

Was this helpful?

Get Template URL

Request

Responses

Was this helpful?

ASSETS

AUTHENTICATION

CDN (Coming Soon!)

COLLECTIONS

METADATA

SEARCH

REQUESTS

SECURITY

PEOPLE

WEBHOOKS

PROOFING

API Endpoint Reference (1.5)
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude
Connect to Cursor
Install MCP server on Cursor
Connect to VS Code
Install MCP server on VS Code

Request