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

# Browse documents in a knowledge source

> Lists the documents a person could pin by running the provider's listing tool on the vendor's MCP server and reading the result in code. Providers without a listing recipe answer 501. Organization-global knowledge sources are not available to asset-scoped tokens.



## OpenAPI

````yaml /openapi.json get /knowledge/sources/{sourceId}/documents
openapi: 3.1.0
info:
  title: Strix API
  version: 1.0.0
  description: >-
    Public REST API for the Strix autonomous penetration testing platform.
    Manage scans, vulnerabilities, assets, schedules, API tokens, and webhooks.
servers:
  - url: /api/v1
    description: Strix v1 API
security:
  - BearerAuth: []
tags:
  - name: Scans
    description: Launch, monitor, and manage security scans.
  - name: Vulnerabilities
    description: View and triage discovered vulnerabilities.
  - name: Assets
    description: Domains and repositories registered for scanning.
  - name: Schedules
    description: Recurring scan schedules (Pro plan).
  - name: Tokens
    description: Manage API tokens for authentication.
  - name: Webhooks
    description: Configure webhook subscriptions for real-time event notifications.
  - name: Organization
    description: Workspace configuration for the authenticated organization.
  - name: Members
    description: Manage organization members and roles.
  - name: Invitations
    description: List and revoke organization invitations.
  - name: PR Reviews
    description: Automated security review of pull requests.
  - name: Connectors
    description: Network connectors for scanning internal/private targets.
  - name: Knowledge
    description: >-
      Organization knowledge base: documents, policies, and repo profiles that
      steer the agent.
  - name: Uploads
    description: Upload source/code/documentation archives for whitebox scans.
  - name: Integrations
    description: Third-party integrations (GitLab, Bitbucket, ticketing).
  - name: Chat
    description: Conversational agent sessions.
  - name: Analytics
    description: Aggregate dashboard analytics.
  - name: Test Users
    description: >-
      Per-domain test accounts (with optional MFA) the agent authenticates as
      during scans.
  - name: License
    description: Self-hosted license state, entitlements, and aggregate usage.
  - name: Supply Chain
    description: >-
      SBOM inventory, supply-chain findings, scans, and policy for connected
      repositories.
  - name: CLI
    description: >-
      Device authorization endpoints that let the Strix CLI and coding agents
      sign in and receive an API token.
  - name: Billing
    description: Credit balance, agent-payable top-ups, and automatic top-up settings.
  - name: Workspaces
    description: List, create, and switch workspaces.
  - name: Asset Discovery
    description: >-
      Passive reconnaissance runs that map the organization's external attack
      surface, and the discovered-asset inventory they fill.
  - name: Containers
    description: >-
      Container registries, tracked images, image scans, findings, and SBOM
      components.
  - name: Run Logs
    description: Persisted engine logs and the diagnostics bundle of a self-hosted install.
paths:
  /knowledge/sources/{sourceId}/documents:
    get:
      tags:
        - Knowledge
      summary: Browse documents in a knowledge source
      description: >-
        Lists the documents a person could pin by running the provider's listing
        tool on the vendor's MCP server and reading the result in code.
        Providers without a listing recipe answer 501. Organization-global
        knowledge sources are not available to asset-scoped tokens.
      operationId: listKnowledgeSourceDocuments
      parameters:
        - name: sourceId
          in: path
          required: true
          description: Knowledge source identifier.
          schema:
            type: string
            format: uuid
        - name: search
          in: query
          required: false
          description: >-
            Optional provider search text. A search always runs live against the
            provider and is never cached.
          schema:
            type: string
            maxLength: 500
        - name: cursor
          in: query
          required: false
          description: >-
            Opaque continuation value from nextCursor. Pass it back unchanged
            with the same search text.
          schema:
            type: string
            maxLength: 4096
        - name: refresh
          in: query
          required: false
          description: >-
            Skip the cached list and rebuild it from the provider. Without it, a
            plain listing produced in the last 15 minutes for the same connected
            account is returned; cachedAt in the response says when.
          schema:
            type: string
            enum:
              - 'true'
              - '1'
      responses:
        '200':
          description: Provider-neutral document list.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KnowledgeSourceDocumentList'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          $ref: '#/components/responses/Conflict'
        '501':
          description: This provider's documents cannot be browsed yet.
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: string
                    enum:
                      - browsing_unavailable
                  detail:
                    type: string
                required:
                  - code
                  - detail
        '502':
          $ref: '#/components/responses/BadGateway'
      security:
        - BearerAuth:
            - knowledge:read
components:
  schemas:
    KnowledgeSourceDocumentList:
      type: object
      properties:
        documents:
          type: array
          items:
            $ref: '#/components/schemas/KnowledgeSourceDocument'
        totalCount:
          type: integer
          minimum: 0
        hasMore:
          type: boolean
        nextCursor:
          type:
            - string
            - 'null'
          description: >-
            Opaque continuation value for the next page, or null when there is
            no next page.
        workspaceLabel:
          type:
            - string
            - 'null'
        cachedAt:
          type:
            - string
            - 'null'
          format: date-time
          description: >-
            When this list was produced, if it came from the cache; null when it
            was produced by this request.
      required:
        - documents
        - totalCount
        - hasMore
        - nextCursor
        - workspaceLabel
        - cachedAt
    KnowledgeSourceDocument:
      type: object
      properties:
        id:
          type: string
        title:
          type: string
        kind:
          type: string
        url:
          type:
            - string
            - 'null'
          format: uri
        updatedAt:
          type:
            - string
            - 'null'
        workspaceId:
          type:
            - string
            - 'null'
        workspaceLabel:
          type:
            - string
            - 'null'
      required:
        - id
        - title
        - kind
        - url
        - updatedAt
        - workspaceId
        - workspaceLabel
    ErrorResponse:
      type: object
      properties:
        detail:
          type: string
          description: Human-readable explanation of the error.
        code:
          type: string
          description: >-
            Stable machine-readable error code. `insufficient_scope` means the
            token does not hold the scope that this endpoint requires.
        required_scope:
          $ref: '#/components/schemas/ApiV1Scope'
          description: >-
            Scope that the caller must add to the token. Returned with the
            `insufficient_scope` code.
        docs:
          type: string
          format: uri
          description: Documentation page that explains how to resolve the error.
        hint:
          type: string
          description: >-
            One instruction that resolves the error. For `insufficient_scope`, a
            CLI session gets the `strix cloud session scopes set full` or `strix
            cloud login --scope-profile full` command, and an API token gets the
            settings page where the user creates a token with the scope. When
            the owner's role cannot hold the scope, the hint asks for a role
            change instead.
      required:
        - detail
    ApiV1Scope:
      type: string
      enum:
        - scans:read
        - scans:write
        - vulnerabilities:read
        - vulnerabilities:write
        - dependencies:read
        - schedules:read
        - schedules:write
        - assets:read
        - assets:write
        - organizations:read
        - organizations:write
        - members:read
        - members:write
        - invitations:read
        - invitations:write
        - webhooks:read
        - webhooks:write
        - tokens:write
        - audit:read
        - pr_reviews:read
        - pr_reviews:write
        - connectors:read
        - connectors:write
        - knowledge:read
        - knowledge:write
        - uploads:write
        - integrations:read
        - integrations:write
        - chat:read
        - chat:write
        - scans:message
        - analytics:read
        - llm:read
        - llm:write
        - test_users:read
        - test_users:write
        - discovery:read
        - discovery:write
        - license:read
        - supply_chain:read
        - supply_chain:write
        - billing:read
        - billing:write
        - containers:read
        - containers:write
        - logs:read
  responses:
    BadRequest:
      description: Bad request.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    Unauthorized:
      description: Missing or invalid API token.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    Forbidden:
      description: >-
        Insufficient permissions or missing scope. A missing scope returns the
        `insufficient_scope` code, the `required_scope` field, and a `hint` with
        the command or page that grants the scope, so a client can request the
        correct scope and retry.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    NotFound:
      description: Resource not found.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    Conflict:
      description: Conflict.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    BadGateway:
      description: Bad gateway.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: >-
        API token obtained from the Tokens endpoint or CLI device login. Include
        as `Authorization: Bearer <token>`. Requests made with a managed CLI
        session also include `X-Strix-Workspace: <organization_id>` to pin a
        process to the workspace it started in; recovery endpoints report the
        current workspace after a concurrent switch.

````