Create a space to scan through the API

Creates a space in the key's mode (test or live). With an external_id already used in that mode, returns the existing space with 200 instead of creating another. An account creates at most 200 spaces a day in each mode (by default, test keys included; a replay does not count): past that, 429 RATE_LIMIT_EXCEEDED with Retry-After (seconds to midnight UTC). Needs spaces:read and scans:write.

post/spaces

Request

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

Request body

namestring required
descriptionstring nullable
space_type'apartment' | 'house' | 'office' | 'warehouse' | 'vehicle' | 'boat' | 'camper' | 'shop' | 'garage' | 'appliance' | 'other' | 'null' nullable
external_idstring nullable

Response

The space with this external_id

object'space' required
idstring required
source'api' required
livemodeboolean required
namestring required
descriptionstring nullable required
space_typestring nullable required
external_idstring nullable required
created_atstring date-time nullable required
updated_atstring date-time nullable required

Changes

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