Cancel a colour Assessment | MorphiaOne Docs

{
  "attempts": 0,
  "colour_contract_version": 1,
  "created_at": "2026-10-22T03:19:40.271273Z",
  "failure_code": null,
  "finished_at": "2026-10-22T03:19:40.273715Z",
  "id": "assessment_4p8ha07gfz5pw5e6mg9ye038tp",
  "output": null,
  "output_sha256": null,
  "request": {
    "colour_contract_version": 1,
    "images": [
      {
        "analyzed_bytes_sha256": "802a63709b9b3660da4dd729a944279d93b7589b3e441ed02e76f8bef05f7038",
        "evidence_id": "evidence_4jvaws4n7vkx8t6tz6awjwdsv8",
        "regions": [
          [
            0,
            0,
            32,
            32
          ]
        ]
      }
    ],
    "kind": "digitisation.assessment_request"
  },
  "request_sha256": "37b5394d76fc018987a7bddb12216429ac8ae9cbe47aa1a25ee5f05d94feba91",
  "started_at": null,
  "status": "cancelled"
}

No body and no Idempotency-Key: the operation is naturally idempotent. A queued or running assessment is cancelled now, and a measurement already under way writes nothing. One already cancelled answers itself; a finished one answers 409 ASSESSMENT_NOT_CANCELLABLE. 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.

Path parameters

assessment_idstringRequired

Response

The assessment, cancelled (now, or by an earlier request)

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

404

Not Found Error

409

Conflict Error

503

Service Unavailable Error