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

# Source

> Retrieves the current processing status of an uploaded source. Use this endpoint to poll source readiness before including it in chat or search requests.

**Status Values:**
- `processing`: Source is being parsed and indexed (typically takes 10-60 seconds depending on file size)
- `success`: Source is ready for use in conversations
- `failed`: Processing failed (check file format, size, or content validity)

**Best Practice:** Poll this endpoint with exponential backoff until status is `success` before initiating chat/search requests.



## OpenAPI

````yaml GET /v1/sources/{source_id}
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/sources/{source_id}:
    get:
      tags:
        - Source Management
      summary: Get Source Status
      description: >-
        Retrieves the current processing status of an uploaded source. Use this
        endpoint to poll source readiness before including it in chat or search
        requests.


        **Status Values:**

        - `processing`: Source is being parsed and indexed (typically takes
        10-60 seconds depending on file size)

        - `success`: Source is ready for use in conversations

        - `failed`: Processing failed (check file format, size, or content
        validity)


        **Best Practice:** Poll this endpoint with exponential backoff until
        status is `success` before initiating chat/search requests.
      parameters:
        - name: source_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
          description: >-
            The unique identifier (UUID) of the source returned from POST
            /v1/sources
          example: 456e7890-e89b-12d3-a456-426614174001
      responses:
        '200':
          description: Source status retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetSourceResponse'
              examples:
                processing:
                  summary: Source is being processed
                  value:
                    source_id: 456e7890-e89b-12d3-a456-426614174001
                    status: processing
                success:
                  summary: Source is ready
                  value:
                    source_id: 456e7890-e89b-12d3-a456-426614174001
                    status: success
                failed:
                  summary: Processing failed
                  value:
                    source_id: 456e7890-e89b-12d3-a456-426614174001
                    status: failed
                    error: Unsupported file format or corrupted file
        '401':
          description: Unauthorized - invalid or missing API key
        '404':
          description: Source not found
components:
  schemas:
    GetSourceResponse:
      type: object
      properties:
        source_id:
          type: string
          format: uuid
          description: Source identifier
          example: 456e7890-e89b-12d3-a456-426614174001
        status:
          type: string
          description: |-
            Current processing status:
            - `processing`: File is being parsed and indexed
            - `success`: Source is ready for use in conversations
            - `failed`: Processing failed, source cannot be used
          enum:
            - processing
            - success
            - failed
          example: success
        error:
          type: string
          description: Error message if status is 'failed' (optional)
          example: File format not supported
      required:
        - source_id
        - status
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-KEY

````