Download OpenAPI specification:Download
Returns a QR in base64-encoded format to provision the Edge Device.
| ntp required | string NTP server. The maximum number of characters that can be specified is 64. |
| auto | boolean Default: false Connection state.
|
| 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. |
{- "result": "SUCCESS",
- "contents": "string"
}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).
| device_name required | string The device name. *The maximum number of characters that can be specified is 255. |
| primary_certificate required | string X.509 primary certificate (.pem file or .cer file or .crt file) . *Specify the following certificate without the leading and trailing signatures. -----BEGIN CERTIFICATE----- -----END CERTIFICATE----- Also, do not include line breaks. |
{- "device_name": "string",
- "primary_certificate": "string"
}{- "result": "string",
- "id": "string"
}{- "certificates": [
- {
- "device_id": "string",
- "internal_device_id": "string",
- "device_name": "string",
- "credentials_id_object": "string",
- "credentials_type": "string",
- "expiration_date": "string",
- "created_time": "string"
}
]
}The information for a specific Edge Device (device ID) within a group.
| device_id required | string The Device ID. |
{- "device_id": "string",
- "internal_device_id": "string",
- "device_name": "string",
- "credentials_id_object": "string",
- "credentials_type": "string",
- "expiration_date": "string",
- "created_time": "string"
}Updates the device certificate information for a specific Edge Device.
| device_id required | string The Device ID. |
| primary_certificate required | string Device certificate X.509 primary certificate *Specify the following certificate without the leading and trailing signatures -----BEGIN CERTIFICATE----- -----END CERTIFICATE----- Also, do not include line breaks. |
{- "primary_certificate": "string"
}{- "result": "SUCCESS"
}Lists the information of Edge Devices specified by query parameters.
| connectionState | string Default: "" Connection state.
|
| device_name | string Default: "" Name of the device. *Fuzzy searching is available. |
| device_id | string Default: "" The Device ID. *Fuzzy searching is available. |
| device_group_id | string Default: "" The device group ID. |
| device_ids | string Default: "" To specify multiple device IDs, separate them with commas. |
| scope | string Default: "full" The scope of response parameters to return.
|
{- "devices": [
- {
- "device_id": "string",
- "place": "string",
- "comment": "string",
- "property": {
- "device_name": "string",
- "internal_device_id": "string"
}, - "device_type": "string",
- "display_device_type": "string",
- "ins_id": "string",
- "ins_date": "string",
- "upd_id": "string",
- "upd_date": "string",
- "connectionState": "string",
- "lastActivityTime": "string",
- "models": [
- {
- "model_version_id": "string"
}
], - "configuration": { },
- "state": { },
- "device_groups": [
- {
- "device_group_id": "string",
- "device_type": "string",
- "comment": "string",
- "ins_id": "string",
- "ins_date": "string",
- "upd_id": "string",
- "upd_date": "string"
}
]
}
]
}Returns the information of an Edge Device specified by query parameters.
| device_id required | string The Device ID. |
{- "device_id": "string",
- "place": "string",
- "comment": "string",
- "property": {
- "device_name": "string",
- "internal_device_id": "string"
}, - "device_type": "string",
- "display_device_type": "string",
- "ins_id": "string",
- "ins_date": "string",
- "upd_id": "string",
- "upd_date": "string",
- "connectionState": "string",
- "lastActivityTime": "string",
- "models": [
- {
- "model_version_id": "string"
}
], - "device_groups": [
- {
- "device_group_id": "string",
- "device_type": "string",
- "comment": "string",
- "ins_id": "string",
- "ins_date": "string",
- "upd_id": "string",
- "upd_date": "string"
}
], - "configuration": { },
- "state": { },
- "command_results": [
- {
- "command_name": "string",
- "result": "string",
- "execute_time": "string"
}
], - "apps": [
- {
- "name": "string",
- "version": "string",
- "comment": "string"
}
]
}Specifies whether to allow or deny the execution of a factory reset on the specified Edge Device.
| device_id required | string The Device ID. |
| factory_reset required | string Allow or deny the execution of a factory reset on the specified Edge Device.
|
{- "result": "SUCCESS"
}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.
| device_group_id | string Default: "" Device groups' ID. *Fuzzy searching is available. |
| comment | string Default: "" Description of the subject. *Fuzzy searching is available. |
| device_id | string Default: "" Device IDs within the corresponding group. Lists the device groups that includes the specified device ID. |
{- "device_groups": [
- {
- "device_group_id": "string",
- "device_type": "string",
- "comment": "string",
- "ins_id": "string",
- "ins_date": "string",
- "upd_id": "string",
- "upd_date": "string",
- "devices": [
- {
- "device_id": "string",
- "property": {
- "device_name": "string",
- "internal_device_id": "string"
}, - "device_type": "string",
- "display_device_type": "string",
- "place": "string",
- "comment": "string",
- "ins_id": "string",
- "ins_date": "string",
- "upd_id": "string",
- "upd_date": "string"
}
]
}
]
}Creates a new device group.
| device_group_id required | string Name of the device group. |
| comment | string Default: "" Description of the subject. The maximum number of characters that can be specified is 100. |
| device_id | string Default: "" Included device ID.
|
| del_from_dgroup | string Default: "0" To remove the device belonging to multiple groups, configure the following:
|
{- "result": "SUCCESS"
}Lists the information for specific device groups (device group ID).
| device_group_id required | string The device group ID. |
{- "device_group_id": "string",
- "device_type": "string",
- "comment": "string",
- "ins_id": "string",
- "ins_date": "string",
- "upd_id": "string",
- "upd_date": "string",
- "devices": [
- {
- "device_id": "string",
- "property": {
- "device_name": "string",
- "internal_device_id": "string"
}, - "device_type": "string",
- "display_device_type": "string",
- "place": "string",
- "comment": "string",
- "ins_id": "string",
- "ins_date": "string",
- "upd_id": "string",
- "upd_date": "string"
}
]
}Performs device registration, deletion, and update within the specified device group.
| device_group_id required | string Device group ID to update. |
| comment | 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".
*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.
|
{- "result": "SUCCESS"
}Instructs the Edge Device to start retrieving the inference result metadata (Output Tensor) and the input image.
| device_id required | string The Device ID. |
{- "result": "SUCCESS",
- "outputSubDirectory": "string",
- "outputSubDirectoryIR": "string"
}Implement instructions to the specified device to stop getting the inference result metadata (Output Tensor) and image (Input image).
| device_id required | string The Device ID. |
{- "result": "SUCCESS"
}Performs the following operations to reset the specified Edge Device to its initial state:
| device_id required | string The Device ID. |
{- "result": "SUCCESS"
}DO NOT USE THIS API. Change the log settings of a specified device.
| device_id required | string Device ID |
| level | string Default: "Error" Log level.
|
| destination | string Default: "UART" By output destination type
|
| SensorRegister | string Default: false Sensor register.
|
{- "result": "SUCCESS"
}Configures logging to be enabled or disabled for the specific Edge Device.
| device_id required | string The Device ID. |
| enable | boolean Default: true Enable or disable the feature.
|
{- "enable": true
}{- "result": "SUCCESS"
}The frame rate or drive mode of the image. Either the frame rate or drive mode must be set.
| device_id required | string The Device ID. |
| frame_rate | integer Default: 2997 The frame rate. *Set an integer value multiplied by 100 for the frame rate that output from the sensor. The maximum value of the frame rate depends on the DriveMode value (refer to the Drive mode specification for the details on the drive_mode parameters).
| ||||||||||||||||||||||||||||||
| drive_mode | integer Default: 1 The drive mode.
|
{- "frame_rate": 2997,
- "drive_mode": 1
}{- "result": "SUCCESS"
}Update the following password for the specified device:
| device_id required | string The Device ID. |
| password required | string Plaintext with a maximum of 32 characters allowed. |
{- "password": "string"
}{- "result": "SUCCESS"
}Applies the Device Configuration to the specified device. The configuration will be applied to the device asynchronously. To confirm whether the changes have been applied, use the GetDevices or GetDevice API.
| device_id required | string The Device ID. |
object |
{- "payload": {
- "FWOperation": {
- "OperatingMode": "Manual",
- "ErrorHandling": "ManualReset",
- "PeriodicParameter": {
- "NetworkParameter": "Save",
- "PrimaryInterval": {
- "ConfigInterval": 0,
- "CaptureInterval": 0,
- "BaseTime": "string",
- "UploadCount": 1
}, - "SecondaryInterval": {
- "ConfigInterval": 0,
- "CaptureInterval": 0,
- "BaseTime": "string",
- "UploadCount": 0
}, - "UploadInferenceParameter": {
- "UploadMethodIR": "BlobStorage",
- "StorageNameIR": "string",
- "StorageSubDirectoryPathIR": "string",
- "PPLParameter": "string",
- "CropHOffset": 0,
- "CropVOffset": 0,
- "CropHSize": 4056,
- "CropVSize": 3040,
- "NetworkId": "string"
}
}
}, - "Direction": {
- "Vertical": "Normal",
- "Horizontal": "Normal"
}, - "Adjustment": {
- "Gamma": "std"
}
}
}{- "result": "SUCCESS"
}{- "parameter_list": [
- {
- "parameter": {
- "commands": [
- {
- "command_name": "string",
- "parameters": {
- "Mode": 0,
- "UploadMethod": "string",
- "FileFormat": "string",
- "UploadMethodIR": "string",
- "CropHOffset": 0,
- "CropVOffset": 0,
- "CropHSize": 0,
- "CropVSize": 0,
- "NumberOfImages": 0,
- "UploadInterval": 0,
- "NumberOfInferencesPerMessage": 0,
- "MaxDetectionsPerFrame": 0,
- "ModelId": "string",
- "PPLParameter": { }
}
}
]
}, - "file_name": "string",
- "comment": "string",
- "isdefault": "string",
- "device_ids": [
- "string"
], - "ins_id": "string",
- "ins_date": "string",
- "upd_id": "string",
- "upd_date": "string"
}
]
}Registers different types of command parameter files.
This API allows you to register the following parameters in advance:
The following APIs are used for file management and application of the device:
< Parameter file management >
< Binding/Unbinding with the device >
If the parameter file is not applied to the device, the default value will be used. APIs with such required parameters will result in an error when the API is executed. The default file can be specified using the following API:
| file_name required | string File name. The maximum number of characters that can be specified is 100. |
| parameter required | string Command parameter content in Base64 encoding. Refer to the Console User Manual for detailed format instructions. |
| comment | string Description of the subject. |
{- "file_name": "string",
- "parameter": "string",
- "comment": "string"
}{- "result": "SUCCESS"
}Updates the command parameter file.
| file_name required | string File name. |
| parameter required | string Command parameter content in Base64 encoding. Refer to the Console User Manual for detailed format instructions. |
| comment | string Description of the subject. |
{- "parameter": "string",
- "comment": "string"
}{- "result": "SUCCESS"
}Binds the command parameter file to the specified Edge Devices.
| file_name required | string File name. |
| device_ids required | string To specify multiple device IDs, separate them with commas. |
{- "device_ids": "string"
}{- "result": "SUCCESS"
}Unbinds the command parameter file from the specified Edge Devices.
| file_name required | string File name. |
| device_ids required | string To specify multiple device IDs, separate them with commas. |
{- "device_ids": "string"
}{- "result": "SUCCESS"
}Lists the information of the device custom setup file.
| type | string The type of device custom setup file.
|
{- "device_setup_files": [
- {
- "file_name": "string",
- "type": "string",
- "comment": "string",
- "ins_id": "string",
- "ins_date": "string",
- "upd_id": "string",
- "upd_date": "string"
}
]
}Create device custom setup file.
| type required | string The type of device custom setup file.
|
| file_name required | string File name. |
| file_id required | string File ID of the device custom setup file. |
| comment | string Description of the subject. |
{- "type": "string",
- "file_name": "string",
- "file_id": "string",
- "comment": "string"
}{- "result": "SUCCESS"
}Lists the information of the device custom setup file.
| file_name required | string File name. |
{- "file_name": "string",
- "type": "string",
- "comment": "string",
- "ins_id": "string",
- "ins_date": "string",
- "upd_id": "string",
- "upd_date": "string"
}{- "deploy_configurations": [
- {
- "config_id": "string",
- "device_type": "string",
- "config_comment": "string",
- "running_cnt": 0,
- "success_cnt": 0,
- "fail_cnt": 0,
- "firmware": {
- "sensor_loader_file_name": "string",
- "sensor_loader_version_number": "string",
- "sensor_loader_firmware_comment": "string",
- "sensor_file_name": "string",
- "sensor_version_number": "string",
- "sensor_firmware_comment": "string",
- "apfw_file_name": "string",
- "apfw_version_number": "string",
- "apfw_firmware_comment": "string"
}, - "model": {
- "model_id": "string",
- "model_version_number": "string",
- "model_comment": "string",
- "model_version_comment": "string"
}, - "custom_setup": {
- "gamma_mode": "string",
- "gamma_file_name": "string",
- "gamma_comment": "string"
}, - "ins_id": "string",
- "ins_date": "string",
- "upd_id": "string",
- "upd_date": "string"
}
]
}Creates the Deploy Configuration. The registration will include the following features:
| config_id required | string The maximum number of characters that can be specified is 20 single-byte ones. |
| comment | string Default: "" The maximum number of characters that can be specified is 100. |
| sensor_loader_version_number | string Default: "" Sensor loader version number. |
| sensor_version_number | string Default: "" Sensor version number. |
| model_id | string Default: "" AI model ID. |
| model_version_number | string Default: "Latest" Model version number. |
| ap_fw_version_number | string Default: "" MCU (AppFw) version number. |
| gamma_file_name | string Default: "" Gamma File name. |
{- "result": "SUCCESS"
}Lists the information of the specified deployment configuration.
| config_id required | string Deployment configuration ID. |
{- "config_id": "string",
- "device_type": "string",
- "config_comment": "string",
- "running_cnt": 0,
- "success_cnt": 0,
- "fail_cnt": 0,
- "firmware": {
- "sensor_loader_file_name": "string",
- "sensor_loader_version_number": "string",
- "sensor_loader_firmware_comment": "string",
- "sensor_file_name": "string",
- "sensor_version_number": "string",
- "sensor_firmware_comment": "string",
- "apfw_file_name": "string",
- "apfw_version_number": "string",
- "apfw_firmware_comment": "string"
}, - "model": {
- "model_id": "string",
- "model_version_number": "string",
- "model_comment": "string",
- "model_version_comment": "string"
}, - "custom_setup": {
- "gamma_mode": "string",
- "gamma_file_name": "string",
- "gamma_comment": "string"
}, - "ins_id": "string",
- "ins_date": "string",
- "upd_id": "string",
- "upd_date": "string"
}Deploys the following features specified by the Deploy Configuration to Edge Devices:
| config_id required | string Setting ID. |
| device_ids required | string To specify multiple device IDs, separate them with commas. |
| replace_model_id | string Default: "" Specify the model ID or network_id. |
| comment | string Default: "" The maximum number of characters that can be specified is 100. |
{- "result": "SUCCESS",
- "deploy_id": 12345
}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.
| device_id required | string The Device ID. |
| deploy_id required | integer Deploy ID |
{- "result": "SUCCESS"
}Returns the deployment history of core features such as Edge System softwares, AI models, and Edge Applications that run on the Edge Device.
| device_id required | string The Device ID. |
{- "deploys": [
- {
- "id": 0,
- "deploy_type": "string",
- "deploy_status": "string",
- "update_progress": "string",
- "deploy_comment": "string",
- "config_id": "string",
- "replace_network_id": "string",
- "current_target": "string",
- "total_status": "string",
- "app_name": "string",
- "version_number": "string",
- "firmware": {
- "sensor_loader_target_flg": "string",
- "sensor_loader_status": "string",
- "sensor_loader_retry_count": "string",
- "sensor_loader_start_date": "string",
- "sensor_loader_end_date": "string",
- "sensor_loader_version_number": "string",
- "sensor_loader_version_comment": "string",
- "sensor_target_flg": "string",
- "sensor_status": "string",
- "sensor_retry_count": "string",
- "sensor_start_date": "string",
- "sensor_end_date": "string",
- "sensor_version_number": "string",
- "sensor_version_comment": "string",
- "apfw_target_flg": "string",
- "apfw_status": "string",
- "apfw_retry_count": "string",
- "apfw_start_date": "string",
- "apfw_end_date": "string",
- "apfw_version_number": "string",
- "apfw_version_comment": "string"
}, - "model": {
- "model_target_flg": "string",
- "model_status": "string",
- "model_retry_count": "string",
- "model_start_date": "string",
- "model_end_date": "string",
- "model_id": "string",
- "model_version_number": "string",
- "model_comment": "string"
}, - "custom_setting": {
- "gamma_target_flg": "string",
- "gamma_status": "string",
- "gamma_retry_count": "string",
- "gamma_start_date": "string",
- "gamma_end_date": "string",
- "gamma_mode": "string",
- "gamma_file_name": "string",
- "gamma_comment": "string"
}, - "ins_id": "string",
- "ins_date": "string",
- "upd_id": "string",
- "upd_date": "string"
}
]
}Lists the deployment history statuses in the deployment layer.
| deploy_id | integer Deployment ID. |
| app_deploy_id | integer Deployment ID of the application. |
| from_datetime | string Deployment start date and time, format 'yyyyMMddhhmm', must not be later than the current time. |
| to_datetime | string Deployment end date and time, format 'yyyyMMddhhmm', must not be later than the current time or earlier than from_datetime. |
| top required | number Default: 20 Number of records to retrieve. If 100 is specified, 100 records will be returned. |
| skip required | number Default: 0 Number of records to skip. If 100 is specified, the response will start from the 101st record. |
[- {
- "deploy_id": 10,
- "from_datetime": "2023-09-06T13:50:07.930666+00:00",
- "deploy_type": "1",
- "running_cnt": 3,
- "success_cnt": 5,
- "fail_cnt": 3,
- "config_id": "config_230812",
- "dnn_model": "zonedection_20230824_v1.0",
- "dnn_model_version": "1.00",
- "device_firmware": "D70004",
- "device_sensor": "910701",
- "device_sensor_loader": "920301",
- "gamma_mode": "custom",
- "gamma_file_name": "gamma_file_v1.00"
}, - {
- "deploy_id": 11,
- "from_datetime": "2023-09-06T13:50:07.930666+00:00",
- "deploy_type": "App",
- "running_cnt": 3,
- "success_cnt": 5,
- "fail_cnt": 3,
- "app_name": "OD_FF19.12",
- "app_version": "1",
- "app_description": "FF19.12"
}
]Returns the status of specified deployment ID.
| deploy_id required | integer Deployment ID. |
| deploy_type required | string Deploy type
|
{- "deploy_id": 10,
- "from_datetime": "2023-09-06T13:50:07.930666+00:00",
- "deploy_type": "1",
- "running_cnt": 3,
- "success_cnt": 5,
- "fail_cnt": 3,
- "config_id": "config_230812",
- "dnn_model": "zonedection_20230824_v1.0",
- "dnn_model_version": "1.00",
- "device_firmware": "D70004",
- "device_sensor": "910701",
- "device_sensor_loader": "920301",
- "gamma_mode": "custom",
- "gamma_file_name": "gamma_file_v1.00",
- "devices": [
- {
- "device_id": "sid_2023082401",
- "device_name": "sid_2023082401",
- "deploy_status": "1",
- "update_progress": "100%"
}, - {
- "device_id": "sid_2023082402",
- "device_name": "sid_2023082402",
- "deploy_status": "2",
- "update_progress": "100%"
}, - {
- "device_id": "sid_2023082403",
- "device_name": "sid_2023082403",
- "deploy_status": "0",
- "update_progress": "30%"
}
]
}Deploys the device model to the specified Edge Device.
| model_id required | string AI model ID. |
| device_id required | string The Device ID. |
| version_number | string Default: "" Version number. |
| replace_model_id | string Default: "" Replace model ID. |
| comment | string Default: "" Description of the subject. *The maximum number of characters that can be specified is 100. |
{- "result": "SUCCESS"
}Lists the specific training kit information.
| order_by | string Default: "asc" Sort order: Sorted by the training kit creation date. Value range: desc, asc |
{- "training_kits": [
- {
- "id": "string",
- "name": "string",
- "description": "string",
- "created_on": "string",
- "status": "string",
- "training_kit_type": "string",
- "default_dataset_split_percentage": 0,
- "framework": {
- "name": "string",
- "version": "string"
}, - "owner": "string",
- "is_public": true
}
]
}Searches and returns projects that match the conditions specified in the parameter. If no parameters are specified, all created projects are returned.
| project_name | string Name of the project. *Fuzzy searching is available. |
| model_platform | string Specifies the AI model platform.
|
| project_type | string Project Type.
|
| device_id | string The Device ID. |
| include_training_flg | string Default: "0" To return the project property, set "true". |
{- "model_projects": [
- {
- "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": {
- "training_kit_id": "string",
- "training_kit_name": "string",
- "description": "string",
- "iteration_id": "string",
- "iteration_name": "string",
- "last_modified": "string"
}, - "model": {
- "model_id": "string",
- "model_type": "string",
- "functionality": "string",
- "vendor_name": "string",
- "model_comment": "string",
- "create_by": "string",
- "package_id": "string",
- "product_id": "string",
- "metadata_format_id": "string",
- "latest_version": {
- "version_number": "string",
- "iteration_id": "string",
- "iteration_name": "string",
- "accuracy": "string",
- "model_performances": { },
- "latest_flg": "string",
- "publish_latest_flg": "string",
- "version_status": "string",
- "org_file_name": "string",
- "org_file_size": 0,
- "publish_file_name": "string",
- "publish_file_size": 0,
- "model_file_size": 0,
- "model_framework": "string",
- "conv_id": "string",
- "labels": [
- "string"
], - "stage": "string",
- "result": "string",
- "kpi": { }
}
}
}
]
}Create the project for the base model.
| project_name required | string Name of the project. Max. 50 characters. |
| training_kit required | string Training Kit ID. |
| comment | string Description of the subject. The maximum number of characters that can be specified is 100. |
{- "result": "SUCCESS"
}Create a project for the device model based on the base model of the specified model.
| project_name required | string Name of the project. Max. 50 characters. |
| model_id required | string AI model ID. |
| device_id required | string The Device ID. |
| version_number | string Version number. Default is latest version. |
| comment | string Description of the subject. The maximum number of characters that can be specified is 100. |
{- "result": "SUCCESS"
}Lists the specific project's information.
| project_name required | string Name of the project. |
| include_training_flg | string Default: "0" To return the project property, set "true". |
{- "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": {
- "training_kit_id": "string",
- "training_kit_name": "string",
- "description": "string",
- "iteration_id": "string",
- "iteration_name": "string",
- "last_modified": "string"
}, - "model": {
- "model_id": "string",
- "model_type": "string",
- "functionality": "string",
- "vendor_name": "string",
- "model_comment": "string",
- "create_by": "string",
- "package_id": "string",
- "product_id": "string",
- "metadata_format_id": "string",
- "latest_version": {
- "version_number": "string",
- "iteration_id": "string",
- "iteration_name": "string",
- "accuracy": "string",
- "model_performances": { },
- "latest_flg": "string",
- "publish_latest_flg": "string",
- "version_status": "string",
- "org_file_name": "string",
- "org_file_size": 0,
- "publish_file_name": "string",
- "publish_file_size": 0,
- "model_file_size": 0,
- "model_framework": "string",
- "conv_id": "string",
- "labels": [
- "string"
], - "stage": "string",
- "result": "string",
- "kpi": { },
- "converter_log": [
- { }
], - "convert_start_date": "string",
- "convert_end_date": "string",
- "publish_start_date": "string",
- "publish_end_date": "string",
- "version_comment": "string",
- "version_ins_date": "string",
- "version_upd_date": "string"
}
}
}Export and save the pre-conversion model from the base or device project.
| project_name required | string Name of the project. |
| model_id | string AI model ID. The maximum number of characters that can be specified is 20 single-byte ones. |
| initial_version_number | integer Default: "1" Initial Version Number.
|
| functionality | string Functionality. The maximum number of characters that can be specified is 100. |
| vendor_name | string Vendor Name. The maximum number of characters that can be specified is 100. |
| comment | string Description. The maximum number of characters that can be specified is 100. |
{- "result": "SUCCESS"
}Relearn the specified project.
| project_name required | string Name of the project. |
| training_type | string Default: "Regular" Training type. *Specify only for Custom Vision projects.
|
| reserved_budget_in_hours | string Default: "1" Reserved Budget In Hours. *This parameter is specified when training_type is Advanced for Custom Vision project. |
{- "result": "string",
- "iteration_id": "string",
- "iteration_name": "string"
}Import the image file used for re-learning into the project.
| project_name required | string Name of the project. |
required | Array of objects |
| tags_name | Array of any Default: [] The label *Specify for classification. Supports only 1 tag. |
{- "images": [
- {
- "file_name": "string",
- "contents": "string"
}
], - "tags_name": [ ]
}{- "result": "SUCCESS"
}Import the image file used for retraining into the project via Azure Blob Storage.
| project_name required | string |
| container_url required | string The SAS URI of Blob Storage Container. *Read and List permissions required |
| tags_name | Array of any Default: [] The label *Specify for classification. Supports only 1 tag. |
{- "container_url": "string",
- "tags_name": [ ]
}{- "result": "SUCCESS"
}Lists the specified project's iteration information.
| project_id required | string Project ID. |
| overlap_threshold | string Default: "0.3" Overlap threshold. The bounding box overlap threshold used to determine true predictions. |
| threshold | string Default: "0.5" The threshold used to determine true predictions. |
{- "iterations": [
- { }
]
}The images registered in a specified project and their information.
| project_id required | string Project ID. |
| iteration_id | string Iteration ID. |
| order_by | string Default: "newest" Sort order: Sorted by the creation date of the image. Value range: newest, oldest |
| number_of_images | string Default: 50 The number of images to acquire information. Value range: 0 to 256 |
| skip | string 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.
|
{- "total_image_count": 0,
- "images": [
- {
- "id": "string",
- "created": "string",
- "width": 0,
- "height": 0,
- "image": "string",
- "tags": [
- {
- "tag_id": "string",
- "tag_name": "string",
- "created": "string"
}
], - "regions": [
- {
- "region_id": "string",
- "tag_id": "string",
- "tag_name": "string",
- "created": "string",
- "left": 0,
- "top": 0,
- "width": 0,
- "height": 0
}
]
}
]
}Delete images from a project by image ID.
| project_id required | string Project ID. |
| image_ids required | string ID of the images. *If you have multiple entries, separate them with commas. IDs can be specified from 1 to 256. |
{- "result": "SUCCESS"
}Lists the information for selected image IDs within the project.
| project_id required | string Project ID. |
| image_ids required | string ID of the images. *If you have multiple entries, separate them with commas. IDs can be specified from 1 to 256. |
| iteration_id | string Iteration ID. |
| image_size_type | string Default: "resized" Types of image sizes. *Available only for Custom Vision projects.
|
{- "images": [
- {
- "id": "string",
- "created": "string",
- "width": 0,
- "height": 0,
- "image": "string",
- "tags": [
- {
- "tag_id": "string",
- "tag_name": "string",
- "created": "string"
}
], - "regions": [
- {
- "region_id": "string",
- "tag_id": "string",
- "tag_name": "string",
- "created": "string",
- "left": 0,
- "top": 0,
- "width": 0,
- "height": 0
}
]
}
]
}Returns region proposals (inference result) for an image detection along with the specified image ID.
| project_id required | string Project ID. |
| image_id required | string Image ID. |
{- "project_id": "string",
- "image_id": "string",
- "proposals": [
- {
- "confidence": "string",
- "bounding_box": {
- "left": 0,
- "top": 0,
- "width": 0,
- "height": 0
}
}
]
}Adds a tag to an image within a specific project.
| project_id required | string Project ID. |
Array of objects |
{- "regions": [
- {
- "image_id": "string",
- "tag_id": "string",
- "tag_name": "string",
- "left": 0,
- "top": 0,
- "width": 0,
- "height": 0
}
]
}{- "created": [
- {
- "region_id": "string",
- "tag_id": "string",
- "tag_name": "string",
- "created": "string",
- "left": 0,
- "top": 0,
- "width": 0,
- "height": 0
}
], - "duplicated": [
- {
- "region_id": "string",
- "tag_id": "string",
- "tag_name": "string",
- "created": "string",
- "left": 0,
- "top": 0,
- "width": 0,
- "height": 0
}
], - "exceeded": [
- {
- "region_id": "string",
- "tag_id": "string",
- "tag_name": "string",
- "created": "string",
- "left": 0,
- "top": 0,
- "width": 0,
- "height": 0
}
]
}Updates tags applied to images within a specific project.
| project_id required | string Description of the subject. |
Array of objects |
{- "regions": [
- {
- "image_id": "string",
- "tag_id": "string",
- "tag_name": "string",
- "left": 0,
- "top": 0,
- "width": 0,
- "height": 0
}
]
}{- "updated": [
- {
- "region_id": "string",
- "tag_id": "string",
- "tag_name": "string",
- "created": "string",
- "left": 0,
- "top": 0,
- "width": 0,
- "height": 0
}
]
}Creates a new tag to a specified project.
| project_id required | string Project ID. |
| tag_name required | string Tag name. |
| description | string Description of the subject. |
{- "id": "string",
- "name": "string",
- "description": "string",
- "type": "string",
- "image_count": "string"
}Updates tags applied to a specified project.
| project_id required | string Project ID. |
| tag_id required | string Tag ID. |
| name required | string Name. |
| description | string Description of the subject. |
| type required | string Type. *Specify Regular as fixed. |
{- "name": "string",
- "description": "string",
- "type": "string"
}{- "id": "string",
- "name": "string",
- "description": "string",
- "type": "string",
- "image_count": "string"
}Returns information of tagged images within a specific project.
| project_id required | string Project ID. |
| tag_ids | string ID of tags. *If you have multiple entries, separate them with commas. |
| iteration_id | string Iteration ID. |
| number_of_images | integer Default: 50 Number of images to fetch. 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.
|
{- "total_image_count": 0,
- "tagged_images": [
- {
- "id": "string",
- "created": "string",
- "width": 0,
- "height": 0,
- "image": "string",
- "tags": [
- {
- "tag_id": "string",
- "tag_name": "string",
- "created": "string"
}
], - "regions": [
- {
- "region_id": "string",
- "tag_id": "string",
- "tag_name": "string",
- "created": "string",
- "left": 0,
- "top": 0,
- "width": 0,
- "height": 0
}
]
}
], - "blank_tags": [
- {
- "tag_id": "string",
- "tag_name": "string",
- "description": "string",
- "type": "string"
}
]
}Returns information of untagged images within the specific project.
| project_id required | string Project ID. |
| iteration_id | string Iteration ID. |
| number_of_images | integer Default: 50 Number of images to fetch. 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.
|
{- "total_image_count": 0,
- "untagged_images": [
- {
- "id": "string",
- "created": "string",
- "width": 0,
- "height": 0,
- "image": "string"
}
]
}Lists the model information.
| model_id | string AI model ID. *Fuzzy searching is available. |
| comment | string Model description. *Fuzzy searching is available. |
| project_name | string Name of the project. *Fuzzy searching is available. |
| model_platform | string Specifies the AI model platform.
|
| project_type | string Specifies the project type.
|
| device_id | string Sorts the device ID. |
| latest_type | string Default: "1" Classification of the latest version.
|
{- "models": [
- {
- "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": [
- {
- "model_project_name": "string",
- "model_project_id": "string",
- "model_platform": "string",
- "model_type": "string",
- "project_type": "string",
- "device_id": "string",
- "versions": [
- {
- "version_number": "string",
- "iteration_id": "string",
- "iteration_name": "string",
- "accuracy": "string",
- "model_performances": { },
- "latest_flg": "string",
- "publish_latest_flg": "string",
- "version_status": "string",
- "org_file_name": "string",
- "org_file_size": 0,
- "publish_file_name": "string",
- "publish_file_size": 0,
- "model_file_size": 0,
- "model_framework": "string",
- "conv_id": "string",
- "labels": [
- "string"
], - "stage": "string",
- "result": "string",
- "kpi": { }
}
]
}
]
}
]
}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.
| model required | string SAS URI or Presigned URI of the model file. |
| input_format_param | string SAS URI or Presigned URI of the input format param file. |
| network_config | string SAS URI or Presigned URI of the network config 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 Vendor Name. The maximum number of characters that can be specified is 100. |
| comment | string Description. The maximum number of characters that can be specified is 100. |
| network_type | string Default: "1" Specify whether or not application is required for the model.
|
| metadata_format_id | string Metadata Format ID. The maximum number of characters that can be specified is 100. |
{- "model": "string",
- "input_format_param": "string",
- "network_config": "string",
- "model_id": "string",
- "converted": false,
- "vendor_name": "string",
- "comment": "string",
- "network_type": "1",
- "metadata_format_id": "string"
}{- "result": "SUCCESS"
}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.
| model_id required | string AI model ID. |
| device_id | string The device ID. *Only available for device models. This parameter is only available for deploying base models. |
{- "result": "SUCCESS",
- "import_id": "550e8400-e29b-41d4-a716-446655440000"
}Updates attribute information of the specified AI model.
| model_id required | string AI model ID. The maximum number of characters that can be specified is 100. |
| 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. |
{- "result": "SUCCESS"
}Returns an information of the specified base model.
| model_id required | string AI model ID. |
| latest_type | string Default: "1" Classification of the latest version.
|
{- "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": [
- {
- "model_project_name": "string",
- "model_project_id": "string",
- "model_platform": "string",
- "model_type": "string",
- "project_type": "string",
- "device_id": "string",
- "versions": [
- {
- "version_number": "string",
- "iteration_id": "string",
- "iteration_name": "string",
- "accuracy": "string",
- "model_performances": { },
- "latest_flg": "string",
- "publish_latest_flg": "string",
- "version_status": "string",
- "org_file_name": "string",
- "org_file_size": 0,
- "publish_file_name": "string",
- "publish_file_size": 0,
- "model_file_size": 0,
- "model_framework": "string",
- "conv_id": "string",
- "labels": [
- "string"
], - "stage": "string",
- "result": "string",
- "kpi": { },
- "converter_log": [
- { }
], - "convert_start_date": "string",
- "convert_end_date": "string",
- "publish_start_date": "string",
- "publish_end_date": "string",
- "version_comment": "string",
- "version_ins_date": "string",
- "version_upd_date": "string"
}
]
}
]
}Lists the base model version.
| model_id required | string AI model ID. |
| version_number | string Version number. |
| scope | string Default: "full" The scope of response parameters to return.
|
{- "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": [
- {
- "model_project_name": "string",
- "model_project_id": "string",
- "model_platform": "string",
- "model_type": "string",
- "project_type": "string",
- "device_id": "string",
- "versions": [
- {
- "version_number": "string",
- "iteration_id": "string",
- "iteration_name": "string",
- "accuracy": "string",
- "model_performances": { },
- "latest_flg": "string",
- "publish_latest_flg": "string",
- "version_status": "string",
- "org_file_name": "string",
- "org_file_size": 0,
- "publish_file_name": "string",
- "publish_file_size": 0,
- "model_file_size": 0,
- "model_framework": "string",
- "conv_id": "string",
- "labels": [
- "string"
], - "stage": "string",
- "result": "string",
- "kpi": { },
- "converter_log": [
- { }
], - "convert_start_date": "string",
- "convert_end_date": "string",
- "publish_start_date": "string",
- "publish_end_date": "string",
- "version_comment": "string",
- "version_ins_date": "string",
- "version_upd_date": "string"
}
]
}
]
}Updates attribute information of the specified base model version.
| model_id required | string AI model ID. |
| version_number required | string Version number. |
| comment | string Description of version. The maximum number of characters that can be specified is 100. |
| input_format_param | string SAS URI or Presigned URI of the input format param file. |
| network_config | string SAS URI or Presigned URI of the network config file. |
{- "comment": "string",
- "input_format_param": "string",
- "network_config": "string"
}{- "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": [
- {
- "model_project_name": "string",
- "model_project_id": "string",
- "model_platform": "string",
- "model_type": "string",
- "project_type": "string",
- "device_id": "string",
- "versions": [
- {
- "version_number": "string",
- "iteration_id": "string",
- "iteration_name": "string",
- "accuracy": "string",
- "model_performances": { },
- "latest_flg": "string",
- "publish_latest_flg": "string",
- "version_status": "string",
- "org_file_name": "string",
- "org_file_size": 0,
- "publish_file_name": "string",
- "publish_file_size": 0,
- "model_file_size": 0,
- "model_framework": "string",
- "conv_id": "string",
- "labels": [
- "string"
], - "stage": "string",
- "result": "string",
- "kpi": { }
}
]
}
]
}Returns an information of the specified device model.
| model_id required | string AI model ID. |
| device_id required | string The Device ID. |
| latest_type | string Default: "1" Classification of the latest version.
|
{- "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": [
- {
- "model_project_name": "string",
- "model_project_id": "string",
- "model_platform": "string",
- "model_type": "string",
- "project_type": "string",
- "device_id": "string",
- "versions": [
- {
- "version_number": "string",
- "iteration_id": "string",
- "iteration_name": "string",
- "accuracy": "string",
- "model_performances": { },
- "latest_flg": "string",
- "publish_latest_flg": "string",
- "version_status": "string",
- "org_file_name": "string",
- "org_file_size": 0,
- "publish_file_name": "string",
- "publish_file_size": 0,
- "model_file_size": 0,
- "model_framework": "string",
- "conv_id": "string",
- "labels": [
- "string"
], - "stage": "string",
- "result": "string",
- "kpi": { },
- "converter_log": [
- { }
], - "convert_start_date": "string",
- "convert_end_date": "string",
- "publish_start_date": "string",
- "publish_end_date": "string",
- "version_comment": "string",
- "version_ins_date": "string",
- "version_upd_date": "string"
}
]
}
]
}Lists the device model version information
| model_id required | string AI model ID. |
| device_id required | string The Device ID. |
| scope | string Default: "full" The scope of response parameters to return.
|
| version_number | string Version number. |
{- "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": [
- {
- "model_project_name": "string",
- "model_project_id": "string",
- "model_platform": "string",
- "model_type": "string",
- "project_type": "string",
- "device_id": "string",
- "versions": [
- {
- "version_number": "string",
- "iteration_id": "string",
- "iteration_name": "string",
- "accuracy": "string",
- "model_performances": { },
- "latest_flg": "string",
- "publish_latest_flg": "string",
- "version_status": "string",
- "org_file_name": "string",
- "org_file_size": 0,
- "publish_file_name": "string",
- "publish_file_size": 0,
- "model_file_size": 0,
- "model_framework": "string",
- "conv_id": "string",
- "labels": [
- "string"
], - "stage": "string",
- "result": "string",
- "kpi": { },
- "converter_log": [
- { }
], - "convert_start_date": "string",
- "convert_end_date": "string",
- "publish_start_date": "string",
- "publish_end_date": "string",
- "version_comment": "string",
- "version_ins_date": "string",
- "version_upd_date": "string"
}
]
}
]
}Updates attribute information of the AI model version for the specified Edge Device.
| model_id required | string AI model ID. |
| device_id required | string The Device ID. |
| version_number required | string Version number. |
| comment required | string Description of version. |
{- "comment": "string"
}{- "result": "SUCCESS"
}Returns dnn_params of the specified AI model.
| model_id required | string AI model ID. |
| version_number | string Default: "latest" Version number. |
| device_id | string The device ID. *Only available for device models. This parameter is only available for deploying base models. |
{- "contents": "string"
}Lists the information of the selected Edge System Software.
| firmware_type | string Type and ID of the Edge System Software.
|
{- "firmwares": [
- {
- "firmware_id": "string",
- "firmware_type": "string",
- "comment": "string",
- "ins_id": "string",
- "ins_date": "string",
- "upd_id": "string",
- "upd_date": "string",
- "versions": [
- {
- "file_name": "string",
- "version_number": "string",
- "ppl": "string",
- "stored_type": "string",
- "stored_uri": "string",
- "comment": "string",
- "ins_id": "string",
- "ins_date": "string",
- "upd_id": "string",
- "upd_date": "string"
}
]
}
]
}Registers the selected Edge System Software to the Console.
| firmware_type required | string Type and ID of the Edge System Software.
|
| version_number required | string The version number. |
| comment | string Default: "" Description. *The maximum number of characters that can be specified is 100. |
| file_name required | string The Edge System Software filename. |
| file_content required | string Firmware File in base64 encoding. |
{- "firmware_type": "string",
- "version_number": "string",
- "comment": "",
- "file_name": "string",
- "file_content": "string"
}{- "result": "SUCCESS"
}Returns the information of a selected Edge System Software.
| firmware_type required | string Type and ID of the Edge System Software.
|
| version_number required | string Version number. |
{- "firmware_id": "string",
- "firmware_type": "string",
- "comment": "string",
- "ins_id": "string",
- "ins_date": "string",
- "upd_id": "string",
- "upd_date": "string",
- "versions": [
- {
- "file_name": "string",
- "version_number": "string",
- "ppl": "string",
- "stored_type": "string",
- "stored_uri": "string",
- "comment": "string",
- "ins_id": "string",
- "ins_date": "string",
- "upd_id": "string",
- "upd_date": "string"
}
]
}Deletes the selected Edge System Software from the Console.
| firmware_type required | string Type and ID of the Edge System Software.
|
| version_number required | string Version number. |
{- "result": "SUCCESS"
}Lists the information of the Edge Applications that runs on the Edge Device.
{- "apps": [
- {
- "name": "string",
- "create_by": "string",
- "package_id": "string",
- "product_id": "string",
- "schema_info": {
- "VnSAppId": "string",
- "version": "string",
- "interfaces": {
- "in": [
- {
- "metadataFormatId": "string"
}
]
}
}, - "versions": [
- {
- "version": "string",
- "compiled_flg": "string",
- "status": "string",
- "comment": "string",
- "deploy_count": { },
- "ins_id": "string",
- "ins_date": "string",
- "upd_id": "string",
- "upd_date": "string"
}
]
}
]
}Imports Edge Device Application for deployment to the Edge Device into the Console.
| compiled_flg required | string Compilation status (flag) of the target application.
|
| entry_point | string Default: "ppl" App entry point. |
| app_name required | string App name. |
| version_number required | string App version number. |
| comment | string Description of the subject. *The maximum number of characters that can be specified is 100. |
| file_name required | string Name of the subject file. |
| file_content required | string App file content in base64 encoding. |
object Schema info. |
{- "compiled_flg": "string",
- "entry_point": "ppl",
- "app_name": "string",
- "version_number": "string",
- "comment": "string",
- "file_name": "string",
- "file_content": "string",
- "schema_info": {
- "interfaces": {
- "in": [
- {
- "metadataFormatId": "string"
}
]
}
}
}{- "result": "SUCCESS"
}Returns the information of a specific Edge Application.
| app_name required | string The application name. |
| version_number required | string The application version. |
{- "name": "string",
- "create_by": "string",
- "package_id": "string",
- "product_id": "string",
- "schema_info": {
- "VnSAppId": "string",
- "version": "string",
- "interfaces": {
- "in": [
- {
- "metadataFormatId": "string"
}
]
}
}, - "version": "string",
- "compiled_flg": "string",
- "status": "string",
- "comment": "string",
- "deploy_count": { },
- "ins_id": "string",
- "ins_date": "string",
- "upd_id": "string",
- "upd_date": "string"
}Exports the specified Edge Application information.
| app_name required | string The application name. |
| version_number required | string The application version. |
{- "contents": "string",
- "file_name": "string"
}Returns the specified Edge Application deployment status.
| app_name required | string The application name. |
| version_number required | string The application version. |
{- "deploys": [
- {
- "id": "string",
- "total_status": "string",
- "deploy_parameter": "string",
- "devices": [
- {
- "device_id": "string",
- "status": "string",
- "latest_deployment_flg": "string",
- "ins_id": "string",
- "ins_date": "string",
- "upd_id": "string",
- "upd_date": "string"
}
]
}
]
}Deploys Edge Application to specific devices.
| app_name required | string The application name. |
| version_number required | string The application version. |
| device_ids required | string To specify multiple device IDs, separate them with commas. |
| comment | string Description of the subject. *The maximum number of characters that can be specified is 100. |
{- "app_name": "string",
- "version_number": "string",
- "device_ids": "string",
- "comment": "string"
}{- "result": "string",
- "app_deploy_id": 0
}Returns a URL to export images in a ZIP file format based on the specified conditions.
*Encrypted, for use with training images in other environments.
[Prerequisites]
[Generating a Key]
The public and private keys are generated by Sier.
The keys are issued with a length of either 1024 or 2048 bits.
The public key provided to this API as a parameter should be the content of the public key PEM file, base64 encoded.
Example: Base64 encode the entire string as follows:
-----BEGIN PUBLIC KEY-----
MIGfMA0GCSqGSIb3DQEBAQUAA4GNADC
..
-----END PUBLIC KEY-----
| key required | string The public key. |
| from_datetime | string Default: "" Date and time (From).
|
| to_datetime | string Default: "" Date and time (To).
|
| device_id | string Default: "" The Device ID. |
| file_format | string Default: "" Image file format. If not specified, no filtering will be applied.
|
{- "key": "string",
- "url": "string"
}Returns the directory information (device group and device information) where images are stored.
| device_id | string The device ID. |
| include_deleted_device | boolean Default: false Specify whether to delete images from devices that have been removed from the Console. |
[- {
- "group_id": "string",
- "devices": [
- {
- "device_id": "string",
- "device_name": "string",
- "Image": [
- "string"
]
}
]
}
]Returns the (saved) images from a specific device. *Application: Displaying an image in a UI. *For Developer Edition V1.7.0 or later, please use GetImages Stable API.
| device_id required | string The Device ID. |
| sub_directory_name required | string Directory name. |
| order_by | string Default: "ASC" Sort order: Sorted by the creation date of the image. Value range: DESC, ASC |
| 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. |
| from_datetime | string Default: "" Date and time (From).
|
| to_datetime | string Default: "" Date and time (To).
|
| include_deleted_device | boolean Default: false Specify whether to delete images from devices that have been removed from the Console. |
{- "total_image_count": 0,
- "images": [
- {
- "name": "string",
- "contents": "string"
}
]
}Deletes the saved images from a specific Edge Device. *For Developer Edition V1.7.0 or later, please use DeleteImages Stable API.
| device_id required | string The Device ID. |
| sub_directory_name required | string Directory name. |
| directory_deletion | string Default: "0" Flag that specifies the method for deleting images.
|
| filenames | Array of strings The file to deleted when directory_deletion is set to 0. |
{- "directory_deletion": "0",
- "filenames": [
- "string"
]
}{- "result": "SUCCESS"
}Returns a SAS URL to download images from the specific device. Copy the URL to access the data. The URL will expire after one hour. *This API is available for Developer Edition V1.7.0 or later.
| device_id required | string The Device ID. |
| sub_directory_name required | string Directory name. |
| limit | integer Default: 50 The number of images to acquire information. Value range: 1 to 256 |
| starting_after | string Retrieves additional data beyond the number of images specified by the query parameter (limit). Specify the value obtained from the response (continuation_token) to fetch the next images. |
| name_starts_with | string Default: "" Return only objects that forward match the input string |
{- "continuation_token": "string",
- "data": [
- {
- "name": "string",
- "sas_url": "string"
}
]
}Deletes the (saved) images for the specified device.
*This API is available for Developer Edition V1.7.0 or later.
| device_id required | string The Device ID. |
| sub_directory_name required | string Directory name. |
| directory_deletion | string Default: "0" Flag that specifies the method for deleting images.
|
| filenames | Array of strings The file to deleted when directory_deletion is set to 0. |
| limit | integer Default: 10000 Number of images to delete. The oldest stored items are deleted first. |
{- "directory_deletion": "0",
- "filenames": [
- "string"
], - "limit": 10000
}{- "result": "SUCCESS"
}Returns an inference result from a specific Edge Device.
| device_id required | string The Device ID. |
| id required | string Inference result ID. |
{- "DeviceID": "string",
- "ModelID": "string",
- "Image": true,
- "Inferences": [
- {
- "T": "string",
- "O": "string"
}
], - "id": "string",
- "project_id": "string",
- "_ts": 0
}Returns inference results from a specific Edge Device.
| device_id required | string The Device ID. |
| NumberOfInferenceresults | integer Default: 20 Number of the items to fetch information. Returns the most recent records up to the specified number of cases. *Maximum value: 10,000 |
| filter | string Default: "" Search filter. *The specifications are the same except for the CosmosDB UI of the Azure portal and for the differences listed below.
Example:
|
| raw | integer Default: 0 If 1 is specified, the record will be added to CosmosDB and returned.
|
| time | string Default: "" Extracts the inference result within the following range:
|
| include_deleted_device | boolean Default: false Specify whether to delete inference result from devices that have been removed from the Console. |
[- {
- "id": "string",
- "device_id": "string",
- "model_id": "string",
- "version_number": "string",
- "model_version_id": "string",
- "model_type": "string",
- "training_kit_name": "string",
- "_ts": 0,
- "inference_result": {
- "DeviceID": "string",
- "ModelID": "string",
- "Image": true,
- "Inferences": [
- {
- "T": "string",
- "O": "string"
}
], - "id": "string",
- "project_id": "string",
- "_ts": 0
}, - "inferences": [
- {
- "T": "string",
- "O": "string"
}
]
}
]Deletes the inference data retrieved through the GetInferenceResults. *This API is available for Developer Edition V1.7.0 or later.
| device_id required | string The Device ID. |
| item_ids required | string Example: item_ids=1,2,3,5 The inference result ID of the deletion target 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. |
{- "result": "SUCCESS"
}Updates the external transfer settings to forward inference results obtained from Edge Devices to Azure Event Hubs.
| url | string Connection string for Azure Event Hubs forwarding inference result. *Do not specify when returning to the initial value. In the case of the initial value, it will be streamed within this service. |
| name | string Azure Event Hubs Instance Name. *Do not specify when returning to the initial value. In the case of the initial value, it will be streamed within this service. |
{- "url": "string",
- "name": "string"
}{- "result": "SUCCESS"
}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".
| type | string Default: "AZURE" The storage service type. Specify “AZURE” as the value.
|
| mode | integer Default: 0 The mode to specify whether the image, inference results, or both should be included.
|
| endpoint | string Destination Azure Blob Storage endpoint. |
| connection_string | string Connection string for Azure Blob Storage. |
| container_name | string Container name of Azure Blob Storage. |
{- "type": "AZURE",
- "mode": 0,
- "endpoint": "string",
- "connection_string": "string",
- "container_name": "string"
}{- "result": "SUCCESS"
}Returns the parameter (file ID) used by the API below. Specify the returned 'file_info.id' as the parameter.
| type_code | string Enum: "NonConverted" "Converted" "InputFormatParam" "NetworkConfig" "CustomSetup" File type code. |
| file | string <binary> File contents. |
{- "result": "string",
- "file_info": {
- "id": "10dd852a-a9b5-460a-a2a8-e89657f83c01",
- "name": "object_detection.tflite",
- "type_code": "NonConverted",
- "size": 489813
}
}