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

# Run Analysis

> Queue a durable research input, then observe its saved state over NDJSON.



## OpenAPI

````yaml /api/openapi.json post /agent/v1/analysis/run
openapi: 3.1.0
info:
  title: CrowdListen Agent API
  description: >-
    Configure sources, collect and retain originals, run durable analysis, and
    read or revise cited insights. Humans and agents share authorized
    entity/project records, research jobs and evidence history.
  version: 1.0.0
servers:
  - url: https://agent.crowdlisten.com
    description: Production
  - url: http://localhost:8000
    description: Local development
security: []
paths:
  /agent/v1/analysis/run:
    post:
      tags:
        - analysis
      summary: Run Analysis
      description: >-
        Queue a durable research input, then observe its saved state over
        NDJSON.
      operationId: run_analysis_agent_v1_analysis_run_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AnalysisRunRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    AnalysisRunRequest:
      properties:
        question:
          type: string
          maxLength: 1000
          minLength: 1
          title: Question
          description: Analysis question
        request_id:
          anyOf:
            - type: string
              maxLength: 128
              minLength: 8
            - type: 'null'
          title: Request Id
          description: Idempotency key; changed inputs conflict
        project_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Project Id
          description: Project UUID
        options:
          anyOf:
            - $ref: '#/components/schemas/AnalysisOptions'
            - type: 'null'
          description: Analysis options
        mode:
          anyOf:
            - type: string
            - type: 'null'
          title: Mode
          description: 'Analysis mode: ''crowd'' or ''auto'''
        search_mode:
          anyOf:
            - type: string
            - type: 'null'
          title: Search Mode
          description: >-
            Search mode: 'knowledge' (search stored KB + content_store,
            default), 'multi_source' (live web search), 'hybrid' (legacy alias),
            'web_only', 'user_only', 'user_first'
          default: knowledge
        platforms:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          title: Platforms
          description: 'Platforms to search: reddit, twitter (X), github, news'
        urls:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          title: Urls
          description: URLs pasted by user for MCP content extraction
        uploaded_content:
          anyOf:
            - type: string
            - type: 'null'
          title: Uploaded Content
          description: Content from user-uploaded file (text, transcribed audio, etc.)
        uploaded_file_name:
          anyOf:
            - type: string
            - type: 'null'
          title: Uploaded File Name
          description: Original filename of uploaded content
        provided_sources:
          anyOf:
            - items:
                additionalProperties: true
                type: object
              type: array
              maxItems: 2000
              minItems: 1
            - type: 'null'
          title: Provided Sources
          description: >-
            Supplied originals or stored source IDs; stored bodies are reloaded
            under caller scope
        entity_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Entity Id
          description: Entity UUID for scoped analysis (from frontend entity picker)
        workspace_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Workspace Id
          description: Workspace UUID for content isolation in shared workspaces
        skill:
          anyOf:
            - type: string
            - type: 'null'
          title: Skill
          description: Skill ID (e.g., 'crowd-research') to influence analysis methodology
        depth:
          anyOf:
            - type: string
            - type: 'null'
          title: Depth
          description: >-
            Analysis depth: 'brief' (bounded discovery) or 'deep' (bounded
            discovery plus original text/comment extraction)
          default: brief
      type: object
      required:
        - question
      title: AnalysisRunRequest
      description: Request body for starting new analysis
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    AnalysisOptions:
      properties:
        tag:
          anyOf:
            - type: string
              maxLength: 50
            - type: 'null'
          title: Tag
          description: Category tag
        public:
          type: boolean
          title: Public
          description: Make analysis publicly visible
          default: false
        num_sources:
          anyOf:
            - type: integer
              maximum: 200
              minimum: 1
            - type: 'null'
          title: Num Sources
          description: Number of sources to analyze
      type: object
      title: AnalysisOptions
      description: Optional analysis configuration
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError

````

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