NagentArtefacts
Dev & Technology
Enterprise and White Glove
Company
Uploadcare connects to a Nagent workspace with an API key. Once it is connected, agents can call 34 Uploadcare actions, such as "Create File Group (Upload API)", "Create Uploadcare webhook" and "Get AWS Rekognition Execution Status". Nothing is enabled on connect: each action is allowed one at a time, and an action with side effects runs or waits for a person according to the agent's level.
Every operation an agent can call against Uploadcare, with input parameters and output schema.
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
Request ID returned by the Add-On execution request. Used to query the status of the moderation detection job.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Request ID returned by the Remove.bg Add-On execution request. Format: UUID (e.g., '00000000-0000-0000-0000-000000000000').
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Whether to store the copied file permanently. Must be either 'true' or 'false'. Defaults to 'false' if not specified.
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').
Arbitrary additional metadata to attach to the copied file.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
List of file UUIDs to include in the group. Each element can be a file UUID with or without applied image processing operations.
UNIX timestamp defining how long the signature is valid. Must be sent along with 'signature' if using signed uploads.
Public key identifying an Uploadcare project. This is your project's public key.
Signature for signed uploads. Must be sent along with 'expire' if using signed uploads. Generated on your backend using your Secret key.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
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.
Whether the webhook should be active after creation. Defaults to true if not specified.
HTTPS URL to receive webhook event notifications. The host must be valid and resolvable. Must be unique for each project-event type combination.
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
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
The metadata key to delete.
The UUID of the file.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
UPLOADCARE_DELETE_FILESTool to delete multiple files from Uploadcare storage in a single request. Use when you need to remove up to 100 files at once. Invalid UUIDs or missing files will be reported in the problems field.
Input parameters
List of file UUIDs to delete from storage. Maximum 100 UUIDs per request.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
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
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
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
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
The numeric ID of the webhook to delete. Obtain this from the List Webhooks action.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
The target URL of the webhook subscription to delete. Must match an existing webhook URL exactly.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
UPLOADCARE_EXECUTE_CLAMAV_SCANTool to execute ClamAV virus scan on an uploaded file. Use this when you need to check if a file contains viruses or malware. The scan runs asynchronously - you receive a request_id to track the scan status. Results can be retrieved from file info or via webhooks.
Input parameters
Optional parameters for ClamAV scan execution.
Unique UUID of the file to scan for viruses. Must be a valid UUID in 8-4-4-4-12 hex format.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Request ID returned by the AWS Rekognition Add-On execution request. Use this to check the status of the detection job.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Request ID returned by the ClamAV Add-On execution request. This UUID identifies the specific scan operation to check status for.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Public key identifying the Uploadcare project. This is the project's public API key.
Group's unique ID. Format: UUID~N where N is the number of files in the group (e.g., 'd52d7136-a2e5-4338-9f45-affbf83b857d~2').
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
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
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
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
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
The metadata key to retrieve. Allowed characters: Latin letters (a-z, A-Z), digits (0-9), underscore (_), hyphen (-), dot (.), and colon (:).
The UUID of the file. Format: 8-4-4-4-12 hexadecimal characters.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
The UUID of the group to retrieve information for. Format: UUID~count (e.g., 'badfc9f7-f88f-4921-9cc0-22e2c08aa2da~12').
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
UPLOADCARE_GET_PROJECT_INFOTool to get information about the current Uploadcare project. Use when you need to retrieve project configuration details.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
File's unique ID (UUID) returned after upload. Format: 8-4-4-4-12 hexadecimal characters.
Public key identifying the Uploadcare project. This is your project's public API key.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Token returned by the /from_url/ endpoint that identifies a request to fetch/upload a file from a URL.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
UPLOADCARE_IMAGE_MIRRORTool to mirror an image horizontally via Uploadcare CDN. Use when you need the URL of a horizontally flipped image.
Input parameters
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
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Number of files to return per page (1-1000). Defaults to 100 if not specified.
Pagination offset, zero-based.
Filter by storage status ('true' or 'false').
Include total file count in the response by specifying 'total'.
Filter by removal status ('true' or 'false').
Return files uploaded before this ISO 8601 datetime.
Sort order for results. Use 'datetime_uploaded' for ascending or '-datetime_uploaded' for descending order by upload date.
Return files uploaded after this ISO 8601 datetime.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
UPLOADCARE_LIST_GROUPSTool to list groups in the project. Use when you need to retrieve paginated groups of files.
Input parameters
Number of groups to return per page (1-1000).
Number of groups to skip before starting the result set.
Sort by 'datetime_created'; prefix with '-' for descending.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
UPLOADCARE_ROTATE_IMAGETool to rotate an image by specified degrees counterclockwise. Use when you need to rotate an uploaded image by 90, 180, or 270 degrees. Use after confirming the file UUID.
Input parameters
UUID of the image to rotate. Must follow 8-4-4-4-12 hex format.
Rotation angle in degrees counterclockwise. Must be one of \[90, 180, 270\].
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Precise file size in bytes. The size should not exceed max file size cap for your project.
UNIX timestamp defining how long the signature is valid. Required if using signed uploads.
Original filename of the uploaded file.
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.
Signature for signed uploads. Must be sent along with 'expire' parameter. See Uploadcare docs for signed uploads.
File MIME type (e.g., 'video/mp4', 'application/pdf').
Store file behavior options.
Public key identifying an Uploadcare project your uploads will go to.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
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
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
UUID of the Uploadcare file to mark as stored. Must be a valid UUID in 8-4-4-4-12 hex format.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
UUID of the Uploadcare file to store permanently. Must be a valid UUID in 8-4-4-4-12 hex format.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Key of file metadata. Allowed characters: Latin letters (a-z, A-Z), digits (0-9), underscore (_), hyphen (-), dot (.), colon (:).
The UUID of the file.
Value to set for the metadata key. Must be 1-512 characters.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
The numeric ID of the webhook to update. Obtain this from the List Webhooks action.
Enum for webhook event types.
Whether the webhook should be active. Set to false to temporarily disable notifications without deleting the webhook.
URL to receive webhook notifications. Must be unique for each project-event type combination. If provided, updates the target URL.
Optional HMAC/SHA-256 secret for signing webhook payloads (max 32 characters). The signature is sent in the X-Uc-Signature header.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
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'.
Public key identifying an Uploadcare project your uploads will go to.
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._
Source URL of the file to fetch and upload. Must be publicly available via HTTP/HTTPS.
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'.
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
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
Agents can call 34 Uploadcare actions on Nagent, including "Create File Group (Upload API)", "Create Uploadcare webhook" and "Get AWS Rekognition Execution Status". Create File Group (Upload API): Create a file group from already uploaded files using Uploadcare's Upload API. Each action is listed on this page with its input parameters and its output.
Uploadcare connects with an API key, under your workspace's own connection. Nothing is enabled on connect: each action is allowed one at a time and can be scoped to the agents that need it.
Create File Group (Upload API) takes 2 required inputs: files and pub_key. It also takes 2 optional inputs: expire and signature. It returns data, error and successful.