ImageKit Digital Asset Management (DAM) API

The Digital Asset Management (DAM) API from ImageKit — 22 operation(s) for digital asset management (dam).

Documentation Provider Profile APIs.io OpenAPI GitHub

This API exposes 30 operations across 22 paths, and defines 24 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.

30 operations 22 paths 24 schemas 5 DELETE8 GET3 PATCH12 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

Contact

ImageKit Team

View terms

Resource Areas

Authentication & Security 1

ImageKit Digital Asset Management (DAM) 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 30

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

Digital Asset Management (DAM) 30

POST

/v1/customMetadataFields

Create new field

create-new-field body → 429401403201400

GET

/v1/customMetadataFields

List all fields

list-all-fields 2 params → 429401403200

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

PATCH

/v1/customMetadataFields/{id}

Update existing field

update-existing-field 1 param body → 429401403400404200

DELETE

/v1/customMetadataFields/{id}

Delete a field

delete-a-field 1 param → 429401403400404204

GET

/v1/files

List and search assets

list-and-search-assets 7 params → 429401403200400

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

POST

/v1/folder

Create folder

create-folder body → 429401403201400

DELETE

/v1/folder

Delete folder

delete-folder body → 429401403204404400

POST

/v1/bulkJobs/copyFolder

Copy folder

copy-folder body → 429401403200404400423

POST

/v1/bulkJobs/moveFolder

Move folder

move-folder body → 429401403200404400423

POST

/v1/bulkJobs/renameFolder

Rename folder

rename-folder body → 202400401403404409423429

GET

/v1/bulkJobs/{jobId}

Bulk job status

bulk-job-status 1 param → 429401403200207404

GET

/v1/saved-extensions

List all saved extensions

list-extensions → 429401403200

POST

/v1/saved-extensions

Create saved extension

create-extension body → 429401403201400

GET

/v1/saved-extensions/{id}

Get saved extension details

get-extension 1 param → 429401403200404400

PATCH

/v1/saved-extensions/{id}

Update saved extension

update-extension 1 param body → 429401403200404400

DELETE

/v1/saved-extensions/{id}

Delete saved extension

delete-extension 1 param → 429401403204404400

Schemas 24

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

RemovedotBGExtension

object

2 properties 1 required

SavedExtension

object

Saved extension object containing extension configuration.

6 properties

SavedExtensionReference

object

2 properties 2 required

AITaskYesNo

object

5 properties 2 required

FileDetails

object

Object containing details of a file or file version.

28 properties

FolderDetails

object

7 properties

AITaskAction

object

Defines actions to perform based on AI task results.

4 properties

JobResponse

object

Job submitted successfully. A jobId will be returned.

1 property 1 required

Extensions

array

Array of extensions to be applied to the asset. Each extension can be configured with specific parameters based on the extension type.

ExtensionConfig

object

Configuration object for an extension (base extensions only, not saved extension references).

AITaskSelectMetadata

object

6 properties 3 required

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.

CreateSavedExtension

object

3 properties 3 required

CustomMetadataField

object

Object containing details of a custom metadata field.

4 properties 4 required

UpdateSavedExtension

object

3 properties

AutoTaggingExtension

object

3 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

#Digital Asset Management (DAM)

← Back to I APIs

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

ImageKit Digital Asset Management (DAM) API

Metadata

Authentication & Security 1

Paths & Operations 30

Schemas 24

Specification

Source

API Details

Provider

Explore more