Documentation Powered by ReDoc

AITRIOS | Console (2.0.0)

Download OpenAPI specification:Download

Authentication

accessToken

Security Scheme Type HTTP
HTTP Authorization Scheme bearer

Provisioning

GetQrCodeForProvisioning

Returns a QR in base64-encoded format to provision the Edge Device.

Authorizations:
accessToken
query Parameters
ntp
string

NTP server. The maximum number of characters that can be specified is 64.

auto
boolean
Default: false

QR type.

  • Value definition:
    true: Generates an Enrollment QR for auto enrollment.
    false: Generates a Service QR for manual enrollment.
wifi_ssid
string

SSID information to connect the Wi-Fi network.

wifi_pass
string

Password to connect the Wi-Fi network.

proxy_url
string

URL of the proxy server.

proxy_port
string

Port number of the proxy server.

proxy_user_name
string

Username to access the proxy server.

proxy_pass
string

Password to access the proxy server.

ip_address
string

IP address assigned to the device. The maximum number of characters that can be specified is 39.

subnet_mask
string

Subnet mask applied to the device. The maximum number of characters that can be specified is 39.

gateway
string

Gateway to connect the device. The maximum number of characters that can be specified is 39.

dns
string

DNS information of the server. The maximum number of characters that can be specified is 39.

grant_type
string
Default: "client_credentials"

The authentication grant type.

Responses

Response samples

Content type
application/json
{
  • "result": "SUCCESS",
  • "contents": "string",
  • "expiration_date": "2022-01-01T01:01:01.000001+00:00"
}

Certificate

EnrollDevice

Registers your Edge Device with a device certificate.
Assumptions and Notes:
・Certification format: Primary device X.509 certificate (.pem file, .cer file, or .crt file).

Authorizations:
accessToken
query Parameters
grant_type
string
Default: "client_credentials"

The authentication grant type.

Request Body schema: application/json
device_name
required
string

Device name. The maximum number of characters that can be specified is 255.

primary_certificate
required
string

Specify the string data of the X.509 primary certificate (.pem file or .cer file) for the subject device. *The data should not include the leading signatures, trailing signatures, or line breaks.
-----BEGIN CERTIFICATE-----

-----END CERTIFICATE-----

device_version
string
Default: "v1"
Enum: "v1" "v2"

Device version.
If device type is SZP123S-001, CSV26, or AIH-IVRW2, need to determine the version of the device based on the LED lighting patterns.
For information on the LED lighting patterns, please refer to the Installation Guide in the Developer Site.

Responses

Request samples

Content type
application/json
{
  • "device_name": "string",
  • "primary_certificate": "string",
  • "device_version": "v1"
}

Response samples

Content type
application/json
{
  • "result": "string",
  • "id": "string"
}

DeleteDevice

Deletes the registered Edge Device (device_id) from the Console.

Authorizations:
accessToken
path Parameters
device_id
required
string

Device ID

query Parameters
grant_type
string
Default: "client_credentials"

The authentication grant type.

Responses

Response samples

Content type
application/json
{
  • "result": "SUCCESS"
}

GetDeviceCertificates

Lists the Edge Device certificate information.

Authorizations:
accessToken
query Parameters
limit
integer
Default: 100

Number of the items to fetch information. Value range: 1 to 256

starting_after
string

Retrieves additional data beyond the number of targets specified by the query parameter (limit). Specify the value obtained from the response (continuation_token) to fetch the next data.

grant_type
string
Default: "client_credentials"

The authentication grant type.

Responses

Response samples

Content type
application/json
{
  • "continuation_token": "string",
  • "certificates":
    [
    ]
}

GetDeviceCertificate

The information for a specific Edge Device (device ID) within a group.

Authorizations:
accessToken
path Parameters
device_id
required
string

Device ID.

query Parameters
grant_type
string
Default: "client_credentials"

The authentication grant type.

Responses

Response samples

Content type
application/json
{
  • "device_id": "string",
  • "internal_device_id": "string",
  • "device_name": "string",
  • "credentials_id_object": "string",
  • "credentials_type": "string",
  • "expiration_date": "string",
  • "created_time": "string"
}

UpdateDeviceCertificate

Updates the device certificate information for a specific Edge Device.

Authorizations:
accessToken
path Parameters
device_id
required
string

Device ID

query Parameters
grant_type
string
Default: "client_credentials"

The authentication grant type.

Request Body schema: application/json
primary_certificate
string

Specify the string data of the X.509 primary certificate (.pem file or .cer file) for the subject device.
*The data should not include the leading signatures, trailing signatures, or line breaks.
-----BEGIN CERTIFICATE-----

-----END CERTIFICATE-----

device_name
string

Device Name. The maximum number of characters that can be specified is 255.

Responses

Request samples

Content type
application/json
{
  • "primary_certificate": "string",
  • "device_name": "string"
}

Response samples

Content type
application/json
{
  • "result": "SUCCESS"
}

Manage Devices

GetDevices

Lists the information of Edge Devices specified by query parameters.
This API does not retrieve Edge Application properties. To retrieve them, please use the GetDevice API or GetProperty API.

Authorizations:
accessToken
query Parameters
limit
integer
Default: 500

Number of the items to fetch information. If the parameter (connection_state) is Disconnected, the actual amount of data retrievable will be less than the set limit value.
Value range: 1 to 1000

starting_after
string

Retrieves additional data beyond the number of targets specified by the query parameter (limit). Specify the value obtained from the response (continuation_token) to fetch the next data.

connection_state
string
Default: ""

Connection state.

  • Value definition:
    Connected
    Disconnected
device_name
string
Default: ""

Name of the device. *Fuzzy searching is available.

device_id
string
Default: ""

Device ID. *Fuzzy searching is available.

device_group_id
string
Default: ""

Name of the device group.

device_ids
string
Default: ""

To specify multiple device IDs, separate them with commas.

scope
any
Default: "full"
Enum: "full" "minimal"

The scope of response parameters to return.

  • Value definition:
    full: Returns all parameters
    minimal: Returns minimal parameters *effective for timesaving
grant_type
string
Default: "client_credentials"

The authentication grant type.

Responses

Response samples

Content type
application/json
{
  • "continuation_token": "string",
  • "devices":
    [
    ]
}

GetDevice

Returns the information of an Edge Device specified by query parameters.

Authorizations:
accessToken
path Parameters
device_id
required
string

Device ID.

query Parameters
grant_type
string
Default: "client_credentials"

The authentication grant type.

Responses

Response samples

Content type
application/json
{
  • "device_id": "string",
  • "description": "string",
  • "device_name": "string",
  • "internal_device_id": "string",
  • "device_type": "string",
  • "ins_id": "string",
  • "ins_date": "string",
  • "upd_id": "string",
  • "upd_date": "string",
  • "connection_state": "string",
  • "last_activity_time": "string",
  • "inactivity_timeout": 600,
  • "models":
    [
    ],
  • "device_groups":
    [
    ],
  • "modules":
    [
    ],
  • "property":
    {
    }
}

UpdateDevice

Updates the information of a specific Edge Device specified by path parameters.

Authorizations:
accessToken
path Parameters
device_id
required
string

Device ID

query Parameters
grant_type
string
Default: "client_credentials"

The authentication grant type.

Request Body schema: application/json
device_name
string

Device name. The maximum number of characters that can be specified is 255.

description
string

Device description. The maximum number of characters that can be specified is 100.

inactivity_timeout
number
Default: 600

Time the device is considered inactive. 60 ~ 600 [sec]

Responses

Request samples

Content type
application/json
{
  • "device_name": "string",
  • "description": "string",
  • "inactivity_timeout": 600
}

Response samples

Content type
application/json
{
  • "result": "SUCCESS"
}

GetDeviceGroups

Lists the information of registered Edge Devices included in the specified group. By specifying the device ID in the query parameter, you can also verify to which group the device belongs.

Authorizations:
accessToken
query Parameters
limit
integer
Default: 100

Number of the items to fetch information.
Value range: 1 to 256

starting_after
string

Retrieves additional data beyond the number of targets specified by the query parameter (limit). Specify the value obtained from the response (continuation_token) to fetch the next data.

device_group_id
string
Default: ""

ID of the device groups. *Fuzzy searching is available.

description
string
Default: ""

Description of the subject. *Fuzzy searching is available.

device_id
string
Default: ""

Device IDs within the corresponding group. Returns a list of device groups that includes the specified device ID.

grant_type
string
Default: "client_credentials"

The authentication grant type.

Responses

Response samples

Content type
application/json
{
  • "continuation_token": "string",
  • "device_groups":
    [
    ]
}

CreateDeviceGroup

Creates a new device group.

Authorizations:
accessToken
query Parameters
device_group_id
required
string

Name of the device group.
Group names should be in single-byte characters and the maximum number of characters that can be specified is 100. Half-width commas are not allowed.

description
string
Default: ""

Description of the subject. The maximum number of characters that can be specified is 100.

device_id
string
Default: ""

Included device ID.
If there are multiple targets:

  • use comma separation
  • avoid using same values
del_from_dgroup
string
Default: "0"

To remove the device belonging to multiple groups, configure the following:

  • Value definition: 0: Do not delete
    1: Delete
grant_type
string
Default: "client_credentials"

The authentication grant type.

Responses

Response samples

Content type
application/json
{
  • "result": "SUCCESS"
}

GetDeviceGroup

Lists the information for specific device groups (device group ID).

Authorizations:
accessToken
path Parameters
device_group_id
required
string

The name of a device group. Group names should be in single-byte characters and be specified within 100 characters. Half-width commas are not allowed.

query Parameters
grant_type
string
Default: "client_credentials"

The authentication grant type.

Responses

Response samples

Content type
application/json
{
  • "device_group_id": "string",
  • "device_type": "string",
  • "description": "string",
  • "ins_id": "string",
  • "ins_date": "string",
  • "upd_id": "string",
  • "upd_date": "string",
  • "devices":
    [
    ]
}

DeleteDeviceGroup

Deletes the device registration specified by the device_id.

Authorizations:
accessToken
path Parameters
device_group_id
required
string

ID of device group that you want to delete.

query Parameters
grant_type
string
Default: "client_credentials"

The authentication grant type.

Responses

Response samples

Content type
application/json
{
  • "result": "SUCCESS"
}

UpdateDeviceGroup

Performs device registration, deletion, and update within the specified device group.

Authorizations:
accessToken
path Parameters
device_group_id
required
string

Name of the device group that you want to update.

query Parameters
description
string
Default: ""

Description of the subject. The maximum number of characters that can be specified is 100.
To delete the description, specify "@@nullupdate".

*An error will occur if description and device_id are not set.

device_id
string
Default: ""

The affiliated device ID you want to replace.
To disaffiliate the device ID, specify "@@nullupdate".
If there are multiple targets:

  • use comma separation
  • avoid using same values

*An error will occur if description and device_id are not set.

del_from_dgroup
string
Default: "0"

Specify whether or not to disaffiliate the device from the default group.

  • Value definition:
    0: Do not delete
    1: Delete
grant_type
string
Default: "client_credentials"

The authentication grant type.

Responses

Response samples

Content type
application/json
{
  • "result": "SUCCESS"
}

GetEventLogs

Returns the event log for a specified Edge Device.

Authorizations:
accessToken
path Parameters
device_id
required
string

Device ID.

query Parameters
limit
integer
Default: 20

Number of the items to fetch information.
Value range: 1 to 256

starting_after
string

Retrieves additional data beyond the number of targets specified by the query parameter (limit). Specify the value obtained from the response (continuation_token) to fetch the next data.

from_datetime
string
Default: ""

Date and time (From).

  • Format: yyyyMMddThhmmss.SSSSSS or yyyy-MM-ddThh:mm:ss.SSSSSS (ISO-8601)
  • The time range between from_datetime and to_datetime must not exceed the retention period.
to_datetime
string
Default: ""

Date and time (To).

  • Format: yyyyMMddThhmmss.SSSSSS or yyyy-MM-ddThh:mm:ss.SSSSSS (ISO-8601)
  • It must not be before or equal the value of from_datetime.
  • The time range between from_datetime and to_datetime must not exceed the retention period.
grant_type
string
Default: "client_credentials"

The authentication grant type.

Responses

Response samples

Content type
application/json
{
  • "continuation_token": "string",
  • "event_logs":
    [
    ]
}

GetEdgeAppLogs

Returns logs output by the Edge Application on a specific Edge Device.

Authorizations:
accessToken
path Parameters
device_id
required
string

Device ID.

query Parameters
limit
integer
Default: 50

Number of the items to fetch information.
Value range: 1 to 256

starting_after
string

Retrieves additional data beyond the number of targets specified by the query parameter (limit). Specify the value obtained from the response (continuation_token) to fetch the next data.

from_datetime
string
Default: ""

Date and time (From).

  • Format: yyyyMMddThhmmss.SSSSSS or yyyy-MM-ddThh:mm:ss.SSSSSS (ISO-8601)
  • The time range between from_datetime and to_datetime must not exceed the retention period.
to_datetime
string
Default: ""

Date and time (To).

  • Format: yyyyMMddThhmmss.SSSSSS or yyyy-MM-ddThh:mm:ss.SSSSSS (ISO-8601)
  • It must not be before or equal the value of from_datetime.
  • The time range between from_datetime and to_datetime must not exceed the retention period.
grant_type
string
Default: "client_credentials"

The authentication grant type.

Responses

Response samples

Content type
application/json
{
  • "continuation_token": "string",
  • "logs":
    [
    ]
}

Device Command

GetDeviceProperty

Get Property of the Edge System Software. Property is a data format for storing information about the Edge System Software on a device. Property includes Configuration which is used to set desired state from the cloud to the device, and State which is used to report current state from the device to the cloud.

Authorizations:
accessToken
path Parameters
device_id
required
string

Device ID.

query Parameters
grant_type
string
Default: "client_credentials"

The authentication grant type.

Responses

Response samples

Content type
application/json
{
  • "configuration":
    {
    },
  • "state":
    {
    }
}

UpdateDeviceConfiguration

Updates the Configuration of a device. All fields under the specified Property name will be updated.

Authorizations:
accessToken
path Parameters
device_id
required
string

Device ID.

query Parameters
include_updated_conf
boolean
Default: false

Whether the response includes updated Configuration or not.

grant_type
string
Default: "client_credentials"

The authentication grant type.

Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "configuration":
    {
    }
}

Response samples

Content type
application/json
{
  • "result": "SUCCESS",
  • "configuration":
    {
    }
}

GetProperty

Get Property of a specified module. Property is a data format for storing information about the Edge System Software or Edge Applications on a device.​ Property includes Configuration which is used to set desired state from the cloud to the device, and State which is used to report current state from the device to the cloud.

Authorizations:
accessToken
path Parameters
device_id
required
string

Device ID.

module_id
required
string

Module ID. When the destination is System App, specify $system.

query Parameters
grant_type
string
Default: "client_credentials"

The authentication grant type.

Responses

Response samples

Content type
application/json
{
  • "property":
    {
    },
  • "module_id": "string",
  • "$metadata": { }
}

GetModuleProperty

Get Property of a specified module. Property is a data format for storing information about the Edge Applications on a device. Property includes Configuration which is used to set desired state from the cloud to the device, and State which is used to report current state from the device to the cloud.

Authorizations:
accessToken
path Parameters
device_id
required
string

Device ID.

module_id
required
string

Module ID.

query Parameters
grant_type
string
Default: "client_credentials"

The authentication grant type.

Responses

Response samples

Content type
application/json
{
  • "configuration":
    {
    },
  • "state":
    {
    }
}

UpdateModuleConfiguration

Updates the Configuration of a specific module. All fields under the specified Property name will be updated.

Authorizations:
accessToken
path Parameters
device_id
required
string

Device ID.

module_id
required
string

Module ID.

query Parameters
include_updated_conf
boolean
Default: false

Whether the response includes updated Configuration or not.

grant_type
string
Default: "client_credentials"

The authentication grant type.

Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "configuration":
    {
    }
}

Response samples

Content type
application/json
{
  • "result": "SUCCESS",
  • "configuration":
    {
    }
}

ExecuteDeviceCommand

Synchronously executes commands like device initialization and rebooting based on the parameters defined in the DTDL.

Authorizations:
accessToken
path Parameters
device_id
required
string

Device ID.

query Parameters
grant_type
string
Default: "client_credentials"

The authentication grant type.

Request Body schema: application/json
command_name
required
string
object

Responses

Request samples

Content type
application/json
{
  • "command_name": "command_name_sample",
  • "parameters": { }
}

Response samples

Content type
application/json
{
  • "result": "SUCCESS"
}

ExecuteCommand

Synchronously executes commands like device initialization and rebooting based on the parameters defined in the DTDL.

Authorizations:
accessToken
path Parameters
device_id
required
string

Device ID.

module_id
required
string

Module ID. When the destination is System App, specify $system.

query Parameters
grant_type
string
Default: "client_credentials"

The authentication grant type.

Request Body schema: application/json
command_name
required
string
object

Responses

Request samples

Content type
application/json
{
  • "command_name": "command_name_sample",
  • "parameters": { }
}

Response samples

Content type
application/json
{
  • "result": "SUCCESS"
}

Deploy

GetDeployConfigurations

Extracts and lists the settings of the Deploy Configuration.

Authorizations:
accessToken
query Parameters
limit
integer
Default: 20

Number of the items to fetch information.
Value range: 1 to 256

starting_after
string

Retrieves additional data beyond the number of targets specified by the query parameter (limit). Specify the value obtained from the response (continuation_token) to fetch the next data.

grant_type
string
Default: "client_credentials"

The authentication grant type.

Responses

Response samples

Content type
application/json
{
  • "continuation_token": "string",
  • "deploy_configs":
    [
    ]
}

CreateDeployConfiguration

Creates the Deploy Configuration. The registration will include the following features:

  • Edge System Software
  • AI model
  • Edge App
  • AI model bundle
Authorizations:
accessToken
query Parameters
grant_type
string
Default: "client_credentials"

The authentication grant type.

Request Body schema: application/json
config_id
required
string

The maximum number of characters that can be specified is 100 single-byte ones.

description
string
Default: ""

The maximum number of characters that can be specified is 100.

Array of objects
object
Array of objects
Array of objects

Responses

Request samples

Content type
application/json
{
  • "config_id": "string",
  • "description": "",
  • "models":
    [
    ],
  • "edge_system_sw_package":
    {
    },
  • "edge_apps":
    [
    ],
  • "model_bundles":
    [
    ]
}

Response samples

Content type
application/json
{
  • "result": "SUCCESS"
}

GetDeployConfiguration

Lists the information of specified Deploy Configuration.

Authorizations:
accessToken
path Parameters
config_id
required
string

Deploy Configuration ID

query Parameters
grant_type
string
Default: "client_credentials"

The authentication grant type.

Responses

Response samples

Content type
application/json
{
  • "config_id": "string",
  • "description": "string",
  • "running_cnt": 0,
  • "success_cnt": 0,
  • "fail_cnt": 0,
  • "edge_system_sw_package":
    {
    },
  • "models":
    [
    ],
  • "edge_apps":
    [
    ],
  • "model_bundles":
    [
    ],
  • "ins_id": "string",
  • "ins_date": "string",
  • "upd_id": "string",
  • "upd_date": "string"
}

DeleteDeployConfiguration

Deletes the specified Deploy Configuration.

Authorizations:
accessToken
path Parameters
config_id
required
string

Configuration ID

query Parameters
grant_type
string
Default: "client_credentials"

The authentication grant type.

Responses

Response samples

Content type
application/json
{
  • "result": "SUCCESS"
}

DeployByConfiguration

Deploys the following features specified by the Deploy Configuration to Edge Devices:

  • Edge System Software
  • AI model
  • Edge App
Authorizations:
accessToken
path Parameters
config_id
required
string

Setting ID.

query Parameters
grant_type
string
Default: "client_credentials"

The authentication grant type.

Request Body schema: application/json
device_ids
required
Array of strings

Specify multiple device IDs.

description
string

Maximum is 100 characters.

Responses

Request samples

Content type
application/json
{
  • "device_ids":
    [
    ],
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "result": "SUCCESS",
  • "deploy_id": "12345"
}

CancelDeployment

Cancels the deployment of core features such as Edge System softwares, AI models, and Edge Applications that run on the Edge Device. This operation cancels the deployment for Edge Devices that have not yet received it. If the device already received the deployment, this operation does not change anything.

Authorizations:
accessToken
path Parameters
device_id
required
string

Device ID

deploy_id
required
string

Deploy ID

query Parameters
grant_type
string
Default: "client_credentials"

The authentication grant type.

Responses

Response samples

Content type
application/json
{
  • "result": "SUCCESS"
}

GetDeviceDeployHistory

Returns the deployment history of core features such as Edge System softwares, AI models, and Edge Applications that run on the Edge Device.

Authorizations:
accessToken
path Parameters
device_id
required
string

Device ID

query Parameters
limit
integer
Default: 20

Number of the items to fetch information.
Value range: 1 to 256

starting_after
string

Retrieves additional data beyond the number of targets specified by the query parameter (limit). Specify the value obtained from the response (continuation_token) to fetch the next data.

grant_type
string
Default: "client_credentials"

The authentication grant type.

Responses

Response samples

Content type
application/json
{
  • "continuation_token": "string",
  • "deploys":
    [
    ]
}

GetDeployHistory

Lists the deployment history.

Authorizations:
accessToken
query Parameters
limit
integer
Default: 50

Number of the items to fetch information.
Value range: 1 to 256

starting_after
string

Retrieves additional data beyond the number of targets specified by the query parameter (limit). Specify the value obtained from the response (continuation_token) to fetch the next data.

grant_type
string
Default: "client_credentials"

The authentication grant type.

Responses

Response samples

Content type
application/json
{
  • "continuation_token": "string",
  • "deploy_history":
    [
    ]
}

GetDeployStatus

Returns the status of specified deployment ID.

Authorizations:
accessToken
path Parameters
deploy_id
required
string

Deployment ID.

query Parameters
grant_type
string
Default: "client_credentials"

The authentication grant type.

Responses

Response samples

Content type
application/json
{
  • "deploy_id": "string",
  • "from_datetime": "string",
  • "deploy_type": "string",
  • "deploying_cnt": 0,
  • "success_cnt": 0,
  • "fail_cnt": 0,
  • "config_id": "string",
  • "replace_model_id": "string",
  • "replace_network_id": "string",
  • "edge_system_sw_package":
    {
    },
  • "models":
    [
    ],
  • "edge_apps":
    [
    ],
  • "model_bundles":
    [
    ],
  • "devices":
    [
    ]
}

DeployDeviceModel

Deploys the device model to the specified Edge Device.

Authorizations:
accessToken
path Parameters
model_id
required
string

ID of the AI model.

device_id
required
string

Device ID.

query Parameters
version_number
string
Default: ""

Version number.

replace_model_id
string
Default: ""

Replace model ID.

description
string
Default: ""

Description of the subject. The maximum number of characters that can be specified is 100.

grant_type
string
Default: "client_credentials"

The authentication grant type.

Responses

Response samples

Content type
application/json
{
  • "result": "SUCCESS"
}

Train Model

GetTrainingKits

Returns a list of specific training kit information.

Authorizations:
accessToken
query Parameters
order_by
string
Default: "asc"

Sort order: Sorted by the training kit creation date. Value range: desc or asc

grant_type
string
Default: "client_credentials"

The authentication grant type.

Responses

Response samples

Content type
application/json
{
  • "training_kits":
    [
    ]
}

GetProjects

Searches and returns projects that match the conditions specified in the parameter. If no parameters are specified, all created projects are returned.

Authorizations:
accessToken
query Parameters
project_name
string

Name of the project. *Fuzzy searching is available.

model_platform
string

Specifies the AI model platform.

  • Value definition:
    0: Custom Vision
    1: Non-Custom Vision
project_type
string

Specifies the project type.

  • Value definition:
    0: Base model
    1: Device model
device_id
string

Sorts the device ID.

include_training_flg
string
Default: "0"

To return the project property, set "true".

grant_type
string
Default: "client_credentials"

The authentication grant type.

Responses

Response samples

Content type
application/json
{
  • "model_projects":
    [
    ]
}

CreateBaseProject

Creates a new project for a base model.

Authorizations:
accessToken
query Parameters
project_name
required
string

Name of the project. The maximum number of characters that can be specified is 50.

training_kit
required
string

Specifies the ID of the training kit to use.

comment
string

Description of the subject. The maximum number of characters that can be specified is 100.

grant_type
string
Default: "client_credentials"

The authentication grant type.

Responses

Response samples

Content type
application/json
{
  • "result": "SUCCESS"
}

CreateDeviceProject

Creates a project for the device model by using the specified model's base model.

Authorizations:
accessToken
query Parameters
project_name
required
string

Name of the project. The maximum number of characters that can be specified is 50.

model_id
required
string

ID of the AI model.

device_id
required
string

Sorts the device ID.

version_number
string

Version number. The default version is set to the latest one.

comment
string

Description of the subject. The maximum number of characters that can be specified is 100.

grant_type
string
Default: "client_credentials"

The authentication grant type.

Responses

Response samples

Content type
application/json
{
  • "result": "SUCCESS"
}

GetProject

Returns a list of specific project's information.

Authorizations:
accessToken
path Parameters
project_name
required
string

Name of the project.

query Parameters
include_training_flg
string
Default: "0"

To return the project property, set "true".

grant_type
string
Default: "client_credentials"

The authentication grant type.

Responses

Response samples

Content type
application/json
{
  • "model_project_name": "string",
  • "model_project_id": "string",
  • "model_platform": "string",
  • "model_type": "string",
  • "project_type": "string",
  • "device_id": "string",
  • "project_model_file_name": "string",
  • "project_model_accuracy": "string",
  • "project_comment": "string",
  • "project":
    {
    },
  • "model":
    {
    }
}

DeleteProject

Deletes the created model. *To delete a model in process of creation, use DeleteModel instead.

Authorizations:
accessToken
path Parameters
project_name
required
string

Name of the project.

query Parameters
grant_type
string
Default: "client_credentials"

The authentication grant type.

Responses

Response samples

Content type
application/json
{
  • "result": "SUCCESS"
}

SaveModel

Saves the pre-converted model (projects of base model or device model).

Authorizations:
accessToken
path Parameters
project_name
required
string

Name of the project.

query Parameters
model_id
string

ID of the AI model. The maximum number of characters that can be specified is 20 single-byte ones. *Available only when registering a new base model.

initial_version_number
integer
Default: "1"

An initial version number of the AI model to be saved. *Available only when registering a new base model.

  • Value range: 1 to 99
functionality
string

Description of the functionality. The maximum number of characters that can be specified is 100. *Available only when registering a new base model.

vendor_name
string

Name of the vendor. The maximum number of characters that can be specified is 100. *Available only when registering a new base model.

comment
string

Description of the subject. The maximum number of characters that can be specified is 100. *If the description is saved for the first time, it will be applied for both model and its version. *When updating the content, it will be registered as a description for the version.

grant_type
string
Default: "client_credentials"

The authentication grant type.

Responses

Response samples

Content type
application/json
{
  • "result": "SUCCESS"
}

GetRelearnStatus

The retraining status of a specific model.

Authorizations:
accessToken
path Parameters
project_name
required
string

Name of the project.

query Parameters
grant_type
string
Default: "client_credentials"

The authentication grant type.

Responses

Response samples

Content type
application/json
{
  • "result": "string",
  • "status": "string"
}

Relearn

Performs retraining to the specified project.

Authorizations:
accessToken
path Parameters
project_name
required
string

Name of the project.

query Parameters
training_type
string
Default: "Regular"

Training type. *Available only for Custom Vision projects.

  • Value definition:
    Regular: Facilitates rapid completion of the training. Advanced: Increases the accuracy by specifying the training hours with reserved_budget_in_hours parameter.
reserved_budget_in_hours
string
Default: "1"

The duration time to perform the retraining on Custom Vision projects. *This parameter is available when training_type is set to Advanced.

grant_type
string
Default: "client_credentials"

The authentication grant type.

Responses

Response samples

Content type
application/json
{
  • "result": "string",
  • "iteration_id": "string",
  • "iteration_name": "string"
}

ImportImagesFromFiles

Imports images into your project for retraining purposes.

Authorizations:
accessToken
path Parameters
project_name
required
string

Name of the project.

query Parameters
grant_type
string
Default: "client_credentials"

The authentication grant type.

Request Body schema: application/json
required
Array of objects
tags_name
Array of any
Default: []

The annotation label. *Available only for classification. Supports only 1 tag.

Responses

Request samples

Content type
application/json
{
  • "images":
    [
    ],
  • "tags_name": [ ]
}

Response samples

Content type
application/json
{
  • "result": "SUCCESS"
}

ImportImagesFromScblob

Imports images into your project from Azure Blob Storage for retraining purposes.

Authorizations:
accessToken
path Parameters
project_name
required
string
query Parameters
grant_type
string
Default: "client_credentials"

The authentication grant type.

Request Body schema: application/json
container_url
required
string

The SAS URL of Blob Storage Container. *Read and List permissions required.

tags_name
Array of any
Default: []

The annotation label. *Available only for classification. Supports only 1 tag.

Responses

Request samples

Content type
application/json
{
  • "container_url": "string",
  • "tags_name": [ ]
}

Response samples

Content type
application/json
{
  • "result": "SUCCESS"
}

GetProjectIterations

Returns a list of specified project's iteration information.

Authorizations:
accessToken
path Parameters
project_id
required
string

ID of the project.

query Parameters
overlap_threshold
string
Default: "0.3"

The bounding box overlap threshold used to determine true predictions.

threshold
string
Default: "0.5"

The threshold used to determine true predictions.

grant_type
string
Default: "client_credentials"

The authentication grant type.

Responses

Response samples

Content type
application/json
{
  • "iterations":
    [
    ]
}

GetProjectImages

The images registered in a specified project and their information.

Authorizations:
accessToken
path Parameters
project_id
required
string

ID of the project.

query Parameters
iteration_id
string

ID of the iteration.

order_by
string
Default: "newest"

Sort order: Sorted by the creation date of the image. Value range: newest, oldest

number_of_images
number
Default: 50

The number of images to acquire information. Value range: 0 to 256

skip
number
Default: 0

The number of images to skip acquiring information.

image_size_type
string
Default: "resized"

Types of image sizes. *Available only for Custom Vision projects.

  • Value definition:
    resized
    thumbnail
    original
grant_type
string
Default: "client_credentials"

The authentication grant type.

Responses

Response samples

Content type
application/json
{
  • "total_image_count": 0,
  • "images":
    [
    ]
}

DeleteProjectImages

Deletes an image specified by its ID from the project.

Authorizations:
accessToken
path Parameters
project_id
required
string

ID of the project.

query Parameters
image_ids
required
string

ID of images. *If you have multiple entries, separate them with commas. IDs can be specified from 1 to 256.

grant_type
string
Default: "client_credentials"

The authentication grant type.

Responses

Response samples

Content type
application/json
{
  • "result": "SUCCESS"
}

GetProjectImagesById

Returns a list of information for selected image IDs within a specified project.

Authorizations:
accessToken
path Parameters
project_id
required
string

ID of the project.

query Parameters
image_ids
required
string

ID of images. *If you have multiple entries, separate them with commas. IDs can be specified from 1 to 256.

iteration_id
string

ID of the iteration.

image_size_type
string
Default: "resized"

Types of image sizes. *Available only for Custom Vision projects.

  • Value definition:
    resized
    thumbnail
    original
grant_type
string
Default: "client_credentials"

The authentication grant type.

Responses

Response samples

Content type
application/json
{
  • "images":
    [
    ]
}

GetImageRegionProposals

Returns region proposals (inference result) for an image detection along with the specified image ID.

Authorizations:
accessToken
path Parameters
project_id
required
string

ID of the project.

image_id
required
string

ID of the image.

query Parameters
grant_type
string
Default: "client_credentials"

The authentication grant type.

Responses

Response samples

Content type
application/json
{
  • "project_id": "string",
  • "image_id": "string",
  • "proposals":
    [
    ]
}

CreateProjectImageRegions

Adds a tag to an image within a specified project.

Authorizations:
accessToken
path Parameters
project_id
required
string

ID of the project.

query Parameters
grant_type
string
Default: "client_credentials"

The authentication grant type.

Request Body schema: application/json
Array of objects

Responses

Request samples

Content type
application/json
{
  • "regions":
    [
    ]
}

Response samples

Content type
application/json
{
  • "created":
    [
    ],
  • "duplicated":
    [
    ],
  • "exceeded":
    [
    ]
}

UpdateProjectImageRegions

Updates tags applied to images within a specified project.

Authorizations:
accessToken
path Parameters
project_id
required
string

Description of the subject.

query Parameters
grant_type
string
Default: "client_credentials"

The authentication grant type.

Request Body schema: application/json
Array of objects

Responses

Request samples

Content type
application/json
{
  • "regions":
    [
    ]
}

Response samples

Content type
application/json
{
  • "updated":
    [
    ]
}

DeleteProjectImageRegions

Removes tags from images within a specified project.

Authorizations:
accessToken
path Parameters
project_id
required
string

ID of the project.

region_id
required
string

ID of the region.

query Parameters
grant_type
string
Default: "client_credentials"

The authentication grant type.

Responses

Response samples

Content type
application/json
{
  • "result": "SUCCESS"
}

GetProjectTags

Returns a list of tags applied to a specific project.

Authorizations:
accessToken
path Parameters
project_id
required
string

ID of the project.

query Parameters
iteration_id
string

ID of the iteration.

order_by
string
Default: "asc"

Sort order: Sorted by the creation date of the tag. Value range: asc, desc

grant_type
string
Default: "client_credentials"

The authentication grant type.

Responses

Response samples

Content type
application/json
{
  • "tags":
    [
    ]
}

CreateProjectTag

Creates a new tag to a specified project.

Authorizations:
accessToken
path Parameters
project_id
required
string

ID of the project.

query Parameters
tag_name
required
string

The name of the tag.

description
string

Description of the subject.

grant_type
string
Default: "client_credentials"

The authentication grant type.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "type": "string",
  • "image_count": "string"
}

DeleteProjectTag

Removes tags from a specified project.

Authorizations:
accessToken
path Parameters
project_id
required
string

ID of the project.

tag_id
required
string

ID of the tag.

query Parameters
grant_type
string
Default: "client_credentials"

The authentication grant type.

Responses

Response samples

Content type
application/json
{
  • "result": "SUCCESS"
}

UpdateProjectTag

Updates tags applied to a specified project.

Authorizations:
accessToken
path Parameters
project_id
required
string

ID of the project.

tag_id
required
string

ID of the tag.

query Parameters
grant_type
string
Default: "client_credentials"

The authentication grant type.

Request Body schema: application/json
name
required
string

Name.

description
string

Description of the subject.

type
required
string

type. *Specify Regular as fixed.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "type": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "type": "string",
  • "image_count": "string"
}

GetProjectTaggedImages

Returns information of tagged images within a specified project.

Authorizations:
accessToken
path Parameters
project_id
required
string

ID of the project.

query Parameters
tag_ids
string

ID of tags. *If you have multiple entries, separate them with commas.

iteration_id
string

ID of the iteration.

number_of_images
integer
Default: 50

The number of images to acquire information. Value range: 0 to 256

skip
integer
Default: 0

The number of images to skip acquiring information.

order_by
string
Default: "newest"

Sort order: Sorted by the creation date of the image. Value range: newest, oldest

image_size_type
string
Default: "resized"

Types of image sizes. *Available only for Custom Vision projects.

  • Value definition:
    resized
    thumbnail
    original
grant_type
string
Default: "client_credentials"

The authentication grant type.

Responses

Response samples

Content type
application/json
{
  • "total_image_count": 0,
  • "tagged_images":
    [
    ],
  • "blank_tags":
    [
    ]
}

GetProjectUntaggedImages

Returns information of untagged images within the specified project.

Authorizations:
accessToken
path Parameters
project_id
required
string

ID of the project.

query Parameters
iteration_id
string

ID of the iteration.

number_of_images
integer
Default: 50

The number of images to acquire information. Value range: 0 to 256

skip
integer
Default: 0

The number of images to skip acquiring information.

order_by
string
Default: "newest"

Sort order: Sorted by the creation date of the image. Value range: newest, oldest

image_size_type
string
Default: "resized"

Types of image sizes. *Available only for Custom Vision projects.

  • Value definition:
    resized
    thumbnail
    original
grant_type
string
Default: "client_credentials"

The authentication grant type.

Responses

Response samples

Content type
application/json
{
  • "total_image_count": 0,
  • "untagged_images":
    [
    ]
}

GetModels

Returns a list of model information.

Authorizations:
accessToken
query Parameters
limit
integer
Default: 50

Number of Models to fetch. Value range: 1 to 256

starting_after
string

A token to use in pagination. starting_after is an object ID that defines your place in the list. For example, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo to fetch the next page of the list.

model_id
string

ID of the AI model. *Fuzzy searching is available.

comment
string

Description of the subject. *Fuzzy searching is available.

project_name
string

Name of the project. *Fuzzy searching is available.

model_platform
string

Specifies the AI model platform.

  • Value definition:
    0: Custom Vision
    1: Non-Custom Vision
project_type
string

Specifies the project type.

  • Value definition:
    0: Base model
    1: Device model
device_id
string

Sorts the device ID.

latest_type
string
Default: "1"

Classification of the latest version.

  • Value definition:
    0: Latest version after publication.
    1: Latest version after completion of the conversion process or publication.
grant_type
string
Default: "client_credentials"

The authentication grant type.

Responses

Response samples

Content type
application/json
{
  • "models":
    [
    ],
  • "continuation_token": "string"
}

ImportBaseModel

Imports a base model into your project. When registering a new model ID, it will be added accordingly. Specifying an existing ID will result in overwriting.

Authorizations:
accessToken
query Parameters
grant_type
string
Default: "client_credentials"

The authentication grant type.

Request Body schema: application/json
One of
model
required
string

SAS URL or Presigned URL of the AI model file.

input_format_param
string

SAS URL or Presigned URL of the input format param file. *Usage: Packager conversion information (image format information).
*The json format is an array of objects. Each object contains the following values.
 ・ordinal: Order of DNN input to converter (value range: 0 to 2)
 ・format: Format ("RGB" or "BGR")
*Example:
 [{      "ordinal": 0,
     "format": "RGB"
 },
 {
     "ordinal": 1,
     "format": "RGB"
 }]

network_config
string

SAS URL or Presigned URL of the network config file.
*Usage: Conversion parameter information of the model converter. Therefore, it is not necessary to specify when specifying the AI model before conversion.
*Example:
 {
   "Postprocessor": {
     "params": {
       "background": false,
       "scale_factors": [
         10.0,
         10.0,
         5.0,
         5.0
       ],
       "score_thresh": 0.01,
       "max_size_per_class": 64,
       "max_total_size": 64,
       "clip_window": [
         0,
         0,
         1,
         1
       ],
       "iou_threshold": 0.45
     }
   }
 }

dcpu_firmware_url
string

SAS URL or Presigned URL of the DCPU FW file.

dcpu_manifest_url
string

SAS URL or Presigned URL of the DCPU Manifest file.

dcpu_postprocess_url
string

SAS URL or Presigned URL of the DCPU Post Process file.

model_id
required
string

Model ID for new registration or version upgrade. The maximum number of characters that can be specified is 100.

converted
boolean
Default: false

Specify whether to convert the specified model file.

vendor_name
string

Name of the vendor. The maximum number of characters that can be specified is 100. *Available only when registering a new base model.

comment
string

Description of the subject. The maximum number of characters that can be specified is 100. *If the description is saved for the first time, it will be applied for both model and its version. *When updating the content, it will be registered as a description for the version.

network_type
string
Default: "1"

Specify whether or not application is required for the AI model.

  • Value definition:
    0: Model required application
    1: Model do not required application
reserved_mem
integer
Default: 1024

Amount of the reserved memory on the chip when convert the specified model file. (bytes)

metadata_format_id
string

The metadata format ID returned in the response from the UploadFile API. The maximum number of characters that can be specified is 100.

Responses

Request samples

Content type
application/json
Example
InputFileUrlOfImportBaseModelJsonBody
InputFileUrlOfImportBaseModelJsonBody
InputFileIdOfImportBaseModelJsonBody
{
  • "model": "string",
  • "input_format_param": "string",
  • "network_config": "string",
  • "dcpu_firmware_url": "string",
  • "dcpu_manifest_url": "string",
  • "dcpu_postprocess_url": "string",
  • "model_id": "string",
  • "converted": false,
  • "vendor_name": "string",
  • "comment": "string",
  • "network_type": "1",
  • "reserved_mem": 1024,
  • "metadata_format_id": "string"
}

Response samples

Content type
application/json
{
  • "result": "SUCCESS"
}

PublishModel

Converts the AI model. This process is handled asynchronously due to its time-consuming nature. *To check the processing status, refer to the result of GetBaseModelStatus API or the response from GetDeviceModelStatus API. When the process is completed, 'Import completed' is returned.

Authorizations:
accessToken
path Parameters
model_id
required
string

A unique ID of the AI model.

query Parameters
device_id
string

Device ID
*Only available for device models. This parameter is only available for deploying base models.

grant_type
string
Default: "client_credentials"

The authentication grant type.

Responses

Response samples

Content type
application/json
Example
SUCCESS
SUCCESS
WARNING
{
  • "result": "SUCCESS",
  • "import_id": "550e8400-e29b-41d4-a716-446655440000"
}

DeleteModel

Deletes the base model, device model, and projects associated with the specified model ID.

Authorizations:
accessToken
path Parameters
model_id
required
string

ID of the AI model.

query Parameters
grant_type
string
Default: "client_credentials"

The authentication grant type.

Responses

Response samples

Content type
application/json
{
  • "result": "SUCCESS"
}

UpdateModel

Updates attribute information of the specified model.

Authorizations:
accessToken
path Parameters
model_id
required
string

ID of the AI model. The maximum number of characters that can be specified is 100.

query Parameters
comment
string

Description of the subject. The maximum number of characters that can be specified is 100.

version_number
string

Name of the vendor. The maximum number of characters that can be specified is 100.

grant_type
string
Default: "client_credentials"

The authentication grant type.

Responses

Response samples

Content type
application/json
{
  • "result": "SUCCESS"
}

GetBaseModelStatus

Returns an information of the specified base model.

Authorizations:
accessToken
path Parameters
model_id
required
string

ID of the AI model.

query Parameters
latest_type
string
Default: "1"

Classification of the latest version.

  • Value definition:
    0: Latest version after publication.
    1: Latest version after completion of the conversion process or publication.
grant_type
string
Default: "client_credentials"

The authentication grant type.

Responses

Response samples

Content type
application/json
{
  • "model_id": "string",
  • "model_type": "string",
  • "functionality": "string",
  • "vendor_name": "string",
  • "model_comment": "string",
  • "network_type": "string",
  • "create_by": "string",
  • "package_id": "string",
  • "product_id": "string",
  • "metadata_format_id": "string",
  • "projects":
    [
    ]
}

GetBaseModelVersions

Returns a list of base model version.

Authorizations:
accessToken
path Parameters
model_id
required
string

ID of the AI model.

query Parameters
version_number
string

Version number.

scope
any
Default: "full"
Enum: "full" "minimal"

The scope of response parameters to return.

  • Value definition:
    full: Returns all parameters
    minimal: Returns minimal parameters *effective for timesaving
grant_type
string
Default: "client_credentials"

The authentication grant type.

Responses

Response samples

Content type
application/json
{
  • "model_id": "string",
  • "model_type": "string",
  • "functionality": "string",
  • "vendor_name": "string",
  • "model_comment": "string",
  • "network_type": "string",
  • "create_by": "string",
  • "package_id": "string",
  • "product_id": "string",
  • "metadata_format_id": "string",
  • "projects":
    [
    ]
}

UpdateBaseModelVersion

Updates attribute information of the specified base model version.

Authorizations:
accessToken
path Parameters
model_id
required
string

ID of the AI model.

version_number
required
string

Version number.

query Parameters
grant_type
string
Default: "client_credentials"

The authentication grant type.

Request Body schema: application/json
comment
string

Description of version. The maximum number of characters that can be specified is 100.

input_format_param
string

SAS URL or Presigned URL of the input format param file.
*Usage: Packager conversion information (image format information).
*The json format is an array of objects. Each object contains the following values.
 ・ordinal: Order of DNN input to converter (value range: 0 to 2)
 ・format: Format ("RGB" or "BGR")
*Example:
 [{      "ordinal": 0,
     "format": "RGB"
 },
 {
     "ordinal": 1,
     "format": "RGB"
 }]

network_config
string

SAS URL or Presigned URL of the network config file.
*Usage: Conversion parameter information of the model converter. Therefore, it is not necessary to specify when specifying the AI model before conversion.
*Example:
 {
   "Postprocessor": {
     "params": {
       "background": false,
       "scale_factors": [
         10.0,
         10.0,
         5.0,
         5.0
       ],
       "score_thresh": 0.01,
       "max_size_per_class": 64,
       "max_total_size": 64,
       "clip_window": [
         0,
         0,
         1,
         1
       ],
       "iou_threshold": 0.45
     }
   }
 }

Responses

Request samples

Content type
application/json
{
  • "comment": "string",
  • "input_format_param": "string",
  • "network_config": "string"
}

Response samples

Content type
application/json
{
  • "model_id": "string",
  • "model_type": "string",
  • "functionality": "string",
  • "vendor_name": "string",
  • "model_comment": "string",
  • "network_type": "string",
  • "create_by": "string",
  • "package_id": "string",
  • "product_id": "string",
  • "metadata_format_id": "string",
  • "projects":
    [
    ]
}

GetDeviceModelStatus

Returns an information of the specified device model.

Authorizations:
accessToken
path Parameters
model_id
required
string

ID of the AI model.

device_id
required
string

Device ID.

query Parameters
latest_type
string
Default: "1"

Classification of the latest version.

  • Value definition:
    0: Latest version after publication.
    1: Latest version after completion of the conversion process or publication.
grant_type
string
Default: "client_credentials"

The authentication grant type.

Responses

Response samples

Content type
application/json
{
  • "model_id": "string",
  • "model_type": "string",
  • "functionality": "string",
  • "vendor_name": "string",
  • "model_comment": "string",
  • "network_type": "string",
  • "create_by": "string",
  • "package_id": "string",
  • "product_id": "string",
  • "metadata_format_id": "string",
  • "projects":
    [
    ]
}

GetDeviceModelVersions

Returns a list of device model version information.

Authorizations:
accessToken
path Parameters
model_id
required
string

ID of the AI model.

device_id
required
string

Device ID.

query Parameters
scope
any
Default: "full"
Enum: "full" "minimal"

The scope of response parameters to return.

  • Value definition:
    full: Returns all parameters
    minimal: Returns minimal parameters *effective for timesaving
version_number
string

Version number.

grant_type
string
Default: "client_credentials"

The authentication grant type.

Responses

Response samples

Content type
application/json
{
  • "model_id": "string",
  • "model_type": "string",
  • "functionality": "string",
  • "vendor_name": "string",
  • "model_comment": "string",
  • "network_type": "string",
  • "create_by": "string",
  • "package_id": "string",
  • "product_id": "string",
  • "metadata_format_id": "string",
  • "projects":
    [
    ]
}

UpdateDeviceModelVersion

Updates attribute information of the AI model version for the specified Edge Device.

Authorizations:
accessToken
path Parameters
model_id
required
string

ID of the AI model.

device_id
required
string

Device ID.

version_number
required
string

Version number.

query Parameters
grant_type
string
Default: "client_credentials"

The authentication grant type.

Request Body schema: application/json
comment
required
string

Description of version.

Responses

Request samples

Content type
application/json
{
  • "comment": "string"
}

Response samples

Content type
application/json
{
  • "result": "SUCCESS"
}

GetDnnParams

Returns dnn_params of the specified model.

Authorizations:
accessToken
path Parameters
model_id
required
string

ID of the AI model.

query Parameters
version_number
string
Default: "latest"

Version number.

device_id
string

Device ID
*Only available for device models. This parameter is only available for deploying base models.

grant_type
string
Default: "client_credentials"

The authentication grant type.

Responses

Response samples

Content type
application/json
{
  • "contents": "string"
}

GetModelBundles

Get model bundle list.

Authorizations:
accessToken
query Parameters
model_bundle_name
string (Model Bundle Name)

Model Bundle Name.

Responses

Response samples

Content type
application/json
{
  • "model_bundles":
    [
    ]
}

ImportModelBundle

Imports a model bundle into your project.

Authorizations:
accessToken
Request Body schema: application/json
bundle_name
required
string (Bundle Name)

Model bundle name for new registration or version upgrade. The maximum number of characters that can be specified is 100.

vendor_name
string (Vendor Name)

Name of the vendor. The maximum number of characters that can be specified is 100.

description
string (Description)

Description of the subject. The maximum number of characters that can be specified is 100.
*When saving a new model bundle, a same value is set to model bundle and model_bundle_version parameters. *When updating a model bundle, any string can be set for model_bundle_version.

bundle_file_id
string (Bundle)

File ID of the model bundle file.

Responses

Request samples

Content type
application/json
{
  • "bundle_name": "string",
  • "vendor_name": "string",
  • "description": "string",
  • "bundle_file_id": "string"
}

Response samples

Content type
application/json
{
  • "result": "SUCCESS"
}

DeleteModelBundle

Delete the model bundle associated with the specified model bundle name.

Authorizations:
accessToken
path Parameters
model_bundle_name
required
string (Model bundle name)

Model bundle name.

Responses

Response samples

Content type
application/json
{
  • "result": "SUCCESS"
}

GetModelBundleVersions

Get model bundle version list.

Authorizations:
accessToken
path Parameters
model_bundle_name
required
string (Model Bundle Name)

Model Bundle Name.

query Parameters
version_number
string (Version Number)

Version number.

Responses

Response samples

Content type
application/json
{
  • "model_bundle_name": "string",
  • "description": "string",
  • "create_date": "string",
  • "versions":
    [
    ]
}

Firmware

GetFirmwares

Lists the information of the chosen Edge System Software.

Authorizations:
accessToken
query Parameters
limit
integer
Default: 20

Number of the items to fetch information.
Value range: 1 to 256

starting_after
string

Retrieves additional data beyond the number of targets specified by the query parameter (limit). Specify the value obtained from the response (continuation_token) to fetch the next data.

firmware_type
string
Value: "edge_system_sw_package"

Type of the Edge System Software.

target_device_type
string

Type of the target device.

grant_type
string
Default: "client_credentials"

The authentication grant type.

Responses

Response samples

Content type
application/json
{
  • "continuation_token": "string",
  • "firmwares":
    [
    ]
}

CreateFirmware

Registers the Edge System Software to the Console.

Authorizations:
accessToken
query Parameters
grant_type
string
Default: "client_credentials"

The authentication grant type.

Request Body schema: application/json
firmware_type
required
string
Value: "edge_system_sw_package"

Type of the Edge System Software.

description
string
Default: ""

description. The maximum number of characters that can be specified is 100.

file_id
required
string

The file ID returned in the response from the UploadFile API.

Responses

Request samples

Content type
application/json
{
  • "firmware_type": "edge_system_sw_package",
  • "description": "",
  • "file_id": "string"
}

Response samples

Content type
application/json
{
  • "result": "SUCCESS"
}

GetFirmware

Returns the information of a specific Edge System Software.

Authorizations:
accessToken
path Parameters
firmware_id
required
string

Firmware ID

query Parameters
grant_type
string
Default: "client_credentials"

The authentication grant type.

Responses

Response samples

Content type
application/json
{
  • "firmware_id": "string",
  • "firmware_type": "edge_system_sw_package",
  • "firmware_version": "string",
  • "description": "string",
  • "ins_id": "string",
  • "ins_date": "string",
  • "upd_id": "string",
  • "upd_date": "string",
  • "target_device_types":
    [
    ],
  • "manifest": { }
}

DeleteFirmware

Deletes the specified Edge System Software from the Console.

Authorizations:
accessToken
path Parameters
firmware_id
required
string

Firmware ID

query Parameters
grant_type
string
Default: "client_credentials"

The authentication grant type.

Responses

Response samples

Content type
application/json
{
  • "result": "SUCCESS"
}

Edge App

GetEdgeApps

Returns a list of registered Edge Applications.

Authorizations:
accessToken
query Parameters
limit
integer
Default: 20

Number of the items to fetch information.
Value range: 1 to 256

starting_after
string

Retrieves additional data beyond the number of targets specified by the query parameter (limit). Specify the value obtained from the response (continuation_token) to fetch the next data.

grant_type
string
Default: "client_credentials"

The authentication grant type.

Responses

Response samples

Content type
application/json
{
  • "continuation_token": "string",
  • "apps":
    [
    ]
}

ImportEdgeApp

Imports Edge Application to the Console.

Authorizations:
accessToken
query Parameters
grant_type
string
Default: "client_credentials"

The authentication grant type.

Request Body schema: application/json
description
string

Description of the subject. The maximum number of characters that can be specified is 100.

app_name
string

Specify if you want to use a different The application name. from the one in the package.

edge_app_package_id
required
string

The Edge App Package file ID returned in the response from the UploadFile API.

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "app_name": "string",
  • "edge_app_package_id": "string"
}

Response samples

Content type
application/json
{
  • "result": "SUCCESS"
}

GetEdgeApp

Returns the information of a specific Edge Application.

Authorizations:
accessToken
path Parameters
app_name
required
string

The application name.

app_version
required
string

The application version.

query Parameters
grant_type
string
Default: "client_credentials"

The authentication grant type.

Responses

Response samples

Content type
application/json
{
  • "app_name": "string",
  • "app_version": "string",
  • "root_dtmi": "string",
  • "compiled_flg": true,
  • "status": "before_compile",
  • "description": "string",
  • "deploy_count": 0,
  • "ins_id": "string",
  • "ins_date": "string",
  • "upd_id": "string",
  • "upd_date": "string"
}

DeleteEdgeApp

Deletes the specified Edge Application from the Console.

Authorizations:
accessToken
path Parameters
app_name
required
string

The application name.

app_version
required
string

The application version.

query Parameters
grant_type
string
Default: "client_credentials"

The authentication grant type.

Responses

Response samples

Content type
application/json
{
  • "result": "SUCCESS"
}

ExportEdgeApp

Exports the specified Edge Application information.

Authorizations:
accessToken
path Parameters
app_name
required
string

The application name.

app_version
required
string

The application version.

query Parameters
grant_type
string
Default: "client_credentials"

The authentication grant type.

Responses

Response samples

Content type
application/json
{
  • "contents": "string",
  • "file_name": "string"
}

GetEdgeAppDeploys

Returns the specified Edge Application deployment status.

Authorizations:
accessToken
path Parameters
app_name
required
string

The application name.

app_version
required
string

The application version.

query Parameters
limit
integer
Default: 20

Number of the items to fetch information.
Value range: 1 to 256

starting_after
string

Retrieves additional data beyond the number of targets specified by the query parameter (limit). Specify the value obtained from the response (continuation_token) to fetch the next data.

grant_type
string
Default: "client_credentials"

The authentication grant type.

Responses

Response samples

Content type
application/json
{
  • "continuation_token": "string",
  • "deploys":
    [
    ]
}

Insight

GetImageDirectories

Returns the directory information (device group and device information) where images are stored.

Authorizations:
accessToken
query Parameters
device_id
string

Device ID. If this is specified, return an image directory list linked to the specified device ID.

include_deleted_device
boolean
Default: false

Specify whether to delete images from devices that have been removed from the Console.

grant_type
string
Default: "client_credentials"

The authentication grant type.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

GetImages

Returns a SAS URL to download images from a specific device. Copy the URL to access the data. The URL will expire after one hour. *Application: Use to display an image in a UI

Authorizations:
accessToken
path Parameters
device_id
required
string

Device ID.

sub_directory_name
required
string

Directory name.

query Parameters
limit
integer
Default: 50

Number of the items to fetch information.
Value range: 1 to 256

starting_after
string

Retrieves additional data beyond the number of targets specified by the query parameter (limit). Specify the value obtained from the response (continuation_token) to fetch the next data.

name_starts_with
string
Default: ""

Return only objects that forward match the input string

grant_type
string
Default: "client_credentials"

The authentication grant type.

Responses

Response samples

Content type
application/json
{
  • "continuation_token": "string",
  • "data":
    [
    ]
}

DeleteImages

Deletes the saved images from a specific Edge Device.

Authorizations:
accessToken
path Parameters
device_id
required
string

Device ID.

sub_directory_name
required
string

Directory name.

query Parameters
grant_type
string
Default: "client_credentials"

The authentication grant type.

Request Body schema: application/json
directory_deletion
string
Default: "0"

The directory deletion flag.

  • Value definition:
    0: Delete by specifying a file 1: Delete files by specifying a directory
filenames
Array of strings

Specify the file name to delete when the value of directory_deletion is set to 0.

limit
integer
Default: 10000

Number of the items to be deleted. The oldest stored items are deleted first. Value range: 1 to 10000

Responses

Request samples

Content type
application/json
{
  • "directory_deletion": "0",
  • "filenames":
    [
    ],
  • "limit": 10000
}

Response samples

Content type
application/json
{
  • "result": "SUCCESS"
}

DeleteInferenceResults

Deletes the inference data retrieved through the GetInferenceResults.

Authorizations:
accessToken
path Parameters
device_id
required
string

Device ID

query Parameters
item_ids
required
string
Example: item_ids=1,2,3,5

The ID of the inference result to be deleted, obtained from GetInferenceResults.

include_deleted_device
boolean
Default: false

Specify whether to also delete inference results from devices that have been removed from the Console.

grant_type
string
Default: "client_credentials"

The authentication grant type.

Responses

Response samples

Content type
application/json
{
  • "result": "SUCCESS"
}

Retrieve a list of inferences

Returns a list of inferences with optional filters for devices and time range.

Authorizations:
accessToken
query Parameters
limit
integer [ 1 .. 500 ]
Default: 50

The number of inferences to retrieve. The default is 50, with a minimum of 1 and a maximum of 500.

devices
required
Array of strings <= 10 items
Example: devices=device_123&devices=device_456

A device ID or a list of device IDs to obtain inferences from, with a minimum number of 1 and a maximum of 10.

starting_after
string

Retrieves additional data beyond the number of targets specified by the query parameter (limit). Specify the value obtained from the response (continuation_token) to fetch the next data.

from_datetime
string <date-time>
Example: from_datetime=2024-01-01T00:00:00.000000

The start datetime for filtering inferences (in ISO-8601 format).

  • Format: yyyyMMddThhmmss.SSSSSS or yyyy-MM-ddThh:mm:ss.SSSSSS (ISO-8601)
to_datetime
string <date-time>
Example: to_datetime=2024-01-01T00:00:00.000000

The end datetime for filtering inferences (in ISO-8601 format).

  • Format: yyyyMMddThhmmss.SSSSSS or yyyy-MM-ddThh:mm:ss.SSSSSS (ISO-8601)

Responses

Response samples

Content type
application/json
{
  • "continuation_token": "string",
  • "inferences":
    [
    ]
}

Connector

GetIRHubConnector

Get the inference result hub connector.

Authorizations:
accessToken

Responses

Response samples

Content type
application/json
Example
IrHubConnectorDefault
IrHubConnectorDefault
IrHubConnectorAzureBlobStorage
IrHubConnectorAzureEventHub
IrHubConnectorAwsKinesis
IrHubConnectorAwsS3
IrHubConnectorKafka
{
  • "type": "Default(Internal)",
  • "url": "",
  • "name": ""
}

UpdateIRHubConnector

Updates the external transfer settings to forward inference results obtained from Edge Devices to Azure Event Hubs.

Authorizations:
accessToken
query Parameters
grant_type
string
Default: "client_credentials"

The authentication grant type.

Request Body schema: application/json
One of
type
required
string (Type)
Default: ""

The platform type where the system should store the inference results. Set "AzureEventHub". *Connector would be initial setting if type is "".

url
required
string (Url)

Connection string for Azure Event Hubs.

name
required
string (Name)

The name of Azure Event Hubs Instance Name.

Responses

Request samples

Content type
application/json
Example
AzureEventHub
AzureEventHub
AzureBlobStorage
AWSS3
AWSKinesis
Kafka
{
  • "type": "",
  • "url": "string",
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "result": "SUCCESS"
}

GetStorageConnector

Get the storage hub connectors.

Authorizations:
accessToken

Responses

Response samples

Content type
application/json
{
  • "input_image":
    {
    },
  • "inference_result":
    {
    }
}

UpdateStorageConnector

Updates the storage hub connector. Specify the items (inference results, images, or both) to transfer to a storage service. To change the transmission destination of inference results, please modify the value of UploadMethodIR in the Command parameter. You can store inference results in your cloud storage by setting the value of UploadMethodIR to "BlobStorage". Likewise, to revert the transmission to AITRIOS internal storage, set the value of UploadMethodIR to "Mqtt".

Authorizations:
accessToken
query Parameters
grant_type
string
Default: "client_credentials"

The authentication grant type.

Request Body schema: application/json
One of
type
string
Default: "AZURE"

The storage service type. Specify “AZURE” as the value.

  • Value definition:
    AZURE
mode
integer
Default: 0

Specifies the input image, inferences result or both to be streamed.

  • Value definition:
    0: input image only
    1: input image and inference result
    2: inference result only
endpoint
string

Destination Azure Blob Storage endpoint.
*Please do not set “endpoint”, “connection_string”, or “container_name” when returning to the initial value. In the case of the initial value when input image is specified in “mode”, it will be streamed within this service and then when inference result is specified in “mode”, the settings for inference are deleted.

connection_string
string

Connection string for Azure Blob Storage.
*When initializing, see the description of “endpoint”.

container_name
string

Container name of Azure Blob Storage.
*When initializing, see the description of “endpoint”.

Responses

Request samples

Content type
application/json
Example
Azure
Azure
AWS
{
  • "type": "AZURE",
  • "mode": 0,
  • "endpoint": "string",
  • "connection_string": "string",
  • "container_name": "string"
}

Response samples

Content type
application/json
{
  • "result": "SUCCESS"
}

Utility

UploadFile

Returns the parameter (file ID) used by the API below. Specify the returned 'file_info.id' as the parameter.

  • ImportBaseModel
  • CreateFirmware
  • ImportEdgeApp
Authorizations:
accessToken
query Parameters
grant_type
string
Default: "client_credentials"

The authentication grant type.

Request Body schema: multipart/form-data
type_code
string
Enum: "non_converted_model" "converted_model" "input_format_param" "network_config" "firmware" "edge_app" "edge_app_dtdl" "edge_app_pkg" "dcpu_firmware" "dcpu_manifest" "dcpu_postprocess" "model_bundle"

File type code.

file
string <binary>

File contents.

Responses

Response samples

Content type
application/json
{
  • "result": "string",
  • "file_info":
    {
    }
}