Devices API

Manage your Palpable devices programmatically.

Not a developer? You don't need this page! Manage your devices through the Palpable app instead.

Your API key

List Devices

Retrieve all devices associated with your account.

GET /api/devices

const res = await fetch('https://palpable.technology/api/devices', {
  headers: { 'Authorization': 'Bearer pk_your_api_key' }
})
const data = await res.json()
console.log(data.devices)

Response

{
  "devices": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "Living Room Hub",
      "status": "online",
      "lastSeen": "2024-01-15T10:30:00Z",
      "createdAt": "2024-01-01T00:00:00Z",
      "modules": [
        {
          "id": "mod-123",
          "moduleId": "modulino-thermo",
          "name": "Modulino Thermo",
          "i2cAddress": 64,
          "capabilities": ["temperature", "humidity"]
        }
      ]
    }
  ]
}

Device Status Values

Status	Description
`online`	Device is connected and responding
`offline`	Device is not currently connected
`pairing`	Device is awaiting initial setup

Get Device

GET /api/devices/{deviceId}

const res = await fetch('https://palpable.technology/api/devices/550e8400-...', {
  headers: { 'Authorization': 'Bearer pk_your_api_key' }
})
const device = await res.json()

Returns the full device object including all detected modules with their capabilities.

Update Device

PATCH /api/devices/{deviceId}

const res = await fetch('https://palpable.technology/api/devices/550e8400-...', {
  method: 'PATCH',
  headers: {
    'Authorization': 'Bearer pk_your_api_key',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({ name: 'Main Hub' })
})

Delete Device

DELETE /api/devices/{deviceId}

const res = await fetch('https://palpable.technology/api/devices/550e8400-...', {
  method: 'DELETE',
  headers: { 'Authorization': 'Bearer pk_your_api_key' }
})

Common Module IDs

Modules are auto-detected when the device comes online. The moduleId is used to reference modules in behaviors and commands.

Module ID	Description	Capabilities
`modulino-thermo`	Temperature & Humidity	`temperature`, `humidity`
`modulino-distance`	Time-of-Flight Distance	`distance`
`modulino-knob`	Rotary Encoder	`encoder`, `pressed`
`modulino-buttons`	3 Tactile Buttons	`buttons`
`modulino-buzzer`	Piezo Buzzer	Actuator
`modulino-pixels`	8 RGB LEDs	Actuator
`bme280`	Temp/Humidity/Pressure	`temperature`, `humidity`, `pressure`
`scd41`	CO2 Sensor	`co2`, `temperature`, `humidity`
`sgp40`	Air Quality (VOC)	`voc_index`
`veml7700`	Ambient Light	`lux`
`ssd1306`	OLED Display	Display

For the full catalog, browse the Palpable store in the app. Request new modules here (opens in a new tab).

Project Context API Commands API