Create a Device
Create a new device in the workspace and return the identifiers needed to install it. Device-scoped API keys cannot call this endpoint and receive 403. Requires the device:update scope.
Roboflow API key passed as a Bearer token.
Workspace ID (URL slug).
Human-readable name for the device. For AI1 devices that are not duplicating an existing device and do not specify a workflow_id, the slugified name must contain at least one alphanumeric character, otherwise the request returns 400.
Device type. Common values are "ai1" and "edge"; any custom string is also accepted. AI1 creation requires the workspace to have the deviceAio feature enabled.
Optional initial workflow assignment. For AI1 devices it seeds the default aione stream.
Tags to attach to the device. Must be an array of non-empty strings; duplicates are removed and entries are trimmed.
Only valid for AI1 devices, and only if the workspace has the roboflowLiteMode feature.
Duplicate an existing device's config instead of generating a fresh one. The source device must belong to the same workspace.
Device created.
ID of the newly-created device.
Short-lived install token. Feed it into GET /devices/v2/{installId}/install.sh from the device to bootstrap RFDM.
Returned only for AI1 devices created in offline mode. Encodes the QR payload used by the offline RFDM provisioner.
Invalid query parameter or request body.
Missing or invalid API key.
API key is bound to a different device, or this endpoint is not permitted for device-scoped keys, a source device belongs to another workspace, or a feature gate (for example AI1 creation, roboflowLiteMode) blocks the request.
Device, stream, configuration, or source device not found. Read requests for devices owned by another workspace also return 404.
Example Request
Example Response
Notes on AI1 devices
Notes on duplication
Last updated
Was this helpful?