> ## Documentation Index > Fetch the complete documentation index at: https://docs.kodelabs.com/llms.txt > Use this file to discover all available pages before exploring further. # Create a building > Creates a building in your organization. The building starts unpublished, with no products enabled. > [!WARNING] > > This call creates a real building in your organization. The API has no endpoint to delete a building, and the name stays taken until someone removes the building in KODE OS. Test with a clearly named building, such as `API test building`, and ask your KODE project team to remove it when you are done. > [!NOTE] > > A new building has every product turned off. Until the `api` product is enabled for it, calls that name the building return `403`, including [Get a building](https://docs.kodelabs.com/products/kode-api/api-reference/buildings/get-a-building.md), [Create a KODE API connector](https://docs.kodelabs.com/products/kode-api/api-reference/connectors/create-a-kode-api-connector.md), and [Update a building](https://docs.kodelabs.com/products/kode-api/api-reference/buildings/update-a-building.md). The API cannot enable products. Your KODE project team enables the `api` product for a new building by hand, so ask them before you call the building, and allow for that step if you automate building creation. ## Required fields | Field | Rule | | - | - | | `name` | Up to 50 characters. Must be unique in your organization, ignoring case. | | `primaryFunction` | One of `Banking/financial services`, `Education`, `Entertainment/public assembly`, `Food sales and service`, `Healthcare`, `Lodging/residential`, `Manufacturing/industrial`, `Mixed use`, `Office`, `Parking`, `Public services`, `Religious worship`, `Retail`, `Technology/science`, `Services`, `Utility`, `Warehouse/storage`, or `Other`. The value is case-sensitive. | | `address` | An object with `address1`, `city`, `zip`, and `country`. `address2` (up to 100 characters) and `state` are optional. | | `baseTemp` | The base temperature as a number, in °F. | ## Optional fields | Field | Rule | | - | - | | `yearBuild` | A whole number from `1600` to `2100`. | | `area` | The building area in square feet. A whole number, `0` or more. | | `region`, `brand`, `zone`, `district`, `identifier` | Up to 255 characters each. `identifier` is your own building code. It does not have to be unique. | | `phoneNumber` | A phone number, for example `+16502530000`. | | `site` | An object with both `identifier` and `name` (up to 255 characters each). | ## What the API sets for you * The API looks up the `address` to find the building location. The response carries the location, the state and country codes, and the time zone `tz`. If the address cannot be located, the request fails with `400`. Check `address1`, `city`, `zip`, and `country`. * `published` is `false`. Use [Set the status of a building](https://docs.kodelabs.com/products/kode-api/api-reference/buildings/set-the-status-of-a-building.md) to change it. * `products` lists the products with `enabled` set to `false`, and the counts and `stats` start at `0`. Send `baseTemp` in °F whatever unit you use in KODE OS. ## OpenAPI ````yaml /openapi/kode-api.yaml post /api/v1/buildings openapi: 3.1.0 info: title: KODE API version: 1.0.0 summary: Programmatic access to KODE OS resources and operations. description: > Use the KODE API to work with buildings, data sources, connectors, devices, points, virtual devices, timeseries data, schedules, the ontology, templating, mass writes, spaces, space assignments, tenants, meters, users, actions, and AssetOps work orders. license: name: Proprietary identifier: LicenseRef-Proprietary servers: - url: https://api.kodelabs.com/kodeos description: KODE API security: - bearerAuth: [] tags: - name: Authentication description: OAuth 2.0 discovery, token, and revocation endpoints. - name: Buildings description: Buildings and their areas. - name: Data sources description: Data sources connected to a building. - name: Devices description: Devices and their points. - name: Points description: Point queries and point writes. - name: Timeseries description: Current and historical point values. - name: Actions description: Actions exposed by building data sources. - name: Work orders description: AssetOps work orders, lookups, comments, and attachments. - name: Connectors description: KODE API connectors and the devices and points ingested through them. - name: Schedules description: Schedules discovered on building data sources. - name: Templating description: Apply ontology templates to groups of points. - name: Virtual devices description: Virtual devices that group points from other devices. - name: Ontology description: Canonical types, fields, units, and connections of the KODE ontology. - name: Users description: Users of the organization and their app access. - name: Mass write description: Write values to many points across buildings, and follow each run. - name: Spaces description: Levels and space units of a building, and the meters located in them. - name: Space assignments description: Assign tenants to leasable spaces of a building for a period. - name: Tenants description: Tenants of a building, the people or companies that lease its spaces. - name: Meters description: >- Meters of a building, their space assignments, parent and child links, and readings. paths: /api/v1/buildings: post: tags: - Buildings summary: Create a building description: >- Creates a building in your organization. The building starts unpublished, with no products enabled. operationId: createBuilding requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateBuildingRequest' required: true responses: '200': description: The created building. content: application/json: schema: $ref: '#/components/schemas/BuildingPublic' '400': description: >- A required field is missing, a value is outside its limits, the `primaryFunction` is not on the list, the phone number is invalid, or the address cannot be located. When a field is at fault, `error.fields` names it. '401': $ref: '#/components/responses/Unauthorized' '403': description: >- Your service account cannot create buildings. Its role needs the **Create building** action. '409': description: >- A building with this name already exists in your organization. The comparison ignores case. '429': $ref: '#/components/responses/TooManyRequests' components: schemas: CreateBuildingRequest: type: object required: - name - primaryFunction - address - baseTemp properties: name: type: string pattern: \S maxLength: 50 primaryFunction: type: string pattern: \S address: $ref: '#/components/schemas/AddressRequest' baseTemp: type: number format: double yearBuild: type: integer format: int32 maximum: 2100 minimum: 1600 area: type: integer format: int32 minimum: 0 region: type: string maxLength: 255 brand: type: string maxLength: 255 zone: type: string maxLength: 255 district: type: string maxLength: 255 identifier: type: string maxLength: 255 phoneNumber: type: string site: $ref: '#/components/schemas/SiteRequest' BuildingPublic: type: object properties: _id: type: string organizationId: type: string createdAt: $ref: '#/components/schemas/Date' type: string readOnly: true updatedAt: $ref: '#/components/schemas/Date' type: string readOnly: true name: type: string identifier: type: string area: $ref: '#/components/schemas/Area1' yearBuild: type: integer format: int32 primaryFunction: type: string tags: type: array items: type: string address: $ref: '#/components/schemas/Address1' picture: type: string tz: type: string areasCount: type: integer format: int32 devicesCount: type: integer format: int32 connectorsCount: type: integer format: int32 systemsCount: type: integer format: int32 pointsCount: type: integer format: int32 stats: $ref: '#/components/schemas/BuildingStats1' baseTemp: type: number format: double published: type: boolean ossEnabled: type: boolean climateZone: $ref: '#/components/schemas/ClimateZone1' region: type: string brand: type: string zone: type: string district: type: string phoneNumber: type: string site: $ref: '#/components/schemas/Site1' products: type: array items: $ref: '#/components/schemas/Product' AddressRequest: type: object required: - address1 - city - zip - country properties: address1: type: string pattern: \S address2: type: string maxLength: 100 city: type: string pattern: \S state: type: string zip: type: string pattern: \S country: type: string pattern: \S SiteRequest: type: object required: - identifier - name properties: identifier: type: string pattern: \S maxLength: 255 name: type: string pattern: \S maxLength: 255 Date: type: string description: >- Date and time in UTC, with a numeric offset and no colon, for example `2026-10-28T13:51:31+0000`. examples: - 2026-10-28T13:51:31+0000 Area1: type: object properties: _id: type: string value: type: number format: double unit: type: string Address1: type: object properties: address1: type: string address2: type: string country: type: string countryAbbr: type: string state: type: string stateAbbr: type: string city: type: string zip: type: string location: $ref: '#/components/schemas/Location1' BuildingStats1: type: object properties: buildingId: type: string devices: $ref: '#/components/schemas/Devices1' ClimateZone1: type: object properties: iecc: type: string ba: type: string Site1: type: object properties: identifier: type: string name: type: string Product: type: object properties: id: type: string enabled: type: boolean Location1: type: object properties: lat: type: number format: double lng: type: number format: double Devices1: type: object properties: ok: type: integer format: int32 down: type: integer format: int32 responses: Unauthorized: description: The access token is missing, invalid, or expired. Request a new token. TooManyRequests: description: >- A rate-limit window is exhausted. Wait, then retry with increasing delays. securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: JWT description: > Paste an access token from [Create an access token](/products/kode-api/api-reference/authentication/create-an-access-token). Tokens expire, so request a new one if you receive `401`. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.