API docs by Redocly

Analysis Service (0.0.1)

Download OpenAPI specification:Download

The analysis service is in charge of running ML models and algorithms to extract insights from patient images.

Analysis

The results of running a certain algorithm/model.

Request a new AI analysis

Trigger the execution of an algorithm with some inputs.

Authorizations:
ApiKey
Request Body schema: application/json

Send the algorithm you want to run, as well as its inputs.

modelId
required
string
parameters
object
Array of objects (ImagingTest)

Responses

Request samples

Content type
application/json
{
  • "modelId": "31bd5132-c683-4e66-ac7c-62c8f2dd5bc6",
  • "parameters": { },
  • "imagingTests": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "39b30df5-2b40-4396-8452-9b456aaadd48",
  • "modelId": "31bd5132-c683-4e66-ac7c-62c8f2dd5bc6",
  • "status": "done",
  • "parameters": { },
  • "results": { },
  • "imagingTests": [
    ]
}

Cancels or removes an AI analysis

If the AI analysis was still pending, it cancels it. If the AI analysis had completed, it removes it.

Authorizations:
ApiKey
path Parameters
id
required
string

id of the Analysis

Responses

Get the results of an AI analysis

Retrieves the result or progress of an AI analysis.

Authorizations:
ApiKey
path Parameters
id
required
string

id of the Analysis

Responses

Response samples

Content type
application/json
{
  • "id": "39b30df5-2b40-4396-8452-9b456aaadd48",
  • "modelId": "31bd5132-c683-4e66-ac7c-62c8f2dd5bc6",
  • "status": "done",
  • "parameters": { },
  • "results": { },
  • "imagingTests": [
    ]
}

Models

The available models and algorithms.

Get all available models/algorithms.

Retrieves a list of models which can be run as part of this service.

Authorizations:
ApiKey

Responses

Response samples

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