Skip to content
  • Auto
  • Light
  • Dark

Update

Update a Knowledge Base
put/v2/gen-ai/knowledge_bases/{uuid}

To update a knowledge base, send a PUT request to /v2/gen-ai/knowledge_bases/{uuid}.

Path Parameters
uuidstring
Body Parameters
database_idstring
optional

The id of the DigitalOcean database this knowledge base will use, optiona.

embedding_model_uuidstring
optional

Identifier for the foundation model.

namestring
optional

Knowledge base name

project_idstring
optional

The id of the DigitalOcean project this knowledge base will belong to

tagsarray of string
optional

Tags to organize your knowledge base.

uuidstring
optional

Knowledge base id

Returns
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 \
    -X PUT \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $GRADIENTAI_API_KEY"
200 Example
{
  "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\""
  }
}