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

# Open a share link

> The shared thread as it was when the link was made, read-only, in the same format as a thread's history.



## OpenAPI

````yaml get /api/chat/shared/{share_id}
openapi: 3.1.0
info:
  title: Nx1 AI API
  description: |

    AI API for Nx1 Data Platform Management and Automated Data Tasks.

    Authentication is required via PSK in Authorization header.

    Default PSK is | [ask a friend] |
  version: 0.10.2
servers: []
security: []
paths:
  /api/chat/shared/{share_id}:
    get:
      tags:
        - Chat
      summary: Open a share link
      description: >-
        The shared thread as it was when the link was made, read-only, in the
        same format as a thread's history.
      operationId: get_shared_api_chat_shared__share_id__get
      parameters:
        - name: share_id
          in: path
          required: true
          schema:
            type: string
            minLength: 8
            maxLength: 64
            pattern: ^[A-Za-z0-9_-]+$
            description: Link token.
            title: Share Id
          description: Link token.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ChatSharedThreadResponse'
        '404':
          description: Revoked or unknown link.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
      security:
        - OAuth2AuthorizationCodeBearer: []
        - APIKeyHeader: []
components:
  schemas:
    ChatSharedThreadResponse:
      properties:
        share:
          $ref: '#/components/schemas/ChatShareResponse'
          description: The link.
        title:
          anyOf:
            - type: string
            - type: 'null'
          title: Title
          description: The thread's title.
        messages:
          items:
            $ref: '#/components/schemas/ChatStoredMessage'
          type: array
          title: Messages
          description: The thread up to when the link was made, in the chat UI's format.
      type: object
      required:
        - share
        - messages
      title: ChatSharedThreadResponse
      description: A shared thread as a viewer sees it.
    ErrorResponse:
      properties:
        error:
          type: string
          title: Error
          description: A brief description of the error that occurred.
        code:
          type: integer
          title: Code
          description: The HTTP status code associated with the error.
          default: 500
      type: object
      required:
        - error
      title: ErrorResponse
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ChatShareResponse:
      properties:
        id:
          type: string
          title: Id
          description: 'The token in the link: `/chat/shared/{id}`.'
        thread_id:
          type: string
          title: Thread Id
          description: The shared thread.
        created_by:
          type: string
          title: Created By
          description: Who made the link.
        created_at:
          type: string
          format: date-time
          title: Created At
          description: When the link was made.
        include_tool_results:
          type: boolean
          title: Include Tool Results
          description: Whether viewers see tool results, or only that tools ran.
      type: object
      required:
        - id
        - thread_id
        - created_by
        - created_at
        - include_tool_results
      title: ChatShareResponse
      description: A read-only link to a thread as it was when the link was made.
    ChatStoredMessage:
      properties:
        id:
          type: string
          title: Id
          description: Message ID.
        parent_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Parent Id
          description: The previous message's ID; null for the first message.
        format:
          type: string
          title: Format
          description: Encoding of `content`, e.g. `ai-sdk/v6`.
        content:
          additionalProperties: true
          type: object
          title: Content
          description: The encoded message.
      type: object
      required:
        - id
        - parent_id
        - format
        - content
      title: ChatStoredMessage
      description: >-
        One message of a thread's history, in the shape the chat UI loads.


        ``content`` is a Vercel AI SDK ``UIMessage`` without its ``id``;
        ``format``

        names that encoding so the UI decodes it with the matching adapter. Its

        ``metadata.author`` names who sent the turn the message belongs to.
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    OAuth2AuthorizationCodeBearer:
      type: oauth2
      flows:
        authorizationCode:
          scopes: {}
          authorizationUrl: >-
            https://sso-rapid.rapid.nx1cloud.com/realms/rapid/protocol/openid-connect/auth
          tokenUrl: >-
            https://sso-rapid.rapid.nx1cloud.com/realms/rapid/protocol/openid-connect/token
    APIKeyHeader:
      type: apiKey
      in: header
      name: Authorization-PSK

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.