Skip to content
DigitalOcean Gradient™ AI Agentic Cloud SDK Docs
  • Auto
  • Light
  • Dark

List

API Reference
Knowledge Bases
List Knowledge Bases
knowledge_bases.list(KnowledgeBaseListParams**kwargs) -> KnowledgeBaseListResponse
get/v2/gen-ai/knowledge_bases

To list all knowledge bases, send a GET request to /v2/gen-ai/knowledge_bases.

ParametersExpand Collapse
page: Optional[int]

Page number.

per_page: Optional[int]

Items per page.

ReturnsExpand Collapse
class KnowledgeBaseListResponse: …

List of knowledge bases

knowledge_bases: Optional[List[APIKnowledgeBase]]

The knowledge bases

added_to_agent_at: Optional[datetime]

Time when the knowledge base was added to the agent

formatdate-time
created_at: Optional[datetime]

Creation date / time

formatdate-time
database_id: Optional[str]
embedding_model_uuid: Optional[str]
is_public: Optional[bool]

Whether the knowledge base is public or not

last_indexing_job: Optional[APIIndexingJob]

IndexingJob description

completed_datasources: Optional[int]

Number of datasources indexed completed

formatint64
created_at: Optional[datetime]

Creation date / time

formatdate-time
data_source_jobs: Optional[List[APIIndexedDataSource]]

Details on Data Sources included in the Indexing Job

completed_at: Optional[datetime]

Timestamp when data source completed indexing

formatdate-time
data_source_uuid: Optional[str]

Uuid of the indexed data source

error_details: Optional[str]

A detailed error description

error_msg: Optional[str]

A string code provinding a hint which part of the system experienced an error

failed_item_count: Optional[str]

Total count of files that have failed

formatuint64
indexed_file_count: Optional[str]

Total count of files that have been indexed

formatuint64
indexed_item_count: Optional[str]

Total count of files that have been indexed

formatuint64
removed_item_count: Optional[str]

Total count of files that have been removed

formatuint64
skipped_item_count: Optional[str]

Total count of files that have been skipped

formatuint64
started_at: Optional[datetime]

Timestamp when data source started indexing

formatdate-time
status: Optional[Literal["DATA_SOURCE_STATUS_UNKNOWN", "DATA_SOURCE_STATUS_IN_PROGRESS", "DATA_SOURCE_STATUS_UPDATED", 4 more]]
Accepts one of the following:
"DATA_SOURCE_STATUS_UNKNOWN"
"DATA_SOURCE_STATUS_IN_PROGRESS"
"DATA_SOURCE_STATUS_UPDATED"
"DATA_SOURCE_STATUS_PARTIALLY_UPDATED"
"DATA_SOURCE_STATUS_NOT_UPDATED"
"DATA_SOURCE_STATUS_FAILED"
"DATA_SOURCE_STATUS_CANCELLED"
total_bytes: Optional[str]

Total size of files in data source in bytes

formatuint64
total_bytes_indexed: Optional[str]

Total size of files in data source in bytes that have been indexed

formatuint64
total_file_count: Optional[str]

Total file count in the data source

formatuint64
data_source_uuids: Optional[List[str]]
finished_at: Optional[datetime]
formatdate-time
is_report_available: Optional[bool]

Boolean value to determine if the indexing job details are available

knowledge_base_uuid: Optional[str]

Knowledge base id

phase: Optional[Literal["BATCH_JOB_PHASE_UNKNOWN", "BATCH_JOB_PHASE_PENDING", "BATCH_JOB_PHASE_RUNNING", 4 more]]
Accepts one of the following:
"BATCH_JOB_PHASE_UNKNOWN"
"BATCH_JOB_PHASE_PENDING"
"BATCH_JOB_PHASE_RUNNING"
"BATCH_JOB_PHASE_SUCCEEDED"
"BATCH_JOB_PHASE_FAILED"
"BATCH_JOB_PHASE_ERROR"
"BATCH_JOB_PHASE_CANCELLED"
started_at: Optional[datetime]
formatdate-time
status: Optional[Literal["INDEX_JOB_STATUS_UNKNOWN", "INDEX_JOB_STATUS_PARTIAL", "INDEX_JOB_STATUS_IN_PROGRESS", 4 more]]
Accepts one of the following:
"INDEX_JOB_STATUS_UNKNOWN"
"INDEX_JOB_STATUS_PARTIAL"
"INDEX_JOB_STATUS_IN_PROGRESS"
"INDEX_JOB_STATUS_COMPLETED"
"INDEX_JOB_STATUS_FAILED"
"INDEX_JOB_STATUS_NO_CHANGES"
"INDEX_JOB_STATUS_PENDING"
tokens: Optional[int]

Number of tokens [This field is deprecated]

formatint64
total_datasources: Optional[int]

Number of datasources being indexed

formatint64
total_items_failed: Optional[str]

Total Items Failed

formatuint64
total_items_indexed: Optional[str]

Total Items Indexed

formatuint64
total_items_removed: Optional[str]

Total Items Removed

formatuint64
total_items_skipped: Optional[str]

Total Items Skipped

formatuint64
total_tokens: Optional[str]

Total Tokens Consumed By the Indexing Job

formatuint64
updated_at: Optional[datetime]

Last modified

formatdate-time
uuid: Optional[str]

Unique id

name: Optional[str]

Name of knowledge base

project_id: Optional[str]
region: Optional[str]

Region code

tags: Optional[List[str]]

Tags to organize related resources

updated_at: Optional[datetime]

Last modified

formatdate-time
user_id: Optional[str]

Id of user that created the knowledge base

formatint64
uuid: Optional[str]

Unique id for knowledge base

meta: Optional[APIMeta]

Meta information about the data set

page: Optional[int]

The current page

formatint64
pages: Optional[int]

Total number of pages

formatint64
total: Optional[int]

Total amount of items over all pages

formatint64
List Knowledge Bases
  • http
  • typescript
  • python
from gradient import Gradient

client = Gradient(
    access_token="My Access Token",
)
knowledge_bases = client.knowledge_bases.list()
print(knowledge_bases.knowledge_bases)
{
  "knowledge_bases": [
    {
      "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_jobs": [
          {
            "completed_at": "2023-01-01T00:00:00Z",
            "data_source_uuid": "123e4567-e89b-12d3-a456-426614174000",
            "error_details": "example string",
            "error_msg": "example string",
            "failed_item_count": "12345",
            "indexed_file_count": "12345",
            "indexed_item_count": "12345",
            "removed_item_count": "12345",
            "skipped_item_count": "12345",
            "started_at": "2023-01-01T00:00:00Z",
            "status": "DATA_SOURCE_STATUS_UNKNOWN",
            "total_bytes": "12345",
            "total_bytes_indexed": "12345",
            "total_file_count": "12345"
          }
        ],
        "data_source_uuids": [
          "example string"
        ],
        "finished_at": "2023-01-01T00:00:00Z",
        "is_report_available": true,
        "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,
        "total_items_failed": "12345",
        "total_items_indexed": "12345",
        "total_items_removed": "12345",
        "total_items_skipped": "12345",
        "total_tokens": "12345",
        "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"
    }
  ],
  "links": {
    "pages": {
      "first": "example string",
      "last": "example string",
      "next": "example string",
      "previous": "example string"
    }
  },
  "meta": {
    "page": 123,
    "pages": 123,
    "total": 123
  }
}
Returns Examples
{
  "knowledge_bases": [
    {
      "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_jobs": [
          {
            "completed_at": "2023-01-01T00:00:00Z",
            "data_source_uuid": "123e4567-e89b-12d3-a456-426614174000",
            "error_details": "example string",
            "error_msg": "example string",
            "failed_item_count": "12345",
            "indexed_file_count": "12345",
            "indexed_item_count": "12345",
            "removed_item_count": "12345",
            "skipped_item_count": "12345",
            "started_at": "2023-01-01T00:00:00Z",
            "status": "DATA_SOURCE_STATUS_UNKNOWN",
            "total_bytes": "12345",
            "total_bytes_indexed": "12345",
            "total_file_count": "12345"
          }
        ],
        "data_source_uuids": [
          "example string"
        ],
        "finished_at": "2023-01-01T00:00:00Z",
        "is_report_available": true,
        "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,
        "total_items_failed": "12345",
        "total_items_indexed": "12345",
        "total_items_removed": "12345",
        "total_items_skipped": "12345",
        "total_tokens": "12345",
        "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"
    }
  ],
  "links": {
    "pages": {
      "first": "example string",
      "last": "example string",
      "next": "example string",
      "previous": "example string"
    }
  },
  "meta": {
    "page": 123,
    "pages": 123,
    "total": 123
  }
}