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 Upload File API

The Upload File API from ImageKit — 2 operation(s) for upload file.

This API exposes 2 operations across 2 paths, and defines 25 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.

2 operations 2 paths 25 schemas 2 POST

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 Upload File 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 2

Across 2 paths, the API surfaces 2 operations — 2 POST. Each is listed below with its method, path, parameters, and response codes.

Upload File 2
POST
/api/v1/files/upload
Upload file V1
upload-file body → 401403200202400
POST
/api/v2/files/upload
Upload file V2
upload-file-v2 body → 401403200202400

Schemas 25

The contract defines 25 schemas that model the data the API accepts and returns. The most detailed are ExifDetails (34 properties), Upload (25 properties), FileUploadV1 (23 properties), FileUploadV2 (20 properties). Each schema is shown below with its type and property counts.

RemovedotBGExtension
object
2 properties 1 required
Gps
object
Object containing GPS information.
11 properties
ExifImage
object
Object containing EXIF image information.
14 properties
AITaskYesNo
object
5 properties 2 required
Thumbnail
object
Object containing Thumbnail information.
6 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.
FileUploadV2
object
20 properties 2 required
AITaskSelectMetadata
object
6 properties 3 required
Metadata
object
JSON object containing metadata.
14 properties
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.
TransformationObject
object
Configure pre-processing (pre) and post-processing (post) transformations. - pre — applied before the file is uploaded to the Media Library. Useful for reducin…
2 properties
FileUploadV1
object
23 properties 2 required
Upload
object
Object containing details of a successful upload.
25 properties
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…
ExifDetails
object
Object containing Exif details.
34 properties
Interoperability
object
JSON object.
2 properties
SavedExtensionReference
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

imagekit-upload-file-api-openapi.yml Raw ↑