Create a Session Token

curl --request POST \
  --url https://api.getmelody.io/api/sessions/v2 \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "device_keys": [
    "alpha-bravo-charlie-delta"
  ]
}
'

import requests

url = "https://api.getmelody.io/api/sessions/v2"

payload = { "device_keys": ["alpha-bravo-charlie-delta"] }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({device_keys: ['alpha-bravo-charlie-delta']})
};

fetch('https://api.getmelody.io/api/sessions/v2', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.getmelody.io/api/sessions/v2",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'device_keys' => [
        'alpha-bravo-charlie-delta'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.getmelody.io/api/sessions/v2"

	payload := strings.NewReader("{\n  \"device_keys\": [\n    \"alpha-bravo-charlie-delta\"\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.getmelody.io/api/sessions/v2")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"device_keys\": [\n    \"alpha-bravo-charlie-delta\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.getmelody.io/api/sessions/v2")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"device_keys\": [\n    \"alpha-bravo-charlie-delta\"\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "token": "eyJhbGciOiJIUzI1NiIs...",
  "expires_in": 900
}

Authentication

Create a Session Token

Exchange your organization Developer Key (Melody Key) for a short-lived session token used to control devices.

Send your Developer Key as Authorization: Bearer <melody_key>. Optionally restrict the token to specific devices by listing their Device Keys; omit device_keys to allow every device linked to your organization.

The returned token is then used on every /device/* request as Authorization: Bearer <session_token> together with the X-Device-Key header.

Flow

Obtain your Organization ID and Developer Key from Melody (see Authentication).
Link a device to your organization via POST /device/otp/confirm/v2 to get its Device Key.
Call this endpoint with your Developer Key to receive a session token.
Control the device via /device/* using the session token and X-Device-Key.

Usage

# 1. Create a session token
curl -X POST https://api.getmelody.io/api/sessions/v2 \\
  -H "Authorization: Bearer <melody_key>" \\
  -H "Content-Type: application/json" \\
  -d '{"device_keys": ["alpha-bravo-charlie-delta"]}'
# -> { "token": "eyJhbGciOi...", "expires_in": 900 }

# 2. Control the device with the session token
curl https://api.getmelody.io/device/status \\
  -H "Authorization: Bearer <session_token>" \\
  -H "X-Device-Key: alpha-bravo-charlie-delta"

POST

api

sessions

Create a Session Token

curl --request POST \
  --url https://api.getmelody.io/api/sessions/v2 \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "device_keys": [
    "alpha-bravo-charlie-delta"
  ]
}
'

import requests

url = "https://api.getmelody.io/api/sessions/v2"

payload = { "device_keys": ["alpha-bravo-charlie-delta"] }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({device_keys: ['alpha-bravo-charlie-delta']})
};

fetch('https://api.getmelody.io/api/sessions/v2', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.getmelody.io/api/sessions/v2",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'device_keys' => [
        'alpha-bravo-charlie-delta'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.getmelody.io/api/sessions/v2"

	payload := strings.NewReader("{\n  \"device_keys\": [\n    \"alpha-bravo-charlie-delta\"\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.getmelody.io/api/sessions/v2")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"device_keys\": [\n    \"alpha-bravo-charlie-delta\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.getmelody.io/api/sessions/v2")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"device_keys\": [\n    \"alpha-bravo-charlie-delta\"\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "token": "eyJhbGciOiJIUzI1NiIs...",
  "expires_in": 900
}

Authorizations

Authorization

string

header

required

Developer Key (Melody Key) tied to your organization. Your Organization ID and Developer Key are issued to you by Melody — contact support@getmelody.io to request them. Used to create session tokens via POST /api/sessions/v2, and to link devices via the X-Org-Key header on POST /device/otp/confirm/v2.

Body

application/json

device_keys

string[]

Device Keys the session token may control. Omit to allow every device linked to your organization.

Pattern: ^[a-z]+-[a-z]+-[a-z]+-[a-z]+$

Response

Session token created

Response from POST /api/sessions/v2. Contains a short-lived session token used with the X-Device-Key header.

token

string

required

JWT session token for device control. Use as Authorization: Bearer <token> with the X-Device-Key header.

Example:

"eyJhbGciOiJIUzI1NiIs..."

expires_in

integer

required

Token lifetime in seconds. Configurable per organization (default 900 = 15 minutes).

Example:

900

Authentication

Retrieve Device ID