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

# Research Entity

> Run all entity questions through durable capture and cited findings.



## OpenAPI

````yaml /api/openapi.json post /agent/v1/ingest/research
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/ingest/research:
    post:
      tags:
        - ingest
      summary: Research Entity
      description: Run all entity questions through durable capture and cited findings.
      operationId: research_entity_agent_v1_ingest_research_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ResearchRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResearchResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    ResearchRequest:
      properties:
        entity_id:
          type: string
          maxLength: 100
          minLength: 1
          title: Entity Id
        questions:
          items:
            type: string
          type: array
          maxItems: 5
          minItems: 1
          title: Questions
          description: >-
            Research angles to discover across the configured web and community
            scope
        depth:
          type: string
          enum:
            - brief
            - deep
          title: Depth
          description: '''brief'' or ''deep'''
          default: deep
        platforms:
          anyOf:
            - items:
                type: string
                enum:
                  - twitter
                  - linkedin
                  - reddit
                  - youtube
                  - tiktok
                  - instagram
                  - hackernews
                  - producthunt
                  - web
              type: array
              maxItems: 9
            - type: 'null'
          title: Platforms
          description: Omit to use entity settings; an empty array disables live discovery.
      type: object
      required:
        - entity_id
        - questions
      title: ResearchRequest
    ResearchResponse:
      properties:
        status:
          type: string
          title: Status
        entity_id:
          type: string
          title: Entity Id
        analysis_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Analysis Id
        job_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Job Id
        research_receipt:
          additionalProperties: true
          type: object
          title: Research Receipt
        total_stored:
          type: integer
          title: Total Stored
          default: 0
        questions_processed:
          type: integer
          title: Questions Processed
        total_sources:
          type: integer
          title: Total Sources
        total_comments:
          type: integer
          title: Total Comments
          default: 0
        platforms_covered:
          items:
            type: string
          type: array
          title: Platforms Covered
        kb_updated:
          type: boolean
          title: Kb Updated
          default: false
        pipeline_triggered:
          type: boolean
          title: Pipeline Triggered
          default: false
        errors:
          items:
            type: string
          type: array
          title: Errors
      type: object
      required:
        - status
        - entity_id
        - questions_processed
        - total_sources
      title: ResearchResponse
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    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.