Skip to main content
GET
/
knowledgebase
/
{rag_id}
cURL
curl --request GET \
  --url https://api.bolna.ai/knowledgebase/{rag_id} \
  --header 'Authorization: Bearer <token>'
{
  "rag_id": "f265b06a-7fa7-4fbf-8923-55d5ae9c4ba2",
  "file_name": "sample-rag.pdf",
  "humanized_created_at": "5 minutes ago",
  "created_at": "2024-01-23T05:14:37Z",
  "updated_at": "2024-02-29T04:22:89Z",
  "vector_id": "77a3473c-c78f-4695-ba56-95b1f4f9e80b",
  "status": "processed",
  "chunk_size": 512,
  "similarity_top_k": 15,
  "overlapping": 128,
  "language_support": null
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
rag_id
string<uuid>
required

The ID of the knowledgebase

Response

list knowledgebase response

​
rag_id
string

The ID of the knowledgebase

Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}
Example:

"f265b06a-7fa7-4fbf-8923-55d5ae9c4ba2"

​
file_name
string

File name of the document

Example:

"sample-rag.pdf"

​
humanized_created_at
string

Human-readable relative time since knowledgebase creation

Example:

"5 minutes ago"

​
created_at
string<date-time>

Created timestamp of knowledgebase

Example:

"2024-01-23T05:14:37Z"

​
updated_at
string<date-time>

Last updated timestamp of knowledgebase

Example:

"2024-02-29T04:22:89Z"

​
vector_id
string

Unique vector ID of the knowledgebase

Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}
Example:

"77a3473c-c78f-4695-ba56-95b1f4f9e80b"

​
status
enum<string>

Current status of the knowledgebase

Available options:
processing,
processed
Example:

"processed"

​
chunk_size
integer
default:512

Chunk size for embedding model

Example:

512

​
similarity_top_k
integer
default:15

Number of top similar nodes to return.

Example:

15

​
overlapping
integer
default:128

Number of characters which overlap in between neighboring nodes.

Example:

128

​
language_support
enum<string> | null

Language support mode of the knowledgebase. multilingual if enabled, null otherwise.

Available options:
multilingual
Example:

null