---
title: "Preview"
slug: "server-api-kb-preview"
updated: 2022-06-16T08:00:29Z
published: 2022-06-16T08:00:29Z
canonical: "developer.comm100.com/server-api-kb-preview"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://developer.comm100.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Preview

## Preview

- `Previews` - Previews Manage
  - `GET kb/previews` - [Get the list of Previews](/docs/server-api-kb-preview#get-the-list-of-previews)
  - `GET kb/previews/{id}` - [Get a single Preview](/docs/server-api-kb-preview#get-a-single-preview)
  - `POST kb/previews` - [Create a new Preview](/docs/server-api-kb-preview#create-a-new-preview)
  - `PUT kb/previews/{id}` - [Update the Preview](/docs/server-api-kb-preview#update-the-preview)
  - `DELETE kb/previews/{id}` - [Remove the Preview](/docs/server-api-kb-preview#remove-the-preview)

### Preview JSON Format

Preview is represented as simple flat JSON objects with the following keys:

| Name | Type | Description |
| --- | --- | --- |
| `entityName` | string |  |
| `data` | string |  |
| `id` | guid |  |

### Get the list of Previews

`GET kb/previews`

- #### Parameters:

No Parameters

- #### Response:

An array of [Preview](/docs/server-api-kb-preview#preview-json-format)

- #### Example

Sample Request:

```
curl https://api11.comm100.io/v4/kb/previews \ 
    -X 'GET' \ 
    -H 'Authorization: Bearer {access_token}' \
```

Response:

HTTP/1.1 200 OK

```
[
  {
      "entityName": "",
      "data": "",
      "id": "04669ee3-1dd5-4558-bc42-412a9426b4fa"
  }
]
```

### Get a single Preview

`GET kb/previews/{id}`

- #### Parameters:

No Parameters

- #### Response:

[Preview](/docs/server-api-kb-preview#preview-json-format)

- #### Example

Sample Request:

```
curl https://api11.comm100.io/v4/kb/previews/04669ee3-1dd5-4558-bc42-412a9426b4fa \ 
    -X 'GET' \ 
    -H 'Authorization: Bearer {access_token}' \
```

Response:

HTTP/1.1 200 OK

```
{
  "entityName": "",
  "data": "",
  "id": "04669ee3-1dd5-4558-bc42-412a9426b4fa"
}
```

### Create a new Preview

`POST kb/previews`

- #### Parameters:

| Name | Type | in | Required | Description |
| --- | --- | --- | --- | --- |
| `entityName` | string | body | yes |  |
| `data` | string | body | yes |  |

- #### Response:

[Preview](/docs/server-api-kb-preview#preview-json-format)

- #### Example

Sample Request:

```
curl https://api11.comm100.io/v4/kb/previews \ 
    -X 'POST' \ 
    -H 'Authorization: Bearer {access_token}' \ 
    -H 'Content-Type: application/json' \ 
    -D '{"entityName":"","data":""}'
```

Response:

HTTP/1.1 201 Created

```
{
  "entityName": "",
  "data": "",
  "id": "04669ee3-1dd5-4558-bc42-412a9426b4fa"
}
```

### Update the Preview

`PUT kb/previews/{id}`

- #### Parameters:

| Name | Type | in | Required | Description |
| --- | --- | --- | --- | --- |
| `entityName` | string | body | yes |  |
| `data` | string | body | yes |  |

- #### Response:

[Preview](/docs/server-api-kb-preview#preview-json-format)

- #### Example

Sample Request:

```
curl https://api11.comm100.io/v4/kb/previews/04669ee3-1dd5-4558-bc42-412a9426b4fa \ 
    -X 'PUT' \ 
    -H 'Authorization: Bearer {access_token}' \ 
    -H 'Content-Type: application/json' \ 
    -D '{"entityName":"","data":""}'
```

Response:

HTTP/1.1 200 OK

```
{
  "entityName": "",
  "data": "",
  "id": "04669ee3-1dd5-4558-bc42-412a9426b4fa"
}
```

### Remove the Preview

`DELETE kb/previews/{id}`

- #### Parameters:

No Parameters

- #### Response:

No Content

- #### Example

Sample Request:

```
curl https://api11.comm100.io/v4/kb/previews/04669ee3-1dd5-4558-bc42-412a9426b4fa \ 
    -X 'DELETE' \ 
    -H 'Authorization: Bearer {access_token}' \
```

Response:

HTTP/1.1 204 No Content