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

# Get Knowledge Base by ID

> Retrieves a specific knowledge base by its ID. Rate limit: 60 requests per hour per workspace.

## Get Knowledge Base by ID

Retrieve detailed information about a specific knowledge base, including all files, URLs, and FAQs along with their processing status.

<Warning>
  **Rate Limit**: Maximum 60 requests per hour per workspace
</Warning>

## Response Structure

The response includes comprehensive details about your knowledge base:

### Basic Information

* `kb_id`: Unique identifier
* `kb_name`: Name of the knowledge base
* `status`: Overall processing status (`pending`, `processing`, `completed`, `failed`)
* `created_at`: Creation timestamp
* `updated_at`: Last modification timestamp

### Content Arrays

#### Files

Each file object includes:

* `file_id`: Unique identifier for removal operations
* `file_type`: Document type (pdf, txt, docx, etc.)
* `file_size`: Size in bytes
* `filename`: Original filename
* `file_path`: Storage path

#### URLs

Each URL object includes:

* `file_id`: Unique identifier for removal operations
* `file_type`: Content type
* `file_size`: Extracted content size
* `url`: Original URL
* `file_path`: Storage path for indexed content

#### FAQs

Each FAQ object includes:

* `file_id`: Unique identifier for removal operations
* `file_type`: Always "faq"
* `file_size`: Content size
* `content`: Question and answer object

## Use Cases

* **Check Processing Status**: Monitor when content is ready for use
* **Get Content IDs**: Retrieve file and FAQ IDs for removal operations
* **Audit Content**: Review what's currently in your knowledge base
* **Debug Issues**: Identify failed or pending items

<Note>
  **Processing Time**: Large files or many URLs may take several minutes to process. Check the `status` field to confirm completion.
</Note>


## OpenAPI

````yaml get /external/kb/{kb_id}
openapi: 3.0.0
info:
  title: Ringg AI API Documentation
  description: >-
    This is the documentation for the Ringg AI APIs. The Ringg AI API follows
    RESTful principles, making it intuitive and easy to integrate with your
    applications. All API requests should be made to the base URL. The API
    accepts and returns data in JSON format. Ensure your requests include the
    appropriate Content-Type header for POST and PATCH requests.
  version: 2.0.0
servers:
  - url: https://prod-api.ringg.ai/ca/api/v0
security: []
tags:
  - name: workspace
    description: Endpoints for managing your workspace.
  - name: agent
    description: Endpoints for managing assistants (agents).
  - name: calling
    description: Endpoints for making and managing calls.
  - name: campaign
    description: Endpoints for managing campaigns.
  - name: analytics
    description: Endpoints for accessing call analytics and performance metrics.
  - name: termination
    description: Endpoints for terminating active calls using different methods.
  - name: knowledgebase
    description: Endpoints for managing knowledge bases.
paths:
  /external/kb/{kb_id}:
    get:
      tags:
        - knowledgebase
      summary: Get Knowledge Base by ID
      description: >-
        Retrieves a specific knowledge base by its ID. Rate limit: 60 requests
        per hour per workspace.
      operationId: getKnowledgeBaseById
      parameters:
        - name: X-API-KEY
          in: header
          description: (Required) Your Ringg AI API key.
          required: true
          schema:
            type: string
            example: 7251cb4b-3373-43a4-844c-b27a1d45e0c9
        - name: kb_id
          in: path
          description: (Required) ID of the knowledge base
          required: true
          schema:
            type: string
            example: 550e8400-e29b-41d4-a716-446655440000
      responses:
        '200':
          description: Knowledge base details retrieved successfully.
          content:
            application/json:
              schema:
                type: object
                properties:
                  kb_id:
                    type: string
                    example: 550e8400-e29b-41d4-a716-446655440000
                  kb_name:
                    type: string
                    example: Product Documentation
                  status:
                    type: string
                    description: Processing status of the knowledge base
                    example: completed
                  created_at:
                    type: string
                    format: date-time
                    example: '2024-12-16T13:03:29.947147+00:00'
                  updated_at:
                    type: string
                    format: date-time
                    example: '2024-12-16T14:15:32.123456+00:00'
                  files:
                    type: array
                    items:
                      type: object
                      properties:
                        file_id:
                          type: string
                        file_type:
                          type: string
                        file_size:
                          type: number
                        filename:
                          type: string
                        file_path:
                          type: string
                  urls:
                    type: array
                    items:
                      type: object
                      properties:
                        file_id:
                          type: string
                        file_type:
                          type: string
                        file_size:
                          type: number
                        url:
                          type: string
                        file_path:
                          type: string
                  faqs:
                    type: array
                    items:
                      type: object
                      properties:
                        file_id:
                          type: string
                        file_type:
                          type: string
                        file_size:
                          type: number
                        content:
                          type: object
        '401':
          description: Unauthorized - Invalid or missing API key.
        '404':
          description: Knowledge base not found.
        '429':
          description: Rate limit exceeded - Maximum 60 requests per hour.

````