---
title: "Create device"
method: POST
path: "/api/{projectId}/devices/create"
tags: ["Devices"]
---

# Create device

`POST /api/{projectId}/devices/create`

## Request

- Base URL: `https://studio.edgeimpulse.com/v1`
- URL: `https://studio.edgeimpulse.com/v1/api/{projectId}/devices/create`
- Auth: one of:
  - API key in header `x-api-key`
  - API key in cookie `jwt`
  - API key in header `x-jwt-token`
  - OAuth 2
    - Authorization code: `/v1/oauth/authorize`
    - Client credentials
    - Implicit: `/v1/oauth/authorize`
    - Password
    - Token URL: `/v1/oauth/token`
- TypeScript: <https://skmtc.dev/edgeimpulse/apis/edge-impulse-api/docs/api/:projectId/devices/create/post.ts> (a function with typed inputs; its response is checked against the schema)

Create a new device. If you set `ifNotExists` to `false` and the device already exists, the `deviceType` will be overwritten.

## Path parameters

- `projectId` integer, required

## Request body

- CreateDeviceRequest
  - `deviceId` string, required: Globally unique device identifier (e.g. MAC address)
  - `deviceType` string, required: Device type, for example the exact model of the device. Should be the same for all similar devices
  - `ifNotExists` boolean, required: Whether to throw an error when this device already exists.

## Response `200`

OK

- GenericApiResponse
  - `success` boolean, required: Whether the operation succeeded
  - `error` string: Optional error description (set if 'success' was false)

---

[API](https://skmtc.dev/edgeimpulse/apis/edge-impulse-api.md) - [All operations](https://skmtc.dev/edgeimpulse/apis/edge-impulse-api/llms.txt) - [OpenAPI document](https://skmtc.dev/edgeimpulse/apis/edge-impulse-api/revisions/e2a976d38427?raw)