Skip to main content
POST
Create a pairing

Body

application/json
device_name
string

Shown on the phone's claim sheet, e.g. the computer's hostname.

Required string length: 1 - 80
Pattern: .*\S.*
Example:

"Advait's MacBook Pro"

engine
string

Bridge engine identifier shown on the claim sheet.

Pattern: ^[a-z0-9][a-z0-9._-]{0,39}$
Example:

"claude"

Response

Pairing created; poll it until claimed.

pairing_id
string
required
Pattern: ^pair_
Example:

"pair_01jz9x2m8ktqv4"

code
string
required

Human-typable single-use code the user enters in the Relay app.

Pattern: ^[A-Z]+-[A-Z]+-[A-Z]+-[0-9]{4}$
Example:

"AMBER-KITE-ROYAL-0472"

url
string<uri>
required

Universal link that opens the claim sheet directly.

Example:

"https://relayapp.im/pair/AMBER-KITE-ROYAL-0472"

poll_token
string
required

Bearer credential for GET /v1/pairings/{pairing_id} only. It never authorizes the platform API.

Pattern: ^rlyp_
expires_in
integer
required

Seconds until the code stops being claimable.

Example:

600