Skip to main content
Server path: /gist-knowledge | Type: Application | PCID required: Yes

Tools


gist_knowledge_create_article

Create an article Parameters:
ParameterTypeRequiredDefaultDescription
parent_idintegerNoParent article ID
secondary_idsinteger[]NoSecondary collection IDs
translationsobjectYesTranslations keyed by locale. Each translation has: author_id (required), title (required), html_text (required), description (optional), status (required: published/draft)

gist_knowledge_create_collection

Create a collection Parameters:
ParameterTypeRequiredDefaultDescription
parent_idintegerNoParent collection ID
translationsobjectYesTranslations keyed by locale. Each has: name (required), description (required), icon (required)

gist_knowledge_delete_article

Delete an article Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesArticle ID

gist_knowledge_delete_collection

Delete a collection Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesCollection ID

gist_knowledge_get_article

Retrieve an article Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesArticle ID

gist_knowledge_get_collection

Retrieve a collection Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesCollection ID

gist_knowledge_get_knowledgebase_settings

Get knowledgebase settings

gist_knowledge_list_articles

List all articles Parameters:
ParameterTypeRequiredDefaultDescription
pageintegerNoPage number
per_pageintegerNoResults per page (max 60)
orderstringNoSort order
order_bystringNoSort field (default: created_at)
statusstringNoFilter by status
collection_idstringNoFilter by collection ID
author_idstringNoFilter by author ID

gist_knowledge_list_collections

List all collections Parameters:
ParameterTypeRequiredDefaultDescription
pageintegerNoPage number
per_pageintegerNoResults per page (max 60)
orderstringNoSort order
order_bystringNoSort field

gist_knowledge_search_articles

Search articles Parameters:
ParameterTypeRequiredDefaultDescription
search_textstringYesSearch query text
localestringNoLocale to search in
pageintegerNoPage number
per_pageintegerNoResults per page (max 60)
orderstringNoSort order
order_bystringNoSort field

gist_knowledge_update_article

Update an article Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesArticle ID
default_localestringNoDefault locale
parent_idintegerNoParent article ID
secondary_idsinteger[]NoSecondary collection IDs
translationsobjectNoTranslations keyed by locale

gist_knowledge_update_collection

Update a collection Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesCollection ID
descriptionstringNoCollection description
iconstringNoCollection icon
namestringNoCollection name
parent_idintegerNoParent collection ID
translationsobjectNoTranslations keyed by locale