Dynamiq
Knowledge Bases

Update a knowledge base

Updates a knowledge base. Supplying workflow_version_id publishes that ingestion-workflow version as the knowledge base's active configuration; description and runtime_id can be updated alongside it.

PUT
/v1/knowledgebases/{knowledgebase_id}

Authorization

personalAccessToken
AuthorizationBearer <token>

Personal Access Token of a Dynamiq user — the only credential accepted by the management API (api.*). Prefix dyn_pat_ (legacy uak_ tokens still authenticate). Send as Authorization: Bearer <token>.

In: header

Path Parameters

knowledgebase_id*string

Knowledge base UUID.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Body for PUT /v1/knowledgebases/{knowledgebase_id}.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X PUT "https://example.com/v1/knowledgebases/497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Content-Type: application/json" \  -d '{    "workflow_version_id": "60bab57e-9f59-448d-bef4-a6fd602db8a4"  }'
{
  "data": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string",
    "description": "string",
    "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
    "workflow_id": "03e70e31-d7a4-4401-a629-6a4b6096cdfe",
    "workflow_version_id": "60bab57e-9f59-448d-bef4-a6fd602db8a4",
    "runtime_id": "cb6c5dda-251e-4b64-ab75-e6c8247ffa87",
    "hostname": "string",
    "vector_store_id": "fde8ce2d-425a-4f9f-ac16-b00440677b44",
    "runtime": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "version": "string",
      "label": "string"
    },
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z",
    "created_by": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "first_name": "string",
      "last_name": "string",
      "avatar_url": "string"
    },
    "updated_by": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "first_name": "string",
      "last_name": "string",
      "avatar_url": "string"
    }
  }
}
{
  "error": {
    "code": "bad_request",
    "message": "Bad Request",
    "details": {
      "input": "cannot be blank"
    }
  }
}
{
  "error": {
    "code": "unauthorized",
    "message": "Unauthorized"
  }
}
{
  "error": {
    "code": "forbidden",
    "message": "Forbidden"
  }
}
{
  "error": {
    "code": "not_found",
    "message": "Not Found"
  }
}

Delete a knowledge base

Deletes a knowledge base along with its items, sources, and indexed documents.

Search knowledge base documents

Performs a semantic search over the knowledge base's documents using the knowledge base's configured embedder and retriever. Served on the knowledge base's own hostname (returned in the `hostname` field of the knowledge base resource).