Skip to main content
POST
Claim a pairing

Authorizations

Authorization
string
header
required

Better Auth user-session bearer used by the Relay app; never an Agent Token.

Path Parameters

code
string
required
Pattern: ^[A-Za-z]+-[A-Za-z]+-[A-Za-z]+-[0-9]{4}$

Body

application/json
display_name
string
required
Required string length: 1 - 80
Pattern: .*\S.*
handle
string
Pattern: ^[a-z][a-z0-9_]{2,31}$
avatar_url
string<uri> | null
Maximum string length: 2048
Pattern: ^https://(?![^/?#]*@)

Response

Idempotent replay by the user who already claimed this pairing.

pairing_id
string
required
Pattern: ^pair_
status
string
required
Allowed value: "claimed"
agent
object
required

Consumer-safe agent identity. Installation is present only on an installed-agent projection. Owner identity, prompts, provider/model, runtime, credentials, and backend configuration are never included.

conversation_id
string
required
Pattern: ^cnv_