Submit a colour Assessment

POST

https://api.morphiaone.ai/v1/digitisation/assessments

POST

/v1/digitisation/assessments

curl -X POST https://api.morphiaone.ai/v1/digitisation/assessments \
     -H "X-API-Key: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "images": [
    {
      "evidence_id": "string",
      "regions": [
        [
          1
        ]
      ]
    }
  ]
}'

{
  "attempts": 0,
  "colour_contract_version": 1,
  "created_at": "2026-10-22T03:19:40.254296Z",
  "failure_code": null,
  "finished_at": null,
  "id": "assessment_3t38gf4mbt0y96z8pzmp4w5mpq",
  "output": null,
  "output_sha256": null,
  "request": {
    "colour_contract_version": 1,
    "images": [
      {
        "analyzed_bytes_sha256": "9229dacfcfb7a93b54efccf2119c2e417546d10ed3fce2a18a067294b646c5a2",
        "evidence_id": "evidence_6952rp5rnjq4bpn9sk93vbq6pv",
        "regions": [
          [
            0,
            0,
            32,
            32
          ],
          [
            16,
            16,
            64,
            64
          ]
        ]
      },
      {
        "analyzed_bytes_sha256": "802a63709b9b3660da4dd729a944279d93b7589b3e441ed02e76f8bef05f7038",
        "evidence_id": "evidence_4jvaws4n7vkx8t6tz6awjwdsv8",
        "regions": [
          [
            0,
            0,
            32,
            32
          ]
        ]
      }
    ],
    "kind": "digitisation.assessment_request"
  },
  "request_sha256": "f69b572a86480a0d96286c0440e63567fdfdc276aa7f39b58357e565c170ce97",
  "started_at": null,
  "status": "queued"
}

Measures the colour of up to four regions in each of up to eight evidence images. A region is [left, top, right, bottom] in pixels, at least 16 on each side and inside its image. Every limit is checked before anything is written, so a refusal is 400 INVALID_REQUEST naming the image or region and records nothing. The answer is 202 with the assessment queued and its recorded request, which binds each evidence id to the digest of the bytes it will measure. Poll GET /v1/digitisation/assessments/{assessment_id} for the result. Send an Idempotency-Key: it is required, and a retry with the same key and the same request answers the first response, byte for byte, with Idempotency-Replayed: true. Requires the digitisation.write scope, which your account operator provisions; served only where digitisation is enabled for your environment.

Authentication

X-API-Keystring

API key for one environment of your account. Keep server-side; never expose in browser clients.

Request

Queue an assessment: images and regions are ordered, and the result keeps it.

imageslist of objectsRequired

subjectobject or nullOptional

The product the images show, as the caller names it. Every field is optional and descriptive: it is what a reviewer reads, never what is measured. A stage of a candidate defaults its external_ref and shade_name from it.

Response

The assessment, queued; a replay under the same Idempotency-Key answers it again with Idempotency-Replayed: true

attemptsinteger>=0

colour_contract_versioninteger

created_atdatetime

failure_codeenum or null

Allowed values:

finished_atdatetime or null

idstring

outputobject or null

The canonical result; result_sha256 is its digest.

output_sha256string or nullformat: "^[0-9a-f]{64}$"

requestobject

The canonical request; request_sha256 is its digest.

request_sha256stringformat: "^[0-9a-f]{64}$"

started_atdatetime or null

statusenum

Allowed values:

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

409

Conflict Error

503

Service Unavailable Error

Authentication

Headers

Request

Response

Errors