Skip to main content
Uploadcare logo
  • Category: file management & storage
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 34
  • Triggers: 0
  • Slug: UPLOADCARE
  • Version: 20261101_00

Tools

Slug: UPLOADCARE_CHECK_AWS_REKOGNITION_MODERATION_STATUSTool to check the execution status of AWS Rekognition Moderation labels detection. Use after initiating a moderation check to monitor progress and determine when results are ready.

Input Parameters

string
required
Request ID returned by the Add-On execution request. Used to query the status of the moderation detection job.

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: UPLOADCARE_CHECK_REMOVE_BG_STATUSTool to check Remove.bg execution status and get the UUID of the file with removed background. Use after requesting background removal to poll for completion and retrieve the processed file UUID.

Input Parameters

string
required
Request ID returned by the Remove.bg Add-On execution request. Format: UUID (e.g., ‘00000000-0000-0000-0000-000000000000’).

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: UPLOADCARE_COPY_FILE_LOCALTool to copy a file to local storage within the same Uploadcare project. Use when you need to create a duplicate of an existing file.

Input Parameters

string
Whether to store the copied file permanently. Must be either ‘true’ or ‘false’. Defaults to ‘false’ if not specified.
string
required
A CDN URL or UUID of the file to copy. Can be a full CDN URL (e.g., ‘http://www.ucarecdn.com/85b5644f-e692-4855-9db0-8c5a83096e25/’) or just the UUID (e.g., ‘85b5644f-e692-4855-9db0-8c5a83096e25’).
object
Arbitrary additional metadata to attach to the copied file.

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: UPLOADCARE_CREATE_FILE_GROUP_UPLOADTool to create a file group from already uploaded files using Uploadcare’s Upload API. Use after files have been uploaded to group them together.

Input Parameters

array
required
List of file UUIDs to include in the group. Each element can be a file UUID with or without applied image processing operations.
integer
UNIX timestamp defining how long the signature is valid. Must be sent along with ‘signature’ if using signed uploads.
string
required
Public key identifying an Uploadcare project. This is your project’s public key.
string
Signature for signed uploads. Must be sent along with ‘expire’ if using signed uploads. Generated on your backend using your Secret key.

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: UPLOADCARE_CREATE_WEBHOOKCreate a new webhook subscription to receive notifications when file events occur. Use this to get real-time callbacks at your URL when files are uploaded, stored, deleted, or flagged. The project is automatically determined by your API credentials. Note: Each target_url must be unique per event type within your project.

Input Parameters

string
required
Type of event to subscribe to. Supported values: ‘file.uploaded’ (file upload complete), ‘file.infected’ (file failed virus check), ‘file.stored’ (file stored), ‘file.deleted’ (file deleted). The target_url must be unique for each project-event combination.
boolean
Whether the webhook should be active after creation. Defaults to true if not specified.
string
required
HTTPS URL to receive webhook event notifications. The host must be valid and resolvable. Must be unique for each project-event type combination.
string
Optional secret to sign webhook payloads for verification (max 32 characters). If not provided, webhook payloads will not be signed (signing_secret will be null in response).

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: UPLOADCARE_DELETE_FILE_METADATA_KEYTool to delete a specific metadata key from an Uploadcare file. Use when you need to remove obsolete metadata after file processing.

Input Parameters

string
required
The metadata key to delete.
string
required
The UUID of the file.

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: UPLOADCARE_DELETE_FILESDelete up to 100 files from Uploadcare storage in a single request. The response may include per-file problems.

Input Parameters

array
required
List of file UUIDs to delete from storage. Maximum 100 UUIDs per request.

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: UPLOADCARE_DELETE_GROUPTool to delete a file group. Use when you need to remove a group from the project. Note that files within the group are not deleted, only the group itself.

Input Parameters

string
required
The UUID of the group to delete. Format: standard UUID with file count suffix (e.g., ‘badfc9f7-f88f-4921-9cc0-22e2c08aa2da~12’). Note: Deleting the group does not delete the files within it.

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: UPLOADCARE_DELETE_SINGLE_FILETool to delete a single file from Uploadcare storage by UUID. Use when you need to permanently remove a file from storage (note: file may remain in CDN cache).

Input Parameters

string
required
UUID of the Uploadcare file to delete from storage. Must be a valid UUID in 8-4-4-4-12 hex format. Note: this removes the file from storage but not from CDN cache.

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: UPLOADCARE_DELETE_WEBHOOKPermanently deletes a webhook subscription from your Uploadcare project. Use the List Webhooks action first to obtain the webhook ID. This action is irreversible.

Input Parameters

string
required
The numeric ID of the webhook to delete. Obtain this from the List Webhooks 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: UPLOADCARE_DELETE_WEBHOOK_BY_URLTool to delete a webhook subscription by its target URL. Use when you know the webhook’s target URL but not its ID.

Input Parameters

string
required
The target URL of the webhook subscription to delete. Must match an existing webhook URL exactly.

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: UPLOADCARE_EXECUTE_CLAMAV_SCANStart an asynchronous ClamAV virus scan on an uploaded file, optionally purging infected files, and receive a request ID to track its status. Results can be retrieved from file info or via webhooks.

Input Parameters

object
Optional parameters for ClamAV scan execution.
string
required
Unique UUID of the file to scan for viruses. Must be a valid UUID in 8-4-4-4-12 hex format.

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: UPLOADCARE_GET_AWS_REKOGNITION_EXECUTION_STATUSTool to check AWS Rekognition execution status for label detection. Use after initiating an AWS Rekognition add-on execution to monitor job progress.

Input Parameters

string
required
Request ID returned by the AWS Rekognition Add-On execution request. Use this to check the status of the detection job.

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: UPLOADCARE_GET_CLAMAV_SCAN_STATUSTool to check the execution status of a ClamAV virus scan. Use after initiating a ClamAV scan to monitor its progress and determine when results are available.

Input Parameters

string
required
Request ID returned by the ClamAV Add-On execution request. This UUID identifies the specific scan operation 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: UPLOADCARE_GET_FILE_GROUP_INFO_UPLOADTool to get information about a file group from the Upload API. Use when you need to retrieve group details including file metadata from the upload endpoint.

Input Parameters

string
required
Public key identifying the Uploadcare project. This is the project’s public API key.
string
required
Group’s unique ID. Format: UUIDN where N is the number of files in the group (e.g., ‘d52d7136-a2e5-4338-9f45-affbf83b857d2’).

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: UPLOADCARE_GET_FILE_INFOTool to get information about a specific file. Use after uploading a file to retrieve detailed metadata and usage information.

Input Parameters

string
required
The UUID of the file to retrieve information for. Format: 8-4-4-4-12 hexadecimal characters (e.g., ‘3e0923f2-e05a-4b37-9f0d-343b981c9d70’).

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: UPLOADCARE_GET_FILE_METADATATool to retrieve all metadata key-value pairs associated with an Uploadcare file. Use when you need to inspect custom metadata attached to a file.

Input Parameters

string
required
The UUID of the file to retrieve metadata for. Format: 8-4-4-4-12 hexadecimal characters (e.g., ‘28569df2-b963-4120-85d8-99d349623ec1’).

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: UPLOADCARE_GET_FILE_METADATA_KEYTool to get the value of a specific metadata key for an Uploadcare file. Use when you need to retrieve custom metadata associated with a file.

Input Parameters

string
required
The metadata key to retrieve. Allowed characters: Latin letters (a-z, A-Z), digits (0-9), underscore (_), hyphen (-), dot (.), and colon (:).
string
required
The UUID of the file. Format: 8-4-4-4-12 hexadecimal characters.

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: UPLOADCARE_GET_GROUP_INFOTool to get information about a specific file group. Use when you need to retrieve detailed metadata about a group and its contained files.

Input Parameters

string
required
The UUID of the group to retrieve information for. Format: UUIDcount (e.g., ‘badfc9f7-f88f-4921-9cc0-22e2c08aa2da12’).

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: UPLOADCARE_GET_PROJECT_INFOTool to get information about the current Uploadcare project. Use when you need to retrieve project configuration details.

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: UPLOADCARE_GET_UPLOADED_FILE_INFOTool to get information about an uploaded file using Uploadcare’s Upload API. Use this to retrieve file metadata including size, MIME type, and content information immediately after upload.

Input Parameters

string
required
File’s unique ID (UUID) returned after upload. Format: 8-4-4-4-12 hexadecimal characters.
string
required
Public key identifying the Uploadcare project. This is your project’s public API key.

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: UPLOADCARE_GET_URL_UPLOAD_STATUSTool to check the status of a URL upload task. Use after initiating a file upload from a URL to monitor progress or verify completion.

Input Parameters

string
required
Token returned by the /from_url/ endpoint that identifies a request to fetch/upload a file from a 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: UPLOADCARE_IMAGE_MIRRORTool to mirror an image horizontally via Uploadcare CDN. Use when you need the URL of a horizontally flipped image.

Input Parameters

string
required
The Uploadcare file UUID (e.g., ‘3e0923f2-e05a-4b37-9f0d-343b981c9d70’) or full CDN URL (e.g., ‘https://ucarecdn.com/3e0923f2-e05a-4b37-9f0d-343b981c9d70/’).

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: UPLOADCARE_LIST_FILESList files in an Uploadcare project with pagination and optional filtering. Use this tool to retrieve uploaded files. Supports filtering by storage status, removal status, and date range. Results are paginated with optional ordering.

Input Parameters

integer
Number of files to return per page (1-1000). Defaults to 100 if not specified.
integer
Pagination offset, zero-based.
string ("true" | "false")
Filter by storage status (‘true’ or ‘false’).
string
Include total file count in the response by specifying ‘total’.
string ("true" | "false")
Filter by removal status (‘true’ or ‘false’).
string
Return files uploaded before this ISO 8601 datetime.
string ("datetime_uploaded" | "-datetime_uploaded")
Sort order for results. Use ‘datetime_uploaded’ for ascending or ‘-datetime_uploaded’ for descending order by upload date.
string
Return files uploaded after this ISO 8601 datetime.

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: UPLOADCARE_LIST_GROUPSTool to list groups in the project. Use when you need to retrieve paginated groups of files.

Input Parameters

integer
Number of groups to return per page (1-1000).
integer
Number of groups to skip before starting the result set.
string ("datetime_created" | "-datetime_created")
Sort by ‘datetime_created’; prefix with ’-’ for descending.

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: UPLOADCARE_LIST_WEBHOOKSRetrieves all webhook subscriptions for the authenticated Uploadcare project. Use this tool to view configured webhooks that receive notifications for file events (uploads, deletions, storage, etc.). Returns an array of webhook objects with their IDs, target URLs, event types, and active status.

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: UPLOADCARE_ROTATE_IMAGEGenerate and verify a CDN URL for an uploaded image rotated counterclockwise by 90, 180, or 270 degrees. Returns the rotated image URL.

Input Parameters

string
required
UUID of the image to rotate. Must follow 8-4-4-4-12 hex format.
integer ("90" | "180" | "270")
required
Rotation angle in degrees counterclockwise. Must be one of [90, 180, 270].

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: UPLOADCARE_START_MULTIPART_UPLOADTool to start a multipart upload session for files larger than 100MB. Use when you need to upload large files that exceed the direct upload size limit. Returns presigned URLs for uploading file parts.

Input Parameters

integer
required
Precise file size in bytes. The size should not exceed max file size cap for your project.
integer
UNIX timestamp defining how long the signature is valid. Required if using signed uploads.
string
required
Original filename of the uploaded file.
integer
Size of each upload part in bytes. Default is 5 MB (5242880 bytes). Increase for large files (e.g., 10485760 for 10 MB chunks). Must be between 5 MB and 5 GB.
string
Signature for signed uploads. Must be sent along with ‘expire’ parameter. See Uploadcare docs for signed uploads.
string
required
File MIME type (e.g., ‘video/mp4’, ‘application/pdf’).
string ("0" | "1" | "auto")
Store file behavior options.
string
required
Public key identifying an Uploadcare project your uploads will go to.

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: UPLOADCARE_STORE_BATCH_FILESTool to store multiple files in one request. Use when you need to mark up to 100 files as permanently stored in bulk.

Input Parameters

array
required
List of file UUIDs to store. Maximum 100 UUIDs per request. Each UUID must be a valid UUID in 8-4-4-4-12 hex format.

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: UPLOADCARE_STORE_FILETool to mark an Uploadcare file as permanently stored. Use after uploading a file when you need to store it permanently.

Input Parameters

string
required
UUID of the Uploadcare file to mark as stored. Must be a valid UUID in 8-4-4-4-12 hex format.

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: UPLOADCARE_STORE_SINGLE_FILETool to store a single file by UUID permanently. Use when you need to make an uploaded file available permanently (stored files are retained indefinitely).

Input Parameters

string
required
UUID of the Uploadcare file to store permanently. Must be a valid UUID in 8-4-4-4-12 hex format.

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: UPLOADCARE_UPDATE_FILE_METADATA_KEYTool to update or set the value of a specific metadata key for a file. Use when you need to add or modify file metadata.

Input Parameters

string
required
Key of file metadata. Allowed characters: Latin letters (a-z, A-Z), digits (0-9), underscore (_), hyphen (-), dot (.), colon (:).
string
required
The UUID of the file.
string
required
Value to set for the metadata key. Must be 1-512 characters.

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: UPLOADCARE_UPDATE_WEBHOOKUpdate an existing webhook subscription by its ID. Use this to modify the target URL, event type, active status, or signing secret of a webhook. Only provide the fields you want to update - all fields are optional except the webhook ID.

Input Parameters

integer
required
The numeric ID of the webhook to update. Obtain this from the List Webhooks action.
string ("file.uploaded" | "file.infected" | "file.stored" | "file.deleted" | "file.info_updated")
Enum for webhook event types.
boolean
Whether the webhook should be active. Set to false to temporarily disable notifications without deleting the webhook.
string
URL to receive webhook notifications. Must be unique for each project-event type combination. If provided, updates the target URL.
string
Optional HMAC/SHA-256 secret for signing webhook payloads (max 32 characters). The signature is sent in the X-Uc-Signature header.

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: UPLOADCARE_UPLOAD_FROM_URLTool to upload a file from a publicly available URL to Uploadcare. Use when you need to import files from external URLs into your Uploadcare project.

Input Parameters

string ("0" | "1" | "auto")
Determines if an uploaded file should be marked as temporary or permanent. Values: ‘0’ (remove after 24 hours), ‘1’ (mark as stored), ‘auto’ (use project-wide setting). Default is ‘auto’.
string
required
Public key identifying an Uploadcare project your uploads will go to.
string
Sets the file name of the resource fetched from the source URL. If not defined, the file name is obtained from HTTP response headers or the source URL’s path. Will be sanitized to only contain: a-zA-Z0-9._
string
required
Source URL of the file to fetch and upload. Must be publicly available via HTTP/HTTPS.
string
Determines if the requested source_url should be kept in the history of fetched/uploaded URLs. If not defined explicitly, it is set to the value of check_URL_duplicates. Values: ‘0’ or ‘1’.
string
If set to ‘1’, enables source_url duplicates prevention. If the source_url was already fetched and uploaded previously, this request will return information about the already uploaded file. Values: ‘0’ or ‘1’.

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