Lunit INSIGHT Backend API (2.10.0)

Lunit INSIGHT API lets your applications utilize our algorithms easily. Based on simple REST principles, our Web API endpoints return response data mostly in JSON format. You can refer to each endpoint’s request/header section to find out the request format.

Note that the default encoding is UTF-8

Authorization

All requests to Lunit INSIGHT API require authorization; that is, the client must have granted permission to utilize each endpoint. To prove that, each request sent by the client must include a valid API key within it’s header like below.

Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6I...

App Type

App name	Production	Description
cxr-v3	Lunit INSIGHT CXR 3	Lunit INSIGHT CXR 3 detects 10 independent radiologic findings: Atelectasis, Calcification, Cardiomegaly, Consolidation, Fibrosis, Mediastinal widening, Nodule, Pleural effusion, Pnemoperitoneum, Pneumothorax. It generates (1) the location information of detected lesions in the form of heatmaps/contours/text, and (2) abnormality scores of independent findings which reflect the probability that the detected lesion is abnormal.
mmg	Lunit INSIGHT MMG	Lunit INSIGHT MMG accurately detects lesions suspicious of breast cancer by generating (1) location information of detected lesions in the form of heatmaps/contours and (2) abnormality scores reflecting the probability that the detected lesion is malignant.

Localization

If you want to get the translated lesion name, client can include a valid laguage code within it's header like below.

Accept-Language: en

You can choose one of the following language codes; the default is English.

Code	Language name	Example (Nodule)
en	English	Nodule
de	German	Knoten
es	Spanish	Nódulo
fr	French	Nodul
it	Italian	Nodulo
no	Norwegian	Nodul
pt-BR	Brazilian Portuguese	Nódulo
ru	Russian	Узелок
sv	Swedish	Nodul
sl	Slovenian	Vozliček
da	Danish	Knude
nl	Dutch	Nodule
fi	Finnish	Kyhmy
el	Greek	Όζος
pl	Polish	Guzek
cs	Czech	Uzlina
pt	Portuguese	Nódulo

Error Details

Lunit INSIGHT API uses following response format to describe an error.

Key	Value Type	Description
status	Integer	The HTTP status code which is also given in the response header
message	String	A detailed description for the occurred error

Below are examples of responses when something went wrong.

{

   "status": 500,

   "message": "Internal server error."

}

{

   "status": 401,

   "message": "No authorization header found."

}

{

   "status": 403,

   "message": "No API key found in the authorization header."

}

Common API

GET server health

Check deployed server health.

header Parameters

Authorization

required

string

Example: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6I...

API Key

Responses

GET a UDI

Get a UDI

path Parameters

app

required

string

Enum: "cxr-v3" "mmg"

A app name that you want to analyze.

header Parameters

Authorization

required

string

Example: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6I...

API Key

Responses

Response Schema: application/json

udi	string
serial_number	string
manufactured_date	string
product_version	string

Response samples

Content type

application/json

{"udi": "(01)08800076099999(10)0CXRDOM030103002A00(20)00(21)0GYCQ67890",
"serial_number": "0GYCQ67890",
"manufactured_date": "2022-01-01",
"product_version": "v3.1.5.0"
}

POST a DICOM file

Upload a single dicom for prediction. An UUID of the DICOM will be given back within response.

header Parameters

Authorization

required

string

Example: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6I...

API Key

Responses

Response Schema: application/json

app	string
uuid	string
file	string
valid	boolean
width	number
height	number
created_at	string

Response Schema: application/json

message	string
code	number
insight_error_code	string

Response Schema: application/json

message	string
code	number
insight_error_code	string

Response samples

Content type

application/json

{"app": "cxr-v3",
"uuid": "843eb001-0119-4baa-83f2-43f11b980b2a",
"file": "http://10.120.100.16:8000/data/dicom/843eb001-0119-4baa-83f2-43f11b980b2a.dcm",
"valid": true,
"width": 2488,
"height": 3020,
"created_at": "2022-10-05T01:33:08.941600Z"
}

CXR-V3 API

POST a predict request

Request analysis of the uploaded dicom file.

header Parameters

Authorization

required

string

Example: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6I...

API Key

Request Body schema: application/json

required

Array of objects

Array

dicom	string UUID of uploaded DICOM file
view_name	string Enum: "frontal" "frontal_previous" view name of DICOM image

filtering

boolean

Default: false

Predict whether dicom is a frontal image or not. It's not 100% accuracy and should be used with caution.

threshold

number

Default: 0.15

Enum: 0.15 0.2 0.25 0.3 0.35 0.4 0.45

Threshold score for prediction result. It can be used when all finding's threshold is the same. It can not be used with thresholds option.

object

Threshold score for each findings. It can be used when specify each finding's threshold. It can not be used with threshold option.

nodule	number Enum: 0.15 0.2 0.25 0.3 0.35 0.4 0.45
consolidation	number Enum: 0.15 0.2 0.25 0.3 0.35 0.4 0.45
atelectasis	number Enum: 0.15 0.2 0.25 0.3 0.35 0.4 0.45
fibrosis	number Enum: 0.15 0.2 0.25 0.3 0.35 0.4 0.45
calcification	number Enum: 0.15 0.2 0.25 0.3 0.35 0.4 0.45
cardiomegaly	number Enum: 0.15 0.2 0.25 0.3 0.35 0.4 0.45
mediastinal_widening	number Enum: 0.15 0.2 0.25 0.3 0.35 0.4 0.45
pneumothorax	number Enum: 0.15 0.2 0.25 0.3 0.35 0.4 0.45
pleural_effusion	number Enum: 0.15 0.2 0.25 0.3 0.35 0.4 0.45
pneumoperitoneum	number Enum: 0.15 0.2 0.25 0.3 0.35 0.4 0.45
tuberculosis	number Enum: 0.15 0.2 0.25 0.3 0.35 0.4 0.45

Responses

Response Schema: application/json

uuid

string

object

tag	string
description	string
supported_features	Array of any

Array of objects

Array

dicom	string
view_name	string

threshold

number

object

nodule	number
consolidation	number
atelectasis	number
fibrosis	number
calcification	number
cardiomegaly	number
mediastinal_widening	number
pneumothorax	number
pleural_effusion	number
pneumoperitoneum	number
tuberculosis	number

filtering

boolean

apply_prior_window

boolean

wait_time

number

init_time

any or null

prediction_time

number

status

string

status_code

string

created_at

string

Response Schema: application/json

message	string
code	number
insight_error_code	string

Request samples

Payload

Content type

application/json

Example

prediction by setting the threshold to 30 for all findings

{"case": [{"dicom": "21503c99-4fad-4b08-a69d-dd06820a5c70",
"view_name": "frontal"
}
],
"threshold": 0.3
}

Response samples

Content type

application/json

{"uuid": "21503c99-4fad-4b08-a69d-dd06820a5c70",
"inference_model": {"tag": "3.9.0.1",
"description": "",
"supported_features": [ ]
},
"case": [{"dicom": "c3a203c7-3c7c-4172-8b00-7a523e6b44bd",
"view_name": "frontal"
}
],
"threshold": 0.15,
"thresholds": {"nodule": 0.15,
"consolidation": 0.15,
"atelectasis": 0.15,
"fibrosis": 0.15,
"calcification": 0.15,
"cardiomegaly": 0.15,
"mediastinal_widening": 0.15,
"pneumothorax": 0.15,
"pleural_effusion": 0.15,
"pneumoperitoneum": 0.15,
"tuberculosis": 0.15
},
"filtering": false,
"apply_prior_window": true,
"wait_time": 2.242044,
"init_time": null,
"prediction_time": 1.869625,
"status": "SUCCESS",
"status_code": "200.40.ISTIS.000",
"created_at": "2022-10-19T07:50:18.036862Z"
}

GET score prediction result

Get score prediction result

path Parameters

uuid

required

string

Example: 41ee74f5-f87e-4ff9-a76d-eb70c06b5fc4

The UUID from the Predict API response

query Parameters

lesion_names	string Default: "atelectasis,calcification,cardiomegaly,consolidation,fibrosis,mediastinal_widening,nodule,pleural_effusion,pneumoperitoneum,pneumothorax" Comma-separated list of lesion names to detect. If you set specific lesion names, only specified lesions will be shown in response.
tb_screening	boolean Default: false Enable Tuberculosis detection.
raw	boolean Default: false Show raw value of lesion probabilities.

header Parameters

Authorization

required

string

Example: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6I...

API Key

Responses

Response Schema: application/json

object

atelectasis	number
calcification	number
cardiomegaly	number
consolidation	number
fibrosis	number
mediastinal_widening	number
nodule	number
pleural_effusion	number
pneumoperitoneum	number
pneumothorax	number

object

abnormality_score	number
all_findings_under_thresholds	boolean

object

atelectasis	number
calcification	number
cardiomegaly	number
consolidation	number
fibrosis	number
mediastinal_widening	number
nodule	number
pleural_effusion	number
pneumoperitoneum	number
pneumothorax	number

Response samples

Content type

application/json

{"score": {"atelectasis": 5.78,
"calcification": 51.14,
"cardiomegaly": 3.46,
"consolidation": 77.53,
"fibrosis": 80.35,
"mediastinal_widening": 6.53,
"nodule": 25.25,
"pleural_effusion": 2.43,
"pneumoperitoneum": 0.43,
"pneumothorax": 11.77
},
"metascore": {"abnormality_score": 80.35,
"all_findings_under_thresholds": false
},
"thresholds": {"atelectasis": 15,
"calcification": 15,
"cardiomegaly": 15,
"consolidation": 15,
"fibrosis": 15,
"mediastinal_widening": 15,
"nodule": 15,
"pleural_effusion": 15,
"pneumoperitoneum": 15,
"pneumothorax": 15
}
}

GET report prediction result

Get report prediction result

path Parameters

uuid

required

string

Example: 41ee74f5-f87e-4ff9-a76d-eb70c06b5fc4

The UUID from the Predict API response

query Parameters

lesion_names	string Default: "atelectasis,calcification,cardiomegaly,consolidation,fibrosis,mediastinal_widening,nodule,pleural_effusion,pneumoperitoneum,pneumothorax" Comma-separated list of lesion names to detect. If you set specific lesion names, only specified lesions will be shown in response.
tb_analysis	boolean Default: true Enable Tuberculosis detection.
show_score	boolean Default: false Show maximum probability of specified lesions in analyzed section.
show_note	boolean Default: false Show structured note about specified lesions in analyzed section. If prediction result has compare result, compare note will be return about `consolidation`,`pneumothorax` and `pleural_effusion`.

header Parameters

Authorization

required

string

Example: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6I...

API Key

Responses

Response Schema: application/json

object

fibrosis	string
consolidation	string
calcification	string
nodule	string
atelectasis	string
cardiomegaly	string
mediastinal_widening	string
pleural_effusion	string
pneumoperitoneum	string
pneumothorax	string
tuberculosis	string

Response samples

Content type

application/json

{"report": {"fibrosis": "Fibrosis is present in the left upper zone.",
"consolidation": "Consolidation is present in the left middle zone.",
"calcification": "Calcification is present in the right middle zone.",
"nodule": "Nodular opacity is present in the right middle zone.",
"atelectasis": "",
"cardiomegaly": "",
"mediastinal_widening": "",
"pleural_effusion": "",
"pneumoperitoneum": "",
"pneumothorax": "",
"tuberculosis": "Active Tuberculosis is not suspected."
}
}

GET contour prediction result as JSON

Get contour prediction result as JSON

path Parameters

uuid

required

string

Example: 41ee74f5-f87e-4ff9-a76d-eb70c06b5fc4

The UUID from the Predict API response

query Parameters

lesion_names	string Default: "atelectasis,calcification,cardiomegaly,consolidation,fibrosis,mediastinal_widening,nodule,pleural_effusion,pneumoperitoneum,pneumothorax" Comma-separated list of lesion names to detect. If you set specific lesion names, only specified lesions will be shown in response.
tb_screening	boolean Default: false Enable Tuberculosis screening. One of the options `tb_screening`, `show_abn_score` must be enabled.
show_abn_score	boolean Default: true Show maximum probability of specified lesions in score section. One of the options `tb_screening`, `show_abn_score` must be enabled.
show_mw_cm_score_only	boolean Default: true Show maximum probability of mediastinal widening and cardiomegaly in score section. If you set `show_mw_cm_score_only`=`true` then mediastinal widening and cardiomegaly is showing below.
show_low_score	boolean Default: false Show probability of specified lesions in score section which score is lower than threshold.
show_license	boolean Default: false Determines whether to print license warning statements.
show_license_detail	string Enum: "date" "count" "date,count" Determines the type of license details to display. Details are not displayed by default.
merge	boolean Default: true Enabling contour merging option. If enabled, contours intersecting with IOU larger than `merge_threshold` are merged together.
merge_threshold	string Default: 0.2 IOU threshold option used for merging, which ranges from `0` to `1`. Only used when `merge` is `true`. If you set `merge_threshold`=`0` then merging every intersecting contours.

header Parameters

Authorization required	string Example: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6I... API Key
Accept-Language	string Display lesion names in the selected language.

Responses

GET contour prediction result as JPG

Get contour prediction result as JPG

path Parameters

uuid

required

string

Example: 41ee74f5-f87e-4ff9-a76d-eb70c06b5fc4

The UUID from the Predict API response

query Parameters

lesion_names	string Default: "atelectasis,calcification,cardiomegaly,consolidation,fibrosis,mediastinal_widening,nodule,pleural_effusion,pneumoperitoneum,pneumothorax" Comma-separated list of lesion names to detect. If you set specific lesion names, only specified lesions will be shown in response.
tb_screening	boolean Default: false Enable Tuberculosis screening. One of the options `tb_screening`, `show_abn_score` must be enabled.
show_abn_score	boolean Default: true Show maximum probability of specified lesions in score section. One of the options `tb_screening`, `show_abn_score` must be enabled.
show_mw_cm_score_only	boolean Default: true Show maximum probability of mediastinal widening and cardiomegaly in score section. If you set `show_mw_cm_score_only`=`true` then mediastinal widening and cardiomegaly is showing below.
show_low_score	boolean Default: false Show probability of specified lesions in score section which score is lower than threshold.
show_license	boolean Default: false Determines whether to print license warning statements.
show_license_detail	string Enum: "date" "count" "date,count" Determines the type of license details to display. Details are not displayed by default.
merge	boolean Default: true Enabling contour merging option. If enabled, contours intersecting with IOU larger than `merge_threshold` are merged together.
merge_threshold	string Default: 0.2 IOU threshold option used for merging, which ranges from `0` to `1`. Only used when `merge` is `true`. If you set `merge_threshold`=`0` then merging every intersecting contours.
sc_type	string Default: "map" Enum: "map" "report" Type of secondary capture display format.
compare_type	string Default: "none" Enum: "none" "augmented" "additional" Enabling return JPEG content with compare result. It only works prediction result has compare result.
current_date	string Show date when taken `frontal` DICOM. It only works prediction result has compare result.
previous_date	string Show date when taken `frontal_previous` DICOM. It only works prediction result has compare result.

header Parameters

Authorization required	string Example: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6I... API Key
Accept-Language	string Display lesion names in the selected language.

Responses

Response samples

Content type

image/jpeg

JPEG image content

GET a heatmap prediction result as JSON

Get a heatmap prediction result as v1 JSON for the detected CXR-V3 lesions. /v1/ can be substituted with /.

path Parameters

uuid

required

string

Example: 41ee74f5-f87e-4ff9-a76d-eb70c06b5fc4

The UUID from the Predict API response

query Parameters

lesion_names	string Default: "atelectasis,calcification,cardiomegaly,consolidation,fibrosis,mediastinal_widening,nodule,pleural_effusion,pneumoperitoneum,pneumothorax" Comma-separated list of lesion names to detect. If you set specific lesion names, only specified lesions will be shown in response.
tb_screening	boolean Default: false Enable Tuberculosis screening. One of the options `tb_screening`, `show_abn_score` must be enabled.
show_abn_score	boolean Default: true Show maximum probability of specified lesions in score section. One of the options `tb_screening`, `show_abn_score` must be enabled.
show_mw_cm_score_only	boolean Default: true Show maximum probability of mediastinal widening and cardiomegaly in score section. If you set `show_mw_cm_score_only`=`true` then mediastinal widening and cardiomegaly is showing below.
show_low_score	boolean Default: false Show probability of specified lesions in score section which score is lower than threshold.
show_license	boolean Default: false Determines whether to print license warning statements.
show_license_detail	string Enum: "date" "count" "date,count" Determines the type of license details to display. Details are not displayed by default.

header Parameters

Authorization required	string Example: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6I... API Key
Accept-Language	string Display lesion names in the selected language.

Responses

GET a heatmap prediction result as JPG

Get a heatmap prediction result as JPG for the detected CXR-V3 lesions.

path Parameters

uuid

required

string

Example: 41ee74f5-f87e-4ff9-a76d-eb70c06b5fc4

The UUID from the Predict API response

query Parameters

lesion_names	string Default: "atelectasis,calcification,cardiomegaly,consolidation,fibrosis,mediastinal_widening,nodule,pleural_effusion,pneumoperitoneum,pneumothorax" Comma-separated list of lesion names to detect. If you set specific lesion names, only specified lesions will be shown in response.
tb_screening	boolean Default: false Enable Tuberculosis screening. One of the options `tb_screening`, `show_abn_score` must be enabled.
show_abn_score	boolean Default: true Show maximum probability of specified lesions in score section. One of the options `tb_screening`, `show_abn_score` must be enabled.
show_mw_cm_score_only	boolean Default: true Show maximum probability of mediastinal widening and cardiomegaly in score section. If you set `show_mw_cm_score_only`=`true` then mediastinal widening and cardiomegaly is showing below.
show_low_score	boolean Default: false Show probability of specified lesions in score section which score is lower than threshold.
show_license	boolean Default: false Determines whether to print license warning statements.
show_license_detail	string Enum: "date" "count" "date,count" Determines the type of license details to display. Details are not displayed by default.
sc_type	string Default: "map" Enum: "map" "report" Type of secondary capture display format.
compare_type	string Default: "none" Enum: "none" "augmented" "additional" Enabling return JPEG content with compare result. It only works prediction result has compare result.
current_date	string Show date when taken `frontal` DICOM. It only works prediction result has compare result.
previous_date	string Show date when taken `frontal_previous` DICOM. It only works prediction result has compare result.

header Parameters

Authorization required	string Example: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6I... API Key
Accept-Language	string Display lesion names in the selected language.

Responses

Response samples

Content type

image/jpeg

JPEG image content

GET a singlemap prediction result as JPG

Get a singlemap prediction result as JPG for the detected CXR-V3 lesions.

path Parameters

uuid

required

string

Example: 41ee74f5-f87e-4ff9-a76d-eb70c06b5fc4

The UUID from the Predict API response

query Parameters

lesion_names	string Default: "atelectasis,calcification,cardiomegaly,consolidation,fibrosis,mediastinal_widening,nodule,pleural_effusion,pneumoperitoneum,pneumothorax" Comma-separated list of lesion names to detect. If you set specific lesion names, only specified lesions will be shown in response.
tb_screening	boolean Default: false Enable Tuberculosis screening. One of the options `tb_screening`, `show_abn_score` must be enabled.
show_abn_score	boolean Default: true Show maximum probability of specified lesions in score section. One of the options `tb_screening`, `show_abn_score` must be enabled.
show_mw_cm_score_only	boolean Default: true Show maximum probability of mediastinal widening and cardiomegaly in score section. If you set `show_mw_cm_score_only`=`true` then mediastinal widening and cardiomegaly is showing below.
show_low_score	boolean Default: false Show probability of specified lesions in score section which score is lower than threshold.
show_license	boolean Default: false Determines whether to print license warning statements.
show_license_detail	string Enum: "date" "count" "date,count" Determines the type of license details to display. Details are not displayed by default.
sc_type	string Default: "map" Enum: "map" "report" Type of secondary capture display format.
compare_type	string Default: "none" Enum: "none" "augmented" "additional" Enabling return JPEG content with compare result. It only works prediction result has compare result.
current_date	string Show date when taken `frontal` DICOM. It only works prediction result has compare result.
previous_date	string Show date when taken `frontal_previous` DICOM. It only works prediction result has compare result.
color	string Default: "00C9EA" A Color to fill the lesion area. It must be expressed in hexadecimal.
opacity	string Default: "0.2" A opacity to fill the lesion area. It muse be between `0.0` and `1.0`.

header Parameters

Authorization required	string Example: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6I... API Key
Accept-Language	string Display lesion names in the selected language.

Responses

Response samples

Content type

image/jpeg

JPEG image content

GET a combined(contour and heatmap) prediction result as JSON

Get a combined(contour and heatmap) prediction result as v1 JSON for the detected CXR-V3 lesions. /v1/ can be substituted with /.

path Parameters

uuid

required

string

Example: 41ee74f5-f87e-4ff9-a76d-eb70c06b5fc4

The UUID from the Predict API response

query Parameters

lesion_names	string Default: "atelectasis,calcification,cardiomegaly,consolidation,fibrosis,mediastinal_widening,nodule,pleural_effusion,pneumoperitoneum,pneumothorax" Comma-separated list of lesion names to detect. If you set specific lesion names, only specified lesions will be shown in response.
tb_screening	boolean Default: false Enable Tuberculosis screening. One of the options `tb_screening`, `show_abn_score` must be enabled.
show_abn_score	boolean Default: true Show maximum probability of specified lesions in score section. One of the options `tb_screening`, `show_abn_score` must be enabled.
show_mw_cm_score_only	boolean Default: true Show maximum probability of mediastinal widening and cardiomegaly in score section. If you set `show_mw_cm_score_only`=`true` then mediastinal widening and cardiomegaly is showing below.
show_low_score	boolean Default: false Show probability of specified lesions in score section which score is lower than threshold.
show_license	boolean Default: false Determines whether to print license warning statements.
show_license_detail	string Enum: "date" "count" "date,count" Determines the type of license details to display. Details are not displayed by default.

header Parameters

Authorization required	string Example: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6I... API Key
Accept-Language	string Display lesion names in the selected language.

Responses

GET a combined(contour and heatmap) prediction result as JPG

Get a combined(contour and heatmap) prediction result as JPG for the detected CXR-V3 lesions.

path Parameters

uuid

required

string

Example: 41ee74f5-f87e-4ff9-a76d-eb70c06b5fc4

The UUID from the Predict API response

query Parameters

lesion_names	string Default: "atelectasis,calcification,cardiomegaly,consolidation,fibrosis,mediastinal_widening,nodule,pleural_effusion,pneumoperitoneum,pneumothorax" Comma-separated list of lesion names to detect. If you set specific lesion names, only specified lesions will be shown in response.
tb_screening	boolean Default: false Enable Tuberculosis screening. One of the options `tb_screening`, `show_abn_score` must be enabled.
show_abn_score	boolean Default: true Show maximum probability of specified lesions in score section. One of the options `tb_screening`, `show_abn_score` must be enabled.
show_mw_cm_score_only	boolean Default: true Show maximum probability of mediastinal widening and cardiomegaly in score section. If you set `show_mw_cm_score_only`=`true` then mediastinal widening and cardiomegaly is showing below.
show_low_score	boolean Default: false Show probability of specified lesions in score section which score is lower than threshold.
show_license	boolean Default: false Determines whether to print license warning statements.
show_license_detail	string Enum: "date" "count" "date,count" Determines the type of license details to display. Details are not displayed by default.
sc_type	string Default: "map" Enum: "map" "report" Type of secondary capture display format.
compare_type	string Default: "none" Enum: "none" "augmented" "additional" Enabling return JPEG content with compare result. It only works prediction result has compare result.
current_date	string Show date when taken `frontal` DICOM. It only works prediction result has compare result.
previous_date	string Show date when taken `frontal_previous` DICOM. It only works prediction result has compare result.

header Parameters

Authorization required	string Example: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6I... API Key
Accept-Language	string Display lesion names in the selected language.

Responses

Response samples

Content type

image/jpeg

JPEG image content

MMG API

POST a predict request

Request analysis of the uploaded dicom file.

header Parameters

Authorization

required

string

Example: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6I...

API Key

Request Body schema: application/json

required

Array of objects

Array

dicom	string UUID of uploaded DICOM file
view_name	string Enum: "lcc" "lmlo" "rcc" "rmlo" view name of DICOM image

threshold

number

Default: 0.1

Enum: 0.1 0.2 0.3

Threshold for prediction

Responses

Response Schema: application/json

uuid

string

object

tag	string
description	string
supported_features	Array of any

Array of objects

Array

dicom	string
view_name	string

threshold

number

thresholds

object or null

filtering

boolean

apply_prior_window

boolean

wait_time

number

init_time

any or null

prediction_time

number

status

string

status_code

string

created_at

string

Request samples

Payload

Content type

application/json

{"case": [{"dicom": "21503c99-4fad-4b08-a69d-dd06820a5c70",
"view_name": "lcc"
},
{"dicom": "c3788a05-d440-449d-8798-f494c1c7c8df",
"view_name": "lmlo"
},
{"dicom": "bf403d85-d334-4633-83a6-45685627b8cb",
"view_name": "rcc"
},
{"dicom": "b3797f6f-35cd-42d9-88de-03307c6ebdaf",
"view_name": "rmlo"
}
],
"threshold": 0.1
}

Response samples

Content type

application/json

{"uuid": "21503c99-4fad-4b08-a69d-dd06820a5c70",
"inference_model": {"tag": "5.9.0",
"description": "",
"supported_features": ["density"
]
},
"case": [{"dicom": "21503c99-4fad-4b08-a69d-dd06820a5c70",
"view_name": "lcc"
},
{"dicom": "c3788a05-d440-449d-8798-f494c1c7c8df",
"view_name": "lmlo"
},
{"dicom": "bf403d85-d334-4633-83a6-45685627b8cb",
"view_name": "rcc"
},
{"dicom": "b3797f6f-35cd-42d9-88de-03307c6ebdaf",
"view_name": "rmlo"
}
],
"threshold": 0.1,
"thresholds": null,
"filtering": false,
"apply_prior_window": true,
"wait_time": 2.242044,
"init_time": null,
"prediction_time": 1.869625,
"status": "SUCCESS",
"status_code": "200.40.ISTIS.000",
"created_at": "2022-10-19T07:50:18.036862Z"
}

GET a score prediction result

Get a score prediction result for the detected MMG lesions.

path Parameters

uuid

required

string

Example: 41ee74f5-f87e-4ff9-a76d-eb70c06b5fc4

The UUID from the Predict API response

query Parameters

raw	boolean Default: false Show raw value of lesion probabilities.

header Parameters

Authorization

required

string

Example: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6I...

API Key

Responses

Response Schema: application/json

object

lcc	number
lmlo	number
rcc	number
rmlo	number

object

category	string
score	number
raw_score	number

object

category	string
score	number
raw_score	number

object

category	string
score	number
raw_score	number

object

category	string
score	number
raw_score	number

object

category	string
score	number
raw_score	number

object

category	string
score	number
raw_score	number

object

category	string
score	number
raw_score	number

object

category	string
score	number
raw_score	number

object

category	string
score	number
raw_score	number

Response samples

Content type

application/json

{"score": {"cancer": {"lcc": 99.85,
"lmlo": 99.84,
"rcc": 0.43,
"rmlo": 0.48
}
},
"metascore": {"density": {"lcc": {"category": "b",
"score": 4,
"raw_score": 0.34084119259690243
},
"rcc": {"category": "b",
"score": 5,
"raw_score": 0.4314970667473972
},
"lmlo": {"category": "b",
"score": 4,
"raw_score": 0.3794709478194515
},
"rmlo": {"category": "b",
"score": 5,
"raw_score": 0.43297847888122004
},
"cc": {"category": "b",
"score": 4,
"raw_score": 0.3861691296721498
},
"mlo": {"category": "b",
"score": 5,
"raw_score": 0.4062247133503358
},
"left": {"category": "b",
"score": 4,
"raw_score": 0.36015607020817697
},
"right": {"category": "b",
"score": 5,
"raw_score": 0.43223777281430864
},
"case": {"category": "b",
"score": 5,
"raw_score": 0.3961969215112428
},
"category": "b",
"description": "Scattered Fibroglandular Densities",
"score": 5
}
}
}

GET a contour prediction result as JSON

Get a contour prediction result as v1 JSON for the detected MMG lesions. /v1/ can be substituted with /.

path Parameters

uuid

required

string

Example: 41ee74f5-f87e-4ff9-a76d-eb70c06b5fc4

The UUID from the Predict API response

query Parameters

show_license	boolean Default: false Determines whether to print license warning statements.
show_license_detail	string Enum: "date" "count" "date,count" Determines the type of license details to display. Details are not displayed by default.
show_lesion_score	boolean Default: true Display probability on annotation text.
show_lesion_type	boolean Default: false Display lesion type on annotation text.

header Parameters

Authorization

required

string

Example: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6I...

API Key

Responses

GET a contour prediction result as JPG

Get a contour prediction result as JPG for the detected MMG lesions.

path Parameters

uuid

required

string

Example: 41ee74f5-f87e-4ff9-a76d-eb70c06b5fc4

The UUID from the Predict API response

query Parameters

show_license	boolean Default: false Determines whether to print license warning statements.
show_license_detail	string Enum: "date" "count" "date,count" Determines the type of license details to display. Details are not displayed by default.
show_abn_low_score	boolean Default: false Displays even if the probability score is below the threshold.
show_lesion_score	boolean Default: true Display probability on annotation text.
show_lesion_type	boolean Default: false Display lesion type on annotation text.
show_density_score	boolean Default: true Display density score.
show_density_level	string Default: "case" Enum: "case" "side" Determine whether density score is displayed at case level or side level.
dicoms required	string Example: dicoms=21503c99-4fad-4b08-a69d-dd06820a5c70,c3788a05-d440-449d-8798-f494c1c7c8df,bf403d85-d334-4633-83a6-45685627b8cb,b3797f6f-35cd-42d9-88de-03307c6ebdaf The UUID array of DICOMs to be included in the JPG. It is associated with parameter `page`. If `page` is 1, the `dicoms` parameter must contain only one dicom for each view name. Other than that, it's irrelevant.
page required	string Example: page=1,1 Page information for JPG. It is associated with `dicoms` parameter. `m,n` forms and `m` is less than or equal to `n`. (1 <= `m` <= `n` <4) If `m` is 1, the `dicoms` parameter must contain only one dicom for each view. Other than that, it's irrelevant.

header Parameters

Authorization

required

string

Example: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6I...

API Key

Responses

Response samples

Content type

image/jpeg

JPEG image content

GET a heatmap prediction result as JSON

Get a heatmap prediction result as v1 JSON for the detected MMG lesions. /v1/ can be substituted with /.

path Parameters

uuid

required

string

Example: 41ee74f5-f87e-4ff9-a76d-eb70c06b5fc4

The UUID from the Predict API response

query Parameters

show_license	boolean Default: false Determines whether to print license warning statements.
show_license_detail	string Enum: "date" "count" "date,count" Determines the type of license details to display. Details are not displayed by default.
show_lesion_score	boolean Default: true Display probability on annotation text.
show_lesion_type	boolean Default: false Display lesion type on annotation text.

header Parameters

Authorization

required

string

Example: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6I...

API Key

Responses

GET a heatmap prediction result as JPG

Get a heatmap prediction result as JPG for the detected MMG lesions.

path Parameters

uuid

required

string

Example: 41ee74f5-f87e-4ff9-a76d-eb70c06b5fc4

The UUID from the Predict API response

query Parameters

show_license	boolean Default: false Determines whether to print license warning statements.
show_license_detail	string Enum: "date" "count" "date,count" Determines the type of license details to display. Details are not displayed by default.
show_abn_low_score	boolean Default: false Displays even if the probability score is below the threshold.
show_lesion_score	boolean Default: true Display probability on annotation text.
show_lesion_type	boolean Default: false Display lesion type on annotation text.
show_density_score	boolean Default: true Display density score.
show_density_level	string Default: "case" Enum: "case" "side" Determine whether density score is displayed at case level or side level.
dicoms required	string Example: dicoms=21503c99-4fad-4b08-a69d-dd06820a5c70,c3788a05-d440-449d-8798-f494c1c7c8df,bf403d85-d334-4633-83a6-45685627b8cb,b3797f6f-35cd-42d9-88de-03307c6ebdaf The UUID array of DICOMs to be included in the JPG. It is associated with parameter `page`. If `page` is 1, the `dicoms` parameter must contain only one dicom for each view name. Other than that, it's irrelevant.
page required	string Example: page=1,1 Page information for JPG. It is associated with `dicoms` parameter. `m,n` forms and `m` is less than or equal to `n`. (1 <= `m` <= `n` <4) If `m` is 1, the `dicoms` parameter must contain only one dicom for each view. Other than that, it's irrelevant.

header Parameters

Authorization

required

string

Example: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6I...

API Key

Responses

Response samples

Content type

image/jpeg

JPEG image content

GET a singlemap prediction result as JPG

Get a singlemap prediction result as JPG for the detected MMG lesions.

path Parameters

uuid

required

string

Example: 41ee74f5-f87e-4ff9-a76d-eb70c06b5fc4

The UUID from the Predict API response

query Parameters

show_license	boolean Default: false Determines whether to print license warning statements.
show_license_detail	string Enum: "date" "count" "date,count" Determines the type of license details to display. Details are not displayed by default.
show_abn_low_score	boolean Default: false Displays even if the probability score is below the threshold.
show_lesion_score	boolean Default: true Display probability on annotation text.
show_lesion_type	boolean Default: false Display lesion type on annotation text.
show_density_score	boolean Default: true Display density score.
show_density_level	string Default: "case" Enum: "case" "side" Determine whether density score is displayed at case level or side level.
dicoms required	string Example: dicoms=21503c99-4fad-4b08-a69d-dd06820a5c70,c3788a05-d440-449d-8798-f494c1c7c8df,bf403d85-d334-4633-83a6-45685627b8cb,b3797f6f-35cd-42d9-88de-03307c6ebdaf The UUID array of DICOMs to be included in the JPG. It is associated with parameter `page`. If `page` is 1, the `dicoms` parameter must contain only one dicom for each view name. Other than that, it's irrelevant.
page required	string Example: page=1,1 Page information for JPG. It is associated with `dicoms` parameter. `m,n` forms and `m` is less than or equal to `n`. (1 <= `m` <= `n` <4) If `m` is 1, the `dicoms` parameter must contain only one dicom for each view. Other than that, it's irrelevant.
color	string Default: "00C9EA" A Color to fill the lesion area. It must be expressed in hexadecimal.
opacity	string Default: "0.2" A opacity to fill the lesion area. It muse be between `0.0` and `1.0`.

header Parameters

Authorization

required

string

Example: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6I...

API Key

Responses

Response samples

Content type

image/jpeg

JPEG image content

GET a combined(contour and heatmap) prediction result as JSON

Get a combined(contour and heatmap) prediction result as v1 JSON for the detected MMG lesions. /v1/ can be substituted with /.

path Parameters

uuid

required

string

Example: 41ee74f5-f87e-4ff9-a76d-eb70c06b5fc4

The UUID from the Predict API response

query Parameters

show_license	boolean Default: false Determines whether to print license warning statements.
show_license_detail	string Enum: "date" "count" "date,count" Determines the type of license details to display. Details are not displayed by default.
show_lesion_score	boolean Default: true Display probability on annotation text.
show_lesion_type	boolean Default: false Display lesion type on annotation text.

header Parameters

Authorization

required

string

Example: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6I...

API Key

Responses

GET a combined(contour and heatmap) prediction result as JPG

검출된 MMG 병변에 대한 combined(contour 및 heatmap) 분석 결과를 JPG로 반환합니다.

path Parameters

uuid

required

string

Example: 41ee74f5-f87e-4ff9-a76d-eb70c06b5fc4

The UUID from the Predict API response

query Parameters

show_license	boolean Default: false Determines whether to print license warning statements.
show_license_detail	string Enum: "date" "count" "date,count" Determines the type of license details to display. Details are not displayed by default.
show_abn_low_score	boolean Default: false Displays even if the probability score is below the threshold.
show_lesion_score	boolean Default: true Display probability on annotation text.
show_lesion_type	boolean Default: false Display lesion type on annotation text.
show_density_score	boolean Default: true Display density score.
show_density_level	string Default: "case" Enum: "case" "side" Determine whether density score is displayed at case level or side level.
dicoms required	string Example: dicoms=21503c99-4fad-4b08-a69d-dd06820a5c70,c3788a05-d440-449d-8798-f494c1c7c8df,bf403d85-d334-4633-83a6-45685627b8cb,b3797f6f-35cd-42d9-88de-03307c6ebdaf The UUID array of DICOMs to be included in the JPG. It is associated with parameter `page`. If `page` is 1, the `dicoms` parameter must contain only one dicom for each view name. Other than that, it's irrelevant.
page required	string Example: page=1,1 Page information for JPG. It is associated with `dicoms` parameter. `m,n` forms and `m` is less than or equal to `n`. (1 <= `m` <= `n` <4) If `m` is 1, the `dicoms` parameter must contain only one dicom for each view. Other than that, it's irrelevant.

header Parameters

Authorization

required

string

Example: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6I...

API Key

Responses

Response samples

Content type

image/jpeg

JPEG image content