KB | Giant Context

KB

Manage knowledge base articles and categories.

GET

Get one article including its full content tree, status, SEO and category ids

/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 os2from giantcontext import GiantContext3
4gc = GiantContext(api_key=os.environ["GIANTCONTEXT_API_KEY"])5
6orgs = gc.me.list_my_organizations()7org_id = orgs.items[0].id8
9projects = gc.projects.list_projects(organization_id=org_id)10project_id = projects.items[0].id11
12app_id = "your_app_id"13article_id = "your_article_id"14
15article = gc.kb.get_kb_article(16    organization_id=org_id,17    project_id=project_id,18    app_id=app_id,19    article_id=article_id20)21

DELETE

Delete KB article

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

Soft-deletes a knowledge base article by moving it to the trash. Also removes the article from the AI knowledge base. Returns 404 if the article does not exist or is already deleted.

Parameters

organizationIdRequired

path · string

projectIdRequired

path · string

appIdRequired

path · string

articleIdRequired

path · string

SDK

1import os2from giantcontext import GiantContext3
4gc = GiantContext(api_key=os.environ["GIANTCONTEXT_API_KEY"])5
6orgs = gc.me.list_my_organizations()7org_id = orgs.items[0].id8
9projects = gc.projects.list_projects(organization_id=org_id)10project_id = projects.items[0].id11
12apps = gc.projects.list_project_apps(organization_id=org_id, project_id=project_id)13app_id = apps.items[0].id14
15articles = gc.kb.list_kb_articles(16    organization_id=org_id,17    project_id=project_id,18    app_id=app_id19)20article_id = articles.items[0].id21
22result = gc.kb.delete_kb_article(23    organization_id=org_id,24    project_id=project_id,25    app_id=app_id,26    article_id=article_id27)28

PATCH

Update an article's name, title, slug, SEO fields, excerpt, tags and featured image; cannot publish or edit content

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

Updates the fields that describe a knowledge base article rather than govern it: SEO title, description, image and noindex, plus the excerpt, tags and featured image. Only the fields you send are changed. Can rebind the layout, header and footer. Cannot change the article's content, status, visibility, order or category assignments — use publishContent to take it live.

Parameters

organizationIdRequired

path · string

projectIdRequired

path · string

appIdRequired

path · string

articleIdRequired

path · string

BodyRequired

seo

object

name

stringInternal use only

slug

stringThe URL segment. Changing this MOVES the public URL: a redirect from the old path to the new one is recorded automatically, so existing links keep working, but anything quoting the old URL verbatim (a printed link, an external citation) now travels one hop. Must be unique within the app — a collision is a 409, not a silent rename.

tags

array

title

unionWhat a reader sees, per locale. Send a locale map like {"en": "..."} on a multilingual project; check the project's enabledLocales with getProject first. Falls back to name where unset.

excerpt

union

footerId

unionThe footer this renders with. Discover ids with listWebsiteFooters. Null unbinds and falls back to the app default.

headerId

unionThe header this renders with. Discover ids with listWebsiteHeaders. Null unbinds and falls back to the app default.

layoutId

unionThe layout this renders inside. Discover ids with listWebsiteLayouts. Null unbinds and falls back to the app default.

websiteAppId

unionThe website app whose shell this borrows. Discover ids with listProjectApps (appType website).

featuredImageUrl

unionFeatured image, stored as a file reference (file:{uuid}) and resolved to a serving URL at render. Set it to a project file's reference, not a resolved URL — a URL is not recorded as in-use in core.file_references and could be deleted out from under the article.

SDK

1import os2from giantcontext import GiantContext3
4gc = GiantContext(api_key=os.environ["GIANTCONTEXT_API_KEY"])5
6orgs = gc.me.list_my_organizations()7org_id = orgs.items[0].id8
9projects = gc.projects.list_projects()10project_id = projects.items[0].id11
12result = gc.kb.update_kb_article_meta(13    organization_id=org_id,14    project_id=project_id,15    app_id="app_id_placeholder",16    article_id="article_id_placeholder",17    data={"meta_key": "meta_value"}18)19

GET

List articles in one KB app, newest first; pass lite=true to omit huge content

/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 · numberPage number to return, 1-indexed. Defaults to 1.

pageSize

query · numberItems per page (1-100). Defaults to 10.

lite

query · stringWhen 'true', return only essential fields (id, slug, title/name) to reduce payload size. Useful for context fetching and link resolution.

sort

query · stringSort specifier as 'field:direction'. Sortable fields: name, slug, status, isPublic, createdAt, updatedAt, publishedAt. Direction is 'asc' or 'desc' and defaults to 'asc'.

query · stringFree-text search. Matched against: name, slug.

name

query · stringFilter by name. Operators: name=value (equals), name_ne, name_gt, name_gte, name_lt, name_lte, name_like (contains), name_isnull=true|false, name_has=value (jsonb array contains), name[]=a&name[]=b (in).

slug

query · stringFilter by slug. Operators: slug=value (equals), slug_ne, slug_gt, slug_gte, slug_lt, slug_lte, slug_like (contains), slug_isnull=true|false, slug_has=value (jsonb array contains), slug[]=a&slug[]=b (in).

status

query · stringFilter by status. Operators: status=value (equals), status_ne, status_gt, status_gte, status_lt, status_lte, status_like (contains), status_isnull=true|false, status_has=value (jsonb array contains), status[]=a&status[]=b (in).

isPublic

query · stringFilter by isPublic. Operators: isPublic=value (equals), isPublic_ne, isPublic_gt, isPublic_gte, isPublic_lt, isPublic_lte, isPublic_like (contains), isPublic_isnull=true|false, isPublic_has=value (jsonb array contains), isPublic[]=a&isPublic[]=b (in).

categoryId

query · stringFilter by categoryId. Operators: categoryId=value (equals), categoryId_ne, categoryId_gt, categoryId_gte, categoryId_lt, categoryId_lte, categoryId_like (contains), categoryId_isnull=true|false, categoryId_has=value (jsonb array contains), categoryId[]=a&categoryId[]=b (in).

createdAt

query · stringFilter by createdAt. Operators: createdAt=value (equals), createdAt_ne, createdAt_gt, createdAt_gte, createdAt_lt, createdAt_lte, createdAt_like (contains), createdAt_isnull=true|false, createdAt_has=value (jsonb array contains), createdAt[]=a&createdAt[]=b (in).

updatedAt

query · stringFilter by updatedAt. Operators: updatedAt=value (equals), updatedAt_ne, updatedAt_gt, updatedAt_gte, updatedAt_lt, updatedAt_lte, updatedAt_like (contains), updatedAt_isnull=true|false, updatedAt_has=value (jsonb array contains), updatedAt[]=a&updatedAt[]=b (in).

publishedAt

query · stringFilter by publishedAt. Operators: publishedAt=value (equals), publishedAt_ne, publishedAt_gt, publishedAt_gte, publishedAt_lt, publishedAt_lte, publishedAt_like (contains), publishedAt_isnull=true|false, publishedAt_has=value (jsonb array contains), publishedAt[]=a&publishedAt[]=b (in).

organizationIdRequired

path · string

projectIdRequired

path · string

appIdRequired

path · string

SDK

1import os2from giantcontext import GiantContext3
4gc = GiantContext(api_key=os.environ["GIANTCONTEXT_API_KEY"])5
6orgs = gc.me.list_my_organizations()7org = orgs.items[0]8
9projects = gc.projects.list_projects(organization_id=org.id)10project = projects.items[0]11
12apps = gc.projects.list_project_apps(organization_id=org.id, project_id=project.id)13app = apps.items[0]14
15articles = gc.kb.list_kb_articles(16    organization_id=org.id,17    project_id=project.id,18    app_id=app.id19)20

POST

Create an article shell; publishing with content also ingests it for AI chat

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

Creates a new knowledge base article in the specified app. Validates slug uniqueness, automatically assigns display order, and optionally associates the article with categories. If the article is created with 'published' status and has content, it is automatically ingested into the AI knowledge base for search and retrieval.

Parameters

organizationIdRequired

path · string

projectIdRequired

path · string

appIdRequired

path · string

BodyRequired

seo

object

nameRequired

string

slugRequired

string

tags

array

order

number

title

any

status

union

content

array

excerpt

any

footerId

union

headerId

union

isPublic

boolean

layoutId

union

categoryIds

array

websiteAppId

union

featuredImageUrl

SDK

1import os2from giantcontext import GiantContext3
4gc = GiantContext(api_key=os.environ["GIANTCONTEXT_API_KEY"])5
6orgs = gc.me.list_my_organizations()7org_id = orgs.items[0].id8
9projects = gc.projects.list_projects()10project_id = projects.items[0].id11
12article = gc.kb.create_kb_article(13    organization_id=org_id,14    project_id=project_id,15    app_id="app_123",16    data={"title": "My KB Article", "content": "Article content here"}17)18

GET

Get one category's name, slug, description, parent and order; not its articles

/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 os2from giantcontext import GiantContext3
4gc = GiantContext(api_key=os.environ["GIANTCONTEXT_API_KEY"])5
6orgs = gc.me.list_my_organizations()7org_id = orgs.items[0].id8
9projects = gc.projects.list_projects(organization_id=org_id)10project_id = projects.items[0].id11
12category = gc.kb.get_kb_category(13    organization_id=org_id,14    project_id=project_id,15    app_id="your_app_id",16    category_id="your_category_id"17)18

DELETE

Delete KB category

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

Soft-deletes a knowledge base category by moving it to the trash. Returns 404 if the category does not exist or is already deleted.

Parameters

organizationIdRequired

path · string

projectIdRequired

path · string

appIdRequired

path · string

categoryIdRequired

path · string

SDK

1import os2from giantcontext import GiantContext3
4gc = GiantContext(api_key=os.environ["GIANTCONTEXT_API_KEY"])5
6orgs = gc.me.list_my_organizations()7projects = gc.projects.list_projects(organization_id=orgs.items[0].id)8
9result = gc.kb.delete_kb_category(10    organization_id=orgs.items[0].id,11    project_id=projects.items[0].id,12    app_id="your_app_id",13    category_id="your_category_id"14)15

PATCH

Update a category's name and description; cannot re-slug, reorder or re-parent it

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

Updates a knowledge base category's name and its description, the blurb shown beneath it in listings and on its own page. Only the fields you send are changed. A category has no separate title, so name IS the label a reader sees, and it is translatable. Cannot change the category's slug or icon, reorder it, or move it in the hierarchy — a category slug sits in the public path of every article beneath it and re-slugging leaves no redirect.

Parameters

organizationIdRequired

path · string

projectIdRequired

path · string

appIdRequired

path · string

categoryIdRequired

path · string

BodyRequired

name

unionThe category label a reader sees, per locale. Categories have no separate title: this IS the public string. Send a locale map like {"en": "..."} on a multilingual project.

description

union

SDK

1import os2from giantcontext import GiantContext3
4gc = GiantContext(api_key=os.environ["GIANTCONTEXT_API_KEY"])5
6orgs = gc.me.list_my_organizations()7org_id = orgs.items[0].id8
9projects = gc.projects.list_projects(organization_id=org_id)10project_id = projects.items[0].id11
12result = gc.kb.update_kb_category_meta(13    organization_id=org_id,14    project_id=project_id,15    app_id="app_123",16    category_id="cat_123",17    data={"key": "value"}18)19

GET

List a KB app's categories as a nested parent-child tree, roots paginated

/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

page

query · numberPage number to return, 1-indexed. Defaults to 1.

pageSize

query · numberItems per page (1-100). Defaults to 10.

lite

query · stringWhen 'true', return only essential fields (id, slug, title/name) to reduce payload size. Useful for context fetching and link resolution.

sort

query · stringSort specifier as 'field:direction'. Sortable fields: name, slug, order, createdAt, updatedAt. Direction is 'asc' or 'desc' and defaults to 'asc'.

query · stringFree-text search. Matched against: name, slug, description.

slug

icon

query · stringFilter by icon. Operators: icon=value (equals), icon_ne, icon_gt, icon_gte, icon_lt, icon_lte, icon_like (contains), icon_isnull=true|false, icon_has=value (jsonb array contains), icon[]=a&icon[]=b (in).

organizationIdRequired

path · string

projectIdRequired

path · string

appIdRequired

path · string

SDK

1import os2from giantcontext import GiantContext3
4gc = GiantContext(api_key=os.environ["GIANTCONTEXT_API_KEY"])5
6orgs = gc.me.list_my_organizations()7org_id = orgs.items[0].id8
9projects = gc.projects.list_projects(organization_id=org_id)10project_id = projects.items[0].id11
12apps = gc.projects.list_project_apps(organization_id=org_id, project_id=project_id)13app_id = apps.items[0].id14
15categories = gc.kb.list_kb_categories(16    organization_id=org_id,17    project_id=project_id,18    app_id=app_id19)20

POST

Create a category, optionally nested under a parent; order assigned automatically

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

Creates a new knowledge base category in the specified app. Validates slug uniqueness, automatically assigns display order among sibling categories, and supports hierarchical nesting via the parentId field. Categories are used to organize articles within the knowledge base.

Parameters

organizationIdRequired

path · string

projectIdRequired

path · string

appIdRequired

path · string

BodyRequired

icon

union

nameRequired

any

slugRequired

string

order

number

parentId

union

description

any

SDK

1import os2from giantcontext import GiantContext3
4gc = GiantContext(api_key=os.environ["GIANTCONTEXT_API_KEY"])5
6orgs = gc.me.list_my_organizations()7org = orgs.items[0]8
9projects = gc.projects.list_projects(organization_id=org.id)10project = projects.items[0]11
12apps = gc.projects.list_project_apps(13    organization_id=org.id,14    project_id=project.id15)16app = apps.items[0]17
18category = gc.kb.create_kb_category(19    organization_id=org.id,20    project_id=project.id,21    app_id=app.id,22    data={"name": "New Category"}23)24

PATCH

Update knowledge base landing page metadata

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

Updates the SEO title, description and image of the knowledge base landing page. Only the fields you send are changed. Can rebind its website, layout, header and footer. Cannot replace the landing's builder content or change its visibility.

Parameters

organizationIdRequired

path · string

projectIdRequired

path · string

appIdRequired

path · string

BodyRequired

seo

object

footerId

unionThe footer this renders with. Discover ids with listWebsiteFooters. Null unbinds and falls back to the app default.

headerId

unionThe header this renders with. Discover ids with listWebsiteHeaders. Null unbinds and falls back to the app default.

layoutId

unionThe layout this renders inside. Discover ids with listWebsiteLayouts. Null unbinds and falls back to the app default.

websiteAppId

unionThe website app whose shell this landing borrows. Discover ids with listProjectApps (appType website).

SDK

1import os2from giantcontext import GiantContext3
4gc = GiantContext(api_key=os.environ["GIANTCONTEXT_API_KEY"])5
6orgs = gc.me.list_my_organizations()7org_id = orgs.items[0].id8
9projects = gc.projects.list_projects(organization_id=org_id)10project_id = projects.items[0].id11
12result = gc.kb.update_kb_landing_meta(13    organization_id=org_id,14    project_id=project_id,15    app_id="app_id_placeholder",16    data={"key": "value"}17)18

GET

Get one URL redirect by id

/organizations/{organizationId}/projects/{projectId}/apps/kb/{appId}/redirects/{redirectId}

Returns a single URL redirect by ID, including its fromPath, toPath, status and source.

Parameters

organizationIdRequired

path · string

projectIdRequired

path · string

appIdRequired

path · string

redirectIdRequired

path · string

SDK

1import os2from giantcontext import GiantContext3
4gc = GiantContext(api_key=os.environ["GIANTCONTEXT_API_KEY"])5
6orgs = gc.me.list_my_organizations()7projects = gc.projects.list_projects(organization_id=orgs.items[0].id)8
9redirect = gc.kb.get_kb_redirect(10    organization_id=orgs.items[0].id,11    project_id=projects.items[0].id,12    app_id="app_id",13    redirect_id="redirect_id"14)15

GET

List a knowledge base's URL redirects, newest first, with from, to, status and source

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

Returns a paginated list of the URL redirects for this knowledge base app. Each maps an old path (fromPath) to the current path (toPath) with a status (301 or 308) and a source: auto (recorded when a slug changed) or manual (added by hand).

Parameters

page

query · numberPage number to return, 1-indexed. Defaults to 1.

pageSize

query · numberItems per page (1-100). Defaults to 10.

lite

query · stringWhen 'true', return only essential fields (id, slug, title/name) to reduce payload size. Useful for context fetching and link resolution.

sort

query · stringSort specifier as 'field:direction'. Sortable fields: fromPath, toPath, source, status, createdAt, updatedAt. Direction is 'asc' or 'desc' and defaults to 'asc'.

query · stringFree-text search. Matched against: fromPath, toPath.

source

query · stringFilter by source. Operators: source=value (equals), source_ne, source_gt, source_gte, source_lt, source_lte, source_like (contains), source_isnull=true|false, source_has=value (jsonb array contains), source[]=a&source[]=b (in).

status

createdAt

updatedAt

organizationIdRequired

path · string

projectIdRequired

path · string

appIdRequired

path · string

SDK

1import os2from giantcontext import GiantContext3
4gc = GiantContext(api_key=os.environ["GIANTCONTEXT_API_KEY"])5
6org = gc.me.list_my_organizations().items[0]7project = gc.projects.list_projects(organization_id=org.id).items[0]8app = gc.projects.list_project_apps(organization_id=org.id, project_id=project.id).items[0]9
10redirects = gc.kb.list_kb_redirects(11    organization_id=org.id,12    project_id=project.id,13    app_id=app.id14)15

BuiltAutonomously With AI

This content was built autonomously. Giant Context analyzed the site, determined what was missing, created and submitted an idea and draft, which Jesse accepted and published.