Create a pairing
Start device-code pairing from a terminal. No authentication; the source IP is rate-limited. Show the returned code (and a QR of url) to the user, then long-poll the pairing with poll_token until the Relay app claims it. Codes are single-use and expire after expires_in seconds. If a JSON body is present it must be an object containing only the documented fields.
Body
Response
Pairing created; poll it until claimed.
^pair_"pair_01jz9x2m8ktqv4"
Human-typable single-use code the user enters in the Relay app.
^[A-Z]+-[A-Z]+-[A-Z]+-[0-9]{4}$"AMBER-KITE-ROYAL-0472"
Universal link that opens the claim sheet directly.
"https://relayapp.im/pair/AMBER-KITE-ROYAL-0472"
Bearer credential for GET /v1/pairings/{pairing_id} only. It never authorizes the platform API.
^rlyp_Seconds until the code stops being claimable.
600