Skip to main content
GET
/
v1
/
knowledge-bases
/
{knowledge_base_id}
Get knowledge base details
curl --request GET \
  --url https://api.callrounded.com/v1/knowledge-bases/{knowledge_base_id} \
  --header 'X-Api-Key: <api-key>'
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "status": "ingesting",
    "organization_id": "123e4567-e89b-12d3-a456-426614174001",
    "sources": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "created_at": "2023-11-07T05:31:56Z",
        "file_name": "<string>",
        "file_url": "<string>",
        "type": "file"
      }
    ]
  },
  "message": "Knowledge base retrieved successfully",
  "error": {
    "details": [
      {
        "field": "email",
        "message": "Invalid email format"
      }
    ],
    "message": "An error occurred while processing your request",
    "status": 400,
    "type": "generic_error"
  },
  "status": 200
}

Authorizations

​
X-Api-Key
string
header
required

The API Key created in Rounded Studio.

Path Parameters

​
knowledge_base_id
string<uuid>
required

Response

Successfully retrieved knowledge base information

​
data
KnowledgeBaseGetApiResponseData · object
required

The knowledge base data retrieved.

​
message
string
default:Knowledge base retrieved successfully

Response message indicating the result of the operation.

​
error
ApiResponseError · object
Example:
{
  "details": [
    {
      "field": "email",
      "message": "Invalid email format"
    }
  ],
  "message": "An error occurred while processing your request",
  "status": 400,
  "type": "generic_error"
}
​
status
integer
default:200

HTTP status code of the response.