File Types

Tools for file type definitions and their icons and thumbnails.

This page covers 7 tools, all of them available on request rather than in the default tool list, and 1 destructive.

How to read this page

• 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 confirmed and confirmedDestructive to true.
• Activity and Project labels vary by tenant. Where this page says Activity or Project, your tenant's own configured terminology is substituted at runtime.

Why isn't every tool in the default list?

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
create_file_type	On request	Creates a new Aprimo file type.
delete_file_type	On request	Destructive. Permanently deletes an Aprimo file type by id or by name.
get_file_type	On request	Gets 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_icon	On request	Returns the icon image URL (plus width/height/size/extension) for an Aprimo file type, by id or by name.
get_file_type_thumbnail	On request	Returns the thumbnail image URL (plus width/height/size/extension) for an Aprimo file type, by id or by name.
list_file_types	On request	Lists the file types configured in Aprimo (e.g. Jpeg, PDF, MP4) — name, extension, MIME type, engine/preview format, and supported operations.
update_file_type	On request	Edits an existing Aprimo file type by id or by name.

---

create_file_type

Available on request

Creates a new Aprimo file type. This modifies data. Always confirm the name and any other settings with the user before calling this tool.

Parameters:

Parameter	Type	Required	Description
name	string	Yes	The name for the new file type, exactly as the user stated it.
kind	string	No	The kind of the file type, e.g. "Image", "Video", "Document".
extension	string	No	The file extension associated with this file type, e.g. "PDF".
mimeType	string	No	The MIME type associated with this file type, e.g. "application/pdf".
engineFormat	string	No	Required (not actually optional — DAM's FileType.OnValidateChanges rejects an empty EngineFormat on every save, and a newly-created file type's EngineFormat starts empty, so omitting this always fails server-side with an opaque "An invalid value was specified for EngineFormat" error). The engine format used to process files of this type, e.g. "default" (the built-in passthrough format) — call list_file_types to see engine formats already used in this tenant.
isCatalogable	boolean	No	Whether files of this type can be cataloged. Omit to use DAM's default.
previewFormat	string	No	The preview format used for this file type, e.g. "Jpg", "None".
previewRequired	boolean	No	Whether a preview is required for files of this type. Omit to use DAM's default.
previewKeepDimensions	boolean	No	Whether the preview should keep the original dimensions. Omit to use DAM's default.
supportAssetResize	boolean	No	Whether asset resize is supported for this file type. Omit to use DAM's default.
supportAssetWatermark	boolean	No	Whether asset watermarking is supported for this file type. Omit to use DAM's default.
preferredExtension	boolean	No	Whether this file type's extension is the preferred one for its kind. Omit to use DAM's default.
tag	string	No	Optional custom XML tag for this file type.
registeredFieldIds	array of string	No	Field ids (GUIDs) to register on this file type.
registeredFieldGroupIds	array of string	No	Field group ids (GUIDs) to register on this file type.
mediaEngines	.")] List<string>	No	Media engines used for this file type, e.g. ["Exif", "Text"].
previewPlayers	.")] List<string>	No	Preview render web controls used for this file type, e.g. ["Adam.PdfPreviewPlayer"].
labels	object (map of string)	No	Multi-language labels for the name of this file type: a map of languageId (GUID) to label value.

Returns:

Field	Type	Description
id	string
name	string

---

delete_file_type

Available on request · Destructive

Permanently deletes an Aprimo file type by id or by name. This cannot be undone. Requires both confirmed=true and confirmedDestructive=true, after explicitly confirming the exact file type with the user.

Parameters:

Parameter	Type	Required	Description
fileTypeId	string	No	The file type id (GUID) to delete. Provide this or name, not both.
name	string	No	The file type's name (case-insensitive, exact match). Provide this or fileTypeId, not both.
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 type.
confirmedDestructive	boolean	No	Must also be true (in addition to confirmed) — deleting a file type is permanent and cannot be undone. Set only after stating the exact file type to the user and getting explicit go-ahead.

Returns:

Field	Type	Description
id	string
name	string (optional)
deleted	boolean

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.

---

get_file_type

Available on request

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:

Parameter	Type	Required	Description
fileTypeId	string	No	The file type id (GUID), from list_file_types. Provide this or name, not both.
name	string	No	The file type's name (case-insensitive, exact match), e.g. "Archive (zip)". Provide this or fileTypeId, not both.

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_type_icon

Available on request

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:

Parameter	Type	Required	Description
fileTypeId	string	No	The file type id (GUID). Provide this or name, not both.
name	string	No	The file type's name (case-insensitive, exact match). Provide this or fileTypeId, not both.

Returns:

Field	Type	Description
fileTypeId	string
uri	string (optional)
width	integer (optional)
height	integer (optional)
size	integer (optional)
extension	string (optional)

---

get_file_type_thumbnail

Available on request

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:

Parameter	Type	Required	Description
fileTypeId	string	No	The file type id (GUID). Provide this or name, not both.
name	string	No	The file type's name (case-insensitive, exact match). Provide this or fileTypeId, not both.

Returns:

Field	Type	Description
fileTypeId	string
uri	string (optional)
width	integer (optional)
height	integer (optional)
size	integer (optional)
extension	string (optional)

---

list_file_types

Available on request

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:

Parameter	Type	Required	Description
filter	string	No	Optional filter expression (DAM query syntax), e.g. "ModifiedOn in today". Omit to list every file type.
sort	string	No	Optional sort expression, e.g. "createdOn". Omit for the endpoint's default order.
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
count	integer
items	array of FileTypePayload
items[].id	string
items[].name	string
items[].kind	string (optional)
items[].extension	string (optional)
items[].mimeType	string (optional)
items[].engineFormat	string (optional)
items[].isCatalogable	boolean
items[].mediaEngines	array of string
items[].previewFormat	string (optional)
items[].previewPlayers	array of string
items[].previewRequired	boolean
items[].previewKeepDimensions	boolean
items[].supportAssetResize	boolean
items[].supportAssetWatermark	boolean
items[].preferredExtension	boolean
items[].tag	string (optional)
items[].registeredFieldIds	array of string
items[].registeredFieldGroupIds	array of string
items[].labels	array of FileTypeLabelPayload
items[].labels[].value	string (optional)
items[].labels[].languageId	string
items[].createdOn	string (optional)
items[].modifiedOn	string (optional)

---

update_file_type

Available on request

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

Parameters:

Parameter	Type	Required	Description
fileTypeId	string	No	The file type id (GUID) to edit. Provide this or name, not both.
name	string	No	The file type's current name (case-insensitive, exact match), used to look it up. Provide this or fileTypeId, not both.
newName	string	No	New name for the file type. Omit to leave the name unchanged.
kind	string	No	New kind. Omit to leave it unchanged.
extension	string	No	New file extension. Omit to leave it unchanged.
mimeType	string	No	New MIME type. Omit to leave it unchanged.
engineFormat	string	No	New engine format. Omit to leave it unchanged.
isCatalogable	boolean	No	New "is catalogable" setting. Omit to leave it unchanged.
previewFormat	string	No	New preview format. Omit to leave it unchanged.
previewRequired	boolean	No	New "preview required" setting. Omit to leave it unchanged.
previewKeepDimensions	boolean	No	New "preview keep dimensions" setting. Omit to leave it unchanged.
supportAssetResize	boolean	No	New "support asset resize" setting. Omit to leave it unchanged.
supportAssetWatermark	boolean	No	New "support asset watermark" setting. Omit to leave it unchanged.
preferredExtension	boolean	No	New "preferred extension" setting. Omit to leave it unchanged.
tag	string	No	New custom XML tag. Omit to leave it unchanged.
registeredFieldIdsToAdd	array of string	No	Field ids (GUIDs) to register on this file type.
registeredFieldIdsToRemove	array of string	No	Field ids (GUIDs) to unregister from this file type.
registeredFieldGroupIdsToAdd	array of string	No	Field group ids (GUIDs) to register on this file type.
registeredFieldGroupIdsToRemove	array of string	No	Field group ids (GUIDs) to unregister from this file type.
mediaEnginesToAdd	.")] List<string>	No	Media engines to add, e.g. ["Xmp"].
mediaEnginesToRemove	.")] List<string>	No	Media engines to remove, e.g. ["Exif", "Text"].
previewPlayersToAdd	array of string	No	Preview render web controls to add.
previewPlayersToRemove	array of string	No	Preview render web controls to remove.
labels	object (map of string)	No	Label values to set: a map of languageId (GUID) to label value. Omit to leave labels 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