Calibrate a screen

post/v1/screens/{screen_id}/calibrations

This endpoint is in the contract, but the API doesn't serve it during early access. It returns 404 for now.

Captures a new quality baseline from the screen's latest scored quality window (the same window the screen.quality webhook reports). With no window yet, returns 409 no_quality_readings.

curl -X POST "https://api.vojo-media.com/v1/screens/$SCREEN_ID/calibrations" \
  -H "Authorization: Bearer $VOJO_KEY" \
  -H "Idempotency-Key: $(uuidgen)"

const { data, error } = await api.POST("/v1/screens/{screen_id}/calibrations", {
  params: { path: { screen_id: screenId }, header: { "Idempotency-Key": crypto.randomUUID() } },
});
if (error) throw new VojoApiError(error);

Response 201

{
  "data": {
    "id": "cm1stq7t3y0001u6i2o9p5a8xq",
    "screen_id": "cm1scr2w6n0001h8d4k9t3m7ve",
    "white": 100,
    "red": 98.4,
    "green": 101.2,
    "blue": 99.1,
    "taken_at": "2026-10-07T09:30:00Z"
  },
  "meta": {}
}

Access

Authentication: Secret key or OAuth access token.
Scope: screens:write
User permission: harvesterCalibration
Safe to retry: Send an Idempotency-Key.

Path parameters

screen_idstringRequired
Screen id.

Headers

Vojo-Organisationstring
The organisation this request acts on (org id). Required for oauth2 callers — a missing header returns 400 organisation_header_required; an org the user cannot access (a membership or an access grant, and granted to this OAuth client) returns 403 organisation_access_denied. Secret keys are bound to one org: the header may be omitted, and if sent it must match the key's org (else 403). Every query is scoped by the resolved org, never by an id in the body.
Vojo-Versionstring
Optional API version pin (a date). Overrides the version pinned on the secret key / organisation for this request. Echoed in the Vojo-Version response header. Within /v1 only additive changes ship, so most callers can omit it.
date
Idempotency-Keystring
Client-generated unique key (UUID v4 recommended) making this create safe to retry. A replay within 24 hours returns the stored response (with Idempotent-Replayed: true). Reusing a key with a different body returns 409 idempotency_key_reused.
8 to 255 characters

Response 201

Created

dataobjectRequired
A quality baseline captured from the latest scored quality window.
Show 7 fields
- idstringRequired
  Calibration id. Opaque string — treat as an identifier, never parse it.
- screen_idstringRequired
  Screen id. Opaque string — treat as an identifier, never parse it.
- whitenumber or nullRequired
  Baseline white brightness.
- rednumber or nullRequired
  Baseline red brightness.
- greennumber or nullRequired
  Baseline green brightness.
- bluenumber or nullRequired
  Baseline blue brightness.
- taken_atstringRequired
  When the baseline reading was taken.
  date-time
metaobjectRequired
Response metadata for single-resource responses. Reserved; currently empty. Clients must ignore unknown members.

Response headers

Vojo-Versionstring
The API version (date) this response was rendered with — the request's Vojo-Version, else the key/org pin.
RateLimitstring
IETF RateLimit header: remaining quota in the current window, e.g. "default";r=97;t=42.
RateLimit-Policystring
IETF RateLimit-Policy header, e.g. "default";q=100;w=60. Portal OAuth clients get a higher tier.
Locationstring
URL of the created resource.
Idempotent-Replayedstring
true when this response is a stored replay of an earlier request with the same Idempotency-Key.

Errors

Every error is application/problem+json. Branch on its code.

400
Malformed request: invalid JSON, a bad cursor, a missing Vojo-Organisation for an OAuth caller, or an unknown Vojo-Version.
401
Missing, invalid, expired or revoked credential.
403
The caller is authenticated but not allowed: missing scope (insufficient_scope), missing Permissions flag (permission_denied), a client/installer persona on an operator endpoint (operator_access_required), or no access to the requested org (organisation_access_denied).
404
The resource does not exist, or belongs to another organisation. Cross-org ids always 404, never 403.
409
The request conflicts with current state (duplicate name, device already paired, idempotency key reuse).
429
Rate limit exceeded for this principal. Back off for Retry-After seconds.
500
Unexpected server failure.