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

> ## Agent Instructions
> To search or read these docs, connect the Ringg docs MCP server at https://docs.ringg.ai/mcp (no key needed; tools search_ringg_ai and query_docs_filesystem_ringg_ai) instead of browsing pages one by one. Setup for each client: https://docs.ringg.ai/resources/mcp-server/docs-mcp-server/mcp-for-ai-assistants.md
> The dashboard labels agents "Assistants"; these docs say "agent". Both mean the same object, identified by agent_id.
> API base URL: https://prod-api.ringg.ai/ca/api/v0. Send the workspace API key in the X-API-KEY header, from server-side code only.
> Placing a call dials a real phone number and spends credits. Confirm the number with the user before calling.
> To act on a Ringg workspace (place calls, edit agents, read transcripts), use the separate Ringg workspace MCP server at https://mcp.ringg.ai/mcp: https://docs.ringg.ai/resources/mcp-server/workspace-mcp-server/overview.md

> Get one knowledge base with its processing status and every file, URL and FAQ in it, including the IDs you need to remove items with the edit endpoint.

# Get Knowledge Base by ID

export const RelatedTopics = ({items}) => <div className="not-prose mt-12">
    <div className="text-sm font-medium text-gray-500 dark:text-zinc-400 mb-3">Related topics</div>
    <div className="flex flex-col gap-2.5">
      {items.map(([title, href]) => <a key={href} href={href} className="flex items-center gap-2.5 text-sm text-gray-700 hover:text-gray-950 dark:text-zinc-300 dark:hover:text-white">
          <Icon icon="file-text" size={16} color="currentColor" />
          {title}
        </a>)}
    </div>
  </div>;

Each item has a `file_id`, which is the ID [Edit knowledge base](/api-reference/inventory/knowledge-bases/edit-knowledge-base) takes to remove it.

## Notes

* Poll this endpoint after creating or editing until `status` is `completed`. Large files or many URLs can take several minutes.
* Files carry `filename`, `file_type` and `file_size` (bytes); URLs carry `url`; FAQs carry `content` with the question and answer.

<RelatedTopics items={[["Knowledge base", "/documentation/build-agents/customize-agent-behaviour/attach-a-knowledge-base"]]} />


## OpenAPI

````yaml get /external/kb/{kb_id}
openapi: 3.0.0
info:
  title: Ringg AI API Documentation
  description: >-
    The Ringg AI REST API. Base URL https://prod-api.ringg.ai/ca/api/v0; send
    your workspace API key in the X-API-KEY header from server-side code only.
    Requests and responses are JSON.
  version: 2.0.0
  contact:
    name: Ringg AI support
    email: admin@ringg.ai
    url: https://docs.ringg.ai
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 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: rg_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
        - 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.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Invalid credentials
        '404':
          description: Knowledge base not found.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
        '429':
          description: Rate limit exceeded - Maximum 60 requests per hour.

````

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