ImageKit

Delete origin. DELETE /v1/accounts/origins/{id}. **Note:** This API is currently in beta. Permanently removes the origin identified by `id`. If the origin is in use by any URL‑endpoints, the API will return an error.

Delete URL‑endpoint. DELETE /v1/accounts/url-endpoints/{id}. **Note:** This API is currently in beta. Deletes the URL‑endpoint identified by `id`. You cannot delete the default URL‑endpoint created by ImageKit during account creation.

Delete a field. DELETE /v1/customMetadataFields/{id}. This API deletes a custom metadata field. Even after deleting a custom metadata field, you cannot create any new custom metadata field with the same name.

Delete file. DELETE /v1/files/{fileId}. This API deletes the file and all its file versions permanently. Note: If a file or specific transformation has been requested in the past, then the response is cached. Deleting a file does not purge the cache. You can purge the cache using purge cache API.

Delete file version. DELETE /v1/files/{fileId}/versions/{versionId}. This API deletes a non-current file version permanently. The API returns an empty response. Note: If you want to delete all versions of a file, use the delete file API.

Delete folder. DELETE /v1/folder. This will delete a folder and all its contents permanently. The API returns an empty response.

Delete saved extension. DELETE /v1/saved-extensions/{id}. This API deletes a saved extension permanently.

List origins. GET /v1/accounts/origins. **Note:** This API is currently in beta. Returns an array of all configured origins for the current account.

Get origin. GET /v1/accounts/origins/{id}. **Note:** This API is currently in beta. Retrieves the origin identified by `id`.

List URL‑endpoints. GET /v1/accounts/url-endpoints. **Note:** This API is currently in beta. Returns an array of all URL‑endpoints configured including the default URL-endpoint generated by ImageKit during account creation.

Get URL‑endpoint. GET /v1/accounts/url-endpoints/{id}. **Note:** This API is currently in beta. Retrieves the URL‑endpoint identified by `id`.

Get account usage information. GET /v1/accounts/usage. Get the account usage information between two dates. Note that the API response includes data from the start date while excluding data from the end date. In other words, the data covers the period starting from the specified start date up to, but not including, the end date. For an agency account, the returned usage is aggregated across the agency and all of its child accounts that are billed to it. The response is cached for 6 hours per account, date range and requested metrics.

Get usage analytics. GET /v1/accounts/usage-analytics. **Note:** This API is currently in beta. Get the account analytics data between two dates. The response covers the period from the start date to the end date, both dates inclusive. Both dates are interpreted as UTC calendar days. The returned data is scoped to the requesting account only. Unlike `/v1/accounts/usage`, an agency account's analytics are not aggregated across its child accounts. The response is cached for 5 minutes per account and date range. Use `generatedAt` to check how fresh the returned data is.

Bulk job status. GET /v1/bulkJobs/{jobId}. This API returns the status of a bulk job like copy and move folder operations.

List all fields. GET /v1/customMetadataFields. This API returns the array of created custom metadata field objects. By default the API returns only non deleted field objects, but you can include deleted fields in the API response. You can also filter results by a specific folder path to retrieve custom metadata fields applicable at that location. This path-specific filtering is useful when using the **Path policy** feature to determine which custom metadata fields are selected for a given path.

List and search assets. GET /v1/files. This API can list all the uploaded files and folders in your ImageKit.io media library. In addition, you can fine-tune your query by specifying various filters by generating a query string in a Lucene-like syntax and provide this generated string as the value of the `searchQuery`.

Get file details. GET /v1/files/{fileId}/details. This API returns an object with details or attributes about the current version of the file.

Get uploaded file metadata. GET /v1/files/{fileId}/metadata. You can programmatically get image EXIF, pHash, and other metadata for uploaded files in the ImageKit.io media library using this API. You can also get the metadata in upload API response by passing `metadata` in `responseFields` parameter.

List file versions. GET /v1/files/{fileId}/versions. This API returns details of all versions of a file.

Get file version details. GET /v1/files/{fileId}/versions/{versionId}. This API returns an object with details or attributes of a file version.

Get purge status. GET /v1/files/purge/{requestId}. This API returns the status of a purge cache request.

Get metadata from remote URL. GET /v1/metadata. Get image EXIF, pHash, and other metadata from ImageKit.io powered remote URL using this API.

List all saved extensions. GET /v1/saved-extensions. This API returns an array of all saved extensions for your account. Saved extensions allow you to save complex extension configurations and reuse them by referencing them by ID in upload or update file APIs.

Get saved extension details. GET /v1/saved-extensions/{id}. This API returns details of a specific saved extension by ID.

Update existing field. PATCH /v1/customMetadataFields/{id}. This API updates the label or schema of an existing custom metadata field.

Update file details. PATCH /v1/files/{fileId}/details. This API updates the details or attributes of the current version of the file. You can update `tags`, `customCoordinates`, `customMetadata`, publication status, remove existing `AITags` and apply extensions using this API.

Update saved extension. PATCH /v1/saved-extensions/{id}. This API updates an existing saved extension. You can update the name, description, or config.

Create origin. POST /v1/accounts/origins. **Note:** This API is currently in beta. Creates a new origin and returns the origin object.

Create URL‑endpoint. POST /v1/accounts/url-endpoints. **Note:** This API is currently in beta. Creates a new URL‑endpoint and returns the resulting object.

Copy folder. POST /v1/bulkJobs/copyFolder. This will copy one folder into another. The selected folder, its nested folders, files, and their versions (in `includeVersions` is set to true) are copied in this operation. Note: If any file at the destination has the same name as the source file, then the source file and its versions will be appended to the destination file version history.

Move folder. POST /v1/bulkJobs/moveFolder. This will move one folder into another. The selected folder, its nested folders, files, and their versions are moved in this operation. Note: If any file at the destination has the same name as the source file, then the source file and its versions will be appended to the destination file version history.

Rename folder. POST /v1/bulkJobs/renameFolder. This API allows you to rename an existing folder. The folder and all its nested assets and sub-folders will remain unchanged, but their paths will be updated to reflect the new folder name.

Create new field. POST /v1/customMetadataFields. This API creates a new custom metadata field. Once a custom metadata field is created either through this API or using the dashboard UI, its value can be set on the assets. The value of a field for an asset can be set using the media library UI or programmatically through upload or update assets API.

Add tags (bulk). POST /v1/files/addTags. This API adds tags to multiple files in bulk. A maximum of 50 files can be specified at a time.

Delete multiple files. POST /v1/files/batch/deleteByFileIds. This API deletes multiple files and all their file versions permanently. Note: If a file or specific transformation has been requested in the past, then the response is cached. Deleting a file does not purge the cache. You can purge the cache using purge cache API. A maximum of 100 files can be deleted at a time.

Copy file. POST /v1/files/copy. This will copy a file from one folder to another. Note: If any file at the destination has the same name as the source file, then the source file and its versions (if `includeFileVersions` is set to true) will be appended to the destination file version history.

Move file. POST /v1/files/move. This will move a file and all its versions from one folder to another. Note: If any file at the destination has the same name as the source file, then the source file and its versions will be appended to the destination file.

Purge cache. POST /v1/files/purge. This API will purge CDN cache and ImageKit.io's internal cache for a file. Note: Purge cache is an asynchronous process and it may take some time to reflect the changes.

Remove AI tags (bulk). POST /v1/files/removeAITags. This API removes AITags from multiple files in bulk. A maximum of 50 files can be specified at a time.

Remove tags (bulk). POST /v1/files/removeTags. This API removes tags from multiple files in bulk. A maximum of 50 files can be specified at a time.

Create folder. POST /v1/folder. This will create a new folder. You can specify the folder name and location of the parent folder where this new folder should be created.

Create saved extension. POST /v1/saved-extensions. This API creates a new saved extension. Saved extensions allow you to save complex extension configurations (like AI tasks) and reuse them by referencing the ID in upload or update file APIs. **Saved extension limit** \ You can create a maximum of 100 saved extensions per account.

Update origin. PUT /v1/accounts/origins/{id}. **Note:** This API is currently in beta. Updates the origin identified by `id` and returns the updated origin object.

Update URL‑endpoint. PUT /v1/accounts/url-endpoints/{id}. **Note:** This API is currently in beta. Updates the URL‑endpoint identified by `id` and returns the updated object.

Restore file version. PUT /v1/files/{fileId}/versions/{versionId}/restore. This API restores a file version as the current file version.

Rename file. PUT /v1/files/rename. You can rename an already existing file in the media library using rename file API. This operation would rename all file versions of the file. Note: The old URLs will stop working. The file/file version URLs cached on CDN will continue to work unless a purge is requested.