Check one frame while filming

For apps that capture a space and guide the person filming: is this frame usable, which key locations does it show and, with space_type, which area. With space_type the key locations are those of that type of space (GET /capture-profiles: a car is checked for its VIN plate and dashboard, a boat for its seacocks), and area says where the frame was taken; without it, a home's: electrical_panel, water_shutoff, water_heater, smoke_detector, fire_extinguisher, router, heating_control, gas_meter, and no area. A key location is seen from a probability of 0.7. The raw image as the body: JPEG, PNG or WebP, at most 2 MB. About half a second; nothing is stored. Free within a daily allowance per account (429 when used up). Test keys get a fixed answer. Needs scans:write; a live check needs a card on file, like a live scan. Errors: 400 VALIDATION_ERROR (unknown space_type), 402 PAYMENT_METHOD_REQUIRED (live, no card on file: added in the console, nothing charged), 415 INVALID_CONTENT_TYPE, 503 FRAME_CHECK_UNAVAILABLE, 503 PAYMENTS_UNAVAILABLE (live, where payments are not configured).

post/frames/check

Request

  • Base URL: https://api.spacecontext.app/v1
  • URL: https://api.spacecontext.app/v1/frames/check
  • Auth: HTTP bearer

Query parameters

space_type'apartment' | 'house' | 'office' | 'warehouse' | 'vehicle' | 'boat' | 'camper' | 'shop' | 'garage' | 'appliance' | 'other'

The type of space being filmed: its key locations, and the area question.

Response

What the frame shows

object'frame_check' required
livemodeboolean required
space_type'apartment' | 'house' | 'office' | 'warehouse' | 'vehicle' | 'boat' | 'camper' | 'shop' | 'garage' | 'appliance' | 'other' | 'null' nullable required

The space_type asked, or null.

usableboolean required

Sharp, lit and showing the space: worth keeping in a scan.

shows_spacenumber required

Probability that the frame shows the real thing being filmed (a place, a vehicle, a boat, an appliance), not a drawing, document or screen.

Changes

No recorded changes to this operation across all 1 revision of this API.