Skip to content
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Speaker

API to manage speaker devices.

List speaker.

get

List all available speaker resources.

Authorizations
hue-application-keystringRequired
Responses
200

Speaker Success Response

application/json
get/clip/v2/resource/speaker
GET /clip/v2/resource/speaker HTTP/1.1
Host: 192.168.1.0
hue-application-key: YOUR_API_KEY
Accept: */*
{
  "errors": [
    {
      "description": "text"
    }
  ],
  "data": [
    {
      "type": "light",
      "id": "3883f8bf-30a3-445b-ac06-b047d50599df",
      "id_v1": "/lights/8",
      "owner": {
        "rid": "42edd1f5-9538-4180-9ced-2d9e07f26d0f",
        "rtype": "device"
      },
      "alerts": [
        "soundloop"
      ]
    }
  ]
}

Get speaker.

get

Get details of a single speaker resource from its given {speakerId}.

Authorizations
hue-application-keystringRequired
Path parameters
speakerIdstringRequired

ID of the speaker

Responses
200

Speaker Success Response

application/json
get/clip/v2/resource/speaker/{speakerId}
GET /clip/v2/resource/speaker/{speakerId} HTTP/1.1
Host: 192.168.1.0
hue-application-key: YOUR_API_KEY
Accept: */*
{
  "errors": [
    {
      "description": "text"
    }
  ],
  "data": [
    {
      "type": "light",
      "id": "3883f8bf-30a3-445b-ac06-b047d50599df",
      "id_v1": "/lights/8",
      "owner": {
        "rid": "42edd1f5-9538-4180-9ced-2d9e07f26d0f",
        "rtype": "device"
      },
      "alerts": [
        "soundloop"
      ]
    }
  ]
}

Update speaker.

put

Update a single speaker resource from its given {speakerId}.

Authorizations
hue-application-keystringRequired
Path parameters
speakerIdstringRequired

ID of the speaker

Body
typestringOptional

Type of the supported resources (always speaker here)

Responses
200

Success

application/json
put/clip/v2/resource/speaker/{speakerId}
PUT /clip/v2/resource/speaker/{speakerId} HTTP/1.1
Host: 192.168.1.0
hue-application-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "type": "text"
}
{
  "errors": [
    {
      "description": "text"
    }
  ],
  "data": [
    {
      "rid": "42edd1f5-9538-4180-9ced-2d9e07f26d0f",
      "rtype": "device"
    }
  ]
}

Last updated

Was this helpful?