Skip to content
Gradient SDK Docs
  • Auto
  • Light
  • Dark

List

List Knowledge Bases
get/v2/gen-ai/knowledge_bases

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

Query Parameters
pagenumber
optional

Page number.

per_pagenumber
optional

Items per page.

Returns
knowledge_basesarray of added_to_agent_atstringcreated_atstringdatabase_idstringembedding_model_uuidstringis_publicbooleanlast_indexing_jobAPIIndexingJobnamestringproject_idstringregionstringtagsarray of stringupdated_atstringuser_idstringuuidstringAPIKnowledgeBase
optional

The knowledge bases

metapagenumberpagesnumbertotalnumberAPIMeta
optional

Meta information about the data set

curl https://api.digitalocean.com//v2/gen-ai/knowledge_bases \
    -H "Authorization: Bearer $GRADIENTAI_API_KEY"
200 Example
{
  "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_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\""
    }
  ],
  "links": {
    "pages": {
      "first": "\"example string\"",
      "last": "\"example string\"",
      "next": "\"example string\"",
      "previous": "\"example string\""
    }
  },
  "meta": {
    "page": 123,
    "pages": 123,
    "total": 123
  }
}