ai.newnal.illi.device.getState

illi-service.newnal.id

Documentation

Everything the device needs to render: status, onboarding code while waiting, home, parents, members, pending requests and the acknowledged event cursor.

main query

Everything the device needs to render: status, onboarding code while waiting, home, parents, members, pending requests and the acknowledged event cursor.

Parameters

deviceId string Required

No description available.

Output

Encodingapplication/json
deviceId string Required

No description available.

home ref#homeRef Optional

No description available.

lastEventId integer Optional

No description available.

members array Optional

No description available.

parent1 ref#parent1 Optional

No description available.

parents array Optional

No description available.

pendingRequests array Optional

No description available.

status string Required

No description available.

Known values: registered, awaitingLink, active, unlinked, retired

Errors

DeviceNotFound
Try It

Requests are sent directly from your browser. Some servers may block requests due to CORS.

Base URL for XRPC calls (e.g., https://api.bsky.social)
Parameters
View raw schema
{
  "description": "Everything the device needs to render: status, onboarding code while waiting, home, parents, members, pending requests and the acknowledged event cursor.",
  "errors": [
    {
      "name": "DeviceNotFound"
    }
  ],
  "output": {
    "encoding": "application/json",
    "schema": {
      "properties": {
        "deviceId": {
          "type": "string"
        },
        "home": {
          "ref": "#homeRef",
          "type": "ref"
        },
        "lastEventId": {
          "type": "integer"
        },
        "members": {
          "items": {
            "ref": "ai.newnal.illi.home.defs#memberView",
            "type": "ref"
          },
          "type": "array"
        },
        "onboardingCode": {
          "ref": "#onboardingCode",
          "type": "ref"
        },
        "parent1": {
          "ref": "#parent1",
          "type": "ref"
        },
        "parents": {
          "items": {
            "ref": "ai.newnal.illi.home.defs#parentView",
            "type": "ref"
          },
          "type": "array"
        },
        "pendingRequests": {
          "items": {
            "ref": "#pendingRequest",
            "type": "ref"
          },
          "type": "array"
        },
        "status": {
          "knownValues": [
            "registered",
            "awaitingLink",
            "active",
            "unlinked",
            "retired"
          ],
          "type": "string"
        }
      },
      "required": [
        "deviceId",
        "status"
      ],
      "type": "object"
    }
  },
  "parameters": {
    "properties": {
      "deviceId": {
        "maxLength": 64,
        "type": "string"
      }
    },
    "required": [
      "deviceId"
    ],
    "type": "params"
  },
  "type": "query"
}
homeRef object

No description available.

Properties

homeId string tid Required

A timestamp-based identifier (TID).

name string Required

No description available.

View raw schema
{
  "properties": {
    "homeId": {
      "format": "tid",
      "type": "string"
    },
    "name": {
      "type": "string"
    }
  },
  "required": [
    "homeId",
    "name"
  ],
  "type": "object"
}
onboardingCode object

No description available.

Properties

code string Required

No description available.

expiresAt string datetime Required

An RFC 3339 formatted timestamp.

View raw schema
{
  "properties": {
    "code": {
      "type": "string"
    },
    "expiresAt": {
      "format": "datetime",
      "type": "string"
    }
  },
  "required": [
    "code",
    "expiresAt"
  ],
  "type": "object"
}
parent1 object

No description available.

Properties

did string did Required

A decentralized identifier (DID).

handle string handle Optional

An AT Protocol handle (e.g., alice.bsky.social).

View raw schema
{
  "properties": {
    "did": {
      "format": "did",
      "type": "string"
    },
    "handle": {
      "format": "handle",
      "type": "string"
    }
  },
  "required": [
    "did"
  ],
  "type": "object"
}
pendingRequest object

No description available.

Properties

expiresAt string datetime Required

An RFC 3339 formatted timestamp.

requestId string Required

No description available.

slot integer Optional

No description available.

type string Required

No description available.

Known values: parentCreation
View raw schema
{
  "properties": {
    "expiresAt": {
      "format": "datetime",
      "type": "string"
    },
    "requestId": {
      "type": "string"
    },
    "slot": {
      "type": "integer"
    },
    "type": {
      "knownValues": [
        "parentCreation"
      ],
      "type": "string"
    }
  },
  "required": [
    "requestId",
    "type",
    "expiresAt"
  ],
  "type": "object"
}

Lexicon Garden

@