CropApi

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

Method	HTTP request	Description
cropAsyncGet	GET /crop
cropAsyncGetWithHttpInfo	GET /crop
cropAsyncPost	POST /crop
cropAsyncPostWithHttpInfo	POST /crop
cropSyncGet	GET /crop/sync
cropSyncGetWithHttpInfo	GET /crop/sync
cropSyncPost	POST /crop/sync
cropSyncPostWithHttpInfo	POST /crop/sync

cropAsyncGet

InfoResponse cropAsyncGet(url, x0, x1, y0, y1)

Example

// Import classes:
import io.imager200.ApiClient;
import io.imager200.ApiException;
import io.imager200.Configuration;
import io.imager200.auth.*;
import io.imager200.models.*;
import io.imager200.client.CropApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("https://api.imager200.io");
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        CropApi apiInstance = new CropApi(defaultClient);
        String url = "url_example"; // String | image url, supported formats jpeg,png,bmp,gif
        Integer x0 = 56; // Integer | the x coordinate of the first point of the rectangle to crop.
        Integer x1 = 56; // Integer | the x coordinate of the second point of the rectangle to crop.
        Integer y0 = 56; // Integer | the y coordinate of the first point of the rectangle to crop.
        Integer y1 = 56; // Integer | the y coordinate of the second point of the rectangle to crop.
        try {
            InfoResponse result = apiInstance.cropAsyncGet(url, x0, x1, y0, y1);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CropApi#cropAsyncGet");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Parameters

Name	Type	Description
url	String	image url, supported formats jpeg,png,bmp,gif
x0	Integer	the x coordinate of the first point of the rectangle to crop.
x1	Integer	the x coordinate of the second point of the rectangle to crop.
y0	Integer	the y coordinate of the first point of the rectangle to crop.
y1	Integer	the y coordinate of the second point of the rectangle to crop.

Return type

InfoResponse

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
201	Created	* Location - the temporary url of an image in case a post operation id is not provided
400	Bad Request	-

cropAsyncGetWithHttpInfo

ApiResponse cropAsyncGet cropAsyncGetWithHttpInfo(url, x0, x1, y0, y1)

Example

// Import classes:
import io.imager200.ApiClient;
import io.imager200.ApiException;
import io.imager200.ApiResponse;
import io.imager200.Configuration;
import io.imager200.auth.*;
import io.imager200.models.*;
import io.imager200.client.CropApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("https://api.imager200.io");
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        CropApi apiInstance = new CropApi(defaultClient);
        String url = "url_example"; // String | image url, supported formats jpeg,png,bmp,gif
        Integer x0 = 56; // Integer | the x coordinate of the first point of the rectangle to crop.
        Integer x1 = 56; // Integer | the x coordinate of the second point of the rectangle to crop.
        Integer y0 = 56; // Integer | the y coordinate of the first point of the rectangle to crop.
        Integer y1 = 56; // Integer | the y coordinate of the second point of the rectangle to crop.
        try {
            ApiResponse<InfoResponse> response = apiInstance.cropAsyncGetWithHttpInfo(url, x0, x1, y0, y1);
            System.out.println("Status code: " + response.getStatusCode());
            System.out.println("Response headers: " + response.getHeaders());
            System.out.println("Response body: " + response.getData());
        } catch (ApiException e) {
            System.err.println("Exception when calling CropApi#cropAsyncGet");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Response headers: " + e.getResponseHeaders());
            System.err.println("Reason: " + e.getResponseBody());
            e.printStackTrace();
        }
    }
}

Parameters

Name	Type	Description
url	String	image url, supported formats jpeg,png,bmp,gif
x0	Integer	the x coordinate of the first point of the rectangle to crop.
x1	Integer	the x coordinate of the second point of the rectangle to crop.
y0	Integer	the y coordinate of the first point of the rectangle to crop.
y1	Integer	the y coordinate of the second point of the rectangle to crop.

Return type

ApiResponse<InfoResponse>

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
201	Created	* Location - the temporary url of an image in case a post operation id is not provided
400	Bad Request	-

cropAsyncPost

InfoResponse cropAsyncPost(x0, x1, y0, y1, body)

Example

// Import classes:
import io.imager200.ApiClient;
import io.imager200.ApiException;
import io.imager200.Configuration;
import io.imager200.auth.*;
import io.imager200.models.*;
import io.imager200.client.CropApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("https://api.imager200.io");
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        CropApi apiInstance = new CropApi(defaultClient);
        Integer x0 = 56; // Integer | the x coordinate of the first point of the rectangle to crop.
        Integer x1 = 56; // Integer | the x coordinate of the second point of the rectangle to crop.
        Integer y0 = 56; // Integer | the y coordinate of the first point of the rectangle to crop.
        Integer y1 = 56; // Integer | the y coordinate of the second point of the rectangle to crop.
        File body = new File("/path/to/file"); // File | image binary data, acceptable formats: jpeg,png,bmp,gif
        try {
            InfoResponse result = apiInstance.cropAsyncPost(x0, x1, y0, y1, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CropApi#cropAsyncPost");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Parameters

Name	Type	Description
x0	Integer	the x coordinate of the first point of the rectangle to crop.
x1	Integer	the x coordinate of the second point of the rectangle to crop.
y0	Integer	the y coordinate of the first point of the rectangle to crop.
y1	Integer	the y coordinate of the second point of the rectangle to crop.
body	File	image binary data, acceptable formats: jpeg,png,bmp,gif

Return type

InfoResponse

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: application/octet-stream
Accept: application/json

HTTP response details

Status code	Description	Response headers
201	Created	* Location - the temporary url of an image in case a post operation id is not provided
400	Bad Request	-

cropAsyncPostWithHttpInfo

ApiResponse cropAsyncPost cropAsyncPostWithHttpInfo(x0, x1, y0, y1, body)

Example

// Import classes:
import io.imager200.ApiClient;
import io.imager200.ApiException;
import io.imager200.ApiResponse;
import io.imager200.Configuration;
import io.imager200.auth.*;
import io.imager200.models.*;
import io.imager200.client.CropApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("https://api.imager200.io");
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        CropApi apiInstance = new CropApi(defaultClient);
        Integer x0 = 56; // Integer | the x coordinate of the first point of the rectangle to crop.
        Integer x1 = 56; // Integer | the x coordinate of the second point of the rectangle to crop.
        Integer y0 = 56; // Integer | the y coordinate of the first point of the rectangle to crop.
        Integer y1 = 56; // Integer | the y coordinate of the second point of the rectangle to crop.
        File body = new File("/path/to/file"); // File | image binary data, acceptable formats: jpeg,png,bmp,gif
        try {
            ApiResponse<InfoResponse> response = apiInstance.cropAsyncPostWithHttpInfo(x0, x1, y0, y1, body);
            System.out.println("Status code: " + response.getStatusCode());
            System.out.println("Response headers: " + response.getHeaders());
            System.out.println("Response body: " + response.getData());
        } catch (ApiException e) {
            System.err.println("Exception when calling CropApi#cropAsyncPost");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Response headers: " + e.getResponseHeaders());
            System.err.println("Reason: " + e.getResponseBody());
            e.printStackTrace();
        }
    }
}

Parameters

Name	Type	Description
x0	Integer	the x coordinate of the first point of the rectangle to crop.
x1	Integer	the x coordinate of the second point of the rectangle to crop.
y0	Integer	the y coordinate of the first point of the rectangle to crop.
y1	Integer	the y coordinate of the second point of the rectangle to crop.
body	File	image binary data, acceptable formats: jpeg,png,bmp,gif

Return type

ApiResponse<InfoResponse>

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: application/octet-stream
Accept: application/json

HTTP response details

Status code	Description	Response headers
201	Created	* Location - the temporary url of an image in case a post operation id is not provided
400	Bad Request	-

cropSyncGet

File cropSyncGet(url, x0, x1, y0, y1)

Example

// Import classes:
import io.imager200.ApiClient;
import io.imager200.ApiException;
import io.imager200.Configuration;
import io.imager200.auth.*;
import io.imager200.models.*;
import io.imager200.client.CropApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("https://api.imager200.io");
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        CropApi apiInstance = new CropApi(defaultClient);
        String url = "url_example"; // String | image url, supported formats jpeg,png,bmp,gif
        Integer x0 = 56; // Integer | the x coordinate of the first point of the rectangle to crop.
        Integer x1 = 56; // Integer | the x coordinate of the second point of the rectangle to crop.
        Integer y0 = 56; // Integer | the y coordinate of the first point of the rectangle to crop.
        Integer y1 = 56; // Integer | the y coordinate of the second point of the rectangle to crop.
        try {
            File result = apiInstance.cropSyncGet(url, x0, x1, y0, y1);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CropApi#cropSyncGet");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Parameters

Name	Type	Description
url	String	image url, supported formats jpeg,png,bmp,gif
x0	Integer	the x coordinate of the first point of the rectangle to crop.
x1	Integer	the x coordinate of the second point of the rectangle to crop.
y0	Integer	the y coordinate of the first point of the rectangle to crop.
y1	Integer	the y coordinate of the second point of the rectangle to crop.

Return type

File

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: image/bmp, image/gif, image/jpeg, image/png, application/json

HTTP response details

Status code	Description	Response headers
200	response contains the image file	-
400	Bad Request	-

cropSyncGetWithHttpInfo

ApiResponse cropSyncGet cropSyncGetWithHttpInfo(url, x0, x1, y0, y1)

Example

// Import classes:
import io.imager200.ApiClient;
import io.imager200.ApiException;
import io.imager200.ApiResponse;
import io.imager200.Configuration;
import io.imager200.auth.*;
import io.imager200.models.*;
import io.imager200.client.CropApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("https://api.imager200.io");
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        CropApi apiInstance = new CropApi(defaultClient);
        String url = "url_example"; // String | image url, supported formats jpeg,png,bmp,gif
        Integer x0 = 56; // Integer | the x coordinate of the first point of the rectangle to crop.
        Integer x1 = 56; // Integer | the x coordinate of the second point of the rectangle to crop.
        Integer y0 = 56; // Integer | the y coordinate of the first point of the rectangle to crop.
        Integer y1 = 56; // Integer | the y coordinate of the second point of the rectangle to crop.
        try {
            ApiResponse<File> response = apiInstance.cropSyncGetWithHttpInfo(url, x0, x1, y0, y1);
            System.out.println("Status code: " + response.getStatusCode());
            System.out.println("Response headers: " + response.getHeaders());
            System.out.println("Response body: " + response.getData());
        } catch (ApiException e) {
            System.err.println("Exception when calling CropApi#cropSyncGet");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Response headers: " + e.getResponseHeaders());
            System.err.println("Reason: " + e.getResponseBody());
            e.printStackTrace();
        }
    }
}

Parameters

Name	Type	Description
url	String	image url, supported formats jpeg,png,bmp,gif
x0	Integer	the x coordinate of the first point of the rectangle to crop.
x1	Integer	the x coordinate of the second point of the rectangle to crop.
y0	Integer	the y coordinate of the first point of the rectangle to crop.
y1	Integer	the y coordinate of the second point of the rectangle to crop.

Return type

ApiResponse<File>

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: image/bmp, image/gif, image/jpeg, image/png, application/json

HTTP response details

Status code	Description	Response headers
200	response contains the image file	-
400	Bad Request	-

cropSyncPost

File cropSyncPost(x0, x1, y0, y1, body)

Example

// Import classes:
import io.imager200.ApiClient;
import io.imager200.ApiException;
import io.imager200.Configuration;
import io.imager200.auth.*;
import io.imager200.models.*;
import io.imager200.client.CropApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("https://api.imager200.io");
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        CropApi apiInstance = new CropApi(defaultClient);
        Integer x0 = 56; // Integer | the x coordinate of the first point of the rectangle to crop.
        Integer x1 = 56; // Integer | the x coordinate of the second point of the rectangle to crop.
        Integer y0 = 56; // Integer | the y coordinate of the first point of the rectangle to crop.
        Integer y1 = 56; // Integer | the y coordinate of the second point of the rectangle to crop.
        File body = new File("/path/to/file"); // File | image binary data, acceptable formats: jpeg,png,bmp,gif
        try {
            File result = apiInstance.cropSyncPost(x0, x1, y0, y1, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CropApi#cropSyncPost");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Parameters

Name	Type	Description
x0	Integer	the x coordinate of the first point of the rectangle to crop.
x1	Integer	the x coordinate of the second point of the rectangle to crop.
y0	Integer	the y coordinate of the first point of the rectangle to crop.
y1	Integer	the y coordinate of the second point of the rectangle to crop.
body	File	image binary data, acceptable formats: jpeg,png,bmp,gif

Return type

File

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: application/octet-stream
Accept: image/bmp, image/gif, image/jpeg, image/png, application/json

HTTP response details

Status code	Description	Response headers
200	response contains the image file	-
400	Bad Request	-

cropSyncPostWithHttpInfo

ApiResponse cropSyncPost cropSyncPostWithHttpInfo(x0, x1, y0, y1, body)

Example

// Import classes:
import io.imager200.ApiClient;
import io.imager200.ApiException;
import io.imager200.ApiResponse;
import io.imager200.Configuration;
import io.imager200.auth.*;
import io.imager200.models.*;
import io.imager200.client.CropApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("https://api.imager200.io");
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        CropApi apiInstance = new CropApi(defaultClient);
        Integer x0 = 56; // Integer | the x coordinate of the first point of the rectangle to crop.
        Integer x1 = 56; // Integer | the x coordinate of the second point of the rectangle to crop.
        Integer y0 = 56; // Integer | the y coordinate of the first point of the rectangle to crop.
        Integer y1 = 56; // Integer | the y coordinate of the second point of the rectangle to crop.
        File body = new File("/path/to/file"); // File | image binary data, acceptable formats: jpeg,png,bmp,gif
        try {
            ApiResponse<File> response = apiInstance.cropSyncPostWithHttpInfo(x0, x1, y0, y1, body);
            System.out.println("Status code: " + response.getStatusCode());
            System.out.println("Response headers: " + response.getHeaders());
            System.out.println("Response body: " + response.getData());
        } catch (ApiException e) {
            System.err.println("Exception when calling CropApi#cropSyncPost");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Response headers: " + e.getResponseHeaders());
            System.err.println("Reason: " + e.getResponseBody());
            e.printStackTrace();
        }
    }
}

Parameters

Name	Type	Description
x0	Integer	the x coordinate of the first point of the rectangle to crop.
x1	Integer	the x coordinate of the second point of the rectangle to crop.
y0	Integer	the y coordinate of the first point of the rectangle to crop.
y1	Integer	the y coordinate of the second point of the rectangle to crop.
body	File	image binary data, acceptable formats: jpeg,png,bmp,gif

Return type

ApiResponse<File>

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: application/octet-stream
Accept: image/bmp, image/gif, image/jpeg, image/png, application/json

HTTP response details

Status code	Description	Response headers
200	response contains the image file	-
400	Bad Request	-

FilesExpand file tree

CropApi.md

Latest commit

History

CropApi.md

File metadata and controls

CropApi

cropAsyncGet

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

cropAsyncGetWithHttpInfo

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

cropAsyncPost

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

cropAsyncPostWithHttpInfo

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

cropSyncGet

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

cropSyncGetWithHttpInfo

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

cropSyncPost

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

cropSyncPostWithHttpInfo

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details