Skip to main content
SmugMug logo
  • Category: images & design
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 25
  • Triggers: 0
  • Slug: SMUGMUG
  • Version: 20261101_00

Tools

Slug: SMUGMUG_GET_ALBUMRetrieves detailed information about a SmugMug album using its album key. Returns album settings, metadata, image count, and links to related resources like images and user info. Use this to get comprehensive details about a specific album/gallery.

Input Parameters

string
required
The unique album key that identifies the album on SmugMug. This is typically a 6-character alphanumeric string (e.g., ‘SJT3DX’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMUGMUG_GET_ALBUM_HIGHLIGHT_IMAGERetrieves the highlight/cover image for a SmugMug album. Returns detailed information about the album’s cover image including dimensions, URLs, and metadata. Use this when you need to get the featured image for an album.

Input Parameters

string
required
The unique album key (6-7 character alphanumeric string) that identifies the album. This is different from NodeID - it’s the album’s specific key identifier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMUGMUG_GET_ALBUM_IMAGEGet an image within a specific album context as an AlbumImage relationship object. Returns detailed information about the image including metadata, dimensions, URLs, and relationships. Use this when you need to retrieve a specific image from an album with full album context.

Input Parameters

string
required
The unique album key that identifies the album. This is a 6-7 character alphanumeric string (e.g., ‘SJT3DX’).
string
required
The unique image key that identifies the image. This is typically a 7-8 character alphanumeric string (e.g., ‘jPPKD2c’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMUGMUG_GET_ALBUM_IMAGESTool to retrieve all images in a SmugMug album as AlbumImage relationship objects. Use this action when you need to list or access images within a specific album. An AlbumImage represents the relationship between an album and an image, which is useful because the same image may appear in multiple albums. The response includes image metadata, URIs for different sizes, and pagination support for large albums. Returns AlbumImage objects with fields like ImageKey, Title, Caption, WebUri, ArchivedUri, and nested Uris for accessing related resources (ImageSizes, LargestImage, etc.).

Input Parameters

integer
The number of images to retrieve per page. Default is typically 10 if not specified. Use with ‘start’ for pagination through large albums.
integer
The starting index for pagination (1-indexed). Use this with ‘count’ to paginate through large result sets when an album contains many images.
string
required
The unique key identifier for the album. This is a unique string that identifies the album (e.g., ‘SJT3DX’). You can obtain album keys from SMUGMUG_LIST_ALBUMS_IN_FOLDER or other album listing actions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMUGMUG_GET_FOLDER_ALBUMSTool to retrieve albums from a specific folder in a SmugMug user’s account by nickname and folder path. Use when you need to list albums in a folder using the user’s nickname and folder path rather than NodeID. This is particularly useful when you know the folder structure but don’t have the NodeID.

Input Parameters

string
The folder path within the user’s account (e.g., ‘SmugMug’ or ‘SmugMug/Heroes’). Use ’/’ to separate nested folders. Omit this parameter or pass empty string to get albums from the root folder.
string
Optional folder ID filter parameter to narrow results. This is typically a 5-character alphanumeric string.
string
required
The SmugMug user’s nickname/username whose folder to retrieve albums from. This is the user’s unique identifier on SmugMug (e.g., ‘cmac’, ‘baldy’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMUGMUG_GET_FOLDER_BY_USER_PATHTool to retrieve folder details by user nickname and folder path. Use when you need to access a specific folder within a user’s SmugMug account using the hierarchical path structure. Note: For New SmugMug, use the Node endpoint (SMUGMUG_GET_NODE_DETAILS) instead.

Input Parameters

string
required
The user’s SmugMug nickname (username). This identifies which user’s folder structure to access.
string
required
The path to the folder within the user’s account. Use forward slashes (/) to separate nested folders (e.g., ‘SmugMug’ or ‘Travel/2024’). For the root folder, use an empty string.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMUGMUG_GET_FOLDER_DETAILSRetrieves details of a specific folder in SmugMug using its Node ID. Returns folder metadata including name, description, URL path, creation and modification dates, node ID, and optionally the URI of the album set as the highlight image for the folder. Note: This action only works with Folder-type nodes. If a non-folder node ID (e.g., Album) is provided, an error will be raised. Use SMUGMUG_GET_NODE_DETAILS for general node information.

Input Parameters

string
required
The unique SmugMug Node ID of the folder to retrieve details for. This is typically a 5-character alphanumeric string (e.g., ‘c4jv4’). You can obtain node IDs from the SMUGMUG_LIST_CHILD_NODES action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMUGMUG_GET_FOLDER_SUBFOLDERSRetrieves all subfolders within a specified folder in a SmugMug user’s account. Use this action to navigate the folder hierarchy by fetching direct child folders of a given parent folder. Specify the user’s nickname and the folder path (use empty string or omit for root-level folders). Returns folder metadata including names, URLs, security settings, and IDs.

Input Parameters

string
The folder path within the user’s account. Use ’/’ separator for nested folders (e.g., ‘SmugMug/Heroes’). Leave empty or omit for root-level subfolders.
string
required
The SmugMug user’s nickname/username. This identifies the account whose folder structure you’re accessing.
string
Optional folder ID parameter for additional filtering. Must be at least 5 characters if provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMUGMUG_GET_IMAGETool to retrieve details for a specific image (photo or video) by its image key. Returns comprehensive image metadata including dimensions, upload dates, geolocation, and links to related resources like sizes, metadata, and comments. Use when you need detailed information about a specific photo or video in SmugMug.

Input Parameters

string
required
The unique image key identifier (e.g., ‘jPPKD2c-1’). This is the key that identifies a specific photo or video in SmugMug.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMUGMUG_GET_IMAGE_METADATATool to retrieve additional metadata from an image file including EXIF data, camera settings, GPS location, and other embedded information. Use when you need detailed technical information about an image, such as camera make/model, exposure settings, GPS coordinates, or timestamps.

Input Parameters

string
required
The unique key identifier for the image. This is the image’s unique identifier on SmugMug.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMUGMUG_GET_IMAGE_SIZE_DETAILSRetrieve raw media URLs and dimensions for all available sizes of an image. Returns detailed information including direct download URLs, dimensions, and file sizes for each variant. Use this when you need to download photos or videos with specific size requirements.

Input Parameters

string
required
The unique key identifier for the image. This is typically a short alphanumeric string (e.g., ‘fRmtKwv-0’). You can obtain this from image listings or album contents.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMUGMUG_GET_IMAGE_SIZESRetrieves available image sizes and URLs for a SmugMug image by its unique image key. Use this to get download URLs for different resolutions (tiny, thumb, small, medium, large, xlarge, original, etc.).

Input Parameters

string
required
The unique alphanumeric identifier for the image (e.g., ‘jPPKD2c-1’). This key is returned from album image listings or image creation endpoints.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMUGMUG_GET_NODE_HIGHLIGHT_IMAGETool to get the highlight/cover image for a node (folder, album, or page). Use when you need to retrieve the representative image set for a SmugMug node.

Input Parameters

string
required
The unique identifier for the node (folder, album, or page) to get the highlight/cover image for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMUGMUG_GET_NODE_PARENTTool to retrieve the parent node of a specified SmugMug node. Use when navigating up the folder hierarchy or determining a node’s location within the organizational structure.

Input Parameters

string
required
The unique identifier for the node whose parent you want to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMUGMUG_GET_NODE_PARENTSTool to retrieve a node and all its ancestor nodes (breadcrumb trail). Use when you need to understand the full hierarchy path from a node to the root.

Input Parameters

string
required
The unique identifier of the node to retrieve parent breadcrumb trail for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMUGMUG_GET_USERTool to get a SmugMug user account by their nickname. Returns user details including display name, view pass hint, and links to related resources like albums, profile, and images. Use when you need to fetch basic information about a SmugMug user.

Input Parameters

string
required
The user’s nickname/username on SmugMug. This is the unique identifier used in the user’s SmugMug URL.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMUGMUG_GET_USER_BIO_IMAGETool to retrieve the bio image for a SmugMug user by their nickname (username). Use when you need to get information about a user’s bio/profile image including image metadata, dimensions, URLs, and related resource URIs.

Input Parameters

string
required
The nickname of the SmugMug user whose bio image should be retrieved.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMUGMUG_GET_USER_FEATURESTool to retrieve a list of features available to a SmugMug user based on their subscription plan. Use when you need to check what capabilities or features a specific user has access to on SmugMug.

Input Parameters

string
required
The user’s nickname (username) on SmugMug. This is the unique identifier used to retrieve the user’s available features.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMUGMUG_GET_USER_PROFILERetrieves the public profile information for a SmugMug user by their nickname (username). Returns profile details including name, bio, contact email, and social media links. Use this to get information about a SmugMug photographer or user.

Input Parameters

string
required
The NickName (username) of the SmugMug user to retrieve the profile for. This is the user’s unique identifier on SmugMug.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMUGMUG_GET_USER_ROOT_NODETool to retrieve the root node of a user’s folder tree on SmugMug. Use when you need to navigate a user’s gallery structure or find the starting point of their folder hierarchy.

Input Parameters

string
required
The SmugMug user’s nickname/username. This is the unique identifier for the user whose root folder node you want to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMUGMUG_LIST_CHILD_NODESLists a page of child nodes under a specified SmugMug parent node, with pagination support. Results can include node IDs, types, names, and web URLs for navigating the hierarchy.

Input Parameters

integer
Number of child nodes to retrieve per page. Defaults to 10. Maximum is 100.
integer
The 1-based starting index for pagination. Defaults to 1 (first page).
string
required
The unique NodeID of the parent node. You can get this from user profile (root node), node details, or previous list child nodes responses.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMUGMUG_SEARCH_USER_CONTENTSearch for images across a user’s SmugMug content. This tool searches through a user’s images by querying titles, captions, keywords, and filenames. Returns a list of matching images with details like title, caption, URLs, and related resources. Use this when you need to find specific images within a user’s SmugMug account. Results are returned in paginated format with up to 100 images per page. The default ordering is by popularity, but can be changed to newest or oldest.

Input Parameters

string
required
Search query text to find in the user’s images. The search looks for matches in image titles, captions, keywords, and filenames. Maximum 100 characters.
string ("Popular" | "Oldest" | "Newest")
Order for search results.
integer
The number of results to return per page. Default is 10. Maximum is 100.
integer
The starting index (1-based) for paginated results. Use this to retrieve subsequent pages of results. Default is 1.
string
required
The SmugMug user’s nickname whose content to search. This is the unique username on SmugMug.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMUGMUG_UNLOCK_ALBUMTool to unlock a password-protected SmugMug album. Use when you need to access content in a locked album. Only available for albums that are currently password-protected.

Input Parameters

string
required
The password required to unlock the album. Must match the album’s configured password.
string
required
The album’s unique key (e.g., ‘GxmcTJ’). This identifies the password-protected album to unlock.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMUGMUG_UNLOCK_USERTool to unlock a user’s password-protected SmugMug site. Use when you need to access a locked user’s site content. This action is only available if the user’s site is currently locked with a password.

Input Parameters

string
required
The user’s nickname (username) whose site should be unlocked. This is the SmugMug user identifier.
string
required
The site password required to unlock the user’s password-protected site.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not