Quick Start

Complete the following 4 steps to set up your account and purchase your API：

If you have any questions about Aidge or require any assistance from us, please contact us via navigation bar or email us (aidge_support@service.alibaba.com).

Step 1: Account setup

Learn where to find your authentication key and how to access the Aidge API.

First, create a new Aidge developer account or sign in with an existing account.

Next, find your authentication key to access the API in the 'Access Keys' page in your workplace. It is important to keep your keys confidential. You should not use an API key in publicly-distributed code.

Step 2: Test your API request

We offer 100 trial quota to help you familiarize and test how to use the Aidge API in your account. Check your trial quota in the 'API List' page.

Whether you're new to exploring the capabilities of the Aidge API or have an established integration in a live setting, it's always strongly recommended to establish a secure testing environment to test features before going live.

You can test your API request in either of the folllowing ways:

Method 1: Signing in Aidge Workspace

In the 'API debugging' page, after you have entered the API endpoint you want to test and fill in the parameters, you can view the corresponding response results in the debug box.

Method 2: Coding for a trial experience

Include the following Header in your code:

request.addHeaderParameter("x-iop-trial","true");

Step 3: Make your first API request

Currently, it is recommended to invoke the services using the Java SDK. Aidge's SDK offers functionalities for API request encapsulation, digest signature, response parsing, and message listening. By utilizing this SDK, you can effortlessly make API calls, retrieve API results, and monitor real-time messages. Here is the download link for the SDK.

Environmental dependencies for the JAVA SDK require Java SE/EE 1.5 or higher. The Python SDK requires Python 2.7 or above.

Below is a sample code for the Java/Python SDK. Please note: The API domain for the call is https://api.aidc-ai.com.

IopClient client = new IopClient("https://api.aidc-ai.com", "your key", "your secret");
IopRequest request = new IopRequest();
// Adding this trial tag in header means using the trial resource to test, 
// please remove this ##trial tag after you purchased the API
request.addHeaderParameter("x-iop-trial","true")
request.setApiName("/ai/image/cut/out");
request.addApiParameter("simplify", "true");
//adding parameters as in the api doc we provide etc. I only listed one for example
request.addApiParameter("backGroundType", "WHITE_BACKGROUND");
request.addApiParameter("targetHeight", "1000");
request.addApiParameter("targetWidth", "800");
request.addApiParameter("imageUrl", "https://ae01.alicdn.com/kf/Sa78257f1d9a34dad8ee494178db12ec8l.jpg");
IopResponse response = client.execute(request, Protocol.GOP);
System.out.println(response.getBody());

import iop

client = iop.IopClient("https://api.aidc-ai.com", "your appKey", "your appSecret")
request = iop.IopRequest('/ai/image/cut/out')
request.set_protocol('GOP')
##Adding this trial tag in header means using the trial resource to test, please remove this ##trial tag after you purchased the API
request.add_header("x-iop-trial","true")
request.add_api_param('backGroundType', 'WHITE_BACKGROUND')
request.add_api_param('targetHeight', '1000')
request.add_api_param('targetWidth', '800')
request.add_api_param('imageUrl', 'https://ae01.alicdn.com/kf/Sa78257f1d9a34dad8ee494178db12ec8l.jpg')
response = client.execute(request)
print(response.type)
print(response.body)

Step 4: Purchase API

After logging into the Aidge workplace, you can purchase the API that you need from the API list.

After entering the API ordering page, click on the blue button 'Buy Now' will redirect you to the cashier to start the binding and payment process.

Note: The website currently offers offers individual API resource packages on a subscription basis. If you have demands for bulk orders, Please contact us via navigation bar or email us (aidge_support@service.alibaba.com)

After completing the purchase, you can view the current order in the Order Management, and the API list will be credited with new API quota.