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

Tools

Slug: SHORTPIXEL_ADD_CDN_DOMAINRegister a domain in the ShortPixel CDN system for CDN services. The operation supplies your API key to associate the domain with your account; an existing domain without an associated user can also be associated.

Input Parameters

string
required
Domain name to add to the CDN (e.g., example.com or test-domain-example.com)

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: SHORTPIXEL_BULK_PURGE_STORAGETool to purge all files stored on ShortPixel storage servers for a domain. Use when you need to remove all stored files for a site in bulk.

Input Parameters

string
required
The domain whose files will be purged from ShortPixel storage

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: SHORTPIXEL_CHECK_IMAGE_STATUSTool to check the optimization status of an image being processed by ShortPixel. Returns current status of queued images including URLs and size information.

Input Parameters

string
required
URL of the image to check status 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: SHORTPIXEL_CLEAN_UP_IMAGETool to remove images from the processing queue. Use when you need to optimize another image with the same URL but different contents within the next hour.

Input Parameters

array
required
List of image URLs to remove from the processing queue

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: SHORTPIXEL_GET_ADAPTIVE_IMAGE_CDNOptimize an image by URL via ShortPixel CDN, with options for dimensions, cropping, quality, and format conversion. Returns an image file; depending on the return mode, it may be a placeholder or the original while processing.

Input Parameters

string ("smart" | "center" | "north" | "south" | "east" | "west" | "northeast" | "northwest" | "southeast" | "southwest")
Crop style options.
integer
Desired width in pixels for the optimized image
integer
Desired height in pixels for the optimized image
string ("lqip" | "lossless" | "glossy" | "lossy")
Image quality/compression level options.
string
required
Absolute URL of the original image to optimize (e.g., ‘https://example.com/image.jpg’)
boolean
Whether to keep EXIF metadata in the optimized image. False removes metadata for smaller file size.
string ("webp" | "avif" | "auto")
Output format conversion options.
string ("blank" | "img" | "wait")
Return behavior options.

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: SHORTPIXEL_GET_API_STATUSTool to retrieve the current status of your API key, including available credits. Use when you need to monitor your account usage before making additional API calls.

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: SHORTPIXEL_GET_CDN_USAGERetrieve CDN usage and quota statistics for a ShortPixel domain, including traffic, API calls, and historical usage breakdowns. Use this to monitor consumption and check quota status.

Input Parameters

string
required
Domain name to get CDN usage statistics for (e.g., example.com)

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: SHORTPIXEL_OPTIMIZE_IMAGES_BY_URLTool to optimize images by providing their URLs. Supports batch processing of up to 100 URLs per request with options for lossy, glossy, or lossless compression, resizing, format conversion (WebP/AVIF), and background removal. Use when you need to compress and optimize images accessible online.

Input Parameters

integer
Wait time in seconds (0-30) for optimization before returning. Use 0 to return immediately with scheduled status. Higher values wait for completion.
string ("lossless" | "lossy" | "glossy")
Image compression type.
string ("none" | "outer" | "inner" | "smart_crop_ai")
Image resize type.
integer
Re-fetch and re-optimize image from source URL: 0 to use cached version, 1 to force fresh optimization
string ("none" | "2x" | "3x" | "4x")
Image upscaling factor.
array
required
Array of image URLs to optimize. Images must be accessible online. Maximum 100 URLs per request.
integer
Convert CMYK color space to RGB: 0 to skip conversion, 1 to convert (default is 1)
string
Background removal options: ‘1’ for transparent background, URL for custom background image, ‘#rrggbbxx’ for color with transparency (xx is alpha in hex)
string
Format conversion options: ‘+webp’ (add WebP version), ‘+avif’ (add AVIF version), ‘+webp|+avif’ (add both), ‘webp|avif’ (replace with first available), ‘jpg’, ‘png’, ‘gif’ (convert to format)
integer
Preserve EXIF metadata in optimized images: 0 to remove (default), 1 to keep
array
Array of custom optimization parameters for each URL, allowing per-image settings. Must match urllist length if provided.
integer
Target width in pixels for resizing. Required if resize is specified.
integer
Target height in pixels for resizing. Required if resize is specified.
string
5-character max alphanumeric code identifying your API client
array
Any array to be returned unchanged in the API response for tracking purposes

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: SHORTPIXEL_READ_CDN_DOMAINTool to check the status of a domain and its CDN quota on ShortPixel. Returns a status code indicating credit availability. Use when you need to verify domain accessibility and quota status.

Input Parameters

string
required
Domain name to check CDN status and quota (e.g., example.com)

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: SHORTPIXEL_REVOKE_CDN_DOMAINTool to revoke a domain association from ShortPixel CDN. Only works if the API key belongs to the current domain owner. Use when you need to remove the association between a domain and the user account.

Input Parameters

string
required
Domain name to revoke from ShortPixel CDN (e.g., example.com)

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: SHORTPIXEL_SET_CDN_DOMAINTool to associate an API key with an existing domain. Unlike add-domain, this does not create a new domain - it only associates a user ID if not already associated. Use when you need to claim unassociated domains.

Input Parameters

string
required
Domain name to associate with the API key (e.g., example.com)

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: SHORTPIXEL_UPLOAD_AND_OPTIMIZE_IMAGESTool to upload and optimize images that are not accessible online. Uses multipart form data to upload files directly and applies optimization parameters like compression type, resize options, and format conversion.

Input Parameters

object
required
First image file to upload and optimize.
object
Second image file to upload and optimize (optional).
integer ("0" | "1" | "2")
Compression type for image optimization.
integer ("0" | "1" | "3" | "4")
Resize type for image resizing.
string
Format conversion options: +webp, +avif, or +webp|+avif
string
5 character max alphanumeric code for your API client 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