ImageKit icon

ImageKit

Interact with the ImageKit API

File → Upload

AI-generated

Summary

Upload a file to ImageKit using either binary data from the workflow input or by specifying a remote file URL, with optional upload parameters to customize file properties and metadata.

Inputs

  • API Version — Choose between the stable V1 or the beta V2 version of the upload API.
  • Input Data Field Name — Name of the input field containing binary file data to upload; if empty, a file URL must be provided instead.
  • File URL — URL of the file to upload; used only if no binary data is provided.
  • File Name (required) — Name to assign to the uploaded file.
  • Additional Options — Collection of optional parameters including custom coordinates for cropping, custom metadata as JSON, folder path, privacy setting, overwrite flags for AI tags, metadata, tags, and file, response fields to include in the API response, tags as comma-separated values, and whether to enforce unique file names.

Output shape

a single JSON object representing the uploaded file's metadata and details as returned from the ImageKit API

The output includes fields depending on the selected response fields option. Either binary data or a file URL must be provided to perform the upload. Errors occur if neither is given.

Examples

Example 1: Upload a file using binary data from the workflow

Set the Input Data Field Name to the binary property containing the file (default 'data'), specify the File Name, and optionally set additional upload options.

Example 2: Upload a file using a remote URL

Leave the Input Data Field Name empty, provide the File URL of the remote file, specify the File Name, and optionally set additional upload options.

Links

Discussion