KB

Manage knowledge base articles and categories.

GET

Get KB article

/organizations/{organizationId}/projects/{projectId}/apps/kb/{appId}/articles/{articleId}

Retrieves a single knowledge base article by its ID, including its full rich text content, publish status, SEO metadata, and associated category IDs. Returns 404 if the article does not exist or has been soft-deleted.

Parameters

organizationIdRequired

path · string

projectIdRequired

path · string

appIdRequired

path · string

articleIdRequired

path · string

SDK

1import { createGiantContext } from "@giantcontext/sdk-typescript";2
3const gc = createGiantContext({ apiKey: process.env.GIANTCONTEXT_API_KEY! });4
5const { data: article } = await gc.kb.getKbArticle({6  organizationId: "org_123",7  projectId: "proj_123",8  appId: "app_123",9  articleId: "art_123"10});

GET

Get KB articles

/organizations/{organizationId}/projects/{projectId}/apps/kb/{appId}/articles

Lists all knowledge base articles for the specified app, with support for pagination, filtering by category, filtering by publish status, and full-text search across names and slugs. Returns articles sorted by creation date (newest first) by default.

Parameters

page

query · number

pageSize

query · number

categoryId

query · string

status

query · union

query · string

lite

query · stringWhen 'true', return only essential fields (id, name, slug, status) without content/excerpt/seo.

organizationIdRequired

path · string

projectIdRequired

path · string

appIdRequired

path · string

SDK

1import { createGiantContext } from "@giantcontext/sdk-typescript";2
3const gc = createGiantContext({ apiKey: process.env.GIANTCONTEXT_API_KEY! });4
5const organizationId = "org_123";6const projectId = "proj_123";7const appId = "app_123";8
9const { data: articles } = await gc.kb.listKbArticles({ organizationId, projectId, appId });

GET

Get KB category

/organizations/{organizationId}/projects/{projectId}/apps/kb/{appId}/categories/{categoryId}

Retrieves a single knowledge base category by its ID, including its name, slug, description, parent relationship, icon, and display order. Returns 404 if the category does not exist or has been soft-deleted.

Parameters

organizationIdRequired

path · string

projectIdRequired

path · string

appIdRequired

path · string

categoryIdRequired

path · string

SDK

1import { createGiantContext } from "@giantcontext/sdk-typescript";2
3const gc = createGiantContext({ apiKey: process.env.GIANTCONTEXT_API_KEY! });4
5const { data: category } = await gc.kb.getKbCategory({6  organizationId: "org-id",7  projectId: "project-id",8  appId: "app-id",9  categoryId: "category-id"10});

GET

Get KB categories

/organizations/{organizationId}/projects/{projectId}/apps/kb/{appId}/categories

Lists all knowledge base categories for the specified app, returned as a hierarchical tree structure. Categories are nested under their parent categories and sorted by their display order. Includes all active (non-deleted) categories.

Parameters

organizationIdRequired

path · string

projectIdRequired

path · string

appIdRequired

path · string

SDK

1import { createGiantContext } from "@giantcontext/sdk-typescript";2
3const gc = createGiantContext({ apiKey: process.env.GIANTCONTEXT_API_KEY! });4
5const { data: categories } = await gc.kb.listKbCategories({6  organizationId: "org_123",7  projectId: "proj_123",8  appId: "app_123"9});

GET

Get KB settings

/organizations/{organizationId}/projects/{projectId}/apps/kb/{appId}/settings

Retrieves the current configuration settings for the knowledge base app, including display preferences, branding, and behavioral options stored as a JSON settings object on the app record.

Parameters

organizationIdRequired

path · string

projectIdRequired

path · string

appIdRequired

path · string

SDK

1import { createGiantContext } from "@giantcontext/sdk-typescript";2
3const gc = createGiantContext({ apiKey: process.env.GIANTCONTEXT_API_KEY! });4
5const { data: kbSettings } = await gc.kb.getKbSettings({6  organizationId: "org-id",7  projectId: "project-id",8  appId: "app-id"9});

Built byHuman

This content was designed and written by a human.