Skip to content
Getting Started
/
/
/
(NEW!) Update Security Te...

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

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 manage Metadata Attributes, Groups, and Templates. 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.

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

Operations

REQUESTS

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

Operations

SECURITY

Invoke the Security API to manage Security Templates, Security Roles, Security User Groups, and the Permissions and Privileges that control what a user can see and do across the platform.

Operations

(NEW!) Get Security Template

Request

Retrieve full detail for a single security, rights, or access template — header fields plus a paginated page of its groups, each with its permissions.

Defaults:

  • includePermissions defaults to true.
  • groupLimit defaults to 100.

Pagination:

  • Loop on groups.pageInfo.nextCursor, passing it back as groupCursor, until groups.pageInfo.hasNextPage is false.

The user submitting the request must have the Security Template Management admin privilege.

Security
ApiKeyAuth or BasicAuth
Path
templateIdstring(uuid)required

The unique ID of the security template.

Example: a9380047-07d7-48aa-b4b7-474d00f0f428
Query
includePermissionsboolean

When true, each group includes its permissions array. Defaults to true.

Default true
groupLimitinteger

Number of groups to return per page. Defaults to 100.

Default 100
Example: groupLimit=100
groupCursorstring

Opaque cursor for paging the template's groups. Omit on the first request. Use groups.pageInfo.nextCursor from the previous response for subsequent pages.

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/security/templates/a9380047-07d7-48aa-b4b7-474d00f0f428?includePermissions=true&groupLimit=100&groupCursor=string' \
  -H 'Authorization: string' \
  -H 'X-API-Key: YOUR_API_KEY_HERE'

Responses

Full detail of the security template.

Bodyapplication/json
idstring(uuid)

Unique ID of the template.

Example: "a9380047-07d7-48aa-b4b7-474d00f0f428"
namestring

Display name of the template.

Example: "Confidential"
typestring

Template classification. Set at creation and immutable thereafter.

Enum"security-template""rights-template""access-template"
Example: "security-template"
groupCountinteger

Total number of groups on the template, across all pages.

Example: 2
permissionCountinteger

Total number of permissions granted across all groups, including the watermark permission.

Example: 3
createdBystring(uuid)

User ID of the template's creator.

Example: "dc63db1b-1e63-43bc-877e-418931b6895c"
createdEpochinteger

Unix timestamp (ms) of creation.

Example: 1773070355217
createdDatestring(date-time)

ISO 8601 creation date.

Example: "2026-03-09T15:32:35.217Z"
lastUpdatedBystring(uuid)

User ID of the user who last updated the template.

Example: "dc63db1b-1e63-43bc-877e-418931b6895c"
lastUpdatedEpochinteger

Unix timestamp (ms) of the last update. Pass this value back as expectedLastUpdatedEpoch on PATCH to guard against concurrent edits.

Example: 1773070355217
lastUpdatedDatestring(date-time)

ISO 8601 last updated date.

Example: "2026-03-09T15:32:35.217Z"
groupsobject

Page of groups assigned to the template.

Response
application/json
{
  "id": "a9380047-07d7-48aa-b4b7-474d00f0f428",
  "name": "Confidential",
  "type": "security-template",
  "groupCount": 34,
  "permissionCount": 12,
  "createdBy": "dc63db1b-1e63-43bc-877e-418931b6895c",
  "createdEpoch": 1773070355217,
  "createdDate": "2026-03-11T14:32:35Z",
  "lastUpdatedBy": "dc63db1b-1e63-43bc-877e-418931b6895c",
  "lastUpdatedEpoch": 1773070399999,
  "lastUpdatedDate": "2026-03-11T15:00:00Z",
  "groups": {
    "totalCount": 34,
    "items": [ … ],
    "pageInfo": { … }
  }
}

(NEW!) Update Security Template

Request

Partially update a security, rights, or access template. Only the fields present in the body are changed.

Business Rules:

  • type is not an updatable field. If present in the body, the request is rejected with 400. Type is fixed at creation because assets and metadata templates reference the template by id and assume its type.
  • At least one of name or groups must be present, or the request is rejected with 400. Unknown fields are also rejected with 400.
  • When groups is present, it is a full replacement of the template's group/permission set — omitted groups are removed, not left alone.
  • Every groups[].id and permissionIds[] entry must be a well-formed UUID and must exist for the customer (groups) or in the permission catalog (permissions). Unknown ids are rejected with 422.
  • name, if changed, is re-checked for uniqueness per customer.

Optimistic Concurrency:

  • Opt-in via expectedLastUpdatedEpoch. If provided, it is compared against the template's current lastUpdatedEpoch; a mismatch is rejected with 409 and code: STALE_UPDATE. If omitted, the update proceeds last-write-wins.

The response body is returned in the same shape as GET /security/templates/{id}.

The user submitting the request must have the Security Template Management admin privilege.

Security
ApiKeyAuth or BasicAuth
Path
templateIdstring(uuid)required

The unique ID of the security template to update.

Example: a9380047-07d7-48aa-b4b7-474d00f0f428
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

JSON object with the fields to change. name and/or groups — at least one required. groups, when present, fully replaces the existing group/permission set. type cannot be included.

namestring

Updated display name. Same validation as creation (trimmed, non-empty, maximum 75 characters); re-checked for uniqueness if changed.

Example: "Confidential - Marketing"
groupsArray of objects

When present, this is a full replacement of the template's group/permission set — the service recomputes both stored columns from it. Omit to leave the current groups untouched.

expectedLastUpdatedEpochinteger

Optional optimistic-concurrency guard. When provided, it is compared against the template's current lastUpdatedEpoch; a mismatch is rejected with 409 and code: STALE_UPDATE. Omit for last-write-wins.

Example: 1773070355217
curl -i -X PATCH \
  https://api.uat.tenovos.io/v1/security/templates/a9380047-07d7-48aa-b4b7-474d00f0f428 \
  -H 'Authorization: string' \
  -H 'Content-Type: application/json' \
  -H 'X-API-Key: YOUR_API_KEY_HERE' \
  -d '{
    "name": "Confidential - Marketing"
  }'

Responses

Updated. The response body is the template in the same shape as GET /security/templates/{id}.

Bodyapplication/json
idstring(uuid)

Unique ID of the template.

Example: "a9380047-07d7-48aa-b4b7-474d00f0f428"
namestring

Display name of the template.

Example: "Confidential"
typestring

Template classification. Set at creation and immutable thereafter.

Enum"security-template""rights-template""access-template"
Example: "security-template"
groupCountinteger

Total number of groups on the template, across all pages.

Example: 2
permissionCountinteger

Total number of permissions granted across all groups, including the watermark permission.

Example: 3
createdBystring(uuid)

User ID of the template's creator.

Example: "dc63db1b-1e63-43bc-877e-418931b6895c"
createdEpochinteger

Unix timestamp (ms) of creation.

Example: 1773070355217
createdDatestring(date-time)

ISO 8601 creation date.

Example: "2026-03-09T15:32:35.217Z"
lastUpdatedBystring(uuid)

User ID of the user who last updated the template.

Example: "dc63db1b-1e63-43bc-877e-418931b6895c"
lastUpdatedEpochinteger

Unix timestamp (ms) of the last update. Pass this value back as expectedLastUpdatedEpoch on PATCH to guard against concurrent edits.

Example: 1773070355217
lastUpdatedDatestring(date-time)

ISO 8601 last updated date.

Example: "2026-03-09T15:32:35.217Z"
groupsobject

Page of groups assigned to the template.

Response
application/json
{
  "id": "a9380047-07d7-48aa-b4b7-474d00f0f428",
  "name": "Confidential - Marketing",
  "type": "security-template",
  "groupCount": 1,
  "permissionCount": 1,
  "createdBy": "dc63db1b-1e63-43bc-877e-418931b6895c",
  "createdEpoch": 1773070355217,
  "createdDate": "2026-03-09T15:32:35.217Z",
  "lastUpdatedBy": "dc63db1b-1e63-43bc-877e-418931b6895c",
  "lastUpdatedEpoch": 1773070500000,
  "lastUpdatedDate": "2026-03-09T15:35:00.000Z",
  "groups": {
    "totalCount": 1,
    "items": [ … ],
    "pageInfo": { … }
  }
}

(NEW!) Delete Security Template

Request

Permanently delete a security, rights, or access template the authenticated customer owns.

Delete Rules:

  • Template must exist for the authenticated customer.
  • Deletion is blocked when the template is still referenced: either it has stored dependencies, or it is applied somewhere — for access-template, the count of metadata templates using it; otherwise, the count of assets using it.
  • There is no force-delete option. An in-use template can only be removed directly against the database, outside this API.
  • On success, the deletion is recorded in tenovos_delete_history for the security-template type.

This action is permanent and cannot be undone.

The user submitting the request must have the Security Template Management admin privilege.

Security
ApiKeyAuth or BasicAuth
Path
templateIdstring(uuid)required

The unique ID of the security template to delete.

Example: a9380047-07d7-48aa-b4b7-474d00f0f428
Headers
X-API-Keystringrequired

Customer-specific API key required to invoke API.

Authorizationstringrequired

Provided by Authentication Token creation operation.

curl -i -X DELETE \
  https://api.uat.tenovos.io/v1/security/templates/a9380047-07d7-48aa-b4b7-474d00f0f428 \
  -H 'Authorization: string' \
  -H 'X-API-Key: YOUR_API_KEY_HERE'

Responses

No Content. The security template has been permanently deleted.

Response
No content

PEOPLE

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

PROOFING

Operations