Reference

pairings

Browser access to a local runtime through origin-bound pairing. Index · shared schemas · errors.

pairings.create

Mint a single-use code for one browser origin. troupe studio uses its own origin and puts the code in the URL fragment, the one allowed URL credential.

Input:

{
  origin: string  // ≤ 2048 chars; /^https?:\/\/(\[[0-9A-Fa-f:.]+\]|[A-Za-z0-9.-]+)(:\d{1,5})?$/
  scopes?: RuntimeScope[]  // 1–10 items
  codeTtlMs?: integer  // default 60000; 1000–300000
  tokenTtlMs?: integer  // default 43200000; 60000–604800000
}

Output:

{ pairingId: PairingId; code: string; expiresAt: string }

Errors: U.

Named types: PairingId, RuntimeScope.

pairings.redeem

Exchange a code for an origin-bound token. The request's Origin MUST equal the pairing's origin. At most 5 failures a minute, after which every open code is voided.

Input:

{
  code: string  // 1–128 chars
}

Output:

{ token: string; pairingId: PairingId; scopes: RuntimeScopeOut[]; expiresAt: string }

Errors: U, NOT_FOUND.

Named types: PairingId, RuntimeScopeOut.

pairings.list

List active pairings

Input:

{}

Output:

{ pairings: Pairing[] }

Errors: U.

Named types: Pairing.

pairings.revoke

Revoke a pairing and close its stream sockets with 4403

Input:

{ pairingId: PairingId }

Output:

{ revoked: boolean }

Errors: U, NOT_FOUND.

Named types: PairingId.