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

# get share link

> Returns a share link by ID



## OpenAPI

````yaml https://api.anam.ai/swagger.json get /v1/share-links/{id}
openapi: 3.1.0
info:
  title: Anam AI API
  version: '1.0'
servers:
  - url: https://api.anam.ai
    description: Anam API
security:
  - BearerAuth: []
tags:
  - name: Sessions
  - name: Personas
  - name: Avatars
  - name: Voices
  - name: LLMs
  - name: Knowledge
  - name: Tools
  - name: Share Links
paths:
  /v1/share-links/{id}:
    get:
      tags:
        - Share Links
      summary: get share link
      description: Returns a share link by ID
      operationId: getShareLink
      parameters:
        - in: path
          name: id
          schema:
            type: string
            format: uuid
          required: true
          description: Share link ID
      responses:
        '200':
          description: Successfully retrieved share link
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PersonaShareLink'
              examples:
                default:
                  $ref: '#/components/examples/PersonaShareLinkResponse'
        '400':
          description: Bad request - Invalid share link ID
        '401':
          description: Unauthorized - Invalid or missing API key
        '404':
          description: Not Found - Share link not found
        '500':
          description: Server error
components:
  schemas:
    PersonaShareLink:
      type: object
      description: >-
        A share link as returned by list and get endpoints — includes persona
        details for the link's target.
      allOf:
        - $ref: '#/components/schemas/ShareLink'
        - type: object
          properties:
            personaId:
              type: string
              format: uuid
              description: ID of the persona this link points to.
            personaName:
              type: string
              description: Name of the persona at the time the link was issued.
            organizationId:
              type: string
              description: >-
                ID of the organization that owns the link. IDs may be either
                UUIDs or nanoid-style strings depending on when the organization
                was created.
    ShareLink:
      type: object
      description: >-
        A shareable link to a persona. Can be used as a direct URL or embedded
        via the widget.
      properties:
        id:
          type: string
          format: uuid
          description: Unique identifier for the share link.
        token:
          type: string
          description: Opaque token appended to the public URL.
        type:
          type: string
          enum:
            - LINK
            - PLAYER_EMBED
            - ORB_EMBED
          description: Kind of share link — a direct URL, a player embed, or an orb embed.
        expiresAt:
          type:
            - string
            - 'null'
          format: date-time
          description: >-
            Timestamp after which the link no longer works, or `null` if the
            link does not expire.
        usageLimit:
          type:
            - integer
            - 'null'
          description: >-
            Maximum number of times the link can be used, or `null` for
            unlimited.
        usageCount:
          type: integer
          description: Number of times the link has been used.
        allowedOrigins:
          type: array
          items:
            type: string
          description: >-
            Origins permitted to load the link when embedded. Ignored when
            `allowAllOrigins` is true.
        allowAllOrigins:
          type: boolean
          description: Whether the link can be embedded on any origin.
        removeWatermark:
          type: boolean
          description: >-
            Whether the persona renders without the Anam watermark. Requires a
            plan that permits watermark removal.
        enabled:
          type: boolean
          description: Whether the link currently accepts connections.
        isPrimary:
          type: boolean
          description: >-
            Whether this is the persona's primary share link (at most one per
            persona).
        createdAt:
          type: string
          format: date-time
          description: Timestamp when the share link was created.
  examples:
    PersonaShareLinkResponse:
      summary: A single share link with its persona details (as returned by get)
      value:
        id: 00000000-0000-0000-0000-000000000000
        token: sh_2kL9pQxYzR4vN8mBwHfJc
        type: LINK
        expiresAt: '2026-04-27T10:00:00.000Z'
        usageLimit: 10
        usageCount: 3
        allowedOrigins: []
        allowAllOrigins: false
        removeWatermark: false
        enabled: true
        isPrimary: false
        createdAt: '2026-04-20T10:00:00.000Z'
        personaId: 00000000-0000-0000-0000-000000000000
        personaName: Cara
        organizationId: 00000000-0000-0000-0000-000000000000
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer

````