Create prediction API

Step 1. Clicking the [Create API] tab with the model that you want to create a prediction API for selected takes you to this screen.

Step 2. Click the [Launch] button

Step 3. Select the API type in the [Start API creation] window, then click the [Start] button.

• Create API: Creates an official API. It can be used by purchasing the API option. You can create one API for each API option you purchase. This type cannot be selected with the trial version.
• Create trial API: Creates a trial API. The created API can be used for up to 100 requests.

Step 4. The building API screen will be displayed. It takes about 5 to 20 minutes to build the API. The prediction API can be used after building is complete.

Check prediction API information

Check [API information].

• API type: Displays whether the API is an official API or trial API.
• Model ID: The ID of the model.
• API ID: The ID of the API.
• API URL: The endpoint URL of the API.
• API Key: The API key.
• IP whitelist: The IP address whitelist. Only the IP addresses registered to the whitelist can use this API. To allow all IP addresses, specify ‘0.0.0.0/0’.
• Date/time created: The date and time that the API was created.

Check prediction API request count

Check [API request count]. The number of requests is counted daily and displayed as a graph.

• Status 200: The number of requests without an error.
• Status 4xx or 5xx: The number of requests with an error. 4xx refer to client errors and 5xx refer to server errors, but the total count is displayed.

Check prediction API status

Check [API status].

• Building: Building the API.
• Updating: Updating the API.
• Operating: The API is operating. Requests to the API can be processed in this state.
• Stopped: The API is stopped. Requests to the API cannot be processed in this state.
• Deleting: Deleting the API.

Configure IP whitelist of prediction API

Step 1. Click the [Configure IP whitelist] button

Step 2. In the text box of the displayed window, enter the whitelist of IP addresses to allow. Enter the addresses in the CIDR format.

Step 3. Click the [Add] button.

To delete an IP address from the IP whitelist, click the [Delete] button on the right of the corresponding IP address.

Stop prediction API

Click the [Stop] button.

Delete prediction API

With the prediction API stopped, click the [Delete] button. When you delete an API, the number of API options in use decreases and you can create an API with another model.

Lock prediction API

Click the [Lock API] button. The API is locked and cannot be stopped. This prevents users from accidentally stopping the API.

Unlock prediction API

With the prediction API locked, click the [Lock API] button. Only an account with the administrator role can perform this operation. The administrator role is configured in the User Portal.