ai.newnal.illi.device.requestOnboardingCode Documentation (EN)

main procedure

Register the device (device id, model) under parent 1's device-app session and issue a one-time onboarding code shown on the device.

Input

Encodingapplication/json

attestation string Optional

No description available.

deviceId string Required

No description available.

maxLength: 64 bytes

firmwareVersion string Optional

No description available.

maxLength: 32 bytes

model string Required

No description available.

maxLength: 64 bytes

Output

Encodingapplication/json

code string Required

No description available.

deviceId string Required

No description available.

expiresAt stringdatetime Required

An RFC 3339 formatted timestamp.

Errors

DeviceAlreadyLinked

InvalidAttestation

DeviceRevoked

RateLimitExceeded

Try It

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

Service Endpoint Base URL for XRPC calls (e.g., https://bsky.social)

Request Body (JSON) Enter valid JSON for the request body

View raw schema

{
  "description": "Register the device (device id, model) under parent 1's device-app session and issue a one-time onboarding code shown on the device.",
  "errors": [
    {
      "name": "DeviceAlreadyLinked"
    },
    {
      "name": "InvalidAttestation"
    },
    {
      "name": "DeviceRevoked"
    },
    {
      "name": "RateLimitExceeded"
    }
  ],
  "input": {
    "encoding": "application/json",
    "schema": {
      "properties": {
        "attestation": {
          "type": "string"
        },
        "deviceId": {
          "maxLength": 64,
          "type": "string"
        },
        "firmwareVersion": {
          "maxLength": 32,
          "type": "string"
        },
        "model": {
          "maxLength": 64,
          "type": "string"
        }
      },
      "required": [
        "deviceId",
        "model"
      ],
      "type": "object"
    }
  },
  "output": {
    "encoding": "application/json",
    "schema": {
      "properties": {
        "code": {
          "type": "string"
        },
        "deviceId": {
          "type": "string"
        },
        "expiresAt": {
          "format": "datetime",
          "type": "string"
        }
      },
      "required": [
        "deviceId",
        "code",
        "expiresAt"
      ],
      "type": "object"
    }
  },
  "type": "procedure"
}