🟢API for Images

This page contains description of images management via API.

Image is a data source object that is used by Algorithmsto extract information and convert it into knowledge (for example, the estimation of skin concerns)

What can you do?

You can find more details on these actions in the Images section of Swagger.

• Upload

  • Generate signed URL for upload

  • Send to computation

• List subject images

• Get image info

• Delete image

Upload

Generate signed URL for upload

Generate signed URL to upload image to subject

Underlying batch to store image is created automatically. Don't forget to call /compute/ method when the upload is done

POST/api/v1/companies/{company_id}/subjects/{subject_id}/signed_upload_url/

Authorization

PrivateTokenAuthPasswordAuthcookieAuth

Path parameters

company_id*string (uuid)

subject_id*string (uuid)

Body

application/json

batch_idstring (uuid)

image batch id (uuid)

side_idinteger

image side id related to dataset's image_type, you can choose a side from /dicts/image_types/ API endpoint, if you omit this parameter, the default side will be used

light_idintegernull

image light id related to dataset's image_type, you can choose a light from /dicts/image_types/ API endpoint, if you omit this parameter, the default side will be used

metaone of

image meta

anynull

creation_timestring,null (date-time)

batch creation time

namestring

app_argsone of

anynull

Response

201400

Body

application/json

id*string (uuid)

name*string

side*ImageSideOut (object)

light*ImageLightOut (object)

image_type*ImageTypeShort (object)

side_name*string

side_tech_name*string

light_name*string

light_tech_name*string

image_type_name*string

image_type_tech_name*string

creation_time*string (date-time)

image creation time

quality_scoreintegernull

quality_feedbackany

quality_result*any

image quality

quality_issues*array of string

problems*array of string

stage_step_numberintegernull

stage_numberintegernull

urls*object

signed_url*stringnull

original_image_idstring,null (uuid)

image_batch_id*string (uuid)

image batch id (uuid)

metaone of

image metadata

anynull

application_run_idstring (uuid)

upload_url*all of

Request

JavaScriptCurlPython

const response = await fetch('/api/v1/companies/{company_id}/subjects/{subject_id}/signed_upload_url/', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

201400

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "side": {
    "name": "text",
    "tech_name": "text"
  },
  "light": {
    "name": "text",
    "tech_name": "text"
  },
  "image_type": {
    "name": "text",
    "tech_name": "text"
  },
  "side_name": "text",
  "side_tech_name": "text",
  "light_name": "text",
  "light_tech_name": "text",
  "image_type_name": "text",
  "image_type_tech_name": "text",
  "creation_time": "2024-10-22T10:38:08.023Z",
  "quality_issues": [
    "text"
  ],
  "problems": [
    "text"
  ],
  "image_batch_id": "123e4567-e89b-12d3-a456-426614174000",
  "application_run_id": "123e4567-e89b-12d3-a456-426614174000",
  "upload_url": {
    "url": "https://example.com",
    "method": "text"
  }
}

When you've created a subject connected to your user, you can now request a signed URL to upload the image.

In the simplest case (uploading 1 frontal selfie to subject), you don't even need to send any extra payload in the body of this request.

After you've received response from this API method, you should take the key from response upload_url. It will contain following keys:

• url — the URL where to upload your image

• method — HTTP method that you should use for upload (PUT by default)

• headers — required headers to make an upload request

Also you need to save the response key image_batch_id to a variable in your code, it will be needed later. Batch is simply a grouping of images in one group. In the simplest case when you upload only selfies, it's just a group of 1 image.

Then you perform an upload request:

curl -X PUT {upload_url.url} \
  -H "Content-Type: application/octet-stream" \
  -H "X-Goog-Content-Length-Range: 1,31457280" \
  --upload-file {file_name}

Image requirements:

• Minimum image resolution is 256x256 pixels.

• Maximum resolution is not restricted, but remember - the heavier is the picture, the longer it's being processed.

• Maximum image size is 30MB.

• Optimal image size is an average modern smartphone selfie (3-5MB).

Send to computation

After the upload is done, you should send signal to SaaS API backend, that upload is complete and we should start processing your image by algorithms.

Use previously saved image_batch_id as a batch_id here. The request body can be empty.

Send batch images to algorithms for processing

Send batch images to algorithms for processing

POST/api/v1/companies/{company_id}/batches/{batch_id}/compute/

Authorization

PrivateTokenAuthPasswordAuthcookieAuth

Path parameters

company_id*string (uuid)

batch_id*string (uuid)

Body

application/json

app_argsany

Response

200400

Body

application/json

okboolean

Request

JavaScriptCurlPython

const response = await fetch('/api/v1/companies/{company_id}/batches/{batch_id}/compute/', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200400

{
  "ok": true
}

---

List subject images

List subject images

List subject images

GET/api/v1/companies/{company_id}/subjects/{subject_id}/images/

Authorization

PrivateTokenAuthPasswordAuthcookieAuth

Path parameters

company_id*string (uuid)

subject_id*string (uuid)

Query parameters

Response

200

Body

application/json

count*integer

Example: 123

nextnullable string (uri)

Example: "http://api.example.org/accounts/?page=4"

previousnullable string (uri)

Example: "http://api.example.org/accounts/?page=2"

results*array of Image (object)

Request

JavaScriptCurlPython

const response = await fetch('/api/v1/companies/{company_id}/subjects/{subject_id}/images/', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

200

{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2",
  "results": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "side": "text",
      "created_at": "2024-10-22T10:38:08.023Z",
      "image_batch_id": "123e4567-e89b-12d3-a456-426614174000",
      "aux_images": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "aux_image_type": "text",
          "creation_time": "2024-10-22T10:38:08.023Z",
          "algo_app": "text"
        }
      ]
    }
  ]
}

Note that you can access aux images (aux images API link) directly in this response.

---

Get image info

Get image

Get image

GET/api/v1/companies/{company_id}/images/{image_id}/

Authorization

PrivateTokenAuthPasswordAuthcookieAuth

Path parameters

company_id*string (uuid)

image_id*string (uuid)

Query parameters

Response

200

Body

application/json

id*string (uuid)

name*string

side*string

quality_scoreintegernull

problemsany

created_at*string (date-time)

signed_url*stringnull

image_batch_id*string (uuid)

image batch id (uuid)

metaone of

anynull

aux_images*array of AuxImage (object)

Request

JavaScriptCurlPython

const response = await fetch('/api/v1/companies/{company_id}/images/{image_id}/', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

200

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "side": "text",
  "created_at": "2024-10-22T10:38:08.023Z",
  "image_batch_id": "123e4567-e89b-12d3-a456-426614174000",
  "aux_images": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "aux_image_type": "text",
      "creation_time": "2024-10-22T10:38:08.023Z",
      "algo_app": "text"
    }
  ]
}

Note that you can access aux images (aux images API link) directly in this response.

---

Delete image

Delete image

Delete image

DELETE/api/v1/companies/{company_id}/images/{image_id}/

Authorization

PrivateTokenAuthPasswordAuthcookieAuth

Path parameters

company_id*string (uuid)

image_id*string (uuid)

Response

204

No response body

Request

JavaScriptCurlPython

const response = await fetch('/api/v1/companies/{company_id}/images/{image_id}/', {
    method: 'DELETE',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();