> ## 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 virtual device

> Creates an empty virtual device in a building. A virtual device groups points that come from other devices.

Only `name` is required. The server generates the `id`, sets the device as virtual, and starts it with no points. A body `_id`, `building`, `originType` or `pointIds` is ignored. Sending the same `name` again creates a second device.

The response has these members: `id`, `name`, `type` (`id` and `name`), `locatedIn` (`id` and `name`), `area` (`id` and `name`), `location`, `pointsCount`, `createdAt` and `updatedAt`. `type`, `locatedIn`, `area` and `location` are empty when you did not send them. `area` is the level of the space in `locatedInSpaceId`.

* `name` is trimmed and can be up to 255 characters.
* `typeId` is the device type. Take it from `type._id` of an existing device. Up to 128 characters.
* `locatedInSpaceId` is the `id` of a space in this building. Up to 128 characters.

Add points to the device with [Copy points to devices](https://docs.kodelabs.com/products/kode-api/api-reference/points/copy-points-to-devices.md) or [Attach points to a virtual device](https://docs.kodelabs.com/products/kode-api/api-reference/virtual-devices/attach-points-to-a-virtual-device.md).


## OpenAPI

````yaml /openapi/kode-api.yaml post /api/v1/buildings/{buildingId}/virtual-devices
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/{buildingId}/virtual-devices:
    post:
      tags:
        - Virtual devices
      summary: Create a virtual device
      description: >-
        Creates an empty virtual device in a building. A virtual device groups
        points that come from other devices.
      operationId: createVirtualDevice
      parameters:
        - $ref: '#/components/parameters/BuildingId'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateVirtualDeviceRequest'
        required: true
      responses:
        '201':
          description: The created virtual device.
          content: {}
        '400':
          description: >-
            The body is not valid. For example `name` is missing, blank, longer
            than 255 characters or has control characters, a value has the wrong
            type, or the JSON cannot be read.
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          description: >-
            The `typeId` or the `locatedInSpaceId` does not exist, or the space
            belongs to another building.
        '429':
          $ref: '#/components/responses/TooManyRequests'
components:
  parameters:
    BuildingId:
      name: buildingId
      in: path
      required: true
      description: Building identifier from List buildings.
      schema:
        type: string
      example: 67c960faffaa42223163099e
  schemas:
    CreateVirtualDeviceRequest:
      type: object
      required:
        - name
      properties:
        name:
          type: string
          maxLength: 255
          minLength: 1
          pattern: (?s)(?=.*[^\p{C}\p{Z}])[\P{Cc}\n\r\t]*
        typeId:
          type: string
          pattern: '[^\p{C}\p{Z}]{1,128}'
          maxLength: 128
        locatedInSpaceId:
          type: string
          pattern: '[^\p{C}\p{Z}]{1,128}'
          maxLength: 128
        location:
          type: string
          maxLength: 255
          pattern: (?s)(?=.*[^\p{C}\p{Z}])[\P{Cc}\n\r\t]*
  responses:
    Unauthorized:
      description: The access token is missing, invalid, or expired. Request a new token.
    Forbidden:
      description: The service account lacks permission for this building or operation.
    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.