> ## Documentation Index
> Fetch the complete documentation index at: https://docs.relayapp.im/llms.txt
> Use this file to discover all available pages before exploring further.

# Preview a pairing claim

> App-internal authenticated preview used before the user confirms Add. Claimed and pending codes are visible only until their advertised ten-minute expiry; lookup attempts are rate-limited independently from final claims.




## OpenAPI

````yaml /api-reference/openapi.yaml get /v1/pairings/code/{code}
openapi: 3.1.0
info:
  title: Relay developer API
  version: '0.1'
  description: >
    Add Relay as a channel for your agent, receive messages, and reply with
    plain HTTPS and JSON. Authenticate every request with an Agent Token unless
    the endpoint is marked public. The postback_interactions sync feature
    controls whether clients render message components interactively; component
    data parts can always be sent.
  x-relay-feature-availability:
    postback_interactions: off-by-default-preview
  license:
    name: Proprietary
    identifier: LicenseRef-Proprietary
servers:
  - url: https://api.relayapp.im
    description: Production
security:
  - agentToken: []
tags:
  - name: Agent
    description: Inspect the agent controlled by the current Agent Token.
  - name: Messages
    description: Send finalized messages, pipe native agent output, and react.
  - name: Groups
    description: Propose consent-based groups and observe their terminal state.
  - name: Events
    description: >
      Receive durable inbound events, either through signed webhook receivers or
      by long-polling `GET /v1/events`. The two modes are mutually exclusive per
      agent, enforced per request; around a webhook registration or disable
      there is a brief transition window in which both paths can observe the
      same events. Delivery is at least once everywhere — always deduplicate by
      `event_id`.
  - name: Pairing
    description: >
      Device-code pairing for terminal bridges: create a pairing code on a
      computer, let the Relay app claim it, and recover the minted Agent Token
      only with that computer's poll credential. The token never travels to the
      phone.
  - name: Public
    description: Read approved Store agents and share profiles without authentication.
paths:
  /v1/pairings/code/{code}:
    get:
      tags:
        - Pairing
      summary: Preview a pairing claim
      description: >
        App-internal authenticated preview used before the user confirms Add.
        Claimed and pending codes are visible only until their advertised
        ten-minute expiry; lookup attempts are rate-limited independently from
        final claims.
      operationId: previewPairing
      parameters:
        - name: code
          in: path
          required: true
          schema:
            type: string
            pattern: ^[A-Za-z]+-[A-Za-z]+-[A-Za-z]+-[0-9]{4}$
      responses:
        '200':
          description: Pairing metadata for the claim sheet.
          content:
            application/json:
              schema:
                type: object
                additionalProperties: false
                required:
                  - pairing
                properties:
                  pairing:
                    $ref: '#/components/schemas/PairingPreview'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          description: Unknown or expired pairing code.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: Too many pairing previews for this user or address.
          headers:
            Retry-After:
              description: Whole seconds before another preview attempt.
              schema:
                type: integer
                minimum: 1
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - userSession: []
components:
  schemas:
    PairingPreview:
      type: object
      additionalProperties: false
      required:
        - pairing_id
        - code
        - status
        - device_name
        - engine
        - expires_at
      properties:
        pairing_id:
          type: string
          pattern: ^pair_
        code:
          type: string
          pattern: ^[A-Z]+-[A-Z]+-[A-Z]+-[0-9]{4}$
        status:
          type: string
          enum:
            - pending
            - claimed
        device_name:
          type:
            - string
            - 'null'
          minLength: 1
          maxLength: 80
        engine:
          type:
            - string
            - 'null'
          pattern: ^[a-z0-9][a-z0-9._-]{0,39}$
        expires_at:
          type: string
          format: date-time
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
          properties:
            code:
              type: string
              example: invalid_request
            message:
              type: string
              example: conversation_id is required
  responses:
    Unauthorized:
      description: Token is absent or invalid.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    agentToken:
      type: http
      scheme: bearer
      description: Agent Token (`rly_live_…`), shown once at agent creation.
    userSession:
      type: http
      scheme: bearer
      description: >-
        Better Auth user-session bearer used by the Relay app; never an Agent
        Token.

````