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

> Run a bounded cron sweep or one editor-authorized manual sweep.



## OpenAPI

````yaml /api/openapi.json post /api/sweeps/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:
  /api/sweeps/run:
    post:
      tags:
        - sweeps
      summary: Run Sweeps
      description: Run a bounded cron sweep or one editor-authorized manual sweep.
      operationId: run_sweeps_api_sweeps_run_post
      parameters:
        - name: X-Cron-Key
          in: header
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: X-Cron-Key
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SweepRunRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    SweepRunRequest:
      properties:
        entity_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Entity Id
        limit:
          type: integer
          maximum: 25
          minimum: 1
          title: Limit
          default: 8
        materialize_only:
          type: boolean
          title: Materialize Only
          default: false
        idempotency_key:
          anyOf:
            - type: string
              maxLength: 128
              minLength: 8
              pattern: ^[A-Za-z0-9][A-Za-z0-9._:-]+$
            - type: 'null'
          title: Idempotency Key
      type: object
      title: SweepRunRequest
    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.