ImageKit DotNET SDK allows you to use image resizing, optimization, file uploading and other ImageKit APIs from applications written in server-side C#.
- Installation
- Initialization
- URL generation
- File Upload
- File Management
- Tags
- Manage Folder
- Bulk Job Status
- Purge
- Meta Data
- Utility functions
- Support
- Links
Package Manager
Install-Package ImagekitPackageReference
<PackageReference Include="Imagekit" Version="3.1.6">
</PackageReference>.Net CLI
dotnet add package Imagekit --version 3.1.6Open up your project, navigate to the Nuget package manager console, and add the Imagekit package.
Also, you can search for Imagekit in Nuget GUI.
Add this reference where you want to use imagekit.io services:
using Imagekit;
ImageKitClient imagekit = new ImageKitClient(publicKey, privateKey, urlEndPoint);Note: You can get the apiKey, apiSecret, and ImagekitId from your Imagekit.io dashboard.
The fastest way to get started is by running the demo application in the ImageKitSample folder.
You can use this DotNET SDK for three different functions: URL generation, file uploads, and file management. The usage of the SDK has been explained below.
1. Using image path and image hostname or endpoint
This method allows you to create a URL using the path where the image exists and the URL endpoint (urlEndpoint) you want to use to access the image. You can refer to the documentation here to read more about URL endpoints in ImageKit and the section about image origins to understand paths with different kinds of origins.
string path = "/default-image.jpg";
Transformation trans = new Transformation()
.Width(400)
.Height(300)
.AspectRatio("4-3")
.Quality(40)
.Crop("force")
.CropMode("extract")
.Focus("left")
.Format("jpeg")
.Raw("h-200).w-300).l-image).i-logo.png).l-end");
string imageURL = imagekit.Url(trans).Path(path).TransformationPosition("query").Generate(); This results in a URL like
https://ik.imagekit.io/default-image.jpg?tr=w-400%2Ch-300%2Car-4-3%2Cq-40%2Cc-force%2Ccm-extract%2Cfo-left%2Cf-jpeg%2Ch-200%29.w-300%29.l-image%29.i-logo.png%29.l-end
2. Using full image URL
This method allows you to add transformation parameters to an existing, complete URL that is already mapped to ImageKit using the src parameter. This method should be used if you have the complete URL mapped to ImageKit stored in your database.
string imageURL = imagekit.Url(new Transformation().Width(400).Height(300))
.Src("https://ik.imagekit.io/your_imagekit_id/endpoint/default-image.jpg")
.Generate();This results in a URL like
https://ik.imagekit.io/your_imagekit_id/endpoint/default-image.jpg?tr=h-300,w-400
The .Url() method accepts the following parameters.
| Option | Description |
|---|---|
| urlEndpoint | Optional. The base URL has to be appended before the path of the image. If not specified, the URL Endpoint specified at the time of SDK initialization is used. For example, https://ik.imagekit.io/your_imagekit_id/endpoint/ |
| path | Conditional. This is the path on which the image exists. For example, /path/to/image.jpg. Either the path or src parameter needs to be specified for URL generation. |
| src | Conditional. This is the complete URL of an image already mapped to ImageKit. For example, https://ik.imagekit.io/your_imagekit_id/endpoint/path/to/image.jpg. Either the path or src parameter needs to be specified for URL generation. |
| transformation | Optional. An array of objects specifying the transformation to be applied in the URL. The transformation name and the value should be specified as a key-value pair in the object. Different steps of a chained transformation can be specified as the array's different objects. The complete list of supported transformations in the SDK and some examples of using them are given later. If you use a transformation name that is not specified in the SDK, it gets applied as it is in the URL. |
| transformationPosition | Optional. The default value is path that places the transformation string as a URL path parameter. It can also be specified as query, which adds the transformation string as the URL's query parameter tr. If you use the src parameter to create the URL, then the transformation string is always added as a query parameter. |
| queryParameters | Optional. These are the other query parameters that you want to add to the final URL. These can be any query parameters and not necessarily related to ImageKit. Especially useful if you want to add some versioning parameters to your URLs. |
| signed | Optional. Boolean. Default is false. If set to false, the SDK generates a signed image URL by adding the image signature to the image URL. This can only be used if you create the URL with the urlEndpoint and path parameters, not with the src parameter. |
| expireSeconds | Optional. Integer. It is meant to be used along with the signed parameter to specify the time in seconds from now when the URL should expire. If specified, the URL contains the expiry timestamp in the URL, and the image signature is modified accordingly. |
1. Chained Transformations as a query parameter
Transformation transformation = new Transformation()
.Width(400).Height(300)
.Chain()
.Rotation(90);
string imageURL = imagekit.Url(transformation)
.Path("/default-image.jpg")
.UrlEndpoint("https://ik.imagekit.io/your_imagekit_id/endpoint")
.TransformationPosition("query")
.Generate();https://ik.imagekit.io/your_imagekit_id/endpoint/default-image.jpg?tr=h-300,w-400:rt-90
2. Sharpening and contrast transforms and a progressive JPG image
There are some transforms like Sharpening that can be added to the URL with or without any other value.
string src = "https://ik.imagekit.io/your_imagekit_id/endpoint/default-image.jpg";
Transformation trans = new Transformation()
.Format("jpg")
.Progressive(false)
.EffectSharpen()
.EffectContrast(1);
string imageURL = imagekit.Url(trans)
.Src(src)
.Generate();Note: Because src parameter was used, the transformation string gets added as a query parameter tr.
https://ik.imagekit.io/your_imagekit_id/endpoint/default-image.jpg?tr=f-jpg,pr-false,e-sharpen,e-contrast-1
3. Signed URL that expires in 300 seconds with the default URL endpoint and other query parameters
Transformation trans = new Transformation()
.Height(300).Width(400);
string[] queryParams = { "v = 123" };
string imageURL = imagekit.Url(trans)
.Path("/default-image.jpg")
.QueryParameters(queryParams)
.Signed(false).ExpireSeconds(300)
.Generate();https://ik.imagekit.io/your_imagekit_id/tr:h-300,w-400/default-image.jpg?v=123&ik-t=1567358667&ik-s=f2c7cdacbe7707b71a83d49cf1c6110e3d701054
The complete list of transformations supported and their usage in ImageKit can be found here. The SDK gives a name to each transformation parameter, making the code simpler and more readable. If a transformation is supported in ImageKit, but a name for it cannot be found in the table below, then use the transformation code from ImageKit docs as the name when using the url function.
| Supported Transformation Name | Translates to parameters |
|---|---|
| Height | h |
| Width | w |
| AspectRatio | ar |
| Quality | q |
| Crop | c |
| CropMode | cm |
| X | x |
| Y | y |
| Focus | fo |
| Format | f |
| Radius | r |
| Background | bg |
| Border | b |
| Rotation | rt |
| Blur | bl |
| Named | n |
| OverlayX | ox |
| OverlayY | oy |
| OverlayFocus | ofo |
| OverlayHeight | oh |
| OverlayWidth | ow |
| OverlayImage | oi |
| OverlayImageTrim | oit |
| OverlayImageAspectRatio | oiar |
| OverlayImageBackground | oibg |
| OverlayImageBorder | oib |
| OverlayImageDPR | oidpr |
| OverlayImageQuality | oiq |
| OverlayImageCropping | oic |
| OverlayImageTrim | oit |
| OverlayText | ot |
| OverlayTextFontSize | ots |
| OverlayTextFontFamily | otf |
| OverlayTextColor | otc |
| OverlayTextTransparency | oa |
| OverlayAlpha | oa |
| OverlayTextTypography | ott |
| OverlayBackground | obg |
| OverlayTextEncoded | ote |
| OverlayTextWidth | otw |
| OverlayTextBackground | otbg |
| OverlayTextPadding | otp |
| OverlayTextInnerAlignment | otia |
| OverlayRadius | or |
| Progressive | pr |
| Lossless | lo |
| Trim | t |
| Metadata | md |
| ColorProfile | cp |
| DefaultImage | di |
| Dpr | dpr |
| EffectSharpen | e-sharpen |
| EffectUSM | e-usm |
| EffectContrast | e-contrast |
| EffectGray | e-grayscale |
| Original | orig |
| Raw | replaced by the parameter value |
The SDK provides a simple interface using the .upload() method to upload files to the ImageKit Media Library. It accepts all the parameters supported by the ImageKit Upload API.
The upload() method requires at least the file and the fileName parameter to upload a file. You can pass other parameters supported by the ImageKit upload API using the same parameter name as specified in the upload API documentation. For example, to specify tags for a file at the time of upload, use the tags parameter as specified in the documentation here.
Sample usage
// Upload By URI
FileCreateRequest request = new FileCreateRequest
{
Url = new Uri(@"http://www.google.com/images/logos/ps_logo2.png"),
FileName = "test.jpg",
};
Result resp1 = imagekit.Upload(request);
// Upload by bytes
byte[] bytes = System.IO.File.ReadAllBytes(@"image file path");
FileCreateRequest ob = new FileCreateRequest
{
Bytes = bytes,
FileName = Guid.NewGuid().ToString(),
};
Result resp2 = imagekit.Upload(ob);
//Get Base64
byte[] imageArray = System.IO.File.ReadAllBytes(@"image file path");
string base64ImageRepresentation = Convert.ToBase64String(imageArray);
// Upload by Base64
FileCreateRequest ob2 = new FileCreateRequest
{
Base64 = base64ImageRepresentation,
FileName = Guid.NewGuid().ToString(),
};
Result resp = imagekit.Upload(ob2); Note: Upload argument can be a local fullPath or URL or byte array (byte[]) or Base64String of a file.
The SDK provides a simple interface for all the media APIs mentioned here to manage your files.
1 . List & Search Files
Accepts an object specifying the parameters to be used to list and search files. All parameters specified in the documentation here can be passed as it is with the correct values to get the results.
GetFileListRequest ob = new GetFileListRequest();
ob.limit = 10;
ob.skip = 0;
ResultList resp = await imagekit.GetFileListRequestAsync(ob);2. Get File Details
Accepts the file ID and fetches the details as per the API documentation here.
Result resp = await imagekit.GetFileDetailsAsync(fileId);3. Get File Versions
Accepts the file ID and fetches the details as per the API documentation here.
String fileId = "file-id-1";
ResultFileVersions resultFileVersions = imageKit.getFileVersions(fileId);4. Get File Version details
Accepts the file ID and version ID and fetches the details as per the API documentation here.
String fileId = "file-id-1";
String versionId = "file-version-id-1";
ResultFileVersionDetails resultFileVersionDetails = imageKit.getFileVersionDetails(fileId, versionId);5. Update File Details
Accepts an object of class FileUpdateRequest specifying the parameters to be used to update file details. All parameters specified in the [documentation here] (https://docs.imagekit.io/api-reference/media-api/update-file-details) can be passed via their setter functions to get the results.
List<String> tags = new ArrayList<>();
tags.add("tag-1");
tags.add("tag-2");
tags.add("tag-3");
List<String> aiTags = new ArrayList<>();
aiTags.add("ai-tag-1");
FileUpdateRequest fileUpdateRequest = new FileUpdateRequest("fileId");
fileUpdateRequest.Tags = tags;
fileUpdateRequest.AITags = aiTags;
UpdateFileDetail result = imageKit.updateFileDetail(fileUpdateRequest); 6. Delete File
Accept the file ID and delete a file as per the API documentation here.
String fileId = "file-id-1";
Result result = imageKit.deleteFile(fileId);7. Delete FileVersion
Accepts an object of class DeleteFileVersionRequest specifying the parameters to be used to delete the file version. All parameters specified in the documentation here can be passed via their setter functions to get the results.
DeleteFileVersionRequest deleteFileVersionRequest = new DeleteFileVersionRequest();
deleteFileVersionRequest.FileId = "file-id-1";
deleteFileVersionRequest.VersionId = "file-version-id-1";
ResultNoContent resultNoContent = imageKit.deleteFileVersion(deleteFileVersionRequest);8. Delete files (bulk)
Accepts the file IDs to delete files as per the API documentation here.
List<String> fileIds = new ArrayList<>();
fileIds.add("file-id-1");
fileIds.add("file-id-2");
fileIds.add("file-id-3");
ResultFileDelete result = imageKit.bulkDeleteFiles(fileIds);9. Copy file
Accepts an object of class CopyFileRequest specifying the parameters to be used to copy a file. All parameters specified in the documentation here can be passed via their setter functions to get the results.
CopyFileRequest copyFileRequest = new CopyFileRequest();
copyFileRequest.SourceFilePath = "/w2_image.png";
copyFileRequest.DestinationPath = "/Gallery/";
copyFileRequest.IncludeFileVersions = false;
ResultNoContent resultNoContent = imageKit.copyFile(copyFileRequest);10. Move file
Accepts an object of class MoveFileRequest specifying the parameters to be used to move a file. All parameters specified in the documentation here can be passed via their setter functions to get the results.
MoveFileRequest moveFileRequest = new MoveFileRequest();
moveFileRequest.SourceFilePath="/Gallery/w2_image.png";
moveFileRequest.DestinationPath="/";
ResultNoContent resultNoContent = imageKit.moveFile(moveFileRequest);11. Rename file
Accepts an object of class RenameFileRequest specifying the parameters to be used to rename a file. All parameters specified in the documentation here can be passed via their setter functions to get the results.
RenameFileRequest renameFileRequest = new RenameFileRequest();
renameFileRequest.FilePath = "/w2_image.png";
renameFileRequest.NewFileName = "w2_image_s.png";
renameFileRequest.PurgeCache = false;
ResultRenameFile resultRenameFile = imageKit.renameFile(renameFileRequest); 12. Restore file Version
Accepts the fileId and versionId to restore the file version as per the API documentation here.
Result result = imageKit.restoreFileVersion("fileId", "versionId");The SDK provides a simple interface to manage your tags.
13. Add tags
Accepts an object of class TagsRequest specifying the parameters to be used to add tags. All parameters specified in the documentation here can be passed via their setter functions to get the results.
List<String> fileIds = new ArrayList<>();
fileIds.add("FileId");
List<String> tags = new ArrayList<>();
tags.add("tag-to-add-1");
tags.add("tag-to-add-2");
ResultTags resultTags = imageKit.addTags(new TagsRequest(fileIds, tags));14. Remove tags
Accepts an object of class TagsRequest specifying the parameters to be used to remove tags. All parameters specified in the documentation here can be passed via their setter functions to get the results.
List<String> fileIds = new ArrayList<>();
fileIds.add("FileId");
List<String> tags = new ArrayList<>();
tags.add("tag-to-remove-1");
tags.add("tag-to-remove-2");
ResultTags resultTags = imageKit.removeTags(new TagsRequest(fileIds, tags));15. Remove AI tags
Accepts an object of class AITagsRequest specifying the parameters to be used to remove AI tags. All parameters specified in the documentation here can be passed via their setter functions to get the results.
List<String> fileIds = new ArrayList<>();
fileIds.add("file-id-1");
List<String> aiTags = new ArrayList<>();
aiTags.add("Rectangle");
AITagsRequest aiTagsRequest = new AITagsRequest();
aiTagsRequest.FileIds = fileIds;
aiTagsRequest.AITags = aiTags;
ResultTags resultTags = imageKit.getInstance().removeAITags(aiTagsRequest);16. Create Folder
Accepts an object of class CreateFolderRequest specifying the parameters to be used to create a folder. All parameters specified in the documentation here can be passed via their setter functions to get the results.
CreateFolderRequest createFolderRequest = new CreateFolderRequest();
createFolderRequest.FolderName = "test1";
createFolderRequest.ParentFolderPath = "/";
ResultEmptyBlock resultEmptyBlock = imageKit.createFolder(createFolderRequest);17. Copy Folder
Accepts an object of class CopyFolderRequest specifying the parameters to be used to copy a folder. All parameters specified in the documentation here can be passed via their setter functions to get the results.
CopyFolderRequest copyFolderRequest = new CopyFolderRequest();
copyFolderRequest.SourceFolderPath = "/Gallery/test";
copyFolderRequest.DestinationPath = "/";
ResultOfFolderActions resultOfFolderActions = imageKit.copyFolder(copyFolderRequest);18. Move Folder
Accepts an object of class MoveFolderRequest specifying the parameters to be used to move a folder. All parameters specified in the documentation here can be passed via their setter functions to get the results.
MoveFolderRequest moveFolderRequest = new MoveFolderRequest();
moveFolderRequest.SourceFolderPath = "/Gallery/test";
moveFolderRequest.DestinationPath = "/";
ResultOfFolderActions resultOfFolderActions = imageKit.moveFolder(moveFolderRequest);19. Delete Folder
Accepts an object of class DeleteFolderRequest specifying the parameters to be used to delete a folder. All parameters specified in the documentation here can be passed via their setter functions to get the results.
DeleteFolderRequest deleteFolderRequest = new DeleteFolderRequest();
deleteFolderRequest.FolderPath = "/test1";
ResultNoContent resultNoContent = imageKit.deleteFolder(deleteFolderRequest);20. Get Bulk Job Status
Accepts the jobId to get bulk job status as per the API documentation here.
String jobId = "job-id-1";
ResultBulkJobStatus resultBulkJobStatus = imageKit.getBulkJobStatus(jobId);21. Purge Cache
Accepts a full URL of the file for which the cache has to be cleared as per the API documentation here.
ResultCache result = imageKit.purgeCache("https://ik.imageKit.io/imagekit-id/default-image.jpg");22. Purge Cache Status
Accepts a request ID and fetch purge cache status as per the API documentation here
String requestId = "cache-requestId";
ResultCacheStatus result = imageKit.getPurgeCacheStatus(requestId);Accepts the file ID and fetches the metadata as per the API documentation here
23. Get File Metadata
String fileId = "file-id";
ResultMetaData result = imageKit.getFileMetadata(fileId);Another way to get metadata from a remote file URL as per the API documentation here. This file should be accessible over the imageKit.io URL-endpoint.
String url = "Remote File URL";
ResultMetaData result = imageKit.getRemoteFileMetadata(url);24. Create Custom MetaData Fields
Accepts an object of class CustomMetaDataFieldCreateRequest specifying the parameters to be used to create cusomMetaDataFields. All parameters specified in the documentation here can be passed as-is with the correct values to get the results.
Check for the Allowed Values In The Schema.
CustomMetaDataFieldSchemaObject schemaObject = new CustomMetaDataFieldSchemaObject();
schemaObject.Type = "Number";
schemaObject.MinValue = 10;
schemaObject.MaxValue = 200;
CustomMetaDataFieldCreateRequest customMetaDataFieldCreateRequest = new CustomMetaDataFieldCreateRequest();
customMetaDataFieldCreateRequest.Name = "Name";
customMetaDataFieldCreateRequest.Label = "Label";
customMetaDataFieldCreateRequest.Schema = schemaObject;
ResultCustomMetaDataFieldList ResponseMetaData = imageKit.createCustomMetaDataFields(customMetaDataFieldCreateRequest);- Date type Example:
CustomMetaDataFieldSchemaObject customMetaDataFieldSchemaObject = new CustomMetaDataFieldSchemaObject();
customMetaDataFieldSchemaObject.setType = "Date";
// required if isValueRequired set to false
customMetaDataFieldSchemaObject.MinValue = "2022-11-30T10:11:10+00:00";
customMetaDataFieldSchemaObject.MaxValue = "2022-12-30T10:11:10+00:00";
CustomMetaDataFieldCreateRequest customMetaDataFieldCreateRequest = new CustomMetaDataFieldCreateRequest();
customMetaDataFieldCreateRequest.Name = "Name";
customMetaDataFieldCreateRequest.Label = "Label";
customMetaDataFieldCreateRequest.Schema = customMetaDataFieldSchemaObject;
ResultCustomMetaDataField resultCustomMetaDataField = imageKit.getInstance()
.createCustomMetaDataFields(customMetaDataFieldCreateRequest);25. Get CustomMetaDataFields
Accepts the includeDeleted boolean and fetches the metadata as per the API documentation here
ResultCustomMetaDataFieldList resultCustomMetaDataFieldList = imageKit.getCustomMetaDataFields(false); 26. Edit Custom MetaData Fields
Accepts an ID of customMetaDataField and an object of class CustomMetaDataFieldUpdateRequest specifying the parameters to be used to edit cusomMetaDataFields as per the API documentation here.
CustomMetaDataFieldSchemaObject schemaObject = new CustomMetaDataFieldSchemaObject();
schemaObject.setMinValue(10);
schemaObject.setMaxValue(200);
CustomMetaDataFieldUpdateRequest customMetaDataFieldUpdateRequest = new CustomMetaDataFieldUpdateRequest();
customMetaDataFieldUpdateRequest.Id = "id";
customMetaDataFieldUpdateRequest.Label = "label";
customMetaDataFieldUpdateRequest.Schema = schemaObject;
ResultCustomMetaDataField resultCustomMetaDataField = imageKit.updateCustomMetaDataFields(customMetaDataFieldUpdateRequest);27. Delete Custom MetaData Fields
Accepts the id to delete the customMetaDataFields as per the API documentation here.
ResultNoContent resultNoContent = imageKit.DeleteCustomMetaDataField("id");We have included the following commonly used utility functions in this library.
If you are looking to implement client-side file upload, you will need a token, expiry timestamp, and a valid signature for that upload. The SDK provides a simple method that you can use in your code to generate these authentication parameters for you.
Note: The Private API Key should never be exposed in any client-side code. You must always generate these authentication parameters on the server-side
AuthParamResponse resp = imageKit.GetAuthenticationParameters();Returns
{
"token" : "unique_token",
"expire" : "valid_expiry_timestamp",
"signature" : "generated_signature"
}Both the token and expire parameters are optional. If not specified, the SDK uses the uuid package to generate a random token and also generates a valid expiry timestamp internally. The value of the token and expire used to generate the signature is always returned in the response, no matter if they are provided as an input to this method or not.
Perceptual hashing allows you to construct a hash value that uniquely identifies an input image based on an image's contents. imageKit.io metadata API returns the pHash value of an image in the response. You can use this value to find a duplicate (or similar) image by calculating the distance between the two images' pHash value.
This SDK exposes PHashDistance function to calculate the distance between two pHash values. It accepts two pHash hexadecimal strings and returns a numeric value indicative of the level of difference between the two images.
public static int CalculateDistance() {
// asynchronously fetch metadata of two uploaded image files
// ...
// Extract pHash strings from both: say 'firstHash' and 'secondHash'
// ...
// Calculate the distance between them:
int distance = imageKit.PHashDistance(firstHash, secondHash);
return distance;
}imageKit.PHashDistance('firstHash', 'secondHash');
// output: 0 (same image)
imageKit.PHashDistance('firstHash', 'secondHash');
// output: 17 (similar images)
imageKit.PHashDistance('firstHash', 'secondHash');
// output: 37 (dissimilar images)Catch and respond to invalid data, internal problems, and more.
Imagekit .Net SDK raises exceptions for many reasons, such as being not found, invalid parameters, authentication errors, and internal server errors. We recommend writing code that gracefully handles all possible API exceptions.
try {
// Use ImageKit's SDK to make requests...
} catch (BadRequestException e) {
// Missing or Invalid parameters were supplied to Imagekit.io's API
Console.Writeline("Status is: " + e.getResponseMetaData().getHttpStatusCode());
Console.Writeline("Message is: " + e.getMessage());
} catch (UnauthorizedException e) {
// No valid API key was provided.
} catch (ForbiddenException e) {
// Can be for the following reasons:
// ImageKit could not authenticate your account with the keys provided.
// An expired key (public or private) was used with the request.
// The account is disabled.
// If you are using the upload API, the total storage limit (or upload limit) is exceeded.
} catch (InternalServerException e) {
// Something went wrong with ImageKit.io API.
} catch (PartialSuccessException e) {
// Error cases on partial success.
} catch (NotFoundException e) {
// If any of the field or parameter is not found in data
} catch (UnknownException e) {
// Something else happened, which can be unrelated to imagekit, reason will be indicated in the message field
}For any feedback or to report any issues or general implementation support, please reach out to [email protected]
This project is licensed under the MIT License - see the LICENSE File for details