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

# Extract and capture complete comments with their source references

> Preserve all retrieved originals; each item has its own atomic capture receipt.



## OpenAPI

````yaml /api/openapi.json post /agent/v1/ingest/deep-extract
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/deep-extract:
    post:
      tags:
        - ingest
      summary: Extract and capture complete comments with their source references
      description: >-
        Preserve all retrieved originals; each item has its own atomic capture
        receipt.
      operationId: ingest_deep_extract_agent_v1_ingest_deep_extract_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeepExtractRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeepExtractResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    DeepExtractRequest:
      properties:
        entity_id:
          type: string
          maxLength: 100
          minLength: 1
          title: Entity Id
        items:
          items:
            $ref: '#/components/schemas/DeepExtractItem'
          type: array
          maxItems: 100
          minItems: 1
          title: Items
      type: object
      required:
        - entity_id
        - items
      title: DeepExtractRequest
    DeepExtractResponse:
      properties:
        results:
          items:
            $ref: '#/components/schemas/ExtractionResult'
          type: array
          title: Results
        stats:
          additionalProperties: true
          type: object
          title: Stats
      type: object
      required:
        - results
        - stats
      title: DeepExtractResponse
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    DeepExtractItem:
      properties:
        id:
          anyOf:
            - type: string
              maxLength: 500
            - type: 'null'
          title: Id
        title:
          type: string
          maxLength: 2000
          title: Title
          default: ''
        url:
          type: string
          maxLength: 5000
          minLength: 1
          title: Url
        platform:
          $ref: '#/components/schemas/Platform'
        content:
          type: string
          maxLength: 500000
          title: Content
          default: ''
        author:
          type: string
          maxLength: 500
          title: Author
          default: ''
        published_at:
          anyOf:
            - type: string
            - type: 'null'
          title: Published At
          description: ISO 8601 datetime string
        engagement:
          $ref: '#/components/schemas/EngagementData'
        comments:
          items:
            $ref: '#/components/schemas/DeepExtractComment'
          type: array
          title: Comments
          description: Pre-fetched originals; otherwise extract comments from the URL
        metadata:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Metadata
          description: Extra metadata from local pipeline (transcripts, etc.)
      type: object
      required:
        - url
        - platform
      title: DeepExtractItem
    ExtractionResult:
      properties:
        url:
          type: string
          title: Url
        platform:
          type: string
          title: Platform
        status:
          type: string
          title: Status
        comments_found:
          type: integer
          title: Comments Found
          default: 0
        promoted_count:
          type: integer
          title: Promoted Count
          default: 0
        content_ids:
          items:
            type: string
          type: array
          title: Content Ids
        parent_content_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Parent Content Id
        comment_content_ids:
          items:
            type: string
          type: array
          title: Comment Content Ids
        capture_complete:
          type: boolean
          title: Capture Complete
          default: false
        error:
          anyOf:
            - type: string
            - type: 'null'
          title: Error
      type: object
      required:
        - url
        - platform
        - status
      title: ExtractionResult
    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
    Platform:
      type: string
      enum:
        - reddit
        - youtube
        - tiktok
        - twitter
        - instagram
        - linkedin
        - hackernews
        - producthunt
        - github
        - threads
        - web
        - granola
        - slack
        - agent
        - claude_code
        - codex
      title: Platform
    EngagementData:
      properties:
        likes:
          anyOf:
            - type: integer
              minimum: 0
            - type: 'null'
          title: Likes
        comments:
          anyOf:
            - type: integer
              minimum: 0
            - type: 'null'
          title: Comments
        views:
          anyOf:
            - type: integer
              minimum: 0
            - type: 'null'
          title: Views
        score:
          anyOf:
            - type: integer
              minimum: 0
            - type: 'null'
          title: Score
        shares:
          anyOf:
            - type: integer
              minimum: 0
            - type: 'null'
          title: Shares
      type: object
      title: EngagementData
    DeepExtractComment:
      properties:
        id:
          anyOf:
            - type: string
              maxLength: 500
            - type: 'null'
          title: Id
        url:
          anyOf:
            - type: string
              maxLength: 5000
            - type: 'null'
          title: Url
        published_at:
          anyOf:
            - type: string
            - type: 'null'
          title: Published At
        metadata:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Metadata
        text:
          type: string
          maxLength: 50000
          minLength: 1
          title: Text
        author:
          type: string
          maxLength: 500
          title: Author
          default: unknown
        likes:
          anyOf:
            - type: integer
              minimum: 0
            - type: 'null'
          title: Likes
        replies:
          anyOf:
            - type: integer
              minimum: 0
            - type: 'null'
          title: Replies
        timestamp:
          anyOf:
            - type: string
            - type: 'null'
          title: Timestamp
      type: object
      required:
        - text
      title: DeepExtractComment

````

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