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

# List knowledge bases

> Returns a cursor-paginated list of knowledge bases for the authenticated project. Soft-deleted knowledge bases are excluded.



## OpenAPI

````yaml /api-reference/openapi.documented.json get /v1/knowledge-base
openapi: 3.1.0
info:
  title: Roark Analytics API
  description: >-
    The Roark Analytics API gives you access to the same API that powers the
    award winning Roark Analytics platform.
  version: 1.0.0
servers:
  - description: Production
    url: https://api.roark.ai
security:
  - Bearer: []
tags:
  - name: Agent
  - name: Agent Endpoint
  - name: Call
  - name: Chat
  - name: Metric
  - name: Metric Policy
  - name: Metric Collection Job
  - name: Simulation Persona
  - name: Simulation Scenario
  - name: Simulation Run Plan
  - name: Simulation Run Plan Job
  - name: Simulation Job
  - name: HTTP Request Definition
  - name: Webhook
  - name: Issue
  - name: Knowledge Base
  - name: Call Analysis
  - name: Health
paths:
  /v1/knowledge-base:
    get:
      tags:
        - Knowledge Base
      summary: List knowledge bases
      description: >-
        Returns a cursor-paginated list of knowledge bases for the authenticated
        project. Soft-deleted knowledge bases are excluded.
      operationId: getV1Knowledge-base
      parameters:
        - in: query
          name: limit
          schema:
            type: integer
            minimum: 1
            maximum: 50
            default: 20
        - in: query
          name: after
          schema:
            type: string
        - in: query
          name: searchText
          schema:
            type: string
        - in: query
          name: sourceType
          schema:
            type: string
            enum:
              - TEXT
              - FILE
              - JSON
              - URL
            description: >-
              How the knowledge base content was provided. TEXT/JSON are stored
              as-is; FILE was uploaded and its text content extracted (PDF →
              text); URL was scraped from a webpage into markdown.
      responses:
        '200':
          description: A page of knowledge bases.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          format: uuid
                          description: Unique identifier of the knowledge base.
                        name:
                          type: string
                          description: Customer-supplied name. Unique within the project.
                        description:
                          type:
                            - string
                            - 'null'
                          description: Optional customer-supplied description.
                        sourceType:
                          type: string
                          enum:
                            - TEXT
                            - FILE
                            - JSON
                            - URL
                          description: >-
                            How the knowledge base content was provided.
                            TEXT/JSON are stored as-is; FILE was uploaded and
                            its text content extracted (PDF → text); URL was
                            scraped from a webpage into markdown.
                        status:
                          type: string
                          enum:
                            - READY
                            - PROCESSING
                            - PENDING_UPLOAD
                            - FAILED
                          description: >-
                            Lifecycle of the knowledge base. READY means the
                            content is available to metrics. PROCESSING is set
                            during PDF text extraction. FAILED means extraction
                            errored — see `errorMessage`.
                        originalFilename:
                          type:
                            - string
                            - 'null'
                          description: >-
                            For FILE source: the customer-supplied filename.
                            Null for TEXT/JSON/URL.
                        mimeType:
                          type:
                            - string
                            - 'null'
                          description: >-
                            For FILE source: the mime type of the uploaded file.
                            Null for TEXT/JSON/URL.
                        sourceUrl:
                          type:
                            - string
                            - 'null'
                          description: >-
                            For URL source: the page that was scraped into
                            markdown. Null for TEXT/JSON/FILE.
                        byteSize:
                          type: integer
                          minimum: 0
                          description: >-
                            Size of the content the model will read at
                            evaluation time. For FILE this is the EXTRACTED text
                            size, not the original PDF size.
                        contentHash:
                          type:
                            - string
                            - 'null'
                          description: >-
                            SHA-256 of the content. Stable across
                            whitespace-equivalent edits for JSON (pretty-printed
                            before hashing). Use it to detect change without
                            diffing the content.
                        errorMessage:
                          type:
                            - string
                            - 'null'
                          description: When `status` is FAILED, the reason. Null otherwise.
                        createdAt:
                          type: string
                          description: Creation timestamp in ISO 8601 format.
                        updatedAt:
                          type: string
                          description: Last update timestamp in ISO 8601 format.
                      required:
                        - id
                        - name
                        - description
                        - sourceType
                        - status
                        - originalFilename
                        - mimeType
                        - sourceUrl
                        - byteSize
                        - contentHash
                        - errorMessage
                        - createdAt
                        - updatedAt
                      title: KnowledgeBase
                      description: >-
                        A customer-uploaded reference document attached to
                        custom metrics as ground truth at evaluation time.
                  pagination:
                    type: object
                    properties:
                      total:
                        type: number
                        description: Total number of items
                      hasMore:
                        type: boolean
                        description: Whether there are more items to fetch
                      nextCursor:
                        type:
                          - string
                          - 'null'
                        description: Cursor for the next page of items
                    required:
                      - total
                      - hasMore
                      - nextCursor
                required:
                  - data
                  - pagination
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
                description: Authentication error
              example:
                type: authentication
                code: unauthorized
                message: Authentication required
          description: Unauthorized
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
                description: Server error
              example:
                type: internal
                code: internal_error
                message: Internal server error
          description: Internal Server Error
components:
  schemas:
    ErrorResponse:
      type: object
      properties:
        type:
          type: string
          enum:
            - validation
            - authentication
            - forbidden
            - not_found
            - conflict
            - rate_limit
            - internal
          description: The error type category
          examples:
            - validation
            - authentication
        code:
          type: string
          description: Machine-readable error code identifier
          examples:
            - invalid_parameter
            - missing_required_field
            - unauthorized
        message:
          type: string
          description: Human-readable error message
          examples:
            - The request was invalid
            - Authentication required
        param:
          type: string
          description: The parameter that caused the error (if applicable)
          examples:
            - email
            - user_id
        details:
          description: Additional error context information
      required:
        - type
        - code
        - message
  securitySchemes:
    Bearer:
      type: http
      scheme: bearer
      bearerFormat: JWT

````