Files & File Versions
Tools for working with the files behind DAM records — master files, renditions, additional files, version history, and file-level processing.
This page covers 42 tools, all of them available on request rather than in the default tool list, and 1 destructive.
- Status — In the default tool list means the tool is one of the ~200 Aprimo advertises to every agent out of the box, so the agent discovers and calls it on its own. Available on request means the tool is registered and fully callable, but sits outside that default list — call it by name, or ask Aprimo to extend the list your tenant is served.
- Both statuses work identically when called. Status affects discovery, not capability or authorization.
- Visibility is not authorization. Every tool call executes as the authenticated user, and any tool can return an authorization error if that user lacks rights to the record, task, or file. 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
confirmedandconfirmedDestructivetotrue. - Activity and Project labels vary by tenant. Where this page says Activity or Project, your tenant's own configured terminology is substituted at runtime.
Aprimo's MCP Server exposes far more tools than most MCP clients handle well — many degrade or truncate their tool list well below the full catalogue. Rather than let a client truncate arbitrarily, Aprimo advertises a curated set of roughly 200 tools covering the tasks customers most commonly automate. Everything outside that set remains fully supported and callable by name; it simply isn't offered up front. If your integration leans on a tool that is available on request, talk to your Aprimo Customer Success Manager about extending the advertised list for your tenant.
Tools at a Glance
| Tool | Status | What it does |
|---|---|---|
check_out_file | On request | Checks out a file on an Aprimo asset, locking it so other users can't add a new file version while it's checked out. |
get_additional_file | On request | Gets 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_preview | On request | 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). |
get_additional_file_preview_url | On request | Returns the main preview image URL (plus width/height/size/extension) for an additional file of an Aprimo asset, by its id. |
get_additional_file_public_link | On request | Gets the public link associated with an additional file of an Aprimo asset, by its id. |
get_file | On request | Gets a file on an Aprimo asset by its id: checkout status, checkout date, watermark, and creation date. |
get_file_field | On request | 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). |
get_file_latest_version | On request | Gets 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_preview | On request | 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. |
get_file_preview_image_url | On request | Returns the preview image URL (plus width/height/size/extension) for a file preview on an Aprimo asset, by its id. |
get_file_preview_thumbnail_url | On request | Returns the thumbnail image URL (plus width/height/size/extension) for a file preview on an Aprimo asset, by its id. |
get_file_preview_url | On request | Returns the preview image URL (plus width/height/size/extension) for a file on an Aprimo asset, by file id. |
get_file_process_action | On request | Gets one Aprimo file process action's detail (stage, type, sort index, enabled/allowed flags, conditions, labels) by id. |
get_file_thumbnail_url | On request | Returns the thumbnail image URL (plus width/height/size/extension) for a file on an Aprimo asset, by file id. |
get_file_version_check_result | On request | 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_finding | On request | 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_latest | On request | 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_detail | On request | 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. |
get_file_version_duplicate_info | On request | 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. |
get_file_version_file_type | On request | Gets the Aprimo file type detail (extension, MIME type, engine/preview format, supported operations) for a specific file version. |
get_file_version_master_preview | On request | Gets the master preview of an Aprimo file version: page number, name, and whether it was added manually. |
get_file_version_preview_url | On request | Returns 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_url | On request | Returns the thumbnail image URL (plus width/height/size/extension) for an Aprimo file version's file preview, by file version id. |
get_file_version_watermark | On request | Gets the watermark applied to an Aprimo file version, by file version id: name, position, custom tag, and dates. |
get_file_versions | On request | Lists all versions of a file on an Aprimo asset: version label/number, file name, size, and which is latest. |
get_file_watermark | On request | Gets the watermark applied to a file on an Aprimo asset, by file id: name, position, custom tag, and dates. |
get_record_master_file_version | On request | Gets the latest file version of an Aprimo asset's (record's) master file: version id, label, file name, size, and creation date. |
list_additional_file_previews | On request | Lists the generated preview pages for an additional file of an Aprimo asset: integer preview id and metadata. |
list_additional_files | On request | 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. |
list_file_fields | On request | Lists the custom field values set on a file (not the asset/record) of an Aprimo asset, by the file's id. |
list_file_previews | On request | 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. |
list_file_process_actions | On request | 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_findings | On request | 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_results | On request | Lists every Aprimo check result recorded for a file version — this relays already-computed scanner/check outcomes. |
list_file_version_linked_versions | On request | Lists the publications an Aprimo file version is used in (or contains), by file version id and link type. |
list_file_version_permissions | On request | Gets the calling user's calculated download/delete permissions on an Aprimo file version, by file version id. |
list_file_version_process_action_log | On request | 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. |
list_file_version_public_links | On request | Lists the Aprimo public links pointing at a file version, by file version id. |
list_file_version_renditions | On request | Lists the Aprimo renditions (generated derivatives — thumbnails, resized previews, converted formats) for a file version, by file version id. |
undo_file_checkout | On request | Destructive. Undoes the checkout lock on a file of an Aprimo asset, releasing it without adding a new file version. |
update_file_preview_rotation | On request | Sets the rotation angle (in degrees) of a file preview on an Aprimo asset by its id. |
update_file_process_action | On request | Edits an existing Aprimo file process action by id. |
check_out_file
Available on request
Checks out a file on an Aprimo asset, locking it so other users can't add a new file version while it's checked out. This modifies data. The lock is released automatically when a new file version is added, or explicitly via undo_file_checkout.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
fileId | string | Yes | The file id (32-char hex, from a record's master file). |
Returns:
| Field | Type | Description |
|---|---|---|
fileId | string | |
checkedOut | boolean |
get_additional_file
Available on request
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:
| Parameter | Type | Required | Description |
|---|---|---|---|
additionalFileId | string | Yes | The additional file id (32-char hex, from list_additional_files). |
Returns:
| Field | Type | Description |
|---|---|---|
id | string | |
type | string | |
isManual | boolean | |
label | string | |
fileSize | integer | |
fileName | string | |
extension | string | |
usages | array of string | |
purposes | array of string |
get_additional_file_preview
Available on request
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:
| Parameter | Type | Required | Description |
|---|---|---|---|
additionalFileId | string | Yes | The additional file id (32-char hex, from list_additional_files or get_additional_file). |
filePreviewId | integer | Yes | The preview's integer id (from list_additional_file_previews) — not a GUID, unlike the standalone file-preview resource used by get_file_preview. |
Returns:
| Field | Type | Description |
|---|---|---|
additionalFileId | string | |
id | integer | |
metadata | array of string | |
uri | string (optional) |
get_additional_file_preview_url
Available on request
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:
| Parameter | Type | Required | Description |
|---|---|---|---|
additionalFileId | string | Yes | The additional file id (32-char hex, from list_additional_files or get_additional_file). |
Returns:
| Field | Type | Description |
|---|---|---|
additionalFileId | string | |
uri | string (optional) | |
width | integer (optional) | |
height | integer (optional) | |
size | integer (optional) | |
extension | string (optional) |
get_additional_file_public_link
Available on request
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:
| Parameter | Type | Required | Description |
|---|---|---|---|
additionalFileId | string | Yes | The additional file id (32-char hex, from list_additional_files or get_additional_file). |
Returns:
| Field | Type | Description |
|---|---|---|
id | string | |
uri | string (optional) | |
status | string (optional) | |
canDelete | boolean (optional) | |
provider | string (optional) | |
recordId | string (optional) | |
fileVersionId | string (optional) | |
additionalFileId | string (optional) | |
fileSize | integer (optional) | |
renditionName | string (optional) | |
origin | string (optional) | |
modifiedOn | string (optional) | |
createdOn | string (optional) |
get_file
Available on request
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:
| Parameter | Type | Required | Description |
|---|---|---|---|
fileId | string | Yes | The file id (32-char hex, from a record's master file). |
Returns:
| Field | Type | Description |
|---|---|---|
id | string | |
checkedOut | boolean | |
checkedOutOn | string | |
watermarkId | string | |
watermarkType | string | |
createdOn | string |
get_file_field
Available on request
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:
| Parameter | Type | Required | Description |
|---|---|---|---|
fileId | string | Yes | The file id (32-char hex, from a record's master file). |
fieldId | string | Yes | The field definition id (GUID) whose value to read. |
Returns:
| Field | Type | Description |
|---|---|---|
fileId | string | |
id | string | |
fieldName | string (optional) | |
label | string (optional) | |
dataType | string (optional) | |
value | string (optional) |
get_file_latest_version
Available on request
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:
| Parameter | Type | Required | Description |
|---|---|---|---|
fileId | string | Yes | The file id (32-char hex, from a record's master file). |
Returns:
| Field | Type | Description |
|---|---|---|
id | string | |
fileName | string | |
versionLabel | string | |
versionNumber | integer | |
fileSize | integer | |
fileExtension | string | |
isLatest | boolean | |
createdOn | string |
get_file_preview
Available on request
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:
| Parameter | Type | Required | Description |
|---|---|---|---|
filePreviewId | string | Yes | The file preview id (32-char hex, from list_file_previews). |
Returns:
| Field | Type | Description |
|---|---|---|
id | string | |
pageNumber | integer | |
name | string | |
isMaster | boolean | |
isManual | boolean | |
createdOn | string |
get_file_preview_image_url
Available on request
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:
| Parameter | Type | Required | Description |
|---|---|---|---|
filePreviewId | string | Yes | The file preview id (32-char hex, from list_file_previews or get_file_preview). |
Returns:
| Field | Type | Description |
|---|---|---|
filePreviewId | string | |
uri | string (optional) | |
width | integer (optional) | |
height | integer (optional) | |
size | integer (optional) | |
extension | string (optional) |
get_file_preview_thumbnail_url
Available on request
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:
| Parameter | Type | Required | Description |
|---|---|---|---|
filePreviewId | string | Yes | The file preview id (32-char hex, from list_file_previews or get_file_preview). |
Returns:
| Field | Type | Description |
|---|---|---|
filePreviewId | string | |
uri | string (optional) | |
width | integer (optional) | |
height | integer (optional) | |
size | integer (optional) | |
extension | string (optional) |
get_file_preview_url
Available on request
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:
| Parameter | Type | Required | Description |
|---|---|---|---|
fileId | string | Yes | The file id (32-char hex, from a record's master file). |
Returns:
| Field | Type | Description |
|---|---|---|
fileId | string | |
uri | string (optional) | |
width | integer (optional) | |
height | integer (optional) | |
size | integer (optional) | |
extension | string (optional) |
get_file_process_action
Available on request
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:
| Parameter | Type | Required | Description |
|---|---|---|---|
fileProcessActionId | string | Yes | The file process action id (GUID), from list_file_process_actions. |
Returns:
| Field | Type | Description |
|---|---|---|
id | string | |
name | string | |
fileProcessActionStageId | string (optional) | |
fileProcessActionType | integer (optional) | /// DAM's FileProcessActionType enum value — see 's remarks for why this is a number, not a string. |
sortIndex | integer | |
isConfigurable | boolean | |
enabled | boolean | |
allowed | boolean | |
label | string (optional) | |
labels | array of FileProcessActionLabelPayload | |
labels[].value | string (optional) | |
labels[].languageId | string (optional) | |
description | string (optional) | |
descriptions | array of FileProcessActionLabelPayload | |
descriptions[].value | string (optional) | |
descriptions[].languageId | string (optional) | |
conditions | array of string | |
createdOn | string (optional) | |
modifiedOn | string (optional) |
get_file_thumbnail_url
Available on request
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:
| Parameter | Type | Required | Description |
|---|---|---|---|
fileId | string | Yes | The file id (32-char hex, from a record's master file). |
Returns:
| Field | Type | Description |
|---|---|---|
fileId | string | |
uri | string (optional) | |
width | integer (optional) | |
height | integer (optional) | |
size | integer (optional) | |
extension | string (optional) |
get_file_version_check_result
Available on request
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:
| Parameter | Type | Required | Description |
|---|---|---|---|
fileVersionId | string | Yes | The file version id (32-char hex, from get_file_versions or get_record_master_file_version). |
checkResultId | string | Yes | The check result id (GUID, from list_file_version_check_results). |
Returns:
| Field | Type | Description |
|---|---|---|
id | string | |
fileVersionId | string | |
checkId | string (optional) | |
description | string (optional) | |
outcome | string (optional) | |
createdById | string (optional) | |
createdOn | string (optional) |
get_file_version_check_result_finding
Available on request
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:
| Parameter | Type | Required | Description |
|---|---|---|---|
fileVersionId | string | Yes | The file version id (32-char hex, from get_file_versions or get_record_master_file_version). |
checkResultId | string | Yes | The check result id (GUID, from list_file_version_check_results). |
occurrence | integer | Yes | The finding's occurrence number (from list_file_version_check_result_findings), e.g. 1. |
Returns:
| Field | Type | Description |
|---|---|---|
occurrence | integer | |
fileVersionCheckId | string (optional) | |
finding | string (optional) | |
explanation | string (optional) | |
recommendation | string (optional) | |
additionalData | string (optional) | |
outcome | string (optional) |
get_file_version_check_result_latest
Available on request
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:
| Parameter | Type | Required | Description |
|---|---|---|---|
fileVersionId | string | Yes | The file version id (32-char hex, from get_file_versions or get_record_master_file_version). |
checkId | string | Yes | The check type id (GUID, from list_checks) to select which check's latest result to read. Required — DAM 400s without it. |
Returns:
| Field | Type | Description |
|---|---|---|
id | string | |
fileVersionId | string | |
checkId | string (optional) | |
description | string (optional) | |
outcome | string (optional) | |
createdById | string (optional) | |
createdOn | string (optional) |
get_file_version_detail
Available on request
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:
| Parameter | Type | Required | Description |
|---|---|---|---|
fileVersionId | string | Yes | The file version id (32-char hex, from get_file_versions or get_record_master_file_version). |
Returns:
| Field | Type | Description |
|---|---|---|
id | string | |
versionLabel | string | |
versionNumber | integer | |
fileName | string | |
fileSize | integer | |
fileExtension | string | |
fileCreatedOn | string | |
fileModifiedOn | string | |
comment | string | |
crc32 | integer | |
sha256 | string | |
preventDownload | boolean | |
isLatest | boolean | |
fileProcessingState | string | |
aiInfluenced | string | |
watermarkId | string | |
watermarkType | string | |
fileState | string | |
hasSmartActionFindings | boolean (optional) | |
createdOn | string | |
metadata | map of FileVersionMetadataEntryPayload | |
metadata.contentType | string | |
metadata.value | string | |
duplicateInfo | FileVersionDuplicateInfoPayload | |
duplicateInfo.detectionMode | string | |
duplicateInfo.status | string | |
duplicateInfo.totalCount | integer | |
duplicateInfo.duplicates | array of DuplicatePayload | |
duplicateInfo.duplicates[].recordId | string | |
duplicateInfo.duplicates[].fileVersionId | string | |
duplicateInfo.duplicates[].reason | string | |
annotationInfo | FileVersionAnnotationInfoPayload | |
annotationInfo.totalCount | integer | |
annotationInfo.annotations | array of FileVersionAnnotationPayload | |
annotationInfo.annotations[].id | string | |
annotationInfo.annotations[].comments | string | |
annotationInfo.annotations[].pageNumber | integer | |
annotationInfo.annotations[].createdBy | string | |
annotationInfo.annotations[].createdOn | string |
get_file_version_duplicate_info
Available on request
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:
| Parameter | Type | Required | Description |
|---|---|---|---|
fileVersionId | string | Yes | The file version id (32-char hex, from get_file_versions or get_record_master_file_version). |
Returns:
| Field | Type | Description |
|---|---|---|
detectionMode | string | |
status | string | |
totalCount | integer | |
duplicates | array of DuplicatePayload | |
duplicates[].recordId | string | |
duplicates[].fileVersionId | string | |
duplicates[].reason | string |
get_file_version_file_type
Available on request
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:
| Parameter | Type | Required | Description |
|---|---|---|---|
fileVersionId | string | Yes | The file version id (32-char hex, from get_file_versions or get_record_master_file_version). |
Returns:
| Field | Type | Description |
|---|---|---|
id | string | |
name | string | |
kind | string (optional) | |
extension | string (optional) | |
mimeType | string (optional) | |
engineFormat | string (optional) | |
isCatalogable | boolean | |
mediaEngines | array of string | |
previewFormat | string (optional) | |
previewPlayers | array of string | |
previewRequired | boolean | |
previewKeepDimensions | boolean | |
supportAssetResize | boolean | |
supportAssetWatermark | boolean | |
preferredExtension | boolean | |
tag | string (optional) | |
registeredFieldIds | array of string | |
registeredFieldGroupIds | array of string | |
labels | array of FileTypeLabelPayload | |
labels[].value | string (optional) | |
labels[].languageId | string | |
createdOn | string (optional) | |
modifiedOn | string (optional) |
get_file_version_master_preview
Available on request
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:
| Parameter | Type | Required | Description |
|---|---|---|---|
fileVersionId | string | Yes | The file version id (32-char hex, from get_file_versions or get_record_master_file_version). |
Returns:
| Field | Type | Description |
|---|---|---|
id | string | |
pageNumber | integer | |
name | string | |
isMaster | boolean | |
isManual | boolean | |
createdOn | string |
get_file_version_preview_url
Available on request
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:
| Parameter | Type | Required | Description |
|---|---|---|---|
fileVersionId | string | Yes | The file version id (32-char hex, from get_file_versions or get_record_master_file_version). |
Returns:
| Field | Type | Description |
|---|---|---|
fileVersionId | string | |
uri | string (optional) | |
width | integer (optional) | |
height | integer (optional) | |
size | integer (optional) | |
extension | string (optional) |
get_file_version_thumbnail_url
Available on request
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:
| Parameter | Type | Required | Description |
|---|---|---|---|
fileVersionId | string | Yes | The file version id (32-char hex, from get_file_versions or get_record_master_file_version). |
Returns:
| Field | Type | Description |
|---|---|---|
fileVersionId | string | |
uri | string (optional) | |
width | integer (optional) | |
height | integer (optional) | |
size | integer (optional) | |
extension | string (optional) |
get_file_version_watermark
Available on request
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:
| Parameter | Type | Required | Description |
|---|---|---|---|
fileVersionId | string | Yes | The file version id (32-char hex, from get_file_versions or get_record_master_file_version). |
Returns:
| Field | Type | Description |
|---|---|---|
id | string | |
name | string | |
position | string | |
tag | string (optional) | |
createdOn | string | |
modifiedOn | string |
get_file_versions
Available on request
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:
| Parameter | Type | Required | Description |
|---|---|---|---|
fileId | string | Yes | The file id (32-char hex, from a record's master file). |
Returns:
| Field | Type | Description |
|---|---|---|
fileId | string | |
count | integer | |
items | array of FileVersionPayload | |
items[].id | string | |
items[].fileName | string | |
items[].versionLabel | string | |
items[].versionNumber | integer | |
items[].fileSize | integer | |
items[].fileExtension | string | |
items[].isLatest | boolean | |
items[].createdOn | string |
get_file_watermark
Available on request
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:
| Parameter | Type | Required | Description |
|---|---|---|---|
fileId | string | Yes | The file id (32-char hex, from a record's master file). |
Returns:
| Field | Type | Description |
|---|---|---|
id | string | |
name | string | |
position | string | |
tag | string (optional) | |
createdOn | string | |
modifiedOn | string |
get_record_master_file_version
Available on request
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:
| Parameter | Type | Required | Description |
|---|---|---|---|
recordId | string | Yes | The record id (32-char hex, from a search result or a user-provided link). |
Returns:
| Field | Type | Description |
|---|---|---|
id | string | |
fileName | string | |
versionLabel | string | |
versionNumber | integer | |
fileSize | integer | |
fileExtension | string | |
isLatest | boolean | |
createdOn | string |
list_additional_file_previews
Available on request
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:
| Parameter | Type | Required | Description |
|---|---|---|---|
additionalFileId | string | Yes | The additional file id (32-char hex, from list_additional_files or get_additional_file). |
Returns:
| Field | Type | Description |
|---|---|---|
additionalFileId | string | |
count | integer | |
items | array of AdditionalFilePreviewPayload | |
items[].additionalFileId | string | |
items[].id | integer | |
items[].metadata | array of string | |
items[].uri | string (optional) |
list_additional_files
Available on request
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:
| Parameter | Type | Required | Description |
|---|---|---|---|
fileVersionId | string | Yes | The file version id (32-char hex, from get_file_versions or get_record_master_file_version). |
Returns:
| Field | Type | Description |
|---|---|---|
fileVersionId | string | |
count | integer | |
items | array of AdditionalFilePayload | |
items[].id | string | |
items[].type | string | |
items[].isManual | boolean | |
items[].label | string | |
items[].fileSize | integer | |
items[].fileName | string | |
items[].extension | string | |
items[].usages | array of string | |
items[].purposes | array of string |
list_file_fields
Available on request
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:
| Parameter | Type | Required | Description |
|---|---|---|---|
fileId | string | Yes | The file id (32-char hex, from a record's master file). |
includeFields | string | No | Optional 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. |
skip | integer | No | Number of items to skip, for paging. Defaults to 0. |
take | integer | No | Maximum number of items to return. Omit for the endpoint's default page size. |
Returns:
| Field | Type | Description |
|---|---|---|
fileId | string | |
count | integer | |
items | array of FileFieldPayload | |
items[].fileId | string | |
items[].id | string | |
items[].fieldName | string (optional) | |
items[].label | string (optional) | |
items[].dataType | string (optional) | |
items[].value | string (optional) |
list_file_previews
Available on request
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:
| Parameter | Type | Required | Description |
|---|---|---|---|
fileVersionId | string | Yes | The file version id (32-char hex, from get_file_versions or get_record_master_file_version). |
Returns:
| Field | Type | Description |
|---|---|---|
fileVersionId | string | |
count | integer | |
items | array of FilePreviewPayload | |
items[].id | string | |
items[].pageNumber | integer | |
items[].name | string | |
items[].isMaster | boolean | |
items[].isManual | boolean | |
items[].createdOn | string |
list_file_process_actions
Available on request
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:
| Field | Type | Description |
|---|---|---|
count | integer | |
items | array of FileProcessActionPayload | |
items[].id | string | |
items[].name | string | |
items[].fileProcessActionStageId | string (optional) | |
items[].fileProcessActionType | integer (optional) | /// DAM's FileProcessActionType enum value — see 's remarks for why this is a number, not a string. |
items[].sortIndex | integer | |
items[].isConfigurable | boolean | |
items[].enabled | boolean | |
items[].allowed | boolean | |
items[].label | string (optional) | |
items[].labels | array of FileProcessActionLabelPayload | |
items[].labels[].value | string (optional) | |
items[].labels[].languageId | string (optional) | |
items[].description | string (optional) | |
items[].descriptions | array of FileProcessActionLabelPayload | |
items[].descriptions[].value | string (optional) | |
items[].descriptions[].languageId | string (optional) | |
items[].conditions | array of string | |
items[].createdOn | string (optional) | |
items[].modifiedOn | string (optional) |
list_file_version_check_result_findings
Available on request
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:
| Parameter | Type | Required | Description |
|---|---|---|---|
fileVersionId | string | Yes | The file version id (32-char hex, from get_file_versions or get_record_master_file_version). |
checkResultId | string | Yes | The check result id (GUID, from list_file_version_check_results). |
Returns:
| Field | Type | Description |
|---|---|---|
fileVersionId | string | |
checkResultId | string | |
count | integer | |
items | array of FileVersionCheckResultFindingPayload | |
items[].occurrence | integer | |
items[].fileVersionCheckId | string (optional) | |
items[].finding | string (optional) | |
items[].explanation | string (optional) | |
items[].recommendation | string (optional) | |
items[].additionalData | string (optional) | |
items[].outcome | string (optional) |
list_file_version_check_results
Available on request
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:
| Parameter | Type | Required | Description |
|---|---|---|---|
fileVersionId | string | Yes | The file version id (32-char hex, from get_file_versions or get_record_master_file_version). |
Returns:
| Field | Type | Description |
|---|---|---|
fileVersionId | string | |
count | integer | |
items | array of FileVersionCheckResultPayload | |
items[].id | string | |
items[].fileVersionId | string | |
items[].checkId | string (optional) | |
items[].description | string (optional) | |
items[].outcome | string (optional) | |
items[].createdById | string (optional) | |
items[].createdOn | string (optional) |
list_file_version_linked_versions
Available on request
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:
| Parameter | Type | Required | Description |
|---|---|---|---|
fileVersionId | string | Yes | The file version id (32-char hex, from get_file_versions or get_record_master_file_version). |
linkedVersionType | string | Yes | The link direction: "Contains" or "UsedIn". |
skip | integer | No | Number of items to skip, for paging. Defaults to 0. |
take | integer | No | Maximum number of items to return. Omit for the endpoint's default page size. |
Returns:
| Field | Type | Description |
|---|---|---|
fileVersionId | string | |
linkedVersionType | string | |
count | integer | |
items | array of FileVersionLinkedVersionPayload | |
items[].recordId | string (optional) | |
items[].fileId | string (optional) | |
items[].fileVersionId | string (optional) | |
items[].linkSourceVersionId | string (optional) | |
items[].linkType | string (optional) |
list_file_version_permissions
Available on request
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:
| Parameter | Type | Required | Description |
|---|---|---|---|
fileVersionId | string | Yes | The file version id (32-char hex, from get_file_versions or get_record_master_file_version). |
Returns:
| Field | Type | Description |
|---|---|---|
fileVersionId | string | |
canDownload | boolean | |
canDelete | boolean |
list_file_version_process_action_log
Available on request
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:
| Parameter | Type | Required | Description |
|---|---|---|---|
fileVersionId | string | Yes | The file version id (32-char hex, from get_file_versions or get_record_master_file_version). |
Returns:
| Field | Type | Description |
|---|---|---|
fileVersionId | string | |
count | integer | |
items | array of FileVersionProcessActionLogPayload | |
items[].id | string | |
items[].fileVersionId | string | |
items[].label | string (optional) | |
items[].description | string (optional) | |
items[].status | string (optional) | |
items[].details | string (optional) | |
items[].createdOn | string (optional) | |
items[].completedOn | string (optional) |
list_file_version_public_links
Available on request
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:
| Parameter | Type | Required | Description |
|---|---|---|---|
fileVersionId | string | Yes | The file version id (32-char hex, from get_file_versions or get_record_master_file_version). |
Returns:
| Field | Type | Description |
|---|---|---|
fileVersionId | string | |
count | integer | |
items | array of PublicLinkPayload | |
items[].id | string | |
items[].uri | string (optional) | |
items[].status | string (optional) | |
items[].canDelete | boolean (optional) | |
items[].provider | string (optional) | |
items[].recordId | string (optional) | |
items[].fileVersionId | string (optional) | |
items[].additionalFileId | string (optional) | |
items[].fileSize | integer (optional) | |
items[].renditionName | string (optional) | |
items[].origin | string (optional) | |
items[].modifiedOn | string (optional) | |
items[].createdOn | string (optional) |
list_file_version_renditions
Available on request
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:
| Parameter | Type | Required | Description |
|---|---|---|---|
fileVersionId | string | Yes | The file version id (32-char hex, from get_file_versions or get_record_master_file_version). |
Returns:
| Field | Type | Description |
|---|---|---|
fileVersionId | string | |
count | integer | |
items | array of RenditionPayload | |
items[].id | string | |
items[].uri | string (optional) | |
items[].type | string (optional) | |
items[].name | string (optional) | |
items[].extension | string (optional) | |
items[].preview | string (optional) | |
items[].publishedUri | string (optional) |
undo_file_checkout
Available on request · Destructive
Undoes the checkout lock on a file of an Aprimo asset, releasing it without adding a new file version. Requires both confirmed=true and confirmedDestructive=true, after explicitly confirming the exact file with the user.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
fileId | string | Yes | The file id (32-char hex, from a record's master file). |
confirmed | boolean | No | Must 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 file. |
confirmedDestructive | boolean | No | Must also be true (in addition to confirmed) — undoing a checkout discards the lock; any in-progress expectation of adding a new version is lost. Set only after stating the exact file to the user and getting explicit go-ahead. |
Returns:
| Field | Type | Description |
|---|---|---|
fileId | string | |
undone | boolean |
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.
update_file_preview_rotation
Available on request
Sets the rotation angle (in degrees) of a file preview on an Aprimo asset by its id. This modifies data. Always confirm the exact file preview and the new angle with the user before calling this tool.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
filePreviewId | string | Yes | The file preview id (32-char hex, from list_file_previews or get_file_preview). |
rotationAngle | integer | Yes | The rotation angle to apply, in degrees (e.g. 90, 180, 270). |
Returns:
| Field | Type | Description |
|---|---|---|
id | string | |
rotationAngle | integer |
update_file_process_action
Available on request
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:
| Parameter | Type | Required | Description |
|---|---|---|---|
fileProcessActionId | string | Yes | The file process action id (GUID) to edit, from list_file_process_actions/get_file_process_action. |
name | string | No | New name for the file process action. Omit to leave the name unchanged. |
sortIndex | integer | No | New sort index within its stage. Omit to leave it unchanged. |
enabled | boolean | No | New enabled flag. Omit to leave it unchanged. |
conditions | array of string | No | New conditions collection — replaces the entire existing collection (not merged). Omit to leave conditions unchanged. |
label | string | No | New name label in the current user's language. Omit to leave it unchanged. |
labels | object (map of string) | No | New multi-language name labels: a map of languageId (GUID) to label value. Omit to leave labels unchanged. |
description | string | No | New description in the current user's language. Omit to leave it unchanged. |
descriptions | object (map of string) | No | New multi-language descriptions: a map of languageId (GUID) to description value. Omit to leave descriptions unchanged. |
Returns:
| Field | Type | Description |
|---|---|---|
id | string | |
name | string (optional) |
Related
- Aprimo MCP Server — configuration, connection details, and authentication
- MCP Tool Permission Map — the Aprimo permissions that make each tool visible to your agent
- REST API vs. MCP — choosing the right integration approach for your agent