Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.getmelody.io/llms.txt

Use this file to discover all available pages before exploring further.

​
Quickstart Guide

Bring your project to life with real sensation using the Melody API.
This guide gets you authenticated, connected, and sending your first haptics command — fast.

​
1. Get authenticated

All API traffic is routed through a single live endpoint: 
https://api.getmelody.io

​
Required headers

Content-Type: application/json
Authorization: Bearer <YOUR_JWT_TOKEN>
If the Authorization token is missing or invalid, the API will return 401 Unauthorized.

​
2. Connect your device

Compatible devices can communicate using Bluetooth Low Energy (BLE) or WiFi hubs/bridges.
Both flows use the same universal command schema — so you implement once, and it works everywhere.
TransportDescription
BLE (Bluetooth Low Energy)Nearby pairing and ultra‑fast motion command delivery
WiFi Hub / WiFi BridgeNetwork‑paired device control via WiFi hubs or bridge routing

​
3. Send your first haptics command

Use POST /device/hdc/command (or equivalent command path in your API reference) to send low‑latency motion primitives.

​
Example request

curl --request POST \
  --url https://api.getmelody.io/device/hdc/command \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "pos": 50,
  "time": 1
}'

​
4. Start your first scripted sensation session (Melody)

Melody is both:
  • a physical interactive haptic device hub we built ourselves, and
  • our timeline-first scripting engine for syncing sensation to video and VR playback
With Melody, you can upload or assign a script, then start/pause/seek/stop timeline playback via API.

​
Authoring option modes supported

  • Direct target position + time
  • Sequential haptic point streams (HPS) for smoothing
  • Server‑orchestrated timeline script playback
  • Loop range mode for automatic repeating motion

​
6. Next steps

You’re now ready to start building with Melody:

Melody Overview & Setup

Learn how to pair the Melody Device Hub, upload scripts, and synchronize video timelines to motion.

BLE API Integration

Implement low-latency nearby control for Bluetooth-enabled interactive devices.

WiFi Device Integration

Send motion commands and timeline sessions to devices connected through WiFi hubs or bridges.

SDK & API Reference

Deep‑dive into all endpoints, schemas, and parameter descriptions across reference tabs.
💡 Tip: All transports and devices use the same JSON command contract — “write once, feel anywhere.”
You’re now connected and ready to integrate real sensation into your video or VR immersion stack.
Next, explore the API Reference for endpoint and field details.