# Knowledge Bases

## Create

**post** `/v2/gen-ai/knowledge_bases`

To create a knowledge base, send a POST request to `/v2/gen-ai/knowledge_bases`.

### Returns

- **knowledge\_base:** `APIKnowledgeBase`

  Knowledgebase Description

## Retrieve

**get** `/v2/gen-ai/knowledge_bases/{uuid}`

To retrive information about an existing knowledge base, send a GET request to `/v2/gen-ai/knowledge_bases/{uuid}`.

### Returns

- **database\_status:** `"CREATING" OR "ONLINE" OR "POWEROFF" OR 9 more`

  - `"CREATING"`

  - `"ONLINE"`

  - `"POWEROFF"`

  - `"REBUILDING"`

  - `"REBALANCING"`

  - `"DECOMMISSIONED"`

  - `"FORKING"`

  - `"MIGRATING"`

  - `"RESIZING"`

  - `"RESTORING"`

  - `"POWERING_ON"`

  - `"UNHEALTHY"`

- **knowledge\_base:** `APIKnowledgeBase`

  Knowledgebase Description

## Update

**put** `/v2/gen-ai/knowledge_bases/{uuid}`

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

### Returns

- **knowledge\_base:** `APIKnowledgeBase`

  Knowledgebase Description

## List

**get** `/v2/gen-ai/knowledge_bases`

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

### Returns

- **knowledge\_bases:** `array of APIKnowledgeBase`

  The knowledge bases

- **links:** `APILinks`

  Links to other pages

- **meta:** `APIMeta`

  Meta information about the data set

## Delete

**delete** `/v2/gen-ai/knowledge_bases/{uuid}`

To delete a knowledge base, send a DELETE request to `/v2/gen-ai/knowledge_bases/{uuid}`.

### Returns

- **uuid:** `string`

  The id of the deleted knowledge base

## Domain Types

### API Knowledge Base

- **APIKnowledgeBase:** `object`

  Knowledgebase Description

  - **added\_to\_agent\_at:** `string`

    Time when the knowledge base was added to the agent

  - **created\_at:** `string`

    Creation date / time

  - **database\_id:** `string`

  - **embedding\_model\_uuid:** `string`

  - **is\_public:** `boolean`

    Whether the knowledge base is public or not

  - **last\_indexing\_job:** `APIIndexingJob`

    IndexingJob description

  - **name:** `string`

    Name of knowledge base

  - **project\_id:** `string`

  - **region:** `string`

    Region code

  - **tags:** `array of string`

    Tags to organize related resources

  - **updated\_at:** `string`

    Last modified

  - **user\_id:** `string`

    Id of user that created the knowledge base

  - **uuid:** `string`

    Unique id for knowledge base