Skip to content

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.

formatint64
per_pagenumber
optional

items per page.

formatint64
Returns
knowledge_basesarray of added_to_agent_atstringcreated_atstringdatabase_idstringembedding_model_uuidstringis_publicbooleanlast_indexing_jobAPIIndexingJobnamestringproject_idstringregionstringtagsarray of stringupdated_atstringuser_idstringuuidstringAPIKnowledgeBase
optional
metapagenumberpagesnumbertotalnumberAPIMeta
optional
Request example cURL
curl https://api.digitalocean.com//v2/gen-ai/knowledge_bases \
    -H "Authorization: Bearer $GRADIENTAI_API_KEY"
200 Example
{
  "knowledge_bases": [
    {
      "added_to_agent_at": "2019-12-27T18:11:19.117Z",
      "created_at": "2019-12-27T18:11:19.117Z",
      "database_id": "database_id",
      "embedding_model_uuid": "embedding_model_uuid",
      "is_public": true,
      "last_indexing_job": {
        "completed_datasources": 0,
        "created_at": "2019-12-27T18:11:19.117Z",
        "data_source_uuids": [
          "string"
        ],
        "finished_at": "2019-12-27T18:11:19.117Z",
        "knowledge_base_uuid": "knowledge_base_uuid",
        "phase": "BATCH_JOB_PHASE_UNKNOWN",
        "started_at": "2019-12-27T18:11:19.117Z",
        "status": "INDEX_JOB_STATUS_UNKNOWN",
        "tokens": 0,
        "total_datasources": 0,
        "updated_at": "2019-12-27T18:11:19.117Z",
        "uuid": "uuid"
      },
      "name": "name",
      "project_id": "project_id",
      "region": "region",
      "tags": [
        "string"
      ],
      "updated_at": "2019-12-27T18:11:19.117Z",
      "user_id": "user_id",
      "uuid": "uuid"
    }
  ],
  "links": {
    "pages": {
      "first": "first",
      "last": "last",
      "next": "next",
      "previous": "previous"
    }
  },
  "meta": {
    "page": 0,
    "pages": 0,
    "total": 0
  }
}