Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

ImageKit Managing assets API

The Managing assets API from ImageKit — 12 operation(s) for managing assets.

This API exposes 14 operations across 12 paths, and defines 17 schemas. It is described by OpenAPI 3.0.3, at version 1.0.0.

Requests are made against a single base URL, https://api.imagekit.io.

14 operations 12 paths 17 schemas 2 DELETE3 GET1 PATCH6 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0.0
Base URL
https://api.imagekit.io
Authentication
HTTP Basic
Terms of Service
Resource Areas
1

Authentication & Security 1

ImageKit Managing assets API declares 1 security scheme for authenticating requests. It accepts HTTP basic authentication (basicAuth). By default, every request must be authenticated.

  • basicAuth — Basic HTTP authentication. Allowed headers-- Authorization: Basic | Authorization: Basic ImageKit API uses API keys to authenticate requests. You can view and…

Paths & Operations 14

Across 12 paths, the API surfaces 14 operations — 2 DELETE, 3 GET, 1 PATCH, 6 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Managing assets 14
GET
/v1/files/{fileId}/details
Get file details
get-file-details 1 param → 429401403200404400
PATCH
/v1/files/{fileId}/details
Update file details
update-file-details 1 param body → 429401403200404400
DELETE
/v1/files/{fileId}
Delete file
delete-file 1 param → 429401403204404400
POST
/v1/files/batch/deleteByFileIds
Delete multiple files
delete-multiple-files body → 429401403200207400404
POST
/v1/files/copy
Copy file
copy-file body → 429401403204404400
POST
/v1/files/move
Move file
move-file body → 429401403204404400
PUT
/v1/files/rename
Rename file
rename-file body → 429401403200207404409400
GET
/v1/files/{fileId}/versions
List file versions
list-file-versions 1 param → 429401403200404400
GET
/v1/files/{fileId}/versions/{versionId}
Get file version details
get-file-version-details 2 params → 429401403200404400
DELETE
/v1/files/{fileId}/versions/{versionId}
Delete file version
delete-file-version 2 params → 429401403204400404
PUT
/v1/files/{fileId}/versions/{versionId}/restore
Restore file version
restore-file-version 2 params → 429401403200404400
POST
/v1/files/addTags
Add tags (bulk)
add-tags-bulk body → 429401403200207404400
POST
/v1/files/removeTags
Remove tags (bulk)
remove-tags-bulk body → 429401403200207404400
POST
/v1/files/removeAITags
Remove AI tags (bulk)
remove-ai-tags-bulk body → 429401403200207404400

Schemas 17

The contract defines 17 schemas that model the data the API accepts and returns. The most detailed are FileDetails (28 properties), AITaskSelectMetadata (6 properties), AITaskYesNo (5 properties), AITaskSelectTags (5 properties). Each schema is shown below with its type and property counts.

RemovedotBGExtension
object
2 properties 1 required
AITaskYesNo
object
5 properties 2 required
FileDetails
object
Object containing details of a file or file version.
28 properties
AutoTaggingExtension
object
3 properties 3 required
AITaskAction
object
Defines actions to perform based on AI task results.
4 properties
Extensions
array
Array of extensions to be applied to the asset. Each extension can be configured with specific parameters based on the extension type.
CustomMetadata
object
A key-value data associated with the asset.
EmbeddedMetadata
object
Consolidated embedded metadata associated with the file. It includes exif, iptc, and xmp data.
AITag
object
AI-generated tag associated with an image. These tags can be added using the google-auto-tagging or aws-auto-tagging extensions.
3 properties
AITasksExtension
object
2 properties 2 required
AutoDescriptionExtension
object
1 property 1 required
AITaskSelectTags
object
5 properties 2 required
VersionInfo
object
An object containing the file or file version's id (versionId) and name.
2 properties
SelectedFieldsSchema
object
This field is included in the response only if the Path policy feature is available in the plan. It contains schema definitions for the custom metadata fields…
UpdateFileRequest
object
Schema for update file update request.
AITaskSelectMetadata
object
6 properties 3 required
SavedExtensionReference
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

imagekit-managing-assets-api-openapi.yml Raw ↑