Activate a harvester

post/v1/harvesters

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

Claims an unclaimed harvester for the org by its activation code, and optionally pairs it to a screen. To move a harvester the org already owns, use PUT /v1/screens/{screen_id}/harvester.

Sending screen_id pairs the harvester to that screen, so it also requires harvesterAssignScreen, in addition to harvesterInstall. Without it the request fails with 403 permission_denied and the harvester is not claimed.

curl -X POST "https://api.vojo-media.com/v1/harvesters" \
  -H "Authorization: Bearer $VOJO_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "activation_code": "HV-7Q2K-9X3M",
  "screen_id": "cm1scr2w6n0001h8d4k9t3m7ve",
  "harvester_screen_location": "top_right"
}'

const { data, error } = await api.POST("/v1/harvesters", {
  params: { header: { "Idempotency-Key": crypto.randomUUID() } },
  body: {
    activation_code: "HV-7Q2K-9X3M",
    screen_id: "cm1scr2w6n0001h8d4k9t3m7ve",
    harvester_screen_location: "top_right",
  },
});
if (error) throw new VojoApiError(error);

Response 201

{
  "data": {
    "id": "cm1hrv7c3b0001q9z5l2n8x4tg",
    "mac_address": "D8:3A:DD:41:7C:02",
    "version": "2.4.1",
    "description": null,
    "is_active": true,
    "enabled": true,
    "calibration_status": "calibrated",
    "last_calibration_at": "2026-09-30T07:00:00Z",
    "last_check_in_at": "2026-10-07T09:30:00Z",
    "sensor_style": "square",
    "screen_id": "cm1scr2w6n0001h8d4k9t3m7ve",
    "created_at": "2025-04-11T12:40:00Z",
    "updated_at": "2026-10-07T09:30:00Z"
  },
  "meta": {}
}

Access

Authentication: Secret key or OAuth access token.
Scope: harvesters:write
User permission: harvesterInstall
Sending screen_id: Also needs harvesterAssignScreen
Safe to retry: Send an Idempotency-Key.

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

Request body

activation_codestringRequired
Install id / activation code from the device label.
screen_idstring
Pair to this screen on activation (optional).
harvester_screen_locationstring
Corner of the screen the harvester sensor is mounted on.
One of top_left, top_right, bottom_left, bottom_right

Response 201

Created

dataobjectRequired
A proof-of-display sensor.
Show 13 fields
- idstringRequired
  Harvester id. Opaque string — treat as an identifier, never parse it.
- mac_addressstringRequired
- versionstring or nullRequired
  Firmware version.
- descriptionstring or nullRequired
- is_activebooleanRequired
- enabledbooleanRequired
- calibration_statusstring or nullRequired
  Harvester calibration state.
  One of new, calibrated, new_screen, calibrating
- last_calibration_atstring or nullRequired
  RFC 3339 / ISO-8601 UTC timestamp, or null.
  date-time
- last_check_in_atstring or nullRequired
  Device-reported last check-in. Not monotonic (buffered flushes can move it back).
  date-time
- sensor_stylestring or nullRequired
  Fingerprint sensor patch style.
  One of square, quadrant_with_wings
- screen_idstring or nullRequired
  Screen it is paired to, or null when unassigned.
- created_atstringRequired
  RFC 3339 / ISO-8601 UTC timestamp.
  date-time
- updated_atstring or nullRequired
  RFC 3339 / ISO-8601 UTC timestamp, or null.
  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).
422
Well-formed request that failed validation. errors[] lists each failing field.
429
Rate limit exceeded for this principal. Back off for Retry-After seconds.
500
Unexpected server failure.