Get a base document for a specific scan

A scan read by id is the snapshot as it was recorded. Past scans are not screened for sensitive values, so this operation requires the spaces:sensitive scope and answers 403 INSUFFICIENT_SCOPE without it.

get/spaces/{id}/scans/{scan_id}

Request

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

Path parameters

idstring required
scan_idstring required

Query parameters

include'transcript'

Adds the transcript. Requires the spaces:sensitive scope; without it the request is refused with 403 INSUFFICIENT_SCOPE.

Response

Space document for the scan

object'space_document' required
schema_version'1.0' required
summarystring nullable required
confidencenumber nullable required
featuresstring[] required

Changes

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