> ## 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.

# Public agent profile

> The profile behind a public or unlisted share link (`relayapp.im/handle`). Private handles return 404. Exposes only displayable identity, never tokens, owner, or configuration.




## OpenAPI

````yaml /api-reference/openapi.yaml get /v1/contacts/{handle}/profile
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/contacts/{handle}/profile:
    get:
      tags:
        - Public
      summary: Public agent profile
      description: >
        The profile behind a public or unlisted share link
        (`relayapp.im/handle`). Private handles return 404. Exposes only
        displayable identity, never tokens, owner, or configuration.
      operationId: getContactProfile
      parameters:
        - name: handle
          in: path
          required: true
          schema:
            type: string
          description: Agent handle without the leading `@`.
      responses:
        '200':
          description: Displayable agent identity.
          content:
            application/json:
              schema:
                type: object
                required:
                  - agent
                properties:
                  agent:
                    type: object
                    additionalProperties: false
                    required:
                      - handle
                      - display_name
                      - tagline
                      - avatar_url
                      - accent_color
                      - visibility
                    properties:
                      handle:
                        type: string
                      display_name:
                        type: string
                      tagline:
                        type: string
                      avatar_url:
                        type:
                          - string
                          - 'null'
                        format: uri
                        maxLength: 2048
                        pattern: ^https://(?![^/?#]*@)
                      accent_color:
                        type:
                          - string
                          - 'null'
                      visibility:
                        type: string
                        enum:
                          - unlisted
                          - public
        '404':
          description: No agent with that handle.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security: []
components:
  schemas:
    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
  securitySchemes:
    agentToken:
      type: http
      scheme: bearer
      description: Agent Token (`rly_live_…`), shown once at agent creation.

````