Skip to main content

Find & read content

Search, browse and read DAM content: records and their metadata, files and versions, previews, downloads, and public links. Most groups in this area only read.

This area has 8 groups and 118 tools, 101 of them currently available.

How to read this page
  • Groups are the unit of access. An admin enables tool groups on a client registration, and a tool appears in an agent's tool list only when its group is enabled. See Tool Groups.
  • Needs. Enabling a group also enables every group it needs. Each group below lists them.
  • Read-only groups are intended for look-up access without the ability to change data.
  • Visibility is not authorization. Every tool call executes as the authenticated user, and a visible tool can still return an authorization error. See the MCP Tool Permission Map.
  • Destructive tools are labelled as such. They delete or irreversibly overwrite data, and will not act unless the call sets both confirmed and confirmedDestructive to true.
  • Not currently available tools are registered but are not offered in any tool list at this time.
  • Activity and Project labels vary by tenant. Where this page says Activity or Project, your tenant's own configured terminology is substituted at runtime.

Groups in this area​

GroupAccessNeedsTools
Find & Discover ContentRead-onlyNone18
View Asset Metadata & HistoryRead-onlyFind & Discover Content, Read the Content Model9
View Files & VersionsRead-onlyFind & Discover Content16
Get Previews, Thumbnails & RenditionsRead-onlyView Files & Versions16
Read the Content ModelRead-onlyNone20
View Processing, Check & Watermark ResultsCan change dataView Files & Versions12
Download & Order FilesCan change dataFind & Discover Content, View Files & Versions23
View Public LinksRead-onlyView Files & Versions4

Find & Discover Content​

Read-only · 18 tools (17 currently available) · Group ID find-discover-content

Needs: no other groups.

ToolWhat it does
browse_classificationsBrowses the Aprimo classification tree (category folders that organize assets).
get_classificationGets one Aprimo classification's full detail (identifier, sort order, labels, registered fields/field groups, root/parent status) by id, by leaf name, or by full name path.
get_classification_by_name_pathGets one Aprimo classification by its full name path (e.g. "/Brands/Europe/Digital Images"), or by a unique field's name and value (e.g. fieldName="identifier").
get_classification_parentGets the direct parent of one Aprimo classification, by id, name, or name path.
get_collectionGets one Aprimo collection's full detail (name, description, type, status, owner) by id or by name.
get_collection_recordsLists the assets (records) inside one Aprimo collection: title, deep link, dates, content type, metadata fields.
get_record_by_field_or_fileNot currently available. Looks up a single Aprimo record either by a file id (the id of one of its files) or by an arbitrary field name/value pair (e.g. a unique external identifier field).
get_search_field_value_suggestionsGets field-value autocomplete suggestions for Aprimo given partial input text and a set of field ids, grouped by language.
get_search_phrase_suggestionsGets phrase-level search-box suggestions for Aprimo for a piece of input text (e.g. as the user types a search query).
list_classification_ancestorsLists every ancestor (parent, grandparent, ... up to the root) of one Aprimo classification, by id, name, or name path — ordered from the top-level ancestor (depth 0) down.
list_classification_childrenLists the direct children of one Aprimo classification, by id, name, or name path — full detail per child.
list_collectionsLists the Aprimo collections visible to the user: name, description, type, id.
list_record_associated_collectionsLists the Aprimo collections a record belongs to (static collections it was manually added to, or dynamic collections whose search criteria it currently matches).
list_recordsLists Aprimo records as a plain paged listing (not relevance-ranked — use search_aprimo for keyword/relevance search).
search_aprimoSearches Aprimo assets by keyword with optional filters.
search_classificationsSearches Aprimo classifications with the filter expression sent in the request body instead of the query string — functionally similar to browse_classifications, but usable when the filter expression is too long for a header/query string, or to page through a large result set.
search_collectionsSearches Aprimo collections with a filter expression sent in the request body (equivalent to list_collections, but usable when the filter is too large for a query string).
start_image_similarity_searchStarts an asynchronous Aprimo job that searches for images similar to the image at a given URL, and returns the job's id.

browse_classifications​

Browses the Aprimo classification tree (category folders that organize assets). Without a parentId it returns top-level (root) classifications; with a parentId it returns that node's children. Use when the user wants to explore categories or narrow down where assets live. Display format: one line per classification — name in bold, then the full path.

Parameters:

ParameterTypeRequiredDescription
parentIdstringNoOptional parent classification id (32-char hex / GUID) to list children of. Omit for top-level (root) classifications.

Returns:

FieldTypeDescription
parentIdstring (optional)
countinteger
itemsarray of ClassificationPayload
items[].idstring
items[].namestring
items[].namePathstring (optional)
items[].parentIdstring (optional)

get_classification​

Gets one Aprimo classification's full detail (identifier, sort order, labels, registered fields/field groups, root/parent status) by id, by leaf name, or by full name path. Use after browse_classifications, or pass name/namePath directly when the user names the classification. Not any of its sub-resources (fields, image URL, parent, tree permissions, etc.) or the dedicated name-path lookup (get_classification_by_name_path) -- each has its own get_classification_* tool.

Parameters:

ParameterTypeRequiredDescription
classificationIdstringNoThe classification id (GUID). Provide exactly one of classificationId, name, or namePath.
namestringNoThe classification's leaf name (case-insensitive, exact match) — not guaranteed unique across the tree; ambiguous matches hard-fail. Provide exactly one of classificationId, name, or namePath.
namePathstringNoThe classification's full name path (e.g. "/Brands/Europe/Digital Images"), which is unique. Provide exactly one of classificationId, name, or namePath.

Returns:

FieldTypeDescription
idstring
identifierstring (optional)
namestring
namePathstring (optional)
labelPathstring (optional)
sortIndexinteger (optional)
sortOrderstring (optional)
disabledInDamUiboolean (optional)
labelsarray of ClassificationLabelPayload
labels[].valuestring (optional)
labels[].languageIdstring (optional)
registeredFieldIdsarray of string
registeredFieldGroupIdsarray of string
isRootboolean (optional)
parentIdstring (optional)
hasChildrenboolean (optional)
tagstring (optional)
modifiedOnstring (optional)
createdOnstring (optional)

get_classification_by_name_path​

Gets one Aprimo classification by its full name path (e.g. "/Brands/Europe/Digital Images"), or by a unique field's name and value (e.g. fieldName="identifier"). Use when the user gives a full path or a unique identifier rather than a classification id — pass exactly one of namePath or the fieldName+fieldValue pair.

Parameters:

ParameterTypeRequiredDescription
namePathstringNoThe classification's full name path, e.g. "/Brands/Europe/Digital Images". Provide this or fieldName+fieldValue, not both.
fieldNamestringNoName of a unique field to look up by (e.g. "identifier"). Requires fieldValue. Provide this pair or namePath, not both.
fieldValuestringNoValue of the unique field named by fieldName. Requires fieldName.

Returns:

FieldTypeDescription
idstring
identifierstring (optional)
namestring
namePathstring (optional)
labelPathstring (optional)
sortIndexinteger (optional)
sortOrderstring (optional)
disabledInDamUiboolean (optional)
labelsarray of ClassificationLabelPayload
labels[].valuestring (optional)
labels[].languageIdstring (optional)
registeredFieldIdsarray of string
registeredFieldGroupIdsarray of string
isRootboolean (optional)
parentIdstring (optional)
hasChildrenboolean (optional)
tagstring (optional)
modifiedOnstring (optional)
createdOnstring (optional)

get_classification_parent​

Gets the direct parent of one Aprimo classification, by id, name, or name path. Fails with a friendly message if the classification is a root (it has no parent).

Parameters:

ParameterTypeRequiredDescription
classificationIdstringNoThe classification id (GUID). Provide exactly one of classificationId, name, or namePath.
namestringNoThe classification's leaf name (case-insensitive, exact match). Provide exactly one of classificationId, name, or namePath.
namePathstringNoThe classification's full name path. Provide exactly one of classificationId, name, or namePath.

Returns:

FieldTypeDescription
idstring
identifierstring (optional)
namestring
namePathstring (optional)
labelPathstring (optional)
sortIndexinteger (optional)
sortOrderstring (optional)
disabledInDamUiboolean (optional)
labelsarray of ClassificationLabelPayload
labels[].valuestring (optional)
labels[].languageIdstring (optional)
registeredFieldIdsarray of string
registeredFieldGroupIdsarray of string
isRootboolean (optional)
parentIdstring (optional)
hasChildrenboolean (optional)
tagstring (optional)
modifiedOnstring (optional)
createdOnstring (optional)

get_collection​

Gets one Aprimo collection's full detail (name, description, type, status, owner) by id or by name. Use after list_collections, or pass name directly when the user names the collection. Not a comment (get_collection_comment), comments status (get_collection_comments_status), or its records (get_collection_records).

Parameters:

ParameterTypeRequiredDescription
collectionIdstringNoThe collection id (32-char hex / GUID). Provide exactly one of collectionId or name.
namestringNoThe collection's exact name (case-insensitive) — not guaranteed unique; ambiguous matches hard-fail. Provide exactly one of collectionId or name.

Returns:

FieldTypeDescription
idstring
namestring
descriptionstring
typestring
statusstring (optional)
ownerIdstring (optional)
createdOnstring
modifiedOnstring

get_collection_records​

Lists the assets (records) inside one Aprimo collection: title, deep link, dates, content type, metadata fields. Use after list_collections when the user wants to see a collection's contents. Display format: one block per record — title in bold, then deep link, status, content type, and dates as bullets.

Parameters:

ParameterTypeRequiredDescription
collectionIdstringYesThe collection id (32-char hex / GUID, from list_collections).

Returns:

FieldTypeDescription
collectionIdstring
countinteger
itemsarray of RecordPayload
items[].idstring
items[].titlestring
items[].statusstring
items[].contentTypestring
items[].createdOnstring
items[].modifiedOnstring
items[].deepLinkstring
items[].fieldsmap of string

get_record_by_field_or_file​

Not currently available

Looks up a single Aprimo record either by a file id (the id of one of its files) or by an arbitrary field name/value pair (e.g. a unique external identifier field). This is a lookup, not a keyword search — use search_aprimo for relevance-ranked keyword/filter search instead. Provide either fileId, or both fieldName and fieldValue (not all three).

Parameters:

ParameterTypeRequiredDescription
fileIdstringNoA file id (32-char hex / GUID) belonging to the record's files. Provide this or fieldName+fieldValue, not both.
fieldNamestringNoThe internal field name to match on (e.g. an external-id field name). Requires fieldValue. Provide this pair or fileId, not both.
fieldValuestringNoThe value to match fieldName against. Requires fieldName.

Returns:

FieldTypeDescription
idstring
titlestring
statusstring
contentTypestring
createdOnstring
modifiedOnstring
deepLinkstring
fieldsmap of string

get_search_field_value_suggestions​

Gets field-value autocomplete suggestions for Aprimo given partial input text and a set of field ids, grouped by language. Use to power metadata-field autocomplete.

Parameters:

ParameterTypeRequiredDescription
inputstringYesThe partial text typed by the user to get suggestions for.
fieldIdsarray of stringYesThe field ids (32-char hex / GUID) to generate suggestions from, e.g. from list_field_definitions.
languageIds// Bug fix: DAM's suggestion endpoint unconditionally loops over languageIds with no null-check // (an immediate nre, the same for every field/input, confirmed via direct dam-repo trace -- see // docs/internal/pm-dam-qa-followups.md) -- there was never a working "omit for all languages" // path to begin with. Kept nullable/optional at the C# signature level (not a non-nullable // required parameter) deliberately -- confirmed live that the MCP sdk's own parameter binding // rejects a call that omits a non-nullable required parameter with a generic "error occurred // invoking" message before this method body (and its validation check below) ever runs. Nullable // + the explicit check below is what actually produces the clean "at least one language id is // required" message a caller can act on. List<string>NoThe language ids (32-char hex / GUID) to search within. Required -- DAM has no "all languages" default for this; get language ids from list_languages.
fuzzinessstringNoOptional fuzziness (edit-distance) setting for the suggestion match.
numberOfSuggestionsintegerNoOptional maximum number of suggestions to return per language.

Returns:

FieldTypeDescription
countinteger
itemsarray of LanguageSuggestionsPayload
items[].languageIdstring
items[].suggestionsarray of SuggestionPayload
items[].suggestions[].textstring
items[].suggestions[].scorenumber (optional)

get_search_phrase_suggestions​

Gets phrase-level search-box suggestions for Aprimo for a piece of input text (e.g. as the user types a search query). Use to power search-as-you-type suggestions.

Parameters:

ParameterTypeRequiredDescription
textstringYesThe input text to generate phrase suggestions for.
maxSuggestionsintegerNoOptional maximum number of suggestions to return.
languageIdsarray of stringNoOptional language ids (32-char hex / GUID) to search suggestions within. Omit to search all configured languages.

Returns:

FieldTypeDescription
countinteger
suggestionsarray of string

list_classification_ancestors​

Lists every ancestor (parent, grandparent, ... up to the root) of one Aprimo classification, by id, name, or name path — ordered from the top-level ancestor (depth 0) down. Use to show a classification's full breadcrumb trail.

Parameters:

ParameterTypeRequiredDescription
classificationIdstringNoThe classification id (GUID). Provide exactly one of classificationId, name, or namePath.
namestringNoThe classification's leaf name (case-insensitive, exact match). Provide exactly one of classificationId, name, or namePath.
namePathstringNoThe classification's full name path. Provide exactly one of classificationId, name, or namePath.

Returns:

FieldTypeDescription
classificationIdstring
countinteger
itemsarray of LinkedClassificationPayload
items[].idstring
items[].depthinteger
items[].labelsarray of ClassificationLabelPayload
items[].labels[].valuestring (optional)
items[].labels[].languageIdstring (optional)

list_classification_children​

Lists the direct children of one Aprimo classification, by id, name, or name path — full detail per child. Use browse_classifications instead for a lighter-weight id/name/namePath-only view.

Parameters:

ParameterTypeRequiredDescription
classificationIdstringNoThe classification id (GUID). Provide exactly one of classificationId, name, or namePath.
namestringNoThe classification's leaf name (case-insensitive, exact match). Provide exactly one of classificationId, name, or namePath.
namePathstringNoThe classification's full name path. Provide exactly one of classificationId, name, or namePath.

Returns:

FieldTypeDescription
classificationIdstring
countinteger
itemsarray of ClassificationDetailPayload
items[].idstring
items[].identifierstring (optional)
items[].namestring
items[].namePathstring (optional)
items[].labelPathstring (optional)
items[].sortIndexinteger (optional)
items[].sortOrderstring (optional)
items[].disabledInDamUiboolean (optional)
items[].labelsarray of ClassificationLabelPayload
items[].labels[].valuestring (optional)
items[].labels[].languageIdstring (optional)
items[].registeredFieldIdsarray of string
items[].registeredFieldGroupIdsarray of string
items[].isRootboolean (optional)
items[].parentIdstring (optional)
items[].hasChildrenboolean (optional)
items[].tagstring (optional)
items[].modifiedOnstring (optional)
items[].createdOnstring (optional)

list_collections​

Lists the Aprimo collections visible to the user: name, description, type, id. Use when the user asks what collections exist or wants to pick one. Display format: one line per collection — name in bold, then type and description.

Parameters: none.

Returns:

FieldTypeDescription
countinteger
itemsarray of CollectionPayload
items[].idstring
items[].namestring
items[].descriptionstring
items[].typestring
items[].createdOnstring
items[].modifiedOnstring

list_record_associated_collections​

Lists the Aprimo collections a record belongs to (static collections it was manually added to, or dynamic collections whose search criteria it currently matches). Use get_collection_records for the reverse direction (a collection's records).

Parameters:

ParameterTypeRequiredDescription
recordIdstringYesThe record id (32-char hex / GUID).
skipintegerNoNumber of items to skip, for paging. Defaults to 0.
takeintegerNoMaximum number of items to return. Defaults to 10.

Returns:

FieldTypeDescription
recordIdstring
countinteger
itemsarray of CollectionPayload
items[].idstring
items[].namestring
items[].descriptionstring
items[].typestring
items[].createdOnstring
items[].modifiedOnstring

list_records​

Lists Aprimo records as a plain paged listing (not relevance-ranked — use search_aprimo for keyword/relevance search). Use filter/sort with DAM query syntax to narrow the list, e.g. filter="Status = 'Released'", sort="ModifiedOn desc".

Parameters:

ParameterTypeRequiredDescription
filterstringNoOptional filter expression (DAM query syntax), e.g. "Status = 'Released'". Omit to list every record.
sortstringNoOptional sort expression, e.g. "ModifiedOn desc". Omit for the endpoint's default order.
skipintegerNoNumber of items to skip, for paging. Defaults to 0.
takeintegerNoMaximum number of items to return. Omit for the endpoint's default page size.

Returns:

FieldTypeDescription
countinteger
itemsarray of RecordPayload
items[].idstring
items[].titlestring
items[].statusstring
items[].contentTypestring
items[].createdOnstring
items[].modifiedOnstring
items[].deepLinkstring
items[].fieldsmap of string

search_aprimo​

Searches Aprimo assets by keyword with optional filters. Returns structured JSON data for each matching asset. Supports filtering by date range (created/modified) and file type in addition to keyword search. Display format: For each result, show the title in bold, then list the deep link, content type, file type, dates, preview URI (as a plain URL, never as an HTML img tag), and custom fields as bullet points underneath. Separate results with a blank line. Important: Always display all returned results and all custom fields for every result. Never summarize, truncate, or omit results or fields. Custom fields display: For each custom field, show only the label and value as "label: value". Do not show the id, fieldName, or dataType — those are internal metadata for follow-up tool calls, not for the user. If the user asks for specific custom fields (e.g. "show keywords", "include the status"), pass their terms via includeFields — matching is case-insensitive and partial, so "keyword" matches a field labeled "Keywords". At the end, always show the search results page link. Use this tool for finding images, documents, videos, and other digital assets — not for asking questions (use ask_content_coach for questions). Do not use ask_content_coach as a fallback. Examples: query="product brochure", query="logo" limit=5 sort="title_asc", query="banner" createdAfter="2026-01-01", query="card" fileType="png", query="report" modifiedAfter="2026-03-01" modifiedBefore="2026-03-15" sort="modified_desc".

Parameters:

ParameterTypeRequiredDescription
querystringYesThe exact search keywords. Only include the relevant search terms — no filler text, instructions, or conversational phrasing. Extract only the core search terms the user wants to find. Bad: 'find me some product brochures', 'can you search for logos', 'I need banner images'. Good: 'product brochure', 'logo', 'banner image'. If the term is pluralized, use its singular form. Important: If the user refers to Aprimo by name (e.g. 'Find Aprimo PNGs'), do not include 'Aprimo' as a keyword — it is the system name, not a search term. Use '*' as the query to match all assets when the user's intent is to browse or filter without a specific keyword.
limitintegerNoMaximum number of results to return (1–50, default 20).
offsetintegerNoNumber of results to skip for pagination (default 0).
sortstringNoSort order for results. Options: "relevance" (default), "modified_desc", "modified_asc", "created_desc", "created_asc", "title_asc", "title_desc", "popularity". Use "modified_desc" when the user wants the newest/latest, "created_desc" for recently added, "title_asc" for alphabetical, "popularity" for most popular.
createdAfterstringNoFilter to assets created on or after this date (ISO 8601 format, e.g. "2026-01-15"). Use for queries like "created last week" or "added after January".
createdBeforestringNoFilter to assets created on or before this date (ISO 8601 format, e.g. "2026-03-01"). Use with createdAfter for a date range.
modifiedAfterstringNoFilter to assets modified on or after this date (ISO 8601 format, e.g. "2026-03-01"). Use for queries like "updated recently" or "changed this month".
modifiedBeforestringNoFilter to assets modified on or before this date (ISO 8601 format, e.g. "2026-03-15").
fileTypestringNoFilter by file extension (e.g. "jpg", "pdf", "png", "mp4", "docx"). Use when the user specifies a file type like "find me PDF reports" or "show png logos".
includeFieldsstringNoOptional comma-separated list of custom field terms to include for each result. Matching is case-insensitive: an exact match on field id, or a substring match on fieldName or label. Examples: "keywords", "status", "brand,campaign". Omit to return all custom fields.

Returns:

FieldTypeDescription
contextstring
total_countinteger
countinteger
offsetinteger
has_moreboolean
next_offsetinteger (optional)
searchResultsLinkstring (optional)
itemsarray of SearchAprimoItem
items[].titlestring
items[].deepLinkstring (optional)
items[].customFieldsarray of SearchAprimoFieldValue
items[].customFields[].idstring
items[].customFields[].fieldNamestring (optional)
items[].customFields[].labelstring (optional)
items[].customFields[].dataTypestring (optional)
items[].customFields[].valuestring (optional)
items[].createdDatestring (optional)
items[].modifiedDatestring (optional)
items[].contentTypestring (optional)
items[].fileExtensionstring (optional)
items[].previewUristring (optional)

search_classifications​

Searches Aprimo classifications with the filter expression sent in the request body instead of the query string — functionally similar to browse_classifications, but usable when the filter expression is too long for a header/query string, or to page through a large result set. This is a read: it never modifies data, so no confirmation is needed.

Parameters:

ParameterTypeRequiredDescription
expressionstringNoDAM search-expression string, e.g. "Name Contains 'Digital'". Omit to match every classification (bounded by skip/take).
sortstringNoOptional sort expression, e.g. "createdOn". Omit for the endpoint's default order.
skipintegerNoNumber of items to skip, for paging. Defaults to 0.
takeintegerNoMaximum number of items to return. Omit for the endpoint's default page size.

Returns:

FieldTypeDescription
countinteger
itemsarray of ClassificationDetailPayload
items[].idstring
items[].identifierstring (optional)
items[].namestring
items[].namePathstring (optional)
items[].labelPathstring (optional)
items[].sortIndexinteger (optional)
items[].sortOrderstring (optional)
items[].disabledInDamUiboolean (optional)
items[].labelsarray of ClassificationLabelPayload
items[].labels[].valuestring (optional)
items[].labels[].languageIdstring (optional)
items[].registeredFieldIdsarray of string
items[].registeredFieldGroupIdsarray of string
items[].isRootboolean (optional)
items[].parentIdstring (optional)
items[].hasChildrenboolean (optional)
items[].tagstring (optional)
items[].modifiedOnstring (optional)
items[].createdOnstring (optional)

search_collections​

Searches Aprimo collections with a filter expression sent in the request body (equivalent to list_collections, but usable when the filter is too large for a query string). Use when the user wants collections matching a specific filter, optionally including archived ones.

Parameters:

ParameterTypeRequiredDescription
filterstringNoOptional filter expression (DAM query syntax), e.g. "ModifiedOn in today". Omit to match every collection.
sortstringNoOptional sort expression, e.g. "Name". Omit for the endpoint's default order.
skipintegerNoNumber of items to skip, for paging. Defaults to 0.
takeintegerNoMaximum number of items to return. Omit for the endpoint's default page size.
includeArchivedbooleanNoWhen true, includes archived collections in the results. Defaults to false.

Returns:

FieldTypeDescription
countinteger
itemsarray of CollectionPayload
items[].idstring
items[].namestring
items[].descriptionstring
items[].typestring
items[].createdOnstring
items[].modifiedOnstring

Starts an asynchronous Aprimo job that searches for images similar to the image at a given URL, and returns the job's id. Important limitation: the DAM rest API documents no endpoint to retrieve this job's results (no poll/status/result endpoint exists for this job type) — this tool can only confirm the job was accepted, not report matches. This modifies data (creates a job). Tell the user about this limitation before using it.

Parameters:

ParameterTypeRequiredDescription
urlstringYesThe URL of the image to search for similar images to.
maxResultsintegerNoOptional maximum number of results the job should collect.
userAgentstringNoOptional user agent to use when fetching the image at the URL.
siftstringNoOptional sift (feature-matching) options for the search.
pHashstringNoOptional perceptual-hash matching options for the search.
creatorEmailstringNoOptional email address of the user the job is created on behalf of.
disableNotificationbooleanNoWhen true, suppresses job-completion notifications. Omit for the endpoint's default.
earliestStartDatestringNoOptional ISO-8601 timestamp; the job will not start executing before this time.
prioritystringNoOptional job priority: "High" or "Medium".

Returns:

FieldTypeDescription
jobIdstring
notestring

View Asset Metadata & History​

Read-only · 9 tools · Group ID view-asset-metadata-history

Needs: Find & Discover Content, Read the Content Model

ToolWhat it does
get_record_audit_trail_entryGets the full detail for one audit trail entry of an Aprimo record — who made the change, when, and the individual field/file changes it contains — by the record's id and the entry's id (from list_record_audit_trail).
get_record_classificationGets one classification assigned to an Aprimo record (sort order among the record's other classifications, and whether it was assigned manually or automatically via classification mappings), by the record's id and the classification's id (from list_record_classifications or browse_classifications).
get_record_duplicate_infoGets duplicate-detection info for an Aprimo record's master file: duplicate status, detection mode, and the list of duplicate file versions the caller has read access to.
get_record_fieldGets one custom field value on an Aprimo record, by the record's id and the field's id (from list_record_fields or get_custom_field_definition).
get_record_metadataRetrieves the full metadata for a single Aprimo record by its ID.
get_record_permissionsGets the calling user's own effective permissions on an Aprimo record: read, read-all-versions, modify, delete, download, and full control.
list_record_audit_trailLists the audit trail (change history) for an Aprimo record: who changed what and when, one summary entry per change event.
list_record_classificationsLists every classification assigned to an Aprimo record, in sort order, with whether each was assigned manually or automatically via classification mappings.
list_record_fieldsLists the custom field values on an Aprimo record, by the record's id.

get_record_audit_trail_entry​

Gets the full detail for one audit trail entry of an Aprimo record — who made the change, when, and the individual field/file changes it contains — by the record's id and the entry's id (from list_record_audit_trail).

Parameters:

ParameterTypeRequiredDescription
objectIdstringYesThe record id (32-char hex / GUID) — the audit trail's object id.
entryIdintegerYesThe audit entry's id (an integer, from list_record_audit_trail), e.g. 4.

Returns:

FieldTypeDescription
idinteger
objectIdstring
userIdstring (optional)
externalUserNamestring (optional)
createdOnstring (optional)
changeCountinteger
changesarray of string

get_record_classification​

Gets one classification assigned to an Aprimo record (sort order among the record's other classifications, and whether it was assigned manually or automatically via classification mappings), by the record's id and the classification's id (from list_record_classifications or browse_classifications).

Parameters:

ParameterTypeRequiredDescription
recordIdstringYesThe record id (32-char hex / GUID).
classificationIdstringYesThe classification id (32-char hex / GUID).

Returns:

FieldTypeDescription
recordIdstring
classificationIdstring
namestring (optional)
sortIndexinteger (optional)
isManualboolean (optional)

get_record_duplicate_info​

Gets duplicate-detection info for an Aprimo record's master file: duplicate status, detection mode, and the list of duplicate file versions the caller has read access to. Pass newFileName to check as if the master file were being renamed to that name (useful before an upload that would add a new version).

Parameters:

ParameterTypeRequiredDescription
recordIdstringYesThe record id (32-char hex / GUID).
newFileNamestringNoOptional — check duplicates as if the master file were renamed to this file name instead of its current name.

Returns:

FieldTypeDescription
recordIdstring
duplicateInfoFileVersionDuplicateInfoPayload
duplicateInfo.detectionModestring
duplicateInfo.statusstring
duplicateInfo.totalCountinteger
duplicateInfo.duplicatesarray of DuplicatePayload
duplicateInfo.duplicates[].recordIdstring
duplicateInfo.duplicates[].fileVersionIdstring
duplicateInfo.duplicates[].reasonstring

get_record_field​

Gets one custom field value on an Aprimo record, by the record's id and the field's id (from list_record_fields or get_custom_field_definition). Not the field's list of allowed values (use get_record_field_list_values for that). get_record_metadata is usually more convenient for reading several fields at once. Display the result as "label: value" — never show the id/fieldName/dataType to the user.

Parameters:

ParameterTypeRequiredDescription
recordIdstringYesThe record id (32-char hex / GUID).
fieldIdstringYesThe field definition id (GUID) whose value to read.

Returns:

FieldTypeDescription
recordIdstring
idstring
fieldNamestring (optional)
labelstring (optional)
dataTypestring (optional)
valuestring (optional)

get_record_metadata​

Retrieves the full metadata for a single Aprimo record by its ID. Returns system properties (title, status, content type, dates), master file info (filename, extension, size, version), and all custom field values. Use this tool when you need detailed information about a specific asset. The record ID is a GUID — you can get it from search_aprimo results. If the user asks for specific custom fields (e.g. "show me the keywords", "what's the status"), pass their terms via includeFields — matching is case-insensitive and partial, so "keyword" matches a field labeled "Keywords". Display format: Show the title in bold, then list all properties and custom fields as bullet points. For custom fields, display only "label: value" — never show id, fieldName, or dataType to the user.

Parameters:

ParameterTypeRequiredDescription
recordIdstringYesThe record ID (GUID format, e.g. "a1b2c3d4-e5f6-7890-abcd-ef1234567890"). Obtain from search_aprimo results.
includeFieldsstringNoOptional comma-separated list of custom field terms to include. Matching is case-insensitive: an exact match on field id, or a substring match on fieldName or label. Examples: "keywords", "Status", "brand,campaign". Omit to return all fields.

Returns:

FieldTypeDescription
idstring
titlestring (optional)
statusstring (optional)
contentTypestring (optional)
createdOnstring (optional)
modifiedOnstring (optional)
deepLinkstring (optional)
masterFileRecordFileInfo (optional)
masterFile.fileNamestring (optional)
masterFile.extensionstring (optional)
masterFile.fileSizeinteger (optional)
masterFile.versionNumberinteger (optional)
fieldsarray of RecordFieldValue
fields[].idstring
fields[].fieldNamestring (optional)
fields[].labelstring (optional)
fields[].dataTypestring (optional)
fields[].localizedValuesarray of RecordLocalizedValue
fields[].localizedValues[].languageIdstring (optional)
fields[].localizedValues[].valuestring (optional)
fields[].localizedValues[].valuesarray of string (optional)

get_record_permissions​

Gets the calling user's own effective permissions on an Aprimo record: read, read-all-versions, modify, delete, download, and full control. Use when the user asks what they're allowed to do with a specific asset.

Parameters:

ParameterTypeRequiredDescription
recordIdstringYesThe record id (32-char hex / GUID).

Returns:

FieldTypeDescription
recordIdstring
canReadboolean (optional)
canReadAllVersionsboolean (optional)
canModifyboolean (optional)
canDeleteboolean (optional)
hasFullControlboolean (optional)
canDownloadboolean (optional)

list_record_audit_trail​

Lists the audit trail (change history) for an Aprimo record: who changed what and when, one summary entry per change event. Pass filter="Change" or filter="Download" to narrow to just modifications or just download events. Use get_record_audit_trail_entry (by an entry's id from this list) for the individual field changes within one entry.

Parameters:

ParameterTypeRequiredDescription
objectIdstringYesThe record id (32-char hex / GUID) — the audit trail's object id.
filterstringNoOptional — restrict to "Change" or "Download" events. Omit for every event type.
skipintegerNoNumber of items to skip, for paging. Defaults to 0.
takeintegerNoMaximum number of items to return. Omit for the endpoint's default page size.

Returns:

FieldTypeDescription
objectIdstring
entryCountinteger
countinteger
itemsarray of RecordAuditTrailEntrySummaryPayload
items[].idinteger
items[].typestring (optional)
items[].userIdstring (optional)
items[].createdOnstring (optional)
items[].changeCountinteger (optional)

list_record_classifications​

Lists every classification assigned to an Aprimo record, in sort order, with whether each was assigned manually or automatically via classification mappings.

Parameters:

ParameterTypeRequiredDescription
recordIdstringYesThe record id (32-char hex / GUID).
sortstringNoOptional sort expression, e.g. "sortIndex asc". Omit for the endpoint's default order.
skipintegerNoNumber of items to skip, for paging. Defaults to 0.
takeintegerNoMaximum number of items to return. Omit for the endpoint's default page size.

Returns:

FieldTypeDescription
recordIdstring
countinteger
itemsarray of RecordClassificationPayload
items[].recordIdstring
items[].classificationIdstring
items[].namestring (optional)
items[].sortIndexinteger (optional)
items[].isManualboolean (optional)

list_record_fields​

Lists the custom field values on an Aprimo record, by the record's id. Use includeFields to filter to specific fields (matches by id exactly, or by fieldName/label substring). get_record_metadata also returns fields alongside the record's system properties — use that when you need both. Display each as "label: value" — never show id/fieldName/dataType to the user.

Parameters:

ParameterTypeRequiredDescription
recordIdstringYesThe record id (32-char hex / GUID).
includeFieldsstringNoOptional comma-separated list of custom field terms to include. Matching is case-insensitive: an exact match on field id, or a substring match on fieldName or label. Examples: "keywords", "Status", "brand,campaign". Omit to return all fields.
skipintegerNoNumber of items to skip, for paging. Defaults to 0.
takeintegerNoMaximum number of items to return. Omit for the endpoint's default page size.

Returns:

FieldTypeDescription
recordIdstring
countinteger
itemsarray of RecordFieldPayload
items[].recordIdstring
items[].idstring
items[].fieldNamestring (optional)
items[].labelstring (optional)
items[].dataTypestring (optional)
items[].valuestring (optional)

View Files & Versions​

Read-only · 16 tools (15 currently available) · Group ID view-files-versions

Needs: Find & Discover Content

ToolWhat it does
get_additional_fileGets one additional file (rendition, crop, still, subtitle, etc.) of an Aprimo asset by its id: type, label, file name, size, and usages/purposes.
get_additional_file_public_linkNot currently available. Gets the public link associated with an additional file of an Aprimo asset, by its id.
get_fileGets a file on an Aprimo asset by its id: checkout status, checkout date, watermark, and creation date.
get_file_fieldGets one custom field value set on a file (not the asset/record) of an Aprimo asset, by the file's id and the field's id (from list_file_fields or get_custom_field_definition).
get_file_latest_versionGets the latest file version of a file (not the record) on an Aprimo asset: version id, label, file name, size, and creation date.
get_file_version_detailGets full detail for one file version of an Aprimo asset: all base fields plus the opt-in duplicate detection info, annotation info, and metadata that get_file_versions and get_record_master_file_version do not include.
get_file_version_duplicate_infoGets the full duplicate-detection info for an Aprimo file version: duplicate status, detection mode, and the list of duplicate file versions the caller has read access to.
get_file_version_file_typeGets the Aprimo file type detail (extension, MIME type, engine/preview format, supported operations) for a specific file version.
get_file_versionsLists all versions of a file on an Aprimo asset: version label/number, file name, size, and which is latest.
get_record_master_fileGets the master file of an Aprimo record (checkout status, checkout date, watermark, creation date) — the file id itself, distinct from get_record_master_file_version's file version id.
get_record_master_file_versionGets the latest file version of an Aprimo asset's (record's) master file: version id, label, file name, size, and creation date.
list_additional_filesLists the additional files (renditions, crops, stills, subtitles, etc.) attached to a file version of an Aprimo asset: type, label, file name, size, and usages/purposes.
list_file_fieldsLists the custom field values set on a file (not the asset/record) of an Aprimo asset, by the file's id.
list_file_version_linked_versionsLists the publications an Aprimo file version is used in (or contains), by file version id and link type.
list_file_version_permissionsGets the calling user's calculated download/delete permissions on an Aprimo file version, by file version id.
list_record_filesLists every file attached to an Aprimo record (typically just the master file, but a record can have more): checkout status, checkout date, watermark, and creation date per file.

get_additional_file​

Gets one additional file (rendition, crop, still, subtitle, etc.) of an Aprimo asset by its id: type, label, file name, size, and usages/purposes. Use list_additional_files first to find the id from a file version. Not its preview (get_additional_file_preview), preview URL (get_additional_file_preview_url), or public link (get_additional_file_public_link).

Parameters:

ParameterTypeRequiredDescription
additionalFileIdstringYesThe additional file id (32-char hex, from list_additional_files).

Returns:

FieldTypeDescription
idstring
typestring
isManualboolean
labelstring
fileSizeinteger
fileNamestring
extensionstring
usagesarray of string
purposesarray of string

Not currently available

Gets the public link associated with an additional file of an Aprimo asset, by its id. Returns a not-found error if the additional file has no public link.

Parameters:

ParameterTypeRequiredDescription
additionalFileIdstringYesThe additional file id (32-char hex, from list_additional_files or get_additional_file).

Returns:

FieldTypeDescription
idstring
uristring (optional)
statusstring (optional)
canDeleteboolean (optional)
providerstring (optional)
recordIdstring (optional)
fileVersionIdstring (optional)
additionalFileIdstring (optional)
fileSizeinteger (optional)
renditionNamestring (optional)
originstring (optional)
modifiedOnstring (optional)
createdOnstring (optional)

get_file​

Gets a file on an Aprimo asset by its id: checkout status, checkout date, watermark, and creation date. Use when the user asks about a file's checkout or watermark state rather than its content or version history. Returns only this base file record — not any file sub-resource (previews, versions, thumbnails, process actions, etc.), each of which has its own get_file_* tool.

Parameters:

ParameterTypeRequiredDescription
fileIdstringYesThe file id (32-char hex, from a record's master file).

Returns:

FieldTypeDescription
idstring
checkedOutboolean
checkedOutOnstring
watermarkIdstring
watermarkTypestring
createdOnstring

get_file_field​

Gets one custom field value set on a file (not the asset/record) of an Aprimo asset, by the file's id and the field's id (from list_file_fields or get_custom_field_definition). Display it as "label: value" — never show the id/fieldName/dataType to the user.

Parameters:

ParameterTypeRequiredDescription
fileIdstringYesThe file id (32-char hex, from a record's master file).
fieldIdstringYesThe field definition id (GUID) whose value to read.

Returns:

FieldTypeDescription
fileIdstring
idstring
fieldNamestring (optional)
labelstring (optional)
dataTypestring (optional)
valuestring (optional)

get_file_latest_version​

Gets the latest file version of a file (not the record) on an Aprimo asset: version id, label, file name, size, and creation date. Same shape as get_record_master_file_version, but scoped to a specific file id rather than a record's master file.

Parameters:

ParameterTypeRequiredDescription
fileIdstringYesThe file id (32-char hex, from a record's master file).

Returns:

FieldTypeDescription
idstring
fileNamestring
versionLabelstring
versionNumberinteger
fileSizeinteger
fileExtensionstring
isLatestboolean
createdOnstring

get_file_version_detail​

Gets full detail for one file version of an Aprimo asset: all base fields plus the opt-in duplicate detection info, annotation info, and metadata that get_file_versions and get_record_master_file_version do not include. Use when the user asks about duplicates, annotations, or file-version-level metadata for a specific file version id.

Parameters:

ParameterTypeRequiredDescription
fileVersionIdstringYesThe file version id (32-char hex, from get_file_versions or get_record_master_file_version).

Returns:

FieldTypeDescription
idstring
versionLabelstring
versionNumberinteger
fileNamestring
fileSizeinteger
fileExtensionstring
fileCreatedOnstring
fileModifiedOnstring
commentstring
crc32integer
sha256string
preventDownloadboolean
isLatestboolean
fileProcessingStatestring
aiInfluencedstring
watermarkIdstring
watermarkTypestring
fileStatestring
hasSmartActionFindingsboolean (optional)
createdOnstring
metadatamap of FileVersionMetadataEntryPayload
metadata.contentTypestring
metadata.valuestring
duplicateInfoFileVersionDuplicateInfoPayload
duplicateInfo.detectionModestring
duplicateInfo.statusstring
duplicateInfo.totalCountinteger
duplicateInfo.duplicatesarray of DuplicatePayload
duplicateInfo.duplicates[].recordIdstring
duplicateInfo.duplicates[].fileVersionIdstring
duplicateInfo.duplicates[].reasonstring
annotationInfoFileVersionAnnotationInfoPayload
annotationInfo.totalCountinteger
annotationInfo.annotationsarray of FileVersionAnnotationPayload
annotationInfo.annotations[].idstring
annotationInfo.annotations[].commentsstring
annotationInfo.annotations[].pageNumberinteger
annotationInfo.annotations[].createdBystring
annotationInfo.annotations[].createdOnstring

get_file_version_duplicate_info​

Gets the full duplicate-detection info for an Aprimo file version: duplicate status, detection mode, and the list of duplicate file versions the caller has read access to. Use when the user asks whether a file version has duplicates elsewhere in the system.

Parameters:

ParameterTypeRequiredDescription
fileVersionIdstringYesThe file version id (32-char hex, from get_file_versions or get_record_master_file_version).

Returns:

FieldTypeDescription
detectionModestring
statusstring
totalCountinteger
duplicatesarray of DuplicatePayload
duplicates[].recordIdstring
duplicates[].fileVersionIdstring
duplicates[].reasonstring

get_file_version_file_type​

Gets the Aprimo file type detail (extension, MIME type, engine/preview format, supported operations) for a specific file version. Same shape as get_file_type, but resolved from a file version id rather than a file type id/name.

Parameters:

ParameterTypeRequiredDescription
fileVersionIdstringYesThe file version id (32-char hex, from get_file_versions or get_record_master_file_version).

Returns:

FieldTypeDescription
idstring
namestring
kindstring (optional)
extensionstring (optional)
mimeTypestring (optional)
engineFormatstring (optional)
isCatalogableboolean
mediaEnginesarray of string
previewFormatstring (optional)
previewPlayersarray of string
previewRequiredboolean
previewKeepDimensionsboolean
supportAssetResizeboolean
supportAssetWatermarkboolean
preferredExtensionboolean
tagstring (optional)
registeredFieldIdsarray of string
registeredFieldGroupIdsarray of string
labelsarray of FileTypeLabelPayload
labels[].valuestring (optional)
labels[].languageIdstring
createdOnstring (optional)
modifiedOnstring (optional)

get_file_versions​

Lists all versions of a file on an Aprimo asset: version label/number, file name, size, and which is latest. Use when the user asks about version history of an asset's file.

Parameters:

ParameterTypeRequiredDescription
fileIdstringYesThe file id (32-char hex, from a record's master file).

Returns:

FieldTypeDescription
fileIdstring
countinteger
itemsarray of FileVersionPayload
items[].idstring
items[].fileNamestring
items[].versionLabelstring
items[].versionNumberinteger
items[].fileSizeinteger
items[].fileExtensionstring
items[].isLatestboolean
items[].createdOnstring

get_record_master_file​

Gets the master file of an Aprimo record (checkout status, checkout date, watermark, creation date) — the file id itself, distinct from get_record_master_file_version's file version id. Use get_file (by this file id) for the same shape scoped generically to any file.

Parameters:

ParameterTypeRequiredDescription
recordIdstringYesThe record id (32-char hex / GUID).

Returns:

FieldTypeDescription
idstring
checkedOutboolean
checkedOutOnstring
watermarkIdstring
watermarkTypestring
createdOnstring

get_record_master_file_version​

Gets the latest file version of an Aprimo asset's (record's) master file: version id, label, file name, size, and creation date. Use when the caller only has a record id and needs the file version id (e.g. before calling get_file_versions or other file-version-scoped tools).

Parameters:

ParameterTypeRequiredDescription
recordIdstringYesThe record id (32-char hex, from a search result or a user-provided link).

Returns:

FieldTypeDescription
idstring
fileNamestring
versionLabelstring
versionNumberinteger
fileSizeinteger
fileExtensionstring
isLatestboolean
createdOnstring

list_additional_files​

Lists the additional files (renditions, crops, stills, subtitles, etc.) attached to a file version of an Aprimo asset: type, label, file name, size, and usages/purposes. Use when the user asks about renditions or other files beyond the master file for a specific file version.

Parameters:

ParameterTypeRequiredDescription
fileVersionIdstringYesThe file version id (32-char hex, from get_file_versions or get_record_master_file_version).

Returns:

FieldTypeDescription
fileVersionIdstring
countinteger
itemsarray of AdditionalFilePayload
items[].idstring
items[].typestring
items[].isManualboolean
items[].labelstring
items[].fileSizeinteger
items[].fileNamestring
items[].extensionstring
items[].usagesarray of string
items[].purposesarray of string

list_file_fields​

Lists the custom field values set on a file (not the asset/record) of an Aprimo asset, by the file's id. Use includeFields to filter to specific fields (matches by id exactly, or by fieldName/label substring). Display each as "label: value" — never show id/fieldName/dataType to the user.

Parameters:

ParameterTypeRequiredDescription
fileIdstringYesThe file id (32-char hex, from a record's master file).
includeFieldsstringNoOptional comma-separated list of custom field terms to include. Matching is case-insensitive: an exact match on field id, or a substring match on fieldName or label. Examples: "keywords", "Status", "brand,campaign". Omit to return all fields.
skipintegerNoNumber of items to skip, for paging. Defaults to 0.
takeintegerNoMaximum number of items to return. Omit for the endpoint's default page size.

Returns:

FieldTypeDescription
fileIdstring
countinteger
itemsarray of FileFieldPayload
items[].fileIdstring
items[].idstring
items[].fieldNamestring (optional)
items[].labelstring (optional)
items[].dataTypestring (optional)
items[].valuestring (optional)

list_file_version_linked_versions​

Lists the publications an Aprimo file version is used in (or contains), by file version id and link type. Use "Contains" to see the publication items a publication file version contains, or "UsedIn" to see the publications a file version is used in.

Parameters:

ParameterTypeRequiredDescription
fileVersionIdstringYesThe file version id (32-char hex, from get_file_versions or get_record_master_file_version).
linkedVersionTypestringYesThe link direction: "Contains" or "UsedIn".
skipintegerNoNumber of items to skip, for paging. Defaults to 0.
takeintegerNoMaximum number of items to return. Omit for the endpoint's default page size.

Returns:

FieldTypeDescription
fileVersionIdstring
linkedVersionTypestring
countinteger
itemsarray of FileVersionLinkedVersionPayload
items[].recordIdstring (optional)
items[].fileIdstring (optional)
items[].fileVersionIdstring (optional)
items[].linkSourceVersionIdstring (optional)
items[].linkTypestring (optional)

list_file_version_permissions​

Gets the calling user's calculated download/delete permissions on an Aprimo file version, by file version id. Distinct from list_user_permissions/list_user_group_permissions, which read named-permission grants rather than these two per-file-version flags.

Parameters:

ParameterTypeRequiredDescription
fileVersionIdstringYesThe file version id (32-char hex, from get_file_versions or get_record_master_file_version).

Returns:

FieldTypeDescription
fileVersionIdstring
canDownloadboolean
canDeleteboolean

list_record_files​

Lists every file attached to an Aprimo record (typically just the master file, but a record can have more): checkout status, checkout date, watermark, and creation date per file. Use get_record_master_file for just the master file, or get_file_versions (by file id) for a file's version history.

Parameters:

ParameterTypeRequiredDescription
recordIdstringYesThe record id (32-char hex / GUID).

Returns:

FieldTypeDescription
recordIdstring
countinteger
itemsarray of FilePayload
items[].idstring
items[].checkedOutboolean
items[].checkedOutOnstring
items[].watermarkIdstring
items[].watermarkTypestring
items[].createdOnstring

Get Previews, Thumbnails & Renditions​

Read-only · 16 tools (15 currently available) · Group ID previews-renditions

Needs: View Files & Versions

ToolWhat it does
get_additional_file_previewGets one preview of an additional file of an Aprimo asset, by the additional file's id and the preview's integer id (from list_additional_file_previews).
get_additional_file_preview_urlReturns the main preview image URL (plus width/height/size/extension) for an additional file of an Aprimo asset, by its id.
get_file_previewGets one preview of a file version on an Aprimo asset by its id: page number, name, and whether it's the master preview or manually added.
get_file_preview_image_urlReturns the preview image URL (plus width/height/size/extension) for a file preview on an Aprimo asset, by its id.
get_file_preview_thumbnail_urlReturns the thumbnail image URL (plus width/height/size/extension) for a file preview on an Aprimo asset, by its id.
get_file_preview_urlReturns the preview image URL (plus width/height/size/extension) for a file on an Aprimo asset, by file id.
get_file_thumbnail_urlReturns the thumbnail image URL (plus width/height/size/extension) for a file on an Aprimo asset, by file id.
get_file_version_master_previewGets the master preview of an Aprimo file version: page number, name, and whether it was added manually.
get_file_version_preview_urlReturns the preview image URL (plus width/height/size/extension) for an Aprimo file version's file preview, by file version id.
get_file_version_thumbnail_urlReturns the thumbnail image URL (plus width/height/size/extension) for an Aprimo file version's file preview, by file version id.
get_record_preview_urlReturns the preview image URL for an Aprimo record.
get_record_thumbnail_urlReturns the thumbnail image URL for an Aprimo record.
get_renditionGets one Aprimo rendition's detail (name, type, extension, uri, preview, published uri) by id.
list_additional_file_previewsNot currently available. Lists the generated preview pages for an additional file of an Aprimo asset: integer preview id and metadata.
list_file_previewsLists the previews generated for a file version of an Aprimo asset: page number, name, and whether each is the master preview or manually added.
list_file_version_renditionsLists the Aprimo renditions (generated derivatives — thumbnails, resized previews, converted formats) for a file version, by file version id.

get_additional_file_preview​

Gets one preview of an additional file of an Aprimo asset, by the additional file's id and the preview's integer id (from list_additional_file_previews). Returns metadata; use get_additional_file_preview_url instead if you just need the image URL.

Parameters:

ParameterTypeRequiredDescription
additionalFileIdstringYesThe additional file id (32-char hex, from list_additional_files or get_additional_file).
filePreviewIdintegerYesThe preview's integer id (from list_additional_file_previews) — not a GUID, unlike the standalone file-preview resource used by get_file_preview.

Returns:

FieldTypeDescription
additionalFileIdstring
idinteger
metadataarray of string
uristring (optional)

get_additional_file_preview_url​

Returns the main preview image URL (plus width/height/size/extension) for an additional file of an Aprimo asset, by its id. The URL remains valid for twenty-four hours. Returns a friendly message if no preview has been generated yet. Important: Display the URL as plain text, never as an HTML img tag.

Parameters:

ParameterTypeRequiredDescription
additionalFileIdstringYesThe additional file id (32-char hex, from list_additional_files or get_additional_file).

Returns:

FieldTypeDescription
additionalFileIdstring
uristring (optional)
widthinteger (optional)
heightinteger (optional)
sizeinteger (optional)
extensionstring (optional)

get_file_preview​

Gets one preview of a file version on an Aprimo asset by its id: page number, name, and whether it's the master preview or manually added. Use list_file_previews first to find the id from a file version. Not its image URL (get_file_preview_image_url), thumbnail URL (get_file_preview_thumbnail_url), or preview URL (get_file_preview_url).

Parameters:

ParameterTypeRequiredDescription
filePreviewIdstringYesThe file preview id (32-char hex, from list_file_previews).

Returns:

FieldTypeDescription
idstring
pageNumberinteger
namestring
isMasterboolean
isManualboolean
createdOnstring

get_file_preview_image_url​

Returns the preview image URL (plus width/height/size/extension) for a file preview on an Aprimo asset, by its id. The URL remains valid for twenty-four hours. Important: Display the URL as plain text, never as an HTML img tag.

Parameters:

ParameterTypeRequiredDescription
filePreviewIdstringYesThe file preview id (32-char hex, from list_file_previews or get_file_preview).

Returns:

FieldTypeDescription
filePreviewIdstring
uristring (optional)
widthinteger (optional)
heightinteger (optional)
sizeinteger (optional)
extensionstring (optional)

get_file_preview_thumbnail_url​

Returns the thumbnail image URL (plus width/height/size/extension) for a file preview on an Aprimo asset, by its id. The URL remains valid for twenty-four hours. Important: Display the URL as plain text, never as an HTML img tag.

Parameters:

ParameterTypeRequiredDescription
filePreviewIdstringYesThe file preview id (32-char hex, from list_file_previews or get_file_preview).

Returns:

FieldTypeDescription
filePreviewIdstring
uristring (optional)
widthinteger (optional)
heightinteger (optional)
sizeinteger (optional)
extensionstring (optional)

get_file_preview_url​

Returns the preview image URL (plus width/height/size/extension) for a file on an Aprimo asset, by file id. The URL remains valid for twenty-four hours. Returns a friendly message if no preview has been generated yet. Important: Display the URL as plain text, never as an HTML img tag.

Parameters:

ParameterTypeRequiredDescription
fileIdstringYesThe file id (32-char hex, from a record's master file).

Returns:

FieldTypeDescription
fileIdstring
uristring (optional)
widthinteger (optional)
heightinteger (optional)
sizeinteger (optional)
extensionstring (optional)

get_file_thumbnail_url​

Returns the thumbnail image URL (plus width/height/size/extension) for a file on an Aprimo asset, by file id. The URL remains valid for twenty-four hours. Returns a friendly message if no thumbnail has been generated yet. Important: Display the URL as plain text, never as an HTML img tag.

Parameters:

ParameterTypeRequiredDescription
fileIdstringYesThe file id (32-char hex, from a record's master file).

Returns:

FieldTypeDescription
fileIdstring
uristring (optional)
widthinteger (optional)
heightinteger (optional)
sizeinteger (optional)
extensionstring (optional)

get_file_version_master_preview​

Gets the master preview of an Aprimo file version: page number, name, and whether it was added manually. Use list_file_previews to see every preview, or this tool when only the master (primary) preview is needed.

Parameters:

ParameterTypeRequiredDescription
fileVersionIdstringYesThe file version id (32-char hex, from get_file_versions or get_record_master_file_version).

Returns:

FieldTypeDescription
idstring
pageNumberinteger
namestring
isMasterboolean
isManualboolean
createdOnstring

get_file_version_preview_url​

Returns the preview image URL (plus width/height/size/extension) for an Aprimo file version's file preview, by file version id. The URL remains valid for twenty-four hours. Returns a friendly message if no preview has been generated yet. Important: Display the URL as plain text, never as an HTML img tag.

Parameters:

ParameterTypeRequiredDescription
fileVersionIdstringYesThe file version id (32-char hex, from get_file_versions or get_record_master_file_version).

Returns:

FieldTypeDescription
fileVersionIdstring
uristring (optional)
widthinteger (optional)
heightinteger (optional)
sizeinteger (optional)
extensionstring (optional)

get_file_version_thumbnail_url​

Returns the thumbnail image URL (plus width/height/size/extension) for an Aprimo file version's file preview, by file version id. The URL remains valid for twenty-four hours. Returns a friendly message if no thumbnail has been generated yet. Important: Display the URL as plain text, never as an HTML img tag.

Parameters:

ParameterTypeRequiredDescription
fileVersionIdstringYesThe file version id (32-char hex, from get_file_versions or get_record_master_file_version).

Returns:

FieldTypeDescription
fileVersionIdstring
uristring (optional)
widthinteger (optional)
heightinteger (optional)
sizeinteger (optional)
extensionstring (optional)

get_record_preview_url​

Returns the preview image URL for an Aprimo record. Previews are larger images (typically 800x600) suitable for detail views. The URL contains a time-limited SAS token (typically 24 hours). Returns a user-friendly message if no preview exists. Important: Display the URL as plain text, never as an HTML img tag.

Parameters:

ParameterTypeRequiredDescription
recordIdstringYesThe record ID (GUID format). Obtain from search_aprimo results.

Returns:

FieldTypeDescription
idstring
titlestring (optional)
uristring (optional)
widthinteger (optional)
heightinteger (optional)
extensionstring (optional)

get_record_thumbnail_url​

Returns the thumbnail image URL for an Aprimo record. Thumbnails are small images (typically 150x150) suitable for list/grid displays. The URL contains a time-limited SAS token (typically 24 hours). Returns a user-friendly message if no thumbnail exists. Important: Display the URL as plain text, never as an HTML img tag.

Parameters:

ParameterTypeRequiredDescription
recordIdstringYesThe record ID (GUID format). Obtain from search_aprimo results.

Returns:

FieldTypeDescription
idstring
titlestring (optional)
uristring (optional)
widthinteger (optional)
heightinteger (optional)
extensionstring (optional)

get_rendition​

Gets one Aprimo rendition's detail (name, type, extension, uri, preview, published uri) by id. A rendition is a generated derivative of a file version — a thumbnail, resized preview, or converted format — produced by DAM's media processing pipeline. Use list_rendition_public_links to find any public links pointing at this rendition.

Parameters:

ParameterTypeRequiredDescription
renditionIdstringYesThe rendition id (GUID).

Returns:

FieldTypeDescription
idstring
uristring (optional)
typestring (optional)
namestring (optional)
extensionstring (optional)
previewstring (optional)
publishedUristring (optional)

list_additional_file_previews​

Not currently available

Lists the generated preview pages for an additional file of an Aprimo asset: integer preview id and metadata. Use when the user asks about preview images/pages for a specific additional file (not a file version — use list_file_previews for that).

Parameters:

ParameterTypeRequiredDescription
additionalFileIdstringYesThe additional file id (32-char hex, from list_additional_files or get_additional_file).

Returns:

FieldTypeDescription
additionalFileIdstring
countinteger
itemsarray of AdditionalFilePreviewPayload
items[].additionalFileIdstring
items[].idinteger
items[].metadataarray of string
items[].uristring (optional)

list_file_previews​

Lists the previews generated for a file version of an Aprimo asset: page number, name, and whether each is the master preview or manually added. Use when the user asks about preview images/pages for a specific file version.

Parameters:

ParameterTypeRequiredDescription
fileVersionIdstringYesThe file version id (32-char hex, from get_file_versions or get_record_master_file_version).

Returns:

FieldTypeDescription
fileVersionIdstring
countinteger
itemsarray of FilePreviewPayload
items[].idstring
items[].pageNumberinteger
items[].namestring
items[].isMasterboolean
items[].isManualboolean
items[].createdOnstring

list_file_version_renditions​

Lists the Aprimo renditions (generated derivatives — thumbnails, resized previews, converted formats) for a file version, by file version id. Use to look up a rendition's id before calling get_rendition.

Parameters:

ParameterTypeRequiredDescription
fileVersionIdstringYesThe file version id (32-char hex, from get_file_versions or get_record_master_file_version).

Returns:

FieldTypeDescription
fileVersionIdstring
countinteger
itemsarray of RenditionPayload
items[].idstring
items[].uristring (optional)
items[].typestring (optional)
items[].namestring (optional)
items[].extensionstring (optional)
items[].previewstring (optional)
items[].publishedUristring (optional)

Read the Content Model​

Read-only · 20 tools · Group ID read-content-model

Needs: no other groups.

ToolWhat it does
get_classification_fieldGets one custom field's value on an Aprimo classification, by classification id/name/namePath plus the field id.
get_content_typeGets one Aprimo content type's detail (purpose, parent, registered fields, labels, dates) by id.
get_content_type_by_nameGets one Aprimo content type's detail by its exact name, via DAM's dedicated by-name lookup (distinct from get_content_type, which looks up by id).
get_content_type_parentGets the parent content type of an Aprimo content type, by id or by name.
get_custom_field_definitionReturns the definition of a custom field in Aprimo, including its data type, validation rules, and available values for option list fields.
get_field_definition_list_valuesLists the classifications selectable as values on a classification-list Aprimo field definition, by id or by name.
get_field_groupGets one Aprimo field group's detail (name, custom tag, dates) by id or by name.
get_file_typeGets one Aprimo file type's detail (extension, MIME type, engine/preview format, registered fields, supported operations, labels) by id or by name.
get_file_type_iconReturns the icon image URL (plus width/height/size/extension) for an Aprimo file type, by id or by name.
get_file_type_thumbnailReturns the thumbnail image URL (plus width/height/size/extension) for an Aprimo file type, by id or by name.
get_languageGets one Aprimo language's detail (name, culture, custom tag, enabled-for-fields/UI flags, dates) by id or by name.
list_classification_fieldsLists every custom field value set on one Aprimo classification, by id, name, or name path.
list_content_typesLists the content types configured in Aprimo: name, purpose, parent, registered fields, labels, and dates.
list_content_types_infoLists every Aprimo content type's basic info only: id, name, and parent id — a lighter-weight alternative to list_content_types when the caller doesn't need fields/labels/config, e.g. to build a content-type hierarchy or a quick id lookup.
list_field_definitionsLists the custom metadata field definitions configured in Aprimo: name, label, data type, scope, validation, and dates.
list_field_group_membersLists the custom metadata field definitions that are members of an Aprimo field group, by id or by name.
list_field_groupsLists the field groups configured in Aprimo — named groupings of custom metadata field definitions, used to organize related fields for display in the DAM UI.
list_file_typesLists the file types configured in Aprimo (e.g. Jpeg, PDF, MP4) — name, extension, MIME type, engine/preview format, and supported operations.
list_languagesLists the languages enabled in Aprimo for multi-language fields/labels: name, culture, enabled-for-fields/UI flags, and dates.
search_field_definitionsSearches custom metadata field definitions in Aprimo with the filter sent in the request body instead of the query string — functionally equivalent to list_field_definitions, but usable when the filter expression is too long for a header/query string.

get_classification_field​

Gets one custom field's value on an Aprimo classification, by classification id/name/namePath plus the field id. Use after list_classification_fields to look up a field's id.

Parameters:

ParameterTypeRequiredDescription
fieldIdstringYesThe field id (GUID), from list_classification_fields.
classificationIdstringNoThe classification id (GUID). Provide exactly one of classificationId, name, or namePath.
namestringNoThe classification's leaf name (case-insensitive, exact match). Provide exactly one of classificationId, name, or namePath.
namePathstringNoThe classification's full name path. Provide exactly one of classificationId, name, or namePath.

Returns:

FieldTypeDescription
idstring
fieldNamestring (optional)
labelstring (optional)
dataTypestring (optional)
valuestring (optional)

get_content_type​

Gets one Aprimo content type's detail (purpose, parent, registered fields, labels, dates) by id. Use after list_content_types, or use get_content_type_by_name when the user names the content type directly. Not its parent either (use get_content_type_parent for that).

Parameters:

ParameterTypeRequiredDescription
contentTypeIdstringYesThe content type id (GUID), from list_content_types.

Returns:

FieldTypeDescription
idstring
namestring
purposestring (optional)
parentIdstring (optional)
isManualboolean
isNoFileboolean
fileModestring (optional)
inheritanceConfigurationstring (optional)
inheritanceFieldIdstring (optional)
registeredFieldIdsarray of string
inheritableFieldIdsarray of string
defaultFileExtensionsarray of string
labelsarray of ContentTypeLabelPayload
labels[].valuestring (optional)
labels[].languageIdstring
titleConfigurationOptionstring (optional)
createdOnstring (optional)
modifiedOnstring (optional)

get_content_type_by_name​

Gets one Aprimo content type's detail by its exact name, via DAM's dedicated by-name lookup (distinct from get_content_type, which looks up by id). Use when the user names the content type directly (e.g. "Video", "Image").

Parameters:

ParameterTypeRequiredDescription
namestringYesThe content type's exact name (case-insensitive), e.g. "Video".

Returns:

FieldTypeDescription
idstring
namestring
purposestring (optional)
parentIdstring (optional)
isManualboolean
isNoFileboolean
fileModestring (optional)
inheritanceConfigurationstring (optional)
inheritanceFieldIdstring (optional)
registeredFieldIdsarray of string
inheritableFieldIdsarray of string
defaultFileExtensionsarray of string
labelsarray of ContentTypeLabelPayload
labels[].valuestring (optional)
labels[].languageIdstring
titleConfigurationOptionstring (optional)
createdOnstring (optional)
modifiedOnstring (optional)

get_content_type_parent​

Gets the parent content type of an Aprimo content type, by id or by name. Returns an error if the content type doesn't exist or has no parent (e.g. it is a root content type like "Record").

Parameters:

ParameterTypeRequiredDescription
contentTypeIdstringNoThe content type id (GUID) whose parent to fetch. Provide this or name, not both.
namestringNoThe content type's name (case-insensitive, exact match). Provide this or contentTypeId, not both.

Returns:

FieldTypeDescription
idstring
namestring
purposestring (optional)
parentIdstring (optional)
isManualboolean
isNoFileboolean
fileModestring (optional)
inheritanceConfigurationstring (optional)
inheritanceFieldIdstring (optional)
registeredFieldIdsarray of string
inheritableFieldIdsarray of string
defaultFileExtensionsarray of string
labelsarray of ContentTypeLabelPayload
labels[].valuestring (optional)
labels[].languageIdstring
titleConfigurationOptionstring (optional)
createdOnstring (optional)
modifiedOnstring (optional)

get_custom_field_definition​

Returns the definition of a custom field in Aprimo, including its data type, validation rules, and available values for option list fields. Use this before update_record_metadata_field to understand a field's type and constraints. The field definition ID is a GUID — get it from the field's 'id' property in get_record_metadata results. For option list fields, the response includes the list of valid option values (name/label pairs).

Parameters:

ParameterTypeRequiredDescription
fieldDefinitionIdstringYesThe field definition ID (GUID format). Get from get_record_metadata results: each field in the 'fields' array has an 'id' property.

Returns:

FieldTypeDescription
idstring
namestring (optional)
labelstring (optional)
dataTypestring (optional)
isRequiredboolean
isReadOnlyboolean
acceptMultipleOptionsboolean (optional)
helpTextstring (optional)
itemsarray of FieldOptionItem (optional)
items[].idstring
items[].namestring (optional)
items[].labelstring (optional)

get_field_definition_list_values​

Lists the classifications selectable as values on a classification-list Aprimo field definition, by id or by name. Only meaningful for fields whose dataType is ClassificationList.

Parameters:

ParameterTypeRequiredDescription
fieldDefinitionIdstringNoThe field definition id (GUID). Provide this or name, not both.
namestringNoThe field definition's name (case-insensitive, exact match). Provide this or fieldDefinitionId, not both.

Returns:

FieldTypeDescription
fieldDefinitionIdstring
countinteger
itemsarray of ClassificationListFieldItemPayload
items[].idstring
items[].identifierstring (optional)
items[].namestring (optional)
items[].labelstring (optional)
items[].namePathstring (optional)
items[].labelPathstring (optional)
items[].parentIdstring (optional)
items[].disabledInDamUiboolean (optional)
items[].hasChildrenboolean (optional)

get_field_group​

Gets one Aprimo field group's detail (name, custom tag, dates) by id or by name. Use after list_field_groups, or pass name directly when the user names the group. Not its creator (get_field_group_created_by) or last modifier (get_field_group_modified_by).

Parameters:

ParameterTypeRequiredDescription
fieldGroupIdstringNoThe field group id (GUID), from list_field_groups. Provide this or name, not both.
namestringNoThe field group's name (case-insensitive, exact match). Provide this or fieldGroupId, not both.

Returns:

FieldTypeDescription
idstring
namestring
tagstring (optional)
createdOnstring (optional)
modifiedOnstring (optional)

get_file_type​

Gets one Aprimo file type's detail (extension, MIME type, engine/preview format, registered fields, supported operations, labels) by id or by name. Use after list_file_types, or pass name directly when the user names the file type. Not its icon (get_file_type_icon) or thumbnail (get_file_type_thumbnail).

Parameters:

ParameterTypeRequiredDescription
fileTypeIdstringNoThe file type id (GUID), from list_file_types. Provide this or name, not both.
namestringNoThe file type's name (case-insensitive, exact match), e.g. "Archive (zip)". Provide this or fileTypeId, not both.

Returns:

FieldTypeDescription
idstring
namestring
kindstring (optional)
extensionstring (optional)
mimeTypestring (optional)
engineFormatstring (optional)
isCatalogableboolean
mediaEnginesarray of string
previewFormatstring (optional)
previewPlayersarray of string
previewRequiredboolean
previewKeepDimensionsboolean
supportAssetResizeboolean
supportAssetWatermarkboolean
preferredExtensionboolean
tagstring (optional)
registeredFieldIdsarray of string
registeredFieldGroupIdsarray of string
labelsarray of FileTypeLabelPayload
labels[].valuestring (optional)
labels[].languageIdstring
createdOnstring (optional)
modifiedOnstring (optional)

get_file_type_icon​

Returns the icon image URL (plus width/height/size/extension) for an Aprimo file type, by id or by name. The URL remains valid for twenty-four hours. Important: Display the URL as plain text, never as an HTML img tag.

Parameters:

ParameterTypeRequiredDescription
fileTypeIdstringNoThe file type id (GUID). Provide this or name, not both.
namestringNoThe file type's name (case-insensitive, exact match). Provide this or fileTypeId, not both.

Returns:

FieldTypeDescription
fileTypeIdstring
uristring (optional)
widthinteger (optional)
heightinteger (optional)
sizeinteger (optional)
extensionstring (optional)

get_file_type_thumbnail​

Returns the thumbnail image URL (plus width/height/size/extension) for an Aprimo file type, by id or by name. The URL remains valid for twenty-four hours. Important: Display the URL as plain text, never as an HTML img tag.

Parameters:

ParameterTypeRequiredDescription
fileTypeIdstringNoThe file type id (GUID). Provide this or name, not both.
namestringNoThe file type's name (case-insensitive, exact match). Provide this or fileTypeId, not both.

Returns:

FieldTypeDescription
fileTypeIdstring
uristring (optional)
widthinteger (optional)
heightinteger (optional)
sizeinteger (optional)
extensionstring (optional)

get_language​

Gets one Aprimo language's detail (name, culture, custom tag, enabled-for-fields/UI flags, dates) by id or by name. Use after list_languages, or pass name directly when the user names the language. Not its image (get_language_image) or synonyms (get_language_synonyms).

Parameters:

ParameterTypeRequiredDescription
languageIdstringNoThe language id (GUID), from list_languages. Provide this or name, not both.
namestringNoThe language's name (case-insensitive, exact match), e.g. "Dutch". Provide this or languageId, not both.

Returns:

FieldTypeDescription
idstring
namestring
culturestring
isEnabledForFieldsboolean
isEnabledForUIboolean
tagstring (optional)
createdOnstring
modifiedOnstring

list_classification_fields​

Lists every custom field value set on one Aprimo classification, by id, name, or name path. Use to see a classification's full metadata beyond its core attributes.

Parameters:

ParameterTypeRequiredDescription
classificationIdstringNoThe classification id (GUID). Provide exactly one of classificationId, name, or namePath.
namestringNoThe classification's leaf name (case-insensitive, exact match). Provide exactly one of classificationId, name, or namePath.
namePathstringNoThe classification's full name path. Provide exactly one of classificationId, name, or namePath.

Returns:

FieldTypeDescription
classificationIdstring
countinteger
itemsarray of SearchAprimoFieldValue
items[].idstring
items[].fieldNamestring (optional)
items[].labelstring (optional)
items[].dataTypestring (optional)
items[].valuestring (optional)

list_content_types​

Lists the content types configured in Aprimo: name, purpose, parent, registered fields, labels, and dates. Every Aprimo record has exactly one content type (e.g. Image, Video, Document). Use when the user asks what content types exist, or to look up a content type's id/exact name before calling get_content_type, update_content_type, or delete_content_type by name.

Parameters:

ParameterTypeRequiredDescription
filterstringNoOptional partial-name filter (DAM only supports a partial name match for this filter). Omit to list every content type.

Returns:

FieldTypeDescription
countinteger
itemsarray of ContentTypePayload
items[].idstring
items[].namestring
items[].purposestring (optional)
items[].parentIdstring (optional)
items[].isManualboolean
items[].isNoFileboolean
items[].fileModestring (optional)
items[].inheritanceConfigurationstring (optional)
items[].inheritanceFieldIdstring (optional)
items[].registeredFieldIdsarray of string
items[].inheritableFieldIdsarray of string
items[].defaultFileExtensionsarray of string
items[].labelsarray of ContentTypeLabelPayload
items[].labels[].valuestring (optional)
items[].labels[].languageIdstring
items[].titleConfigurationOptionstring (optional)
items[].createdOnstring (optional)
items[].modifiedOnstring (optional)

list_content_types_info​

Lists every Aprimo content type's basic info only: id, name, and parent id — a lighter-weight alternative to list_content_types when the caller doesn't need fields/labels/config, e.g. to build a content-type hierarchy or a quick id lookup.

Parameters: none.

Returns:

FieldTypeDescription
countinteger
itemsarray of ContentTypeInfoPayload
items[].idstring
items[].namestring
items[].parentIdstring (optional)

list_field_definitions​

Lists the custom metadata field definitions configured in Aprimo: name, label, data type, scope, validation, and dates. Use when the user asks what fields exist, or to look up a field's id/exact name before calling update_field_definition or delete_field_definition by name.

Parameters:

ParameterTypeRequiredDescription
filterstringNoOptional filter expression (DAM query syntax), e.g. "ModifiedOn in today". Omit to list every field definition.

Returns:

FieldTypeDescription
countinteger
itemsarray of FieldDefinitionPayload
items[].idstring
items[].namestring (optional)
items[].labelstring (optional)
items[].dataTypestring (optional)
items[].scopestring (optional)
items[].scopeCategorystring (optional)
items[].indexedboolean (optional)
items[].languageModestring (optional)
items[].isRequiredboolean
items[].isReadOnlyboolean
items[].isUniqueIdentifierboolean (optional)
items[].inlineStylestring (optional)
items[].sortIndexinteger (optional)
items[].tagstring (optional)
items[].defaultValuestring (optional)
items[].resetToDefaultTriggersarray of string
items[].resetToDefaultFieldIdsarray of string
items[].validationstring (optional)
items[].validationErrorMessagestring (optional)
items[].validationTriggerstring (optional)
items[].storageModestring (optional)
items[].helpTextstring (optional)
items[].helpTextsarray of FieldDefinitionLabelPayload
items[].helpTexts[].valuestring (optional)
items[].helpTexts[].languageIdstring
items[].labelsarray of FieldDefinitionLabelPayload
items[].labels[].valuestring (optional)
items[].labels[].languageIdstring
items[].enabledLanguageIdsarray of string
items[].membershipFieldGroupIdsarray of string
items[].createdOnstring (optional)
items[].modifiedOnstring (optional)

list_field_group_members​

Lists the custom metadata field definitions that are members of an Aprimo field group, by id or by name.

Parameters:

ParameterTypeRequiredDescription
fieldGroupIdstringNoThe field group id (GUID). Provide this or name, not both.
namestringNoThe field group's name (case-insensitive, exact match). Provide this or fieldGroupId, not both.

Returns:

FieldTypeDescription
fieldGroupIdstring
countinteger
itemsarray of FieldDefinitionPayload
items[].idstring
items[].namestring (optional)
items[].labelstring (optional)
items[].dataTypestring (optional)
items[].scopestring (optional)
items[].scopeCategorystring (optional)
items[].indexedboolean (optional)
items[].languageModestring (optional)
items[].isRequiredboolean
items[].isReadOnlyboolean
items[].isUniqueIdentifierboolean (optional)
items[].inlineStylestring (optional)
items[].sortIndexinteger (optional)
items[].tagstring (optional)
items[].defaultValuestring (optional)
items[].resetToDefaultTriggersarray of string
items[].resetToDefaultFieldIdsarray of string
items[].validationstring (optional)
items[].validationErrorMessagestring (optional)
items[].validationTriggerstring (optional)
items[].storageModestring (optional)
items[].helpTextstring (optional)
items[].helpTextsarray of FieldDefinitionLabelPayload
items[].helpTexts[].valuestring (optional)
items[].helpTexts[].languageIdstring
items[].labelsarray of FieldDefinitionLabelPayload
items[].labels[].valuestring (optional)
items[].labels[].languageIdstring
items[].enabledLanguageIdsarray of string
items[].membershipFieldGroupIdsarray of string
items[].createdOnstring (optional)
items[].modifiedOnstring (optional)

list_field_groups​

Lists the field groups configured in Aprimo — named groupings of custom metadata field definitions, used to organize related fields for display in the DAM UI. Use when the user asks what field groups exist, or to look up a group's id/exact name before calling get_field_group, update_field_group, or delete_field_group by name.

Parameters:

ParameterTypeRequiredDescription
filterstringNoOptional filter expression (DAM query syntax), e.g. "ModifiedOn in today". Omit to list every field group.

Returns:

FieldTypeDescription
countinteger
itemsarray of FieldGroupPayload
items[].idstring
items[].namestring
items[].tagstring (optional)
items[].createdOnstring (optional)
items[].modifiedOnstring (optional)

list_file_types​

Lists the file types configured in Aprimo (e.g. Jpeg, PDF, MP4) — name, extension, MIME type, engine/preview format, and supported operations. Use when the user asks what file types exist, or to look up a file type's id/exact name before calling get_file_type, update_file_type, or delete_file_type by name.

Parameters:

ParameterTypeRequiredDescription
filterstringNoOptional filter expression (DAM query syntax), e.g. "ModifiedOn in today". Omit to list every file type.
sortstringNoOptional sort expression, e.g. "createdOn". Omit for the endpoint's default order.
skipintegerNoNumber of items to skip, for paging. Defaults to 0.
takeintegerNoMaximum number of items to return. Omit for the endpoint's default page size.

Returns:

FieldTypeDescription
countinteger
itemsarray of FileTypePayload
items[].idstring
items[].namestring
items[].kindstring (optional)
items[].extensionstring (optional)
items[].mimeTypestring (optional)
items[].engineFormatstring (optional)
items[].isCatalogableboolean
items[].mediaEnginesarray of string
items[].previewFormatstring (optional)
items[].previewPlayersarray of string
items[].previewRequiredboolean
items[].previewKeepDimensionsboolean
items[].supportAssetResizeboolean
items[].supportAssetWatermarkboolean
items[].preferredExtensionboolean
items[].tagstring (optional)
items[].registeredFieldIdsarray of string
items[].registeredFieldGroupIdsarray of string
items[].labelsarray of FileTypeLabelPayload
items[].labels[].valuestring (optional)
items[].labels[].languageIdstring
items[].createdOnstring (optional)
items[].modifiedOnstring (optional)

list_languages​

Lists the languages enabled in Aprimo for multi-language fields/labels: name, culture, enabled-for-fields/UI flags, and dates. Use when the user asks what languages exist, or to look up a language's id/exact name before calling get_language, update_language, or delete_language by name.

Parameters:

ParameterTypeRequiredDescription
filterstringNoOptional filter expression (DAM query syntax), e.g. "Name=Dutch". Omit to list every language.
sortstringNoOptional sort expression, e.g. "createdOn". Omit for the endpoint's default order.
skipintegerNoNumber of items to skip, for paging. Defaults to 0.
takeintegerNoMaximum number of items to return. Omit for the endpoint's default page size.

Returns:

FieldTypeDescription
countinteger
itemsarray of LanguagePayload
items[].idstring
items[].namestring
items[].culturestring
items[].isEnabledForFieldsboolean
items[].isEnabledForUIboolean
items[].tagstring (optional)
items[].createdOnstring
items[].modifiedOnstring

search_field_definitions​

Searches custom metadata field definitions in Aprimo with the filter sent in the request body instead of the query string — functionally equivalent to list_field_definitions, but usable when the filter expression is too long for a header/query string. This is a read: it never modifies data.

Parameters:

ParameterTypeRequiredDescription
filterstringNoOptional filter expression (DAM query syntax), e.g. "ScopeCategory=Record Indexed=true". Omit to match every field definition.
skipintegerNoNumber of items to skip, for paging. Defaults to 0.
takeintegerNoMaximum number of items to return. Omit for the endpoint's default page size.
checkEditPermissionbooleanNoWhen true, only field definitions the current user is allowed to edit are returned. Defaults to false.

Returns:

FieldTypeDescription
countinteger
itemsarray of FieldDefinitionPayload
items[].idstring
items[].namestring (optional)
items[].labelstring (optional)
items[].dataTypestring (optional)
items[].scopestring (optional)
items[].scopeCategorystring (optional)
items[].indexedboolean (optional)
items[].languageModestring (optional)
items[].isRequiredboolean
items[].isReadOnlyboolean
items[].isUniqueIdentifierboolean (optional)
items[].inlineStylestring (optional)
items[].sortIndexinteger (optional)
items[].tagstring (optional)
items[].defaultValuestring (optional)
items[].resetToDefaultTriggersarray of string
items[].resetToDefaultFieldIdsarray of string
items[].validationstring (optional)
items[].validationErrorMessagestring (optional)
items[].validationTriggerstring (optional)
items[].storageModestring (optional)
items[].helpTextstring (optional)
items[].helpTextsarray of FieldDefinitionLabelPayload
items[].helpTexts[].valuestring (optional)
items[].helpTexts[].languageIdstring
items[].labelsarray of FieldDefinitionLabelPayload
items[].labels[].valuestring (optional)
items[].labels[].languageIdstring
items[].enabledLanguageIdsarray of string
items[].membershipFieldGroupIdsarray of string
items[].createdOnstring (optional)
items[].modifiedOnstring (optional)

View Processing, Check & Watermark Results​

Can change data · 12 tools (5 currently available) · Group ID view-processing-results

Needs: View Files & Versions

ToolWhat it does
get_file_process_actionNot currently available. Gets one Aprimo file process action's detail (stage, type, sort index, enabled/allowed flags, conditions, labels) by id.
get_file_version_check_resultNot currently available. Gets a specific Aprimo file version check result by its own id — this relays an already-computed scanner/check outcome.
get_file_version_check_result_findingNot currently available. Gets a single finding (by occurrence number) for one Aprimo file version check result — this relays an already-computed scanner finding: what was found, an explanation, and a recommendation.
get_file_version_check_result_latestNot currently available. Gets the latest Aprimo file version check result for a specific check type — this relays an already-computed scanner/check outcome, it never runs a new check.
get_file_version_watermarkGets the watermark applied to an Aprimo file version, by file version id: name, position, custom tag, and dates.
get_file_watermarkGets the watermark applied to a file on an Aprimo asset, by file id: name, position, custom tag, and dates.
get_watermark_imageReturns the image URL (plus width/height/size/extension) for an Aprimo watermark, by id or by name.
list_file_process_actionsNot currently available. Lists the file process actions configured in Aprimo — the configurable steps (e.g. virus scan, preview render) that run at each stage of a file's processing pipeline, in a fixed sort order, and can be individually enabled or disabled.
list_file_version_check_result_findingsNot currently available. Lists every finding for one Aprimo file version check result — this relays already-computed scanner findings (e.g. a specific security or compliance issue detected).
list_file_version_check_resultsLists every Aprimo check result recorded for a file version — this relays already-computed scanner/check outcomes.
list_file_version_process_action_logLists the file process action log entries for an Aprimo file version: which pipeline actions ran (e.g. virus scan, preview render), their status, and timing.
update_file_process_actionNot currently available. Edits an existing Aprimo file process action by id.

get_file_process_action​

Not currently available

Gets one Aprimo file process action's detail (stage, type, sort index, enabled/allowed flags, conditions, labels) by id. Use after list_file_process_actions.

Parameters:

ParameterTypeRequiredDescription
fileProcessActionIdstringYesThe file process action id (GUID), from list_file_process_actions.

Returns:

FieldTypeDescription
idstring
namestring
fileProcessActionStageIdstring (optional)
fileProcessActionTypeinteger (optional)/// DAM's FileProcessActionType enum value — see 's remarks for why this is a number, not a string.
sortIndexinteger
isConfigurableboolean
enabledboolean
allowedboolean
labelstring (optional)
labelsarray of FileProcessActionLabelPayload
labels[].valuestring (optional)
labels[].languageIdstring (optional)
descriptionstring (optional)
descriptionsarray of FileProcessActionLabelPayload
descriptions[].valuestring (optional)
descriptions[].languageIdstring (optional)
conditionsarray of string
createdOnstring (optional)
modifiedOnstring (optional)

get_file_version_check_result​

Not currently available

Gets a specific Aprimo file version check result by its own id — this relays an already-computed scanner/check outcome. Distinct from get_file_version_check_result_latest, which looks up the latest result for a check type rather than a specific result id. Also distinct from get_file_version_check_result_finding, which returns one specific finding within a result, not the result itself.

Parameters:

ParameterTypeRequiredDescription
fileVersionIdstringYesThe file version id (32-char hex, from get_file_versions or get_record_master_file_version).
checkResultIdstringYesThe check result id (GUID, from list_file_version_check_results).

Returns:

FieldTypeDescription
idstring
fileVersionIdstring
checkIdstring (optional)
descriptionstring (optional)
outcomestring (optional)
createdByIdstring (optional)
createdOnstring (optional)

get_file_version_check_result_finding​

Not currently available

Gets a single finding (by occurrence number) for one Aprimo file version check result — this relays an already-computed scanner finding: what was found, an explanation, and a recommendation.

Parameters:

ParameterTypeRequiredDescription
fileVersionIdstringYesThe file version id (32-char hex, from get_file_versions or get_record_master_file_version).
checkResultIdstringYesThe check result id (GUID, from list_file_version_check_results).
occurrenceintegerYesThe finding's occurrence number (from list_file_version_check_result_findings), e.g. 1.

Returns:

FieldTypeDescription
occurrenceinteger
fileVersionCheckIdstring (optional)
findingstring (optional)
explanationstring (optional)
recommendationstring (optional)
additionalDatastring (optional)
outcomestring (optional)

get_file_version_check_result_latest​

Not currently available

Gets the latest Aprimo file version check result for a specific check type — this relays an already-computed scanner/check outcome, it never runs a new check. checkId (from list_checks) is required — confirmed live against DAM: omitting it returns HTTP 400 ("CheckId query parameter is required"), it does not fall back to "any check type". Use list_file_version_check_result_findings for the individual findings behind this result.

Parameters:

ParameterTypeRequiredDescription
fileVersionIdstringYesThe file version id (32-char hex, from get_file_versions or get_record_master_file_version).
checkIdstringYesThe check type id (GUID, from list_checks) to select which check's latest result to read. Required — DAM 400s without it.

Returns:

FieldTypeDescription
idstring
fileVersionIdstring
checkIdstring (optional)
descriptionstring (optional)
outcomestring (optional)
createdByIdstring (optional)
createdOnstring (optional)

get_file_version_watermark​

Gets the watermark applied to an Aprimo file version, by file version id: name, position, custom tag, and dates. Returns a not-found error if the file version has no watermark assigned.

Parameters:

ParameterTypeRequiredDescription
fileVersionIdstringYesThe file version id (32-char hex, from get_file_versions or get_record_master_file_version).

Returns:

FieldTypeDescription
idstring
namestring
positionstring
tagstring (optional)
createdOnstring
modifiedOnstring

get_file_watermark​

Gets the watermark applied to a file on an Aprimo asset, by file id: name, position, custom tag, and dates. Returns a not-found error if the file has no watermark assigned.

Parameters:

ParameterTypeRequiredDescription
fileIdstringYesThe file id (32-char hex, from a record's master file).

Returns:

FieldTypeDescription
idstring
namestring
positionstring
tagstring (optional)
createdOnstring
modifiedOnstring

get_watermark_image​

Returns the image URL (plus width/height/size/extension) for an Aprimo watermark, by id or by name. The URL remains valid for twenty-four hours. Important: Display the URL as plain text, never as an HTML img tag.

Parameters:

ParameterTypeRequiredDescription
watermarkIdstringNoThe watermark id (GUID). Provide this or name, not both.
namestringNoThe watermark's name (case-insensitive, exact match). Provide this or watermarkId, not both.

Returns:

FieldTypeDescription
watermarkIdstring
uristring (optional)
widthinteger (optional)
heightinteger (optional)
sizeinteger (optional)
extensionstring (optional)

list_file_process_actions​

Not currently available

Lists the file process actions configured in Aprimo — the configurable steps (e.g. virus scan, preview render) that run at each stage of a file's processing pipeline, in a fixed sort order, and can be individually enabled or disabled. Use when the user asks what processing steps exist, or to look up a file process action's id before calling get_file_process_action or update_file_process_action.

Parameters: none.

Returns:

FieldTypeDescription
countinteger
itemsarray of FileProcessActionPayload
items[].idstring
items[].namestring
items[].fileProcessActionStageIdstring (optional)
items[].fileProcessActionTypeinteger (optional)/// DAM's FileProcessActionType enum value — see 's remarks for why this is a number, not a string.
items[].sortIndexinteger
items[].isConfigurableboolean
items[].enabledboolean
items[].allowedboolean
items[].labelstring (optional)
items[].labelsarray of FileProcessActionLabelPayload
items[].labels[].valuestring (optional)
items[].labels[].languageIdstring (optional)
items[].descriptionstring (optional)
items[].descriptionsarray of FileProcessActionLabelPayload
items[].descriptions[].valuestring (optional)
items[].descriptions[].languageIdstring (optional)
items[].conditionsarray of string
items[].createdOnstring (optional)
items[].modifiedOnstring (optional)

list_file_version_check_result_findings​

Not currently available

Lists every finding for one Aprimo file version check result — this relays already-computed scanner findings (e.g. a specific security or compliance issue detected). Use get_file_version_check_result_finding to read a single finding by its occurrence number.

Parameters:

ParameterTypeRequiredDescription
fileVersionIdstringYesThe file version id (32-char hex, from get_file_versions or get_record_master_file_version).
checkResultIdstringYesThe check result id (GUID, from list_file_version_check_results).

Returns:

FieldTypeDescription
fileVersionIdstring
checkResultIdstring
countinteger
itemsarray of FileVersionCheckResultFindingPayload
items[].occurrenceinteger
items[].fileVersionCheckIdstring (optional)
items[].findingstring (optional)
items[].explanationstring (optional)
items[].recommendationstring (optional)
items[].additionalDatastring (optional)
items[].outcomestring (optional)

list_file_version_check_results​

Lists every Aprimo check result recorded for a file version — this relays already-computed scanner/check outcomes. Use to look up a check result's id before calling get_file_version_check_result or list_file_version_check_result_findings.

Parameters:

ParameterTypeRequiredDescription
fileVersionIdstringYesThe file version id (32-char hex, from get_file_versions or get_record_master_file_version).

Returns:

FieldTypeDescription
fileVersionIdstring
countinteger
itemsarray of FileVersionCheckResultPayload
items[].idstring
items[].fileVersionIdstring
items[].checkIdstring (optional)
items[].descriptionstring (optional)
items[].outcomestring (optional)
items[].createdByIdstring (optional)
items[].createdOnstring (optional)

list_file_version_process_action_log​

Lists the file process action log entries for an Aprimo file version: which pipeline actions ran (e.g. virus scan, preview render), their status, and timing. Use when the user asks what processing happened to a file version or why a processing step failed.

Parameters:

ParameterTypeRequiredDescription
fileVersionIdstringYesThe file version id (32-char hex, from get_file_versions or get_record_master_file_version).

Returns:

FieldTypeDescription
fileVersionIdstring
countinteger
itemsarray of FileVersionProcessActionLogPayload
items[].idstring
items[].fileVersionIdstring
items[].labelstring (optional)
items[].descriptionstring (optional)
items[].statusstring (optional)
items[].detailsstring (optional)
items[].createdOnstring (optional)
items[].completedOnstring (optional)

update_file_process_action​

Not currently available

Edits an existing Aprimo file process action by id. Only the fields provided are changed — omitted fields keep their current value. This modifies data. Always confirm the exact file process action and the new values with the user before calling this tool.

Parameters:

ParameterTypeRequiredDescription
fileProcessActionIdstringYesThe file process action id (GUID) to edit, from list_file_process_actions/get_file_process_action.
namestringNoNew name for the file process action. Omit to leave the name unchanged.
sortIndexintegerNoNew sort index within its stage. Omit to leave it unchanged.
enabledbooleanNoNew enabled flag. Omit to leave it unchanged.
conditionsarray of stringNoNew conditions collection — replaces the entire existing collection (not merged). Omit to leave conditions unchanged.
labelstringNoNew name label in the current user's language. Omit to leave it unchanged.
labelsobject (map of string)NoNew multi-language name labels: a map of languageId (GUID) to label value. Omit to leave labels unchanged.
descriptionstringNoNew description in the current user's language. Omit to leave it unchanged.
descriptionsobject (map of string)NoNew multi-language descriptions: a map of languageId (GUID) to description value. Omit to leave descriptions unchanged.

Returns:

FieldTypeDescription
idstring
namestring (optional)

Download & Order Files​

Can change data · 23 tools (17 currently available) · Group ID download-order-files

Needs: Find & Discover Content, View Files & Versions

ToolWhat it does
accept_download_link_agreementNot currently available. Records the calling user's acceptance of a download's applicable download agreement, confirming they accept the terms in their language version of it.
accept_record_download_agreementRecords the calling user's acceptance of a record's download agreement, confirming they accept the terms in their language version of it.
check_download_order_statusChecks the status of a download order created by get_record_download_url — including one that handed off after a poll timeout — and returns the download URL once ready.
check_shared_download_linkNot currently available. Checks the status of a shared download link order created by submit_shared_download_link, and returns the shareable link once ready.
get_download_linkGets one Aprimo download link's detail (status, delivered files, applicable download agreement ids) by id — the result of a maintenance job that generates downloadable files (a download order, export, or contact sheet).
get_order_targetGets one target of an Aprimo order by order id and order target id — which record/file was ordered, its asset type, and its per-target status.
get_record_download_agreementGets the applicable Aprimo download agreement's content (title + terms-of-use text) for a record, in the calling user's own language.
get_record_download_urlPlaces a download order for the original file of an Aprimo record and returns the download URL.
get_shared_download_linkNot currently available. Gets one Aprimo shared download link's detail (verification requirement, whether it was emailed, expiration) by id -- not the download URI itself (use get_shared_download_link_file_uri for that).
get_shared_download_link_file_uriNot currently available. Gets the download URI (not the file's bytes) for one file attached to an Aprimo shared download link, by shared download link id and file id.
list_download_link_targetsLists the target ids of an Aprimo download link by id — which records/files it covers.
list_download_linksLists the download links in Aprimo — the results of maintenance jobs that generate downloadable files (download orders, exports, contact sheets).
list_order_targetsLists every target of an Aprimo order by order id — which records/files were ordered and each one's per-target status.
list_ordersLists Aprimo orders (download/publicCdn/shareDownloadLink/email/ftp/etc.): id, order type, status, dates, and delivered files.
request_shared_download_link_verification_codeNot currently available. Requests a verification code for an Aprimo shared download link and emails it to the given recipient.
search_download_agreementsSearches for the Aprimo download agreements applicable to a given set of records.
submit_shared_download_linkNot currently available. Generates a DAM shared download link for one or more Aprimo assets, optionally emailing it to recipients.
update_orderEdits an existing Aprimo order's status and/or delivered files, by order id.
list_shared_download_link_downloadsLists the download-activity events (which file, which recipient, when) for an Aprimo shared download link, newest first.
list_shared_download_linksLists Aprimo shared download links -- by default only the ones created by the current user.
revoke_shared_download_linkRevokes an Aprimo shared download link.
search_shared_download_link_recipientsSearches distinct recipient email addresses across Aprimo shared download links (by default only recipients of links created by the current user) -- powers a recipient-filter autocomplete.
update_shared_download_link_expirationChanges the expiration date of an Aprimo shared download link.

Not currently available

Records the calling user's acceptance of a download's applicable download agreement, confirming they accept the terms in their language version of it. This modifies data. Always show the user the agreement's content (via get_download_agreement_content or get_record_download_agreement) and confirm they accept it, then call again with confirmed=true.

Parameters:

ParameterTypeRequiredDescription
downloadIdstringYesThe download's id (the download link's own id, 32-char hex or GUID) whose download agreement is being accepted.
contentIdintegerYesThe download agreement content id being accepted.
confirmedbooleanNoMust be true to proceed. Set to false (or omit) to get a confirmation gate error, then call again with confirmed=true after the user has explicitly confirmed they accept the agreement's content.

Returns:

FieldTypeDescription
downloadIdstring
contentIdinteger
acceptedboolean

accept_record_download_agreement​

Records the calling user's acceptance of a record's download agreement, confirming they accept the terms in their language version of it. This modifies data. Always show the user the agreement's content (via get_record_download_agreement) and confirm they accept it before calling this tool.

Parameters:

ParameterTypeRequiredDescription
recordIdstringYesThe record id (32-char hex or GUID) whose download agreement is being accepted.
contentIdintegerYesThe download agreement content id being accepted, from get_record_download_agreement.

Returns:

FieldTypeDescription
recordIdstring
contentIdinteger
acceptedboolean

check_download_order_status​

Checks the status of a download order created by get_record_download_url — including one that handed off after a poll timeout — and returns the download URL once ready. If the order is still processing, this is a normal outcome, not an error: tell the user it's still processing and offer to check again shortly, then call this tool again later with the same order id. If the order failed, this call returns a tool error explaining why. Do not resubmit get_record_download_url while waiting — that creates a new, separate order.

Parameters:

ParameterTypeRequiredDescription
orderIdstringYesThe order id returned by get_record_download_url (including from its poll-timeout hand-off).

Returns:

FieldTypeDescription
downloadUrlstring (optional)
orderIdstring (optional)
totalFileSizeinteger (optional)
statusstring (optional)/// Order status hand-off field (Phase 10a, #44b): "completed" once is populated, "processing" when the order hasn't reached a terminal state yet (returned on get_record_download_url's poll-timeout hand-off, and by check_download_order_status while still running) — a normal, actionable, non-error outcome. Null on the original immediate-completion shape so existing callers that only read / are unaffected.

Not currently available

Checks the status of a shared download link order created by submit_shared_download_link, and returns the shareable link once ready. If the order is still processing, this is a normal outcome, not an error: tell the user it's still processing and offer to check again shortly, then call this tool again later with the same order id. If the order failed, this call returns a tool error explaining why. Expiry and verification settings live on the separate shared-download-link resource, not here. Display format: when ready, show the shared link as a plain URL.

Parameters:

ParameterTypeRequiredDescription
orderIdstringYesThe order id returned by submit_shared_download_link.

Returns:

FieldTypeDescription
orderIdstring
statusstring
shareUristring (optional)
sharedDownloadLinkIdstring (optional)
messagestring (optional)

Gets one Aprimo download link's detail (status, delivered files, applicable download agreement ids) by id — the result of a maintenance job that generates downloadable files (a download order, export, or contact sheet). Use after list_download_links, or when you already have the id from another tool's output. Use list_download_link_targets to see which records/files it covers.

Parameters:

ParameterTypeRequiredDescription
downloadLinkIdstringYesThe download link id (32-char hex or GUID), from list_download_links.

Returns:

FieldTypeDescription
idstring
typestring (optional)
statusstring (optional)
titlestring (optional)
descriptionstring (optional)
errorDescriptionstring (optional)
deliveredFilesarray of string (optional)
failedTargetsCountinteger (optional)
succeededRecordsCountinteger (optional)
failedRecordsCountinteger (optional)
downloadAgreementIdsarray of integer (optional)
createdOnstring (optional)

get_order_target​

Gets one target of an Aprimo order by order id and order target id — which record/file was ordered, its asset type, and its per-target status. Use after list_order_targets, or when you already have both ids.

Parameters:

ParameterTypeRequiredDescription
orderIdstringYesThe order id (GUID).
orderTargetIdstringYesThe order target id (GUID), from list_order_targets.

Returns:

FieldTypeDescription
idstring
recordIdstring (optional)
itemIdstring (optional)
recordIdsarray of string (optional)
assetTypestring (optional)
fileNamestring (optional)
statusstring (optional)
messagestring (optional)
errorDetailsstring (optional)
attemptinteger (optional)

get_record_download_agreement​

Gets the applicable Aprimo download agreement's content (title + terms-of-use text) for a record, in the calling user's own language. Use before accept_record_download_agreement, to show the user what they're accepting and to get its content id.

Parameters:

ParameterTypeRequiredDescription
recordIdstringYesThe record id (32-char hex or GUID) to get the applicable download agreement for.

Returns:

FieldTypeDescription
idinteger
languageIdstring (optional)
versioninteger (optional)
titlestring (optional)
termsOfUsestring (optional)

get_record_download_url​

Places a download order for the original file of an Aprimo record and returns the download URL. Downloads the latest version of the master file without transformations. The download URL contains a time-limited SAS token. Each call creates a new download order — results are not cached. Use get_record_metadata first to verify the record exists and has a master file.

Parameters:

ParameterTypeRequiredDescription
recordIdstringYesThe record ID (GUID format). Obtain from search_aprimo or get_record_metadata results.

Returns:

FieldTypeDescription
downloadUrlstring (optional)
orderIdstring (optional)
totalFileSizeinteger (optional)
statusstring (optional)/// Order status hand-off field (Phase 10a, #44b): "completed" once is populated, "processing" when the order hasn't reached a terminal state yet (returned on get_record_download_url's poll-timeout hand-off, and by check_download_order_status while still running) — a normal, actionable, non-error outcome. Null on the original immediate-completion shape so existing callers that only read / are unaffected.

Not currently available

Gets one Aprimo shared download link's detail (verification requirement, whether it was emailed, expiration) by id -- not the download URI itself (use get_shared_download_link_file_uri for that). A shared download link is a controlled alternative to a plain public link for sharing a set of files with a named recipient by email. Use get_shared_download_link_file_uri to get the download URI for one of its files.

Parameters:

ParameterTypeRequiredDescription
sharedDownloadLinkIdstringYesThe shared download link id (GUID), from submit_shared_download_link/check_shared_download_link.

Returns:

FieldTypeDescription
idstring
useVerificationboolean (optional)
sendEmailboolean (optional)
expiresOnstring (optional)
createdOnstring (optional)

Not currently available

Gets the download URI (not the file's bytes) for one file attached to an Aprimo shared download link, by shared download link id and file id. If the link requires verification (see get_shared_download_link), pass the recipient's email and the verification code from request_shared_download_link_verification_code.

Parameters:

ParameterTypeRequiredDescription
sharedDownloadLinkIdstringYesThe shared download link id (GUID).
fileIdintegerYesThe file id, from the shared download link's files.
emailstringNoThe recipient's email, for verification. Only required when the link is configured to require verification.
verificationCodestringNoThe verification code, from request_shared_download_link_verification_code. Only required when the link is configured to require verification.

Returns:

FieldTypeDescription
fileIdinteger
sharedDownloadLinkIdstring (optional)
downloadUristring (optional)

Lists the target ids of an Aprimo download link by id — which records/files it covers.

Parameters:

ParameterTypeRequiredDescription
downloadLinkIdstringYesThe download link id (32-char hex or GUID).

Returns:

FieldTypeDescription
downloadLinkIdstring
countinteger
itemsarray of string

Lists the download links in Aprimo — the results of maintenance jobs that generate downloadable files (download orders, exports, contact sheets). Use when the user asks what downloads exist or their status, or to look up a download link's id before calling get_download_link, list_download_link_targets, or accept_download_link_agreement.

Parameters:

ParameterTypeRequiredDescription
filterstringNoOptional filter expression (DAM query syntax), e.g. "CreatedOn in today". Omit to list every download link.
sortstringNoOptional sort expression, e.g. "createdon". Omit for the endpoint's default order.
skipintegerNoNumber of items to skip, for paging. Defaults to 0.
takeintegerNoMaximum number of items to return. Omit for the endpoint's default page size.

Returns:

FieldTypeDescription
countinteger
itemsarray of DownloadLinkPayload
items[].idstring
items[].typestring (optional)
items[].statusstring (optional)
items[].titlestring (optional)
items[].descriptionstring (optional)
items[].errorDescriptionstring (optional)
items[].deliveredFilesarray of string (optional)
items[].failedTargetsCountinteger (optional)
items[].succeededRecordsCountinteger (optional)
items[].failedRecordsCountinteger (optional)
items[].downloadAgreementIdsarray of integer (optional)
items[].createdOnstring (optional)

list_order_targets​

Lists every target of an Aprimo order by order id — which records/files were ordered and each one's per-target status. Use to look up an order target's id before calling get_order_target.

Parameters:

ParameterTypeRequiredDescription
orderIdstringYesThe order id (GUID) whose targets to list.

Returns:

FieldTypeDescription
orderIdstring
countinteger
itemsarray of OrderTargetPayload
items[].idstring
items[].recordIdstring (optional)
items[].itemIdstring (optional)
items[].recordIdsarray of string (optional)
items[].assetTypestring (optional)
items[].fileNamestring (optional)
items[].statusstring (optional)
items[].messagestring (optional)
items[].errorDetailsstring (optional)
items[].attemptinteger (optional)

list_orders​

Lists Aprimo orders (download/publicCdn/shareDownloadLink/email/ftp/etc.): id, order type, status, dates, and delivered files. Use when the user asks what orders exist or their status, or to look up an order id before calling update_order, list_order_targets, check_public_link, or check_shared_download_link.

Parameters:

ParameterTypeRequiredDescription
filterstringNoOptional filter expression (DAM query syntax), e.g. "CreatedOn in today". Omit to list every order.
sortstringNoOptional sort expression, e.g. "createdOn desc". Omit for the endpoint's default order.
skipintegerNoNumber of items to skip, for paging. Defaults to 0.
takeintegerNoMaximum number of items to return. Omit for the endpoint's default page size.

Returns:

FieldTypeDescription
countinteger
itemsarray of OrderSummaryPayload
items[].orderIdstring
items[].orderTypestring (optional)
items[].statusstring (optional)
items[].createdOnstring (optional)
items[].startedOnstring (optional)
items[].messagestring (optional)
items[].failedTargetsCountinteger (optional)
items[].deliveredFilesarray of DeliveredFilePayload (optional)
items[].deliveredFiles[].deliveredPathstring (optional)
items[].deliveredFiles[].recordIdstring (optional)
items[].deliveredFiles[].renditionNamestring (optional)
items[].deliveredFiles[].statusstring (optional)
items[].totalFileSizeinteger (optional)

Not currently available

Requests a verification code for an Aprimo shared download link and emails it to the given recipient. This sends an email. Use when a shared download link requires verification (see get_shared_download_link) and the recipient needs a new code, e.g. before calling get_shared_download_link_file_uri.

Parameters:

ParameterTypeRequiredDescription
sharedDownloadLinkIdstringYesThe shared download link id (GUID).
emailstringYesEmail address of the recipient who should receive the verification code.

Returns:

FieldTypeDescription
sharedDownloadLinkIdstring
requestedboolean

search_download_agreements​

Searches for the Aprimo download agreements applicable to a given set of records. This is a lookup (read-only), even though DAM exposes it as a POST — no confirmation is required.

Parameters:

ParameterTypeRequiredDescription
recordIdsarray of stringYesThe record ids (32-char hex or GUID) to find applicable download agreements for.
filterstringNoOptional filter expression (DAM query syntax). Omit to apply no additional filter.
sortstringNoOptional sort expression, e.g. "createdOn". Omit for the endpoint's default order.
skipintegerNoNumber of items to skip, for paging. Defaults to 0.
takeintegerNoMaximum number of items to return. Omit for the endpoint's default page size.

Returns:

FieldTypeDescription
countinteger
itemsarray of DownloadAgreementPayload
items[].idinteger
items[].enabledboolean (optional)
items[].createdOnstring (optional)
items[].modifiedOnstring (optional)

Not currently available

Generates a DAM shared download link for one or more Aprimo assets, optionally emailing it to recipients. This modifies data (creates a DAM order) and makes the asset(s) accessible via a shareable link, optionally emailed to the given recipients. Always confirm with the user that the asset(s) should be shared this way before calling this tool. Does not return the link immediately — Aprimo processes shareDownloadLink orders asynchronously. This tool only returns an order id: after calling it, call check_shared_download_link with that same order id to find out when the link is ready and get it. Expiry and verification settings live on the separate shared-download-link resource, not on this order — out of scope for this tool. Use when the user asks to share, send a download link for, or email a link to one or more assets. Do not tell the user the link is ready until check_shared_download_link confirms it.

Parameters:

ParameterTypeRequiredDescription
recordIdsarray of stringYesThe record ids (32-char hex) of the assets to generate a shared download link for.
emailRecipientsarray of stringNoOptional email addresses to send the shared download link to.
emailMessagestringNoOptional email message text to include when sending the link by email.
sendEmailbooleanNoWhether to email the shared download link to emailRecipients once ready.
confirmedbooleanNoMust be true to proceed. Set to false (or omit) to get a confirmation gate error, then call again with confirmed=true after the user explicitly confirms the asset(s) should be shared this way.

Returns:

FieldTypeDescription
orderIdstring
statusstring

update_order​

Edits an existing Aprimo order's status and/or delivered files, by order id. Only the fields provided are changed — omitted fields are expected to keep their current value (this assumes DAM merges the edit rather than fully replacing the order; unverified for this endpoint). This modifies data. Always confirm the exact order and the new values with the user before calling this tool. Valid status values: Pending, Success, Failed, PartiallyFailed, Executing, Cancelled, Scheduled, Queued, AsyncPending, AsyncExecuting.

Parameters:

ParameterTypeRequiredDescription
orderIdstringYesThe order id (GUID) to edit.
statusstringNoNew lifecycle status for the order. Omit to leave the status unchanged.
deliveredFilesarray of stringNoNew list of delivered files for the order. Omit to leave delivered files unchanged.

Returns:

FieldTypeDescription
orderIdstring
statusstring (optional)
deliveredFilesarray of string (optional)

Parameters:

ParameterTypeRequiredDescription
sharedDownloadLinkIdstringYesThe shared download link id (GUID).
skipintegerNoNumber of activity events to skip, for paging. Defaults to 0.
takeintegerNoMaximum number of activity events to return. Omit for the endpoint's default page size.

Parameters:

ParameterTypeRequiredDescription
allUsersbooleanNoWhen true, returns links created by any user in the tenant. Requires the caller to be a member of the Administrators user group. Defaults to false.
filterstringNoOptional filter expression (DAM query syntax), e.g. "ModifiedOn in today". Omit to list every shared download link in scope.
sortstringNoOptional sort expression, e.g. "createdOn". Omit for the endpoint's default order.
skipintegerNoNumber of items to skip, for paging. Defaults to 0.
takeintegerNoMaximum number of items to return. Omit for the endpoint's default page size.

Destructive

Revokes an Aprimo shared download link. THIS IS IRREVERSIBLE -- a revoked link no longer grants downloads to anyone, and there is no way to un-revoke it. Requires confirmed=true and confirmedDestructive=true; call again with both set to true only after the user has explicitly confirmed.

Parameters:

ParameterTypeRequiredDescription
sharedDownloadLinkIdstringYesThe shared download link id (GUID).
confirmedbooleanNoMust be true to proceed. Set to false (or omit) to get a confirmation gate error, then call again with confirmed=true after the user has explicitly confirmed the exact shared download link.
confirmedDestructivebooleanNoMust ALSO be true (in addition to confirmed) -- revoking a shared download link is irreversible. Set only after stating the exact shared download link to the user and getting explicit go-ahead.
Destructive operation

This tool deletes or irreversibly overwrites data in the live tenant; the change cannot be rolled back through the API. It will not act unless the call sets both confirmed and confirmedDestructive to true.


Parameters:

ParameterTypeRequiredDescription
qstringYesFree text to match against recipient email (contains, case-insensitive).
allUsersbooleanNoWhen true, searches recipients across every link in the tenant. Requires the caller to be a member of the Administrators user group. Defaults to false.
skipintegerNoNumber of distinct emails to skip, for paging. Defaults to 0.
takeintegerNoMaximum number of distinct emails to return. Omit for the endpoint's default page size.

Parameters:

ParameterTypeRequiredDescription
sharedDownloadLinkIdstringYesThe shared download link id (GUID).
expiresOnstringYesThe new expiration date/time, in UTC, ISO 8601 (e.g. "2026-09-01T00:00:00Z"). Must be in the future.

Read-only · 4 tools (3 currently available) · Group ID view-public-links

Needs: View Files & Versions

ToolWhat it does
check_public_linkChecks the status of a public CDN link order created by submit_public_link, and returns the public link once ready.
get_public_linkNot currently available. Gets one Aprimo public link's detail (uri, status, provider, the record/file version it targets) by id.
list_file_version_public_linksLists the Aprimo public links pointing at a file version, by file version id.
list_rendition_public_linksLists the Aprimo public links pointing at a rendition, by rendition id.

Checks the status of a public CDN link order created by submit_public_link, and returns the public link once ready. If the order is still processing, this is a normal outcome, not an error: tell the user it's still processing and offer to check again shortly, then call this tool again later with the same order id. If the order failed, this call returns a tool error explaining why. Display format: when ready, show each delivered link as a plain URL, one per line.

Parameters:

ParameterTypeRequiredDescription
orderIdstringYesThe order id returned by submit_public_link.

Returns:

FieldTypeDescription
orderIdstring
statusstring
deliveredFilesarray of DeliveredFilePayload (optional)
deliveredFiles[].deliveredPathstring (optional)
deliveredFiles[].recordIdstring (optional)
deliveredFiles[].renditionNamestring (optional)
deliveredFiles[].statusstring (optional)
messagestring (optional)

Not currently available

Gets one Aprimo public link's detail (uri, status, provider, the record/file version it targets) by id. A public link is a shareable, tokenized URL granting unauthenticated access to a specific file version's content. Use list_rendition_public_links to find a public link's id starting from a rendition.

Parameters:

ParameterTypeRequiredDescription
publicLinkIdstringYesThe public link id (GUID).

Returns:

FieldTypeDescription
idstring
uristring (optional)
statusstring (optional)
canDeleteboolean (optional)
providerstring (optional)
recordIdstring (optional)
fileVersionIdstring (optional)
additionalFileIdstring (optional)
fileSizeinteger (optional)
renditionNamestring (optional)
originstring (optional)
modifiedOnstring (optional)
createdOnstring (optional)

Lists the Aprimo public links pointing at a file version, by file version id. Use to look up a public link's id before calling get_public_link.

Parameters:

ParameterTypeRequiredDescription
fileVersionIdstringYesThe file version id (32-char hex, from get_file_versions or get_record_master_file_version).

Returns:

FieldTypeDescription
fileVersionIdstring
countinteger
itemsarray of PublicLinkPayload
items[].idstring
items[].uristring (optional)
items[].statusstring (optional)
items[].canDeleteboolean (optional)
items[].providerstring (optional)
items[].recordIdstring (optional)
items[].fileVersionIdstring (optional)
items[].additionalFileIdstring (optional)
items[].fileSizeinteger (optional)
items[].renditionNamestring (optional)
items[].originstring (optional)
items[].modifiedOnstring (optional)
items[].createdOnstring (optional)

Lists the Aprimo public links pointing at a rendition, by rendition id. Use to look up a public link's id before calling get_public_link.

Parameters:

ParameterTypeRequiredDescription
renditionIdstringYesThe rendition id (GUID).

Returns:

FieldTypeDescription
renditionIdstring
countinteger
itemsarray of PublicLinkPayload
items[].idstring
items[].uristring (optional)
items[].statusstring (optional)
items[].canDeleteboolean (optional)
items[].providerstring (optional)
items[].recordIdstring (optional)
items[].fileVersionIdstring (optional)
items[].additionalFileIdstring (optional)
items[].fileSizeinteger (optional)
items[].renditionNamestring (optional)
items[].originstring (optional)
items[].modifiedOnstring (optional)
items[].createdOnstring (optional)