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 Dummy Test API

The Dummy Test API from ImageKit — 1 operation(s) for dummy test.

This API exposes 1 operation across 1 path, and defines 30 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.

1 operations 1 paths 30 schemas 1 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 Dummy Test 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 1

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

Dummy Test 1
POST
/v1/dummy/test
Dummy test endpoint using all shared models
create-dummy-test body → 204400401403

Schemas 30

The contract defines 30 schemas that model the data the API accepts and returns. The most detailed are Transformation (55 properties), TextOverlayTransformation (13 properties), SubtitleOverlayTransformation (7 properties), SrcOptions (7 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
SolidColorOverlay
SavedExtensionReference
object
2 properties 2 required
SubtitleOverlayTransformation
object
Subtitle styling options. [Learn more](https://imagekit.io/docs/add-overlays-on-videosstyling-controls-for-subtitles-layer) from the docs.
7 properties
SrcOptions
object
Options for generating ImageKit URLs with transformations. See the [Transformations guide](https://imagekit.io/docs/transformations).
7 properties 2 required
TransformationPosition
string
By default, the transformation string is added as a query parameter in the URL, e.g., ?tr=w-100,h-100. If you want to add the transformation string in the path…
SolidColorOverlayTransformation
object
6 properties
AITaskYesNo
object
5 properties 2 required
Transformation
object
The SDK provides easy-to-use names for transformations. These names are converted to the corresponding transformation string before being added to the URL. SDK…
55 properties
TextOverlayTransformation
object
13 properties
AITaskAction
object
Defines actions to perform based on AI task results.
4 properties
VideoOverlay
ResponsiveImageAttributes
object
Resulting set of attributes suitable for an HTML element. Useful for enabling responsive image loading with srcSet and sizes.
4 properties 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).
OverlayPosition
object
6 properties
OverlayTiming
object
3 properties
Overlay
Specifies an overlay to be applied on the parent image or video. ImageKit supports overlays including images, text, videos, subtitles, and solid colors. See [O…
StreamingResolution
string
Available streaming resolutions for [adaptive bitrate streaming](https://imagekit.io/docs/adaptive-bitrate-streaming)
GetImageAttributesOptions
object
Options for generating responsive image attributes including src, srcSet, and sizes for HTML elements. This schema extends SrcOptions to add support for respon…
TextOverlay
SubtitleOverlay
AITasksExtension
object
2 properties 2 required
AutoDescriptionExtension
object
1 property 1 required
AITaskSelectTags
object
5 properties 2 required
ImageOverlay
AITaskSelectMetadata
object
6 properties 3 required
BaseOverlay
object
3 properties
AutoTaggingExtension
object
3 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

imagekit-dummy-test-api-openapi.yml Raw ↑