Get Knowledge Base by ID

curl --request GET \
  --url https://prod-api.ringg.ai/ca/api/v0/external/kb/{kb_id} \
  --header 'X-API-KEY: <x-api-key>'

{
  "kb_id": "550e8400-e29b-41d4-a716-446655440000",
  "kb_name": "Product Documentation",
  "status": "completed",
  "created_at": "2024-12-16T13:03:29.947147+00:00",
  "updated_at": "2024-12-16T14:15:32.123456+00:00",
  "files": [
    {
      "file_id": "<string>",
      "file_type": "<string>",
      "file_size": 123,
      "filename": "<string>",
      "file_path": "<string>"
    }
  ],
  "urls": [
    {
      "file_id": "<string>",
      "file_type": "<string>",
      "file_size": 123,
      "url": "<string>",
      "file_path": "<string>"
    }
  ],
  "faqs": [
    {
      "file_id": "<string>",
      "file_type": "<string>",
      "file_size": 123,
      "content": {}
    }
  ]
}

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

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

​

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