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

# Stop Stream

> Pause the RMS (Research Management System) chat stream.



## OpenAPI

````yaml POST /v1/stop_stream
openapi: 3.0.1
info:
  title: LinqAlpha API
  description: >-
    Linq helps finance professionals make informed decisions using
    Retrieval-Augmented Generation (RAG)-enhanced answers. By leveraging
    cutting-edge Large Language Models (LLM) and supplementary technology, Linq
    provides the most optimized responses based on your queries.
  version: 1.0.0
  license:
    name: MIT
servers:
  - url: https://api.linqalpha.com
security:
  - ApiKeyAuth: []
tags:
  - name: Search
    description: Search and generate responses
  - name: Data
    description: Data retrieval and mapping
  - name: Feedback
    description: Conversation feedback
  - name: RMS
    description: Research Management System
  - name: Source Management
    description: Source batch and file management
  - name: MCP
    description: >-
      LinqAlpha MCP — Financial data tools for AI assistants via Model Context
      Protocol
  - name: Connectors
    description: Customer Connectors — customer-owned MCP connector management
  - name: Briefing
    description: Briefing Agent — automated market briefings with scheduling and delivery
  - name: Status
    description: Sync status — check organization, document, and container sync progress
paths:
  /v1/stop_stream:
    post:
      tags:
        - RMS
      summary: Pause RMS Chat Stream
      description: Pause the RMS (Research Management System) chat stream.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RmsInterruptRequest'
            example:
              organization_id: 123e4567-e89b-12d3-a456-426614174000
              conversation_id: 987e6543-e21b-32d3-c654-426614174999
              user_id: 123e4567-e89b-12d3-a456-426614174000
              user_email: john.doe@example.com
              user_name: John Doe
              dialogue_id: 2d382478-077e-4bcb-b6ec-4fdcbc75ab33
      responses:
        '200':
          description: Stop Stream response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RmsInterruptResponse'
              example:
                status: success
                message: Interrupt request received
                dialogue_id: 2d382478-077e-4bcb-b6ec-4fdcbc75ab33
                paused: 1676198400
        '400':
          description: Bad Request - Invalid request parameters or incorrect format.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                error:
                  code: ORGANIZATION_ID_MISSING
                  msg: organization_id is required
                  message: organization_id is required
                payload: null
        '401':
          description: Unauthorized - Invalid authentication credentials.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                error:
                  code: API_KEY_MISSING
                  msg: header does not contain api key
                  message: header does not contain api key
                payload: null
        '403':
          description: Forbidden - No permission to access this resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                error:
                  code: FORBIDDEN
                  message: 'Access denied: insufficient permissions.'
                payload: null
components:
  schemas:
    RmsInterruptRequest:
      type: object
      properties:
        organization_id:
          type: string
          format: uuid
          description: Organization ID
        user_id:
          type: string
          description: User ID
        user_email:
          type: string
          description: User email
        user_name:
          type: string
          description: User name
        conversation_id:
          type: string
          format: uuid
          description: Conversation ID
        dialogue_id:
          type: string
          format: uuid
          description: Dialogue ID
      required:
        - conversation_id
        - dialogue_id
    RmsInterruptResponse:
      type: object
      properties:
        status:
          type: string
          description: Response status
          example: success
        message:
          type: string
          description: Response message
          example: Interrupt request received
        dialogue_id:
          type: string
          description: Dialogue ID
          example: 2d382478-077e-4bcb-b6ec-4fdcbc75ab33
        paused:
          type: integer
          description: Pause timestamp (Unix epoch)
          example: 1676198400
    ApiErrorResponse:
      type: object
      description: Standard error response wrapper
      properties:
        error:
          $ref: '#/components/schemas/ApiError'
        payload:
          description: Always null for error responses
          nullable: true
      required:
        - error
        - payload
    ApiError:
      type: object
      properties:
        code:
          type: string
          description: >-
            Error code indicating the type of error. Common codes:

            - Authentication: `API_KEY_MISSING`, `INVALID_API_KEY`

            - Validation: `INVALID_REQUEST_BODY`, `ORGANIZATION_ID_MISSING`,
            `TICKERS_MISSING`, `CHAT_MESSAGE_ID_MISSING`, `DOCUMENT_ID_MISSING`

            - Service: `SEARCH_FAIL`, `TTS_FAIL`, `CREATE_CONV_FAIL`,
            `GET_STOCK_FAIL`, `CREATE_MSG_FAIL`, `ALPHA_COMP_FAIL`,
            `GET_REF_FAIL`

            - Connectors: `CONNECTOR_LIST_FAIL`, `CONNECTOR_NOT_FOUND`,
            `CONNECTOR_CREATE_FAIL`, `CONNECTOR_UPDATE_FAIL`,
            `CONNECTOR_DELETE_FAIL`, `CONNECTOR_TEST_FAIL`

            - Not Found: `NOT_FOUND`
          example: INVALID_REQUEST_BODY
        msg:
          type: string
          description: Error message (deprecated, use `message` instead)
          example: query is required and must be a string
        message:
          type: string
          description: Error message providing more details about the error
          example: query is required and must be a string
      required:
        - code
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-KEY

````