For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.

Home Guides API Reference

Home Guides API Reference

API Reference

API Reference pairing.v1 PairingService

Pair

||View as Markdown|

Example request

1 {
2   "credentials": {
3     "_password": {
4       "password": "example"
5     },
6     "username": "example"
7   },
8   "device_selector": {
9     "selection_type": {
10       "all_devices": {
11         "device_status": [
12           0
13         ],
14         "pairing_status": [
15           0
16         ],
17         "models": [
18           "example"
19         ],
20         "manufacturers": [
21           "example"
22         ]
23       }
24     }
25   }
26 }

Example response

1 {
2   "failed_device_ids": [
3     "example"
4   ]
5 }

Initiates pairing with one or more discovered devices

PairRequest

Request

This endpoint expects an object.

credentialsobject

Credentials for device authentication

device_selectorobject

Device selector specifies which devices to pair

PairResponse

Response

This endpoint returns an object.

failed_device_idslist of strings