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

# Get a knowledge base

> Returns metadata for a single knowledge base. Does not include content — content is read by metrics at evaluation time and is not exposed over the public API.



## OpenAPI

````yaml /api-reference/openapi.documented.json get /v1/knowledge-base/{id}
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: Health
    x-displayName: Health
  - name: Authentication
    x-displayName: Current credential
  - name: Project API Key
    x-displayName: Project API keys
  - name: Personal API Key
    x-displayName: Personal API keys
  - name: Agent
    x-displayName: Agents
  - name: Agent Endpoint
    x-displayName: Endpoints
  - name: Tool
    x-displayName: Tools
  - name: Agent Setup
    x-displayName: Automatic test setup
  - name: Autoimprove
    x-displayName: Autoimprove
  - name: Customer Flow
    x-displayName: Customer flows
  - name: Customer Flow Folder
    x-displayName: Customer flow folders
  - name: Simulation Persona
    x-displayName: Personas
  - name: Simulation Environment
    x-displayName: Environments
  - name: Simulation Template
    x-displayName: Templates
  - name: Simulation Run Plan
    x-displayName: Plans
  - name: Simulation Run
    x-displayName: Runs
  - name: Simulation Tool Mock
    x-displayName: Tool mocks and fixtures
  - name: Metric
    x-displayName: Definitions
  - name: Metric Variant
    x-displayName: Variants
  - name: Metric Policy
    x-displayName: Policies
  - name: Metric Collection Job
    x-displayName: Collection jobs
  - name: Call
    x-displayName: Calls
  - name: Chat
    x-displayName: Chats
  - name: Customer
    x-displayName: Customers
  - name: Issue
    x-displayName: Issues
  - name: Analytics
    x-displayName: Analytics
  - name: Dashboard
    x-displayName: Dashboards
  - name: Live Report
    x-displayName: Reports
  - name: Agent Connection
    x-displayName: Agent platforms
  - name: Calendar Connection
    x-displayName: Calendars
  - name: MCP Server Connection
    x-displayName: MCP servers
  - name: Knowledge Base
    x-displayName: Knowledge bases
  - name: HTTP Request Definition
    x-displayName: HTTP request definitions
  - name: Webhook
    x-displayName: Webhooks
  - name: Config
    x-displayName: Config as code
  - name: Organization Project
    x-displayName: Projects
  - name: Organization Project Member
    x-displayName: Project members
  - name: Usage
    x-displayName: Usage
  - name: Benchmark
    x-displayName: Benchmarks
paths:
  /v1/knowledge-base/{id}:
    get:
      tags:
        - Knowledge Base
      summary: Get a knowledge base
      description: >-
        Returns metadata for a single knowledge base. Does not include content —
        content is read by metrics at evaluation time and is not exposed over
        the public API.
      operationId: getV1Knowledge-baseById
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Knowledge base ID
      responses:
        '200':
          description: The requested knowledge base.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    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.
                required:
                  - data
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
                description: Authentication error
              example:
                type: authentication
                code: unauthorized
                message: Authentication required
          description: Unauthorized
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
                description: Not found error
              example:
                type: not_found
                code: resource_not_found
                message: The requested resource could not be found
          description: Not Found
        '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
            - payment_required
            - 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

````

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