Automatically generated by the OpenAPI Generator

the client provides bindings for interacting with the imager200 API. It is auto-generated from the official open api specs: https://www.imager200.io/imager200.json

To use the API, a (free) registration is needed in order to obtain the API key.

Requirements

Building the API client library requires:

1. Java 11+
2. Maven/Gradle

The github repository: https://maven.pkg.github.com/imager200/java-sdk needs to be added to list of source repositories in Maven/Gradle.

Installation

Maven

  <repositories>
        <repository>
          <id>central</id>
          <url>https://repo1.maven.org/maven2</url>
        </repository>
        <repository>
          <id>github</id>
          <name>GitHub imager200 Apache Maven Packages</name>
          <url>https://maven.pkg.github.com/imager200/java-sdk</url>
        </repository>
      </repositories>

after adding the repo, the dependency needs to be added to the dependencies section:

<dependency>
  <groupId>io.imager200</groupId>
  <artifactId>java-sdk</artifactId>
  <version>1.0.0</version>
  <scope>compile</scope>
</dependency>

Gradle

repositories {
    maven {
        url = uri("https://maven.pkg.github.com/imager200/java-sdk")
   }
}

after adding the repo, the dependency needs to be added:

compile "io.imager200:java-sdk:1.0.0"

Getting Started

import io.imager200.*;
import io.imager200.model.*;
import io.imager200.client.BlendApi;

public class BlendApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure clients using the `defaultClient` object, such as
        // overriding the host and port, timeout, etc.
        BlendApi apiInstance = new BlendApi(defaultClient);
        BlendRequest payload = new BlendRequest(); // BlendRequest | request
        try {
            InfoResponse result = apiInstance.blendAsyncPost(payload);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BlendApi#blendAsyncPost");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Documentation for API Endpoints

All URIs are relative to https://api.imager200.io

Class	Method	HTTP request	Description
BlendApi	blendAsyncPost	POST /blend
BlendApi	blendAsyncPostWithHttpInfo	POST /blend
BlendApi	blendSyncPost	POST /blend/sync
BlendApi	blendSyncPostWithHttpInfo	POST /blend/sync
BlurApi	blurAsyncGet	GET /blur
BlurApi	blurAsyncGetWithHttpInfo	GET /blur
BlurApi	blurAsyncPost	POST /blur
BlurApi	blurAsyncPostWithHttpInfo	POST /blur
BlurApi	blurSyncGet	GET /blur/sync
BlurApi	blurSyncGetWithHttpInfo	GET /blur/sync
BlurApi	blurSyncPost	POST /blur/sync
BlurApi	blurSyncPostWithHttpInfo	POST /blur/sync
BlurhashApi	blurhashAsyncGet	GET /blurhash
BlurhashApi	blurhashAsyncGetWithHttpInfo	GET /blurhash
BlurhashApi	blurhashAsyncPost	POST /blurhash
BlurhashApi	blurhashAsyncPostWithHttpInfo	POST /blurhash
BlurhashApi	blurhashSyncGet	GET /blurhash/sync
BlurhashApi	blurhashSyncGetWithHttpInfo	GET /blurhash/sync
BlurhashApi	blurhashSyncPost	POST /blurhash/sync
BlurhashApi	blurhashSyncPostWithHttpInfo	POST /blurhash/sync
BlurpartialApi	blurpartialAsyncGet	GET /blurpartial
BlurpartialApi	blurpartialAsyncGetWithHttpInfo	GET /blurpartial
BlurpartialApi	blurpartialAsyncPost	POST /blurpartial
BlurpartialApi	blurpartialAsyncPostWithHttpInfo	POST /blurpartial
BlurpartialApi	blurpartialSyncGet	GET /blurpartial/sync
BlurpartialApi	blurpartialSyncGetWithHttpInfo	GET /blurpartial/sync
BlurpartialApi	blurpartialSyncPost	POST /blurpartial/sync
BlurpartialApi	blurpartialSyncPostWithHttpInfo	POST /blurpartial/sync
BrightnessApi	brightnessAsyncGet	GET /brightness
BrightnessApi	brightnessAsyncGetWithHttpInfo	GET /brightness
BrightnessApi	brightnessAsyncPost	POST /brightness
BrightnessApi	brightnessAsyncPostWithHttpInfo	POST /brightness
BrightnessApi	brightnessSyncGet	GET /brightness/sync
BrightnessApi	brightnessSyncGetWithHttpInfo	GET /brightness/sync
BrightnessApi	brightnessSyncPost	POST /brightness/sync
BrightnessApi	brightnessSyncPostWithHttpInfo	POST /brightness/sync
CompressApi	compressAsyncGet	GET /compress
CompressApi	compressAsyncGetWithHttpInfo	GET /compress
CompressApi	compressAsyncPost	POST /compress
CompressApi	compressAsyncPostWithHttpInfo	POST /compress
CompressApi	compressSyncGet	GET /compress/sync
CompressApi	compressSyncGetWithHttpInfo	GET /compress/sync
CompressApi	compressSyncPost	POST /compress/sync
CompressApi	compressSyncPostWithHttpInfo	POST /compress/sync
ConcatApi	concatAsyncPost	POST /concat
ConcatApi	concatAsyncPostWithHttpInfo	POST /concat
ConcatApi	concatSyncPost	POST /concat/sync
ConcatApi	concatSyncPostWithHttpInfo	POST /concat/sync
ContrastApi	contrastAsyncGet	GET /contrast
ContrastApi	contrastAsyncGetWithHttpInfo	GET /contrast
ContrastApi	contrastAsyncPost	POST /contrast
ContrastApi	contrastAsyncPostWithHttpInfo	POST /contrast
ContrastApi	contrastSyncGet	GET /contrast/sync
ContrastApi	contrastSyncGetWithHttpInfo	GET /contrast/sync
ContrastApi	contrastSyncPost	POST /contrast/sync
ContrastApi	contrastSyncPostWithHttpInfo	POST /contrast/sync
ConvertApi	convertAsyncGet	GET /convert
ConvertApi	convertAsyncGetWithHttpInfo	GET /convert
ConvertApi	convertAsyncPost	POST /convert
ConvertApi	convertAsyncPostWithHttpInfo	POST /convert
ConvertApi	convertSyncGet	GET /convert/sync
ConvertApi	convertSyncGetWithHttpInfo	GET /convert/sync
ConvertApi	convertSyncPost	POST /convert/sync
ConvertApi	convertSyncPostWithHttpInfo	POST /convert/sync
CropApi	cropAsyncGet	GET /crop
CropApi	cropAsyncGetWithHttpInfo	GET /crop
CropApi	cropAsyncPost	POST /crop
CropApi	cropAsyncPostWithHttpInfo	POST /crop
CropApi	cropSyncGet	GET /crop/sync
CropApi	cropSyncGetWithHttpInfo	GET /crop/sync
CropApi	cropSyncPost	POST /crop/sync
CropApi	cropSyncPostWithHttpInfo	POST /crop/sync
EqualizeApi	equalizeAsyncGet	GET /equalize
EqualizeApi	equalizeAsyncGetWithHttpInfo	GET /equalize
EqualizeApi	equalizeAsyncPost	POST /equalize
EqualizeApi	equalizeAsyncPostWithHttpInfo	POST /equalize
EqualizeApi	equalizeSyncGet	GET /equalize/sync
EqualizeApi	equalizeSyncGetWithHttpInfo	GET /equalize/sync
EqualizeApi	equalizeSyncPost	POST /equalize/sync
EqualizeApi	equalizeSyncPostWithHttpInfo	POST /equalize/sync
GrayscaleApi	grayscaleAsyncGet	GET /grayscale
GrayscaleApi	grayscaleAsyncGetWithHttpInfo	GET /grayscale
GrayscaleApi	grayscaleAsyncPost	POST /grayscale
GrayscaleApi	grayscaleAsyncPostWithHttpInfo	POST /grayscale
GrayscaleApi	grayscaleSyncGet	GET /grayscale/sync
GrayscaleApi	grayscaleSyncGetWithHttpInfo	GET /grayscale/sync
GrayscaleApi	grayscaleSyncPost	POST /grayscale/sync
GrayscaleApi	grayscaleSyncPostWithHttpInfo	POST /grayscale/sync
ImageinfoApi	imageinfoSyncGet	GET /imageinfo
ImageinfoApi	imageinfoSyncGetWithHttpInfo	GET /imageinfo
ImageinfoApi	imageinfoSyncPost	POST /imageinfo
ImageinfoApi	imageinfoSyncPostWithHttpInfo	POST /imageinfo
PipelineApi	pipelineGet	GET /pipeline/{name}
PipelineApi	pipelineGetWithHttpInfo	GET /pipeline/{name}
PipelineApi	pipelineGetStatus	GET /pipeline/{execution_id}/status
PipelineApi	pipelineGetStatusWithHttpInfo	GET /pipeline/{execution_id}/status
PipelineApi	pipelinePost	POST /pipeline/{name}
PipelineApi	pipelinePostWithHttpInfo	POST /pipeline/{name}
ResizeApi	resizeAsyncGet	GET /resize
ResizeApi	resizeAsyncGetWithHttpInfo	GET /resize
ResizeApi	resizeAsyncPost	POST /resize
ResizeApi	resizeAsyncPostWithHttpInfo	POST /resize
ResizeApi	resizeSyncGet	GET /resize/sync
ResizeApi	resizeSyncGetWithHttpInfo	GET /resize/sync
ResizeApi	resizeSyncPost	POST /resize/sync
ResizeApi	resizeSyncPostWithHttpInfo	POST /resize/sync
RotateApi	rotateAsyncGet	GET /rotate
RotateApi	rotateAsyncGetWithHttpInfo	GET /rotate
RotateApi	rotateAsyncPost	POST /rotate
RotateApi	rotateAsyncPostWithHttpInfo	POST /rotate
RotateApi	rotateSyncGet	GET /rotate/sync
RotateApi	rotateSyncGetWithHttpInfo	GET /rotate/sync
RotateApi	rotateSyncPost	POST /rotate/sync
RotateApi	rotateSyncPostWithHttpInfo	POST /rotate/sync
TextApi	textAsyncGet	GET /text
TextApi	textAsyncGetWithHttpInfo	GET /text
TextApi	textAsyncPost	POST /text
TextApi	textAsyncPostWithHttpInfo	POST /text
TextApi	textSyncGet	GET /text/sync
TextApi	textSyncGetWithHttpInfo	GET /text/sync
TextApi	textSyncPost	POST /text/sync
TextApi	textSyncPostWithHttpInfo	POST /text/sync

Documentation for Models

• BlendRequest
• BlurAsyncPostRequest
• BrightnessAsyncPostRequest
• CompressAsyncPostRequest
• ConcatRequest
• ErrorResponse
• ImageMetadata
• InfoResponse
• PipelineExecutionResult
• PipelinePostRequest
• PipelineStatus
• SuccessResponse

Documentation for Authorization

Authentication schemes defined for the API:

ApiKeyAuth

• Type: API key
• API key parameter name: X-Imager-Key
• Location: HTTP header

Recommendation

It's recommended to create an instance of ApiClient per thread in a multithreaded environment to avoid any potential issues. However, the instances of the api clients created from the ApiClient are thread-safe and can be re-used.

Author

contact@imager200.io