Skip to main content
GET
Get Knowledge Base by ID
Each item has a file_id, which is the ID 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.

Authorizations

X-API-KEY
string
header
required

Headers

X-API-KEY
string
required

(Required) Your Ringg AI API key.

Example:

"rg_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

Path Parameters

kb_id
string
required

(Required) ID of the knowledge base

Example:

"550e8400-e29b-41d4-a716-446655440000"

Response

Knowledge base details retrieved successfully.

kb_id
string
Example:

"550e8400-e29b-41d4-a716-446655440000"

kb_name
string
Example:

"Product Documentation"

status
string

Processing status of the knowledge base

Example:

"completed"

created_at
string<date-time>
Example:

"2024-12-16T13:03:29.947147+00:00"

updated_at
string<date-time>
Example:

"2024-12-16T14:15:32.123456+00:00"

files
object[]
urls
object[]
faqs
object[]