Retrieve
Retrieve Information About an Existing Knowledge Base
get/v2/gen-ai/knowledge_bases/{uuid}
To retrive information about an existing knowledge base, send a GET request to /v2/gen-ai/knowledge_bases/{uuid}.
Path Parameters
uuidstring
Returns
database_statusenum
optional
"CREATING" OR "ONLINE" OR "POWEROFF" OR 9 more
knowledge_baseadded_to_agent_atstringcreated_atstringdatabase_idstringembedding_model_uuidstringis_publicbooleanlast_indexing_jobAPIIndexingJobnamestringproject_idstringregionstringtagsarray of stringupdated_atstringuser_idstringuuidstringAPIKnowledgeBase
optional
Knowledgebase Description
curl https://api.digitalocean.com//v2/gen-ai/knowledge_bases/$UUID \
-H "Authorization: Bearer $GRADIENTAI_API_KEY"200 Example
{
"database_status": "CREATING",
"knowledge_base": {
"added_to_agent_at": "2023-01-01T00:00:00Z",
"created_at": "2023-01-01T00:00:00Z",
"database_id": "\"123e4567-e89b-12d3-a456-426614174000\"",
"embedding_model_uuid": "\"123e4567-e89b-12d3-a456-426614174000\"",
"is_public": true,
"last_indexing_job": {
"completed_datasources": 123,
"created_at": "2023-01-01T00:00:00Z",
"data_source_uuids": [
"example string"
],
"finished_at": "2023-01-01T00:00:00Z",
"knowledge_base_uuid": "\"123e4567-e89b-12d3-a456-426614174000\"",
"phase": "BATCH_JOB_PHASE_UNKNOWN",
"started_at": "2023-01-01T00:00:00Z",
"status": "INDEX_JOB_STATUS_UNKNOWN",
"tokens": 123,
"total_datasources": 123,
"updated_at": "2023-01-01T00:00:00Z",
"uuid": "\"123e4567-e89b-12d3-a456-426614174000\""
},
"name": "\"example name\"",
"project_id": "\"123e4567-e89b-12d3-a456-426614174000\"",
"region": "\"example string\"",
"tags": [
"example string"
],
"updated_at": "2023-01-01T00:00:00Z",
"user_id": "user_id",
"uuid": "\"123e4567-e89b-12d3-a456-426614174000\""
}
}