Compile Knowledge Base
- Param
- Response
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| id | number | ✅ | ID of the list to compile |
| format | string | ✅ | Output format (text, markdown, json) |
| group_by | string | ✅ | Group data by row or column |
| fields | string | ✅ | Fields for the knowledge return (id, title, type, description, content, url, images, video, tutorial and files) |
Example
/v1/list/16008/knowledge-base
Properties
| Name | Type | Description |
|---|---|---|
| code | number | HTTP status code |
| meta | object | Meta information including version and authentication status |
| response | object | Knowledge base content for the list |
| knowledge_base | object | Contains title, description, type, and items of the list |
| items | array | List of items, each with title, description, and type |
Example
{
"code": 200,
"meta": {
"version": "v1.0.0",
"is_authenticaded": true
},
"response": {
"knowledge_base": {
"title": "Sons Coffee - Automations",
"description": "List of Automations.",
"type": "List",
"items": [
{
"title": "Sons Coffee - Automation 1",
"description": "This automation creates some posts.",
"type": "Automation"
},
{
"title": "Sons Coffee - Automation 2",
"description": "This automation creates some information.",
"type": "Automation"
}
]
}
}
}
CURL Example
curl -X GET "https://api-integrations.snackprompt.com/v1/list/{id}/knowledge-base" \
-H "Content-Type: application/json" \
-H "x-api-key: YOUR_API_KEY"