Skip to navigation

Retain an Asset as digitisation Evidence

Copies the bytes of one of your uploaded Assets into evidence you own: it outlives the Asset’s expiry and is erased only with your account’s data. The evidence records the upload’s digest, the digest of the bytes it measures, its dimensions and the colour contract version it was retained under. Retention is content-addressed, so the same image again answers the same evidence: 201 the first time, 200 after, and a retry needs no Idempotency-Key. Another account’s Asset, and an expired or unknown one, answer 404 ASSET_NOT_FOUND; an Asset that is not an intact upload of yours, such as a job result, answers 409 EVIDENCE_SOURCE_UNUSABLE. 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

This endpoint expects any.
anyRequired
OR
anyRequired

Response

The evidence this image already is
analyzed_bytes_sha256stringformat: "^[0-9a-f]{64}$"
colour_contract_versioninteger>=1
created_atdatetime
erased_atdatetime or null
heightinteger>=1
idstring
media_typeenum
Allowed values:
original_upload_sha256stringformat: "^[0-9a-f]{64}$"
sanitizer_revisioninteger>=1
size_bytesinteger>=1
source_asset_idstring
statusenum
Allowed values:
stored_atdatetime or null
widthinteger>=1

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
429
Too Many Requests Error
503
Service Unavailable Error