Charge the scan and start the analysis

Checks that every frame (or the video) is uploaded, uses the free scan or charges the wallet, and starts the analysis. Answers 202 when it started the scan and 200 when the scan had already started. A failed analysis is refunded. Errors: 402 PAYMENT_METHOD_REQUIRED (a live scan needs a card on file: added in the console, nothing charged), INSUFFICIENT_FUNDS or SPENDING_CAP_REACHED, 409 UPLOAD_INCOMPLETE, 429 SCANS_IN_PROGRESS, 429 RATE_LIMIT_EXCEEDED with Retry-After when 5 live scans of the account failed that day because of their footage (no usable frame, an unreadable or too long video, nothing recognisable: each refunded) until midnight UTC, 503 PAYMENTS_UNAVAILABLE (a live scan where payments are not configured). Test keys are never charged and get the demo result. Needs scans:write.

post/scans/{id}/start

Request

  • Base URL: https://api.spacecontext.app/v1
  • URL: https://api.spacecontext.app/v1/scans/{id}/start
  • Auth: HTTP bearer

Path parameters

idstring required

Response

Already started

object'scan' required
idstring required
space_idstring required
livemodeboolean required
status'awaiting_upload' | 'queued' | 'processing' | 'complete' | 'failed' | 'cancelled' required
stage'ingesting' | 'screening' | 'observing' | 'fusing' | 'enriching' | 'saving' | 'verifying' | 'null' nullable required
created_atstring date-time nullable required
started_atstring date-time nullable required
completed_atstring date-time nullable required

Changes

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