Glossary and knowledge API

On this page

Manage glossary concepts, column classifications, and business knowledge. See Glossary and Knowledge.

Paths are relative to https://<your-atlas-host>/api/v1. For the API key and headers every request needs, see Authentication.

Scroll horizontally to see the full table.

Endpoint	What it does
POST /knowledge/glossary	Create a new glossary concept
GET /knowledge/glossary	List glossary concepts for a workspace
GET /knowledge/glossary/effective	Get a workspace’s effective glossary, with workspace overrides resolved
GET /knowledge/glossary/search	Search glossary concepts by name, alias, or definition
GET /knowledge/glossary/activity	The current organization’s glossary change feed (newest first)
GET /knowledge/glossary/activity/heatmap	Glossary change volume bucketed by day × event kind
GET /knowledge/glossary/{concept_id}	Get a glossary concept by ID
PATCH /knowledge/glossary/{concept_id}	Update a glossary concept
DELETE /knowledge/glossary/{concept_id}	Delete a glossary concept
GET /knowledge/glossary/{concept_id}/revisions	Full change history for one concept (snapshots + per-field diffs)
POST /knowledge/glossary/{concept_id}/request-promotion	Request approval to promote a workspace concept to the organizational glossary
POST /knowledge/glossary/{concept_id}/activate	Activate a glossary concept
POST /knowledge/glossary/{concept_id}/deprecate	Deprecate a glossary concept
POST /knowledge/glossary/{concept_id}/override	Create a workspace override of a standard concept
POST /knowledge/glossary/{concept_id}/promote	Promote an organizational concept to the standard glossary
POST /knowledge/glossary/bulk-enrich	Start background AI enrichment for the given concepts
POST /knowledge/pipeline/{datasource_id}	Trigger the semantic classification pipeline for a data source
GET /knowledge/topology/{collection_id}	Get the detected schema topology for a collection
GET /knowledge/topology/datasource/{datasource_id}	List all topologies for a data source (one per collection)
GET /knowledge/classifications/{asset_id}	List column classifications for a data asset
POST /knowledge/classifications/{classification_id}/approve	Approve a column classification
POST /knowledge/classifications/{classification_id}/reject	Reject and delete a column classification
POST /knowledge/business	Create a business knowledge item
GET /knowledge/business	List business knowledge items for the current workspace
GET /knowledge/business/search	Search business knowledge items
GET /knowledge/business/{knowledge_id}	Get a business knowledge item by ID
PATCH /knowledge/business/{knowledge_id}	Update a business knowledge item
DELETE /knowledge/business/{knowledge_id}	Delete a business knowledge item
POST /knowledge/business/{knowledge_id}/confirm	Confirm a detected business knowledge item
POST /knowledge/business/{knowledge_id}/archive	Archive a business knowledge item
POST /knowledge/business/{knowledge_id}/merge	Merge this item (source) into `target_id`, then delete the source
POST /knowledge/business/bulk-confirm	Confirm several business knowledge items at once
POST /knowledge/business/bulk-archive	Archive several business knowledge items at once
POST /knowledge/business/extraction	Trigger warehouse business-knowledge extraction for a datasource

Create glossary concept

POST /knowledge/glossary

Create a new glossary concept.

Request body

Scroll horizontally to see the full table.

Field	Type	Required	Description
`tenant_id`	UUID		Your organization’s ID, with no `workspace_id`: an organizational concept.
`workspace_id`	UUID		Set to make the concept specific to this workspace.
`canonical_name`	string	Yes	Stable machine name, such as `ctr`, used in formulas. Cannot change later.
`display_name`	string	Yes
`definition`	string		Plain-language business definition. Changing it reclassifies matching columns.
`category`	string		Concept type: `metric`, `dimension`, `identifier`, `timestamp` or `text`.
`parent_id`	UUID		A parent concept, used only to arrange concepts in a hierarchy.
`aliases`	list of string		Other names for the concept, such as `spend`, used when matching columns.
`platforms`	list of string		Platform tags, such as `google_ads`, limiting where the concept applies. Empty means everywhere.
`expression`	string		Formula for a calculated metric over other concepts’ canonical names, such as `clicks / NULLIF(impressions, 0)`. Empty for a base concept.
`overrides_id`	UUID		The less specific concept this one replaces in its scope.

Response

Scroll horizontally to see the full table.

Field	Type
`id`	UUID
`tenant_id`	UUID
`workspace_id`	UUID
`overrides_id`	UUID
`canonical_name`	string
`display_name`	string
`definition`	string
`category`	string
`parent_id`	UUID
`aliases`	list of string
`platforms`	list of string
`expression`	string
`status`	string
`replaced_by_id`	UUID
`is_standard`	boolean
`is_organizational`	boolean
`is_workspace_specific`	boolean
`is_override`	boolean
`behavior`	object
`platform_variants`	list of object
`sources`	list of object
`created_at`	datetime
`updated_at`	datetime
`is_global`	boolean
`is_tenant_wide`	boolean

List glossary concepts

GET /knowledge/glossary

List glossary concepts for a workspace.

Parameters

Scroll horizontally to see the full table.

Name	In	Type	Required
`workspace_id`	query	UUID	Yes
`status`	query	string
`category`	query	string

Response A list of objects:

Scroll horizontally to see the full table.

Field	Type
`id`	UUID
`tenant_id`	UUID
`workspace_id`	UUID
`overrides_id`	UUID
`canonical_name`	string
`display_name`	string
`definition`	string
`category`	string
`parent_id`	UUID
`aliases`	list of string
`platforms`	list of string
`expression`	string
`status`	string
`replaced_by_id`	UUID
`is_standard`	boolean
`is_organizational`	boolean
`is_workspace_specific`	boolean
`is_override`	boolean
`behavior`	object
`platform_variants`	list of object
`sources`	list of object
`created_at`	datetime
`updated_at`	datetime
`is_global`	boolean
`is_tenant_wide`	boolean

Get effective glossary

GET /knowledge/glossary/effective

Get a workspace’s effective glossary, with workspace overrides resolved.

Parameters

Scroll horizontally to see the full table.

Name	In	Type	Required
`workspace_id`	query	UUID	Yes
`platforms`	query	string

Response A list of objects:

Scroll horizontally to see the full table.

Field	Type
`id`	UUID
`tenant_id`	UUID
`workspace_id`	UUID
`overrides_id`	UUID
`canonical_name`	string
`display_name`	string
`definition`	string
`category`	string
`parent_id`	UUID
`aliases`	list of string
`platforms`	list of string
`expression`	string
`status`	string
`replaced_by_id`	UUID
`is_standard`	boolean
`is_organizational`	boolean
`is_workspace_specific`	boolean
`is_override`	boolean
`behavior`	object
`platform_variants`	list of object
`sources`	list of object
`created_at`	datetime
`updated_at`	datetime
`is_global`	boolean
`is_tenant_wide`	boolean

Search glossary

GET /knowledge/glossary/search

Search glossary concepts by name, alias, or definition.

Parameters

Scroll horizontally to see the full table.

Name	In	Type	Required
`workspace_id`	query	UUID	Yes
`q`	query	string	Yes
`limit`	query	integer

Response A list of objects:

Scroll horizontally to see the full table.

Field	Type
`id`	UUID
`tenant_id`	UUID
`workspace_id`	UUID
`overrides_id`	UUID
`canonical_name`	string
`display_name`	string
`definition`	string
`category`	string
`parent_id`	UUID
`aliases`	list of string
`platforms`	list of string
`expression`	string
`status`	string
`replaced_by_id`	UUID
`is_standard`	boolean
`is_organizational`	boolean
`is_workspace_specific`	boolean
`is_override`	boolean
`behavior`	object
`platform_variants`	list of object
`sources`	list of object
`created_at`	datetime
`updated_at`	datetime
`is_global`	boolean
`is_tenant_wide`	boolean

Glossary activity feed

GET /knowledge/glossary/activity

The current organization’s glossary change feed (newest first).

Parameters

Scroll horizontally to see the full table.

Name	In	Type
`event_kind`	query	string
`tier`	query	string
`category`	query	string
`actor_type`	query	string
`actor_source`	query	string
`workspace_id`	query	UUID
`include_standard`	query	boolean
`include_global`	query	boolean
`time_from`	query	datetime
`time_to`	query	datetime
`limit`	query	integer
`offset`	query	integer

Response A list of objects:

Scroll horizontally to see the full table.

Field	Type
`id`	UUID
`resource_id`	UUID
`resource_name`	string
`canonical_name`	string
`scope`	`standard`, `organizational`, `workspace`
`tier`	string
`workspace_id`	UUID
`event_kind`	string
`summary`	string
`changed_fields`	list of string
`delta`	object
`snapshot`	object
`actor_id`	UUID
`actor_type`	string
`actor_email`	string
`actor_source`	string
`agent_run_id`	UUID
`created_at`	datetime

Glossary activity heatmap

GET /knowledge/glossary/activity/heatmap

Glossary change volume bucketed by day × event kind.

Parameters

Scroll horizontally to see the full table.

Name	In	Type
`workspace_id`	query	UUID
`include_standard`	query	boolean
`include_global`	query	boolean
`days`	query	integer

Response A list of objects:

Scroll horizontally to see the full table.

Field	Type
`day`	date
`event_kind`	string
`count`	integer

Get glossary concept

GET /knowledge/glossary/{concept_id}

Get a glossary concept by ID.

Parameters

Scroll horizontally to see the full table.

Name	In	Type	Required
`concept_id`	path	UUID	Yes

Response

Scroll horizontally to see the full table.

Field	Type
`id`	UUID
`tenant_id`	UUID
`workspace_id`	UUID
`overrides_id`	UUID
`canonical_name`	string
`display_name`	string
`definition`	string
`category`	string
`parent_id`	UUID
`aliases`	list of string
`platforms`	list of string
`expression`	string
`status`	string
`replaced_by_id`	UUID
`is_standard`	boolean
`is_organizational`	boolean
`is_workspace_specific`	boolean
`is_override`	boolean
`behavior`	object
`platform_variants`	list of object
`sources`	list of object
`created_at`	datetime
`updated_at`	datetime
`is_global`	boolean
`is_tenant_wide`	boolean

Update glossary concept

PATCH /knowledge/glossary/{concept_id}

Update a glossary concept.

Parameters

Scroll horizontally to see the full table.

Name	In	Type	Required
`concept_id`	path	UUID	Yes

Request body

Scroll horizontally to see the full table.

Field	Type	Description
`display_name`	string
`definition`	string	Plain-language business definition. Changing it reclassifies matching columns.
`category`	string	Concept type: `metric`, `dimension`, `identifier`, `timestamp` or `text`.
`parent_id`	UUID	A parent concept, used only to arrange concepts in a hierarchy.
`aliases`	list of string	Other names for the concept, such as `spend`, used when matching columns.
`platforms`	list of string	Platform tags, such as `google_ads`, limiting where the concept applies. Empty means everywhere.
`expression`	string	Formula for a calculated metric over other concepts’ canonical names, such as `clicks / NULLIF(impressions, 0)`. Empty for a base concept.
`behavior`	object	How the concept behaves in analysis; fields left out stay unchanged. `aggregation_type`: `sum`, `average`, `last`, `weighted_average` or `none`. `value_direction`: `higher_better`, `lower_better` or `neutral`. `output_format`: `currency`, `percentage`, `integer` or `decimal`. `typical_range`: such as `{"min": 0, "max": 1}`. `aggregation_warning`: guidance such as not summing a rate. `is_pii`: whether it holds personal data.

Response

Scroll horizontally to see the full table.

Field	Type
`id`	UUID
`tenant_id`	UUID
`workspace_id`	UUID
`overrides_id`	UUID
`canonical_name`	string
`display_name`	string
`definition`	string
`category`	string
`parent_id`	UUID
`aliases`	list of string
`platforms`	list of string
`expression`	string
`status`	string
`replaced_by_id`	UUID
`is_standard`	boolean
`is_organizational`	boolean
`is_workspace_specific`	boolean
`is_override`	boolean
`behavior`	object
`platform_variants`	list of object
`sources`	list of object
`created_at`	datetime
`updated_at`	datetime
`is_global`	boolean
`is_tenant_wide`	boolean

Delete glossary concept

DELETE /knowledge/glossary/{concept_id}

Delete a glossary concept.

Parameters

Scroll horizontally to see the full table.

Name	In	Type	Required
`concept_id`	path	UUID	Yes

Response

The raw file content.

List glossary concept revisions

GET /knowledge/glossary/{concept_id}/revisions

Full change history for one concept (snapshots + per-field diffs).

Parameters

Scroll horizontally to see the full table.

Name	In	Type	Required
`concept_id`	path	UUID	Yes
`workspace_id`	query	UUID
`limit`	query	integer
`offset`	query	integer

Response A list of objects:

Scroll horizontally to see the full table.

Field	Type
`id`	UUID
`resource_id`	UUID
`resource_name`	string
`canonical_name`	string
`scope`	`standard`, `organizational`, `workspace`
`tier`	string
`workspace_id`	UUID
`event_kind`	string
`summary`	string
`changed_fields`	list of string
`delta`	object
`snapshot`	object
`actor_id`	UUID
`actor_type`	string
`actor_email`	string
`actor_source`	string
`agent_run_id`	UUID
`created_at`	datetime

Request glossary concept promotion

POST /knowledge/glossary/{concept_id}/request-promotion

Request approval to promote a workspace concept to the organizational glossary.

Parameters

Scroll horizontally to see the full table.

Name	In	Type	Required
`concept_id`	path	UUID	Yes
`note`	query	string

Response

Scroll horizontally to see the full table.

Field	Type
`id`	UUID
`approval_type`	string
`status`	string
`title`	string
`description`	string
`action`	string
`action_params`	object
`required_approver_role`	`viewer`, `analyst`, `editor`, `knowledge_manager`, `admin`
`min_approvals`	integer
`expires_at`	datetime
`created_at`	datetime
`resolved_at`	datetime
`approval_count`	integer
`rejection_count`	integer

Activate glossary concept

POST /knowledge/glossary/{concept_id}/activate

Activate a glossary concept.

Parameters

Scroll horizontally to see the full table.

Name	In	Type	Required
`concept_id`	path	UUID	Yes

Response

Scroll horizontally to see the full table.

Field	Type
`id`	UUID
`tenant_id`	UUID
`workspace_id`	UUID
`overrides_id`	UUID
`canonical_name`	string
`display_name`	string
`definition`	string
`category`	string
`parent_id`	UUID
`aliases`	list of string
`platforms`	list of string
`expression`	string
`status`	string
`replaced_by_id`	UUID
`is_standard`	boolean
`is_organizational`	boolean
`is_workspace_specific`	boolean
`is_override`	boolean
`behavior`	object
`platform_variants`	list of object
`sources`	list of object
`created_at`	datetime
`updated_at`	datetime
`is_global`	boolean
`is_tenant_wide`	boolean

Deprecate glossary concept

POST /knowledge/glossary/{concept_id}/deprecate

Deprecate a glossary concept.

Parameters

Scroll horizontally to see the full table.

Name	In	Type	Required
`concept_id`	path	UUID	Yes

Response

Scroll horizontally to see the full table.

Field	Type
`id`	UUID
`tenant_id`	UUID
`workspace_id`	UUID
`overrides_id`	UUID
`canonical_name`	string
`display_name`	string
`definition`	string
`category`	string
`parent_id`	UUID
`aliases`	list of string
`platforms`	list of string
`expression`	string
`status`	string
`replaced_by_id`	UUID
`is_standard`	boolean
`is_organizational`	boolean
`is_workspace_specific`	boolean
`is_override`	boolean
`behavior`	object
`platform_variants`	list of object
`sources`	list of object
`created_at`	datetime
`updated_at`	datetime
`is_global`	boolean
`is_tenant_wide`	boolean

Create concept override

POST /knowledge/glossary/{concept_id}/override

Create a workspace override of a standard concept.

Parameters

Scroll horizontally to see the full table.

Name	In	Type	Required
`concept_id`	path	UUID	Yes
`workspace_id`	query	UUID	Yes

Response

Scroll horizontally to see the full table.

Field	Type
`id`	UUID
`tenant_id`	UUID
`workspace_id`	UUID
`overrides_id`	UUID
`canonical_name`	string
`display_name`	string
`definition`	string
`category`	string
`parent_id`	UUID
`aliases`	list of string
`platforms`	list of string
`expression`	string
`status`	string
`replaced_by_id`	UUID
`is_standard`	boolean
`is_organizational`	boolean
`is_workspace_specific`	boolean
`is_override`	boolean
`behavior`	object
`platform_variants`	list of object
`sources`	list of object
`created_at`	datetime
`updated_at`	datetime
`is_global`	boolean
`is_tenant_wide`	boolean

Promote concept

POST /knowledge/glossary/{concept_id}/promote

Promote an organizational concept to the standard glossary.

Parameters

Scroll horizontally to see the full table.

Name	In	Type	Required
`concept_id`	path	UUID	Yes

Response

Scroll horizontally to see the full table.

Field	Type
`id`	UUID
`tenant_id`	UUID
`workspace_id`	UUID
`overrides_id`	UUID
`canonical_name`	string
`display_name`	string
`definition`	string
`category`	string
`parent_id`	UUID
`aliases`	list of string
`platforms`	list of string
`expression`	string
`status`	string
`replaced_by_id`	UUID
`is_standard`	boolean
`is_organizational`	boolean
`is_workspace_specific`	boolean
`is_override`	boolean
`behavior`	object
`platform_variants`	list of object
`sources`	list of object
`created_at`	datetime
`updated_at`	datetime
`is_global`	boolean
`is_tenant_wide`	boolean

Bulk enrich concepts

POST /knowledge/glossary/bulk-enrich

Start background AI enrichment for the given concepts.

Request body

Scroll horizontally to see the full table.

Field	Type	Required
`concept_ids`	list of UUID	Yes

Response

The raw file content.

Run the classification pipeline

POST /knowledge/pipeline/{datasource_id}

Trigger the semantic classification pipeline for a data source.

Parameters

Scroll horizontally to see the full table.

Name	In	Type	Required
`datasource_id`	path	UUID	Yes

Response

The raw file content.

Get topology

GET /knowledge/topology/{collection_id}

Get the detected schema topology for a collection.

Parameters

Scroll horizontally to see the full table.

Name	In	Type	Required
`collection_id`	path	UUID	Yes

Response

Scroll horizontally to see the full table.

Field	Type
`id`	UUID
`collection_id`	UUID
`topology_type`	string
`context_strategy`	string
`platform_column`	string
`platform_signals`	object
`confidence`	number
`signals`	object
`detected_at`	datetime

List topologies

GET /knowledge/topology/datasource/{datasource_id}

List all topologies for a data source (one per collection).

Parameters

Scroll horizontally to see the full table.

Name	In	Type	Required
`datasource_id`	path	UUID	Yes

Response A list of objects:

Scroll horizontally to see the full table.

Field	Type
`id`	UUID
`collection_id`	UUID
`topology_type`	string
`context_strategy`	string
`platform_column`	string
`platform_signals`	object
`confidence`	number
`signals`	object
`detected_at`	datetime

List classifications

GET /knowledge/classifications/{asset_id}

List column classifications for a data asset.

Parameters

Scroll horizontally to see the full table.

Name	In	Type	Required
`asset_id`	path	UUID	Yes

Response A list of objects:

Scroll horizontally to see the full table.

Field	Type
`id`	UUID
`field_id`	UUID
`role`	string
`glossary_concept_id`	UUID
`concept_confidence`	number
`platform_context`	string
`classification_method`	string
`llm_reasoning`	string
`is_approved`	boolean
`approved_by`	string
`created_at`	datetime
`updated_at`	datetime

Approve classification

POST /knowledge/classifications/{classification_id}/approve

Approve a column classification.

Parameters

Scroll horizontally to see the full table.

Name	In	Type	Required
`classification_id`	path	UUID	Yes

Response

Scroll horizontally to see the full table.

Field	Type
`id`	UUID
`field_id`	UUID
`role`	string
`glossary_concept_id`	UUID
`concept_confidence`	number
`platform_context`	string
`classification_method`	string
`llm_reasoning`	string
`is_approved`	boolean
`approved_by`	string
`created_at`	datetime
`updated_at`	datetime

Reject classification

POST /knowledge/classifications/{classification_id}/reject

Reject and delete a column classification.

Parameters

Scroll horizontally to see the full table.

Name	In	Type	Required
`classification_id`	path	UUID	Yes

Response

The raw file content.

Create business knowledge

POST /knowledge/business

Create a business knowledge item.

Request body

Scroll horizontally to see the full table.

Field	Type	Required	Description
`knowledge_type`	`brand`, `market`, `product`, `audience_segment`, `naming_convention`, `funnel_mapping`, `business_rule`, `promoted_finding`, `org_context`, `note`, `design_system`, `slide_master`	Yes
`name`	string	Yes	Unique per knowledge type in its scope.
`summary`	string		Short summary the assistant sees when the item is retrieved; falls back to `content`.
`content`	string		Full text in Markdown. Can be empty when the data is in `properties`.
`usage_mode`	any		How the item reaches the assistant: `always` in every conversation, `auto` when relevant, `never` only through search. Applies to confirmed items.
`properties`	object		Fields specific to the knowledge type, checked against that type’s schema.
`confidence`	number		How certain the item is, from 0 to 1. A merge keeps the higher value.
`status`	any		`detected` (suggested, not reviewed), `confirmed`, or `archived`. Only confirmed items are used by the assistant.
`source_type`	any		Where the item came from: `manual`, `conversation`, `dwh_extraction` or `web_enrichment`.
`source_ref`	string		Reference to the source, such as a data source ID, conversation ID, or URL.
`evidence`	string		Reasoning or examples behind the item. Combined when items are merged.

Response

Scroll horizontally to see the full table.

Field	Type
`id`	UUID
`tenant_id`	UUID
`workspace_id`	UUID
`knowledge_type`	string
`category`	string
`name`	string
`summary`	string
`content`	string
`has_content`	boolean
`usage_mode`	string
`properties`	object
`confidence`	number
`status`	string
`source_type`	string
`source_ref`	string
`evidence`	string
`created_by_id`	UUID
`created_by_name`	string
`created_at`	datetime
`updated_at`	datetime

List business knowledge

GET /knowledge/business

List business knowledge items for the current workspace.

Parameters

Scroll horizontally to see the full table.

Name	In	Type
`knowledge_type`	query	string
`category`	query	string
`status`	query	string
`sort`	query	string
`limit`	query	integer

Response A list of objects:

Scroll horizontally to see the full table.

Field	Type
`id`	UUID
`tenant_id`	UUID
`workspace_id`	UUID
`knowledge_type`	string
`category`	string
`name`	string
`summary`	string
`content`	string
`has_content`	boolean
`usage_mode`	string
`properties`	object
`confidence`	number
`status`	string
`source_type`	string
`source_ref`	string
`evidence`	string
`created_by_id`	UUID
`created_by_name`	string
`created_at`	datetime
`updated_at`	datetime

Search business knowledge

GET /knowledge/business/search

Search business knowledge items.

Parameters

Scroll horizontally to see the full table.

Name	In	Type	Required
`q`	query	string	Yes
`knowledge_type`	query	string
`category`	query	string
`status`	query	string
`limit`	query	integer

Response A list of objects:

Scroll horizontally to see the full table.

Field	Type
`id`	UUID
`tenant_id`	UUID
`workspace_id`	UUID
`knowledge_type`	string
`category`	string
`name`	string
`summary`	string
`content`	string
`has_content`	boolean
`usage_mode`	string
`properties`	object
`confidence`	number
`status`	string
`source_type`	string
`source_ref`	string
`evidence`	string
`created_by_id`	UUID
`created_by_name`	string
`created_at`	datetime
`updated_at`	datetime

Get business knowledge

GET /knowledge/business/{knowledge_id}

Get a business knowledge item by ID.

Parameters

Scroll horizontally to see the full table.

Name	In	Type	Required
`knowledge_id`	path	UUID	Yes

Response

Scroll horizontally to see the full table.

Field	Type
`id`	UUID
`tenant_id`	UUID
`workspace_id`	UUID
`knowledge_type`	string
`category`	string
`name`	string
`summary`	string
`content`	string
`has_content`	boolean
`usage_mode`	string
`properties`	object
`confidence`	number
`status`	string
`source_type`	string
`source_ref`	string
`evidence`	string
`created_by_id`	UUID
`created_by_name`	string
`created_at`	datetime
`updated_at`	datetime

Update business knowledge

PATCH /knowledge/business/{knowledge_id}

Update a business knowledge item.

Parameters

Scroll horizontally to see the full table.

Name	In	Type	Required
`knowledge_id`	path	UUID	Yes

Request body

Scroll horizontally to see the full table.

Field	Type	Description
`name`	string
`summary`	string	Short summary the assistant sees when the item is retrieved; falls back to `content`.
`content`	string	Full text in Markdown. Can be empty when the data is in `properties`.
`usage_mode`	`always`, `auto`, `never`	How the item reaches the assistant: `always` in every conversation, `auto` when relevant, `never` only through search. Applies to confirmed items.
`properties`	object	Fields specific to the knowledge type, checked against that type’s schema.
`confidence`	number	How certain the item is, from 0 to 1. A merge keeps the higher value.
`status`	`detected`, `confirmed`, `archived`	`detected` (suggested, not reviewed), `confirmed`, or `archived`. Only confirmed items are used by the assistant.
`source_type`	`dwh_extraction`, `web_enrichment`, `conversation`, `manual`	Where the item came from: `manual`, `conversation`, `dwh_extraction` or `web_enrichment`.
`source_ref`	string	Reference to the source, such as a data source ID, conversation ID, or URL.
`evidence`	string	Reasoning or examples behind the item. Combined when items are merged.

Response

Scroll horizontally to see the full table.

Field	Type
`id`	UUID
`tenant_id`	UUID
`workspace_id`	UUID
`knowledge_type`	string
`category`	string
`name`	string
`summary`	string
`content`	string
`has_content`	boolean
`usage_mode`	string
`properties`	object
`confidence`	number
`status`	string
`source_type`	string
`source_ref`	string
`evidence`	string
`created_by_id`	UUID
`created_by_name`	string
`created_at`	datetime
`updated_at`	datetime

Delete business knowledge

DELETE /knowledge/business/{knowledge_id}

Delete a business knowledge item.

Parameters

Scroll horizontally to see the full table.

Name	In	Type	Required
`knowledge_id`	path	UUID	Yes

Response

The raw file content.

Confirm business knowledge

POST /knowledge/business/{knowledge_id}/confirm

Confirm a detected business knowledge item.

Parameters

Scroll horizontally to see the full table.

Name	In	Type	Required
`knowledge_id`	path	UUID	Yes

Response

Scroll horizontally to see the full table.

Field	Type
`id`	UUID
`tenant_id`	UUID
`workspace_id`	UUID
`knowledge_type`	string
`category`	string
`name`	string
`summary`	string
`content`	string
`has_content`	boolean
`usage_mode`	string
`properties`	object
`confidence`	number
`status`	string
`source_type`	string
`source_ref`	string
`evidence`	string
`created_by_id`	UUID
`created_by_name`	string
`created_at`	datetime
`updated_at`	datetime

Archive business knowledge

POST /knowledge/business/{knowledge_id}/archive

Archive a business knowledge item.

Parameters

Scroll horizontally to see the full table.

Name	In	Type	Required
`knowledge_id`	path	UUID	Yes

Response

Scroll horizontally to see the full table.

Field	Type
`id`	UUID
`tenant_id`	UUID
`workspace_id`	UUID
`knowledge_type`	string
`category`	string
`name`	string
`summary`	string
`content`	string
`has_content`	boolean
`usage_mode`	string
`properties`	object
`confidence`	number
`status`	string
`source_type`	string
`source_ref`	string
`evidence`	string
`created_by_id`	UUID
`created_by_name`	string
`created_at`	datetime
`updated_at`	datetime

Merge business knowledge

POST /knowledge/business/{knowledge_id}/merge

Merge this item (source) into target_id, then delete the source.

Parameters

Scroll horizontally to see the full table.

Name	In	Type	Required
`knowledge_id`	path	UUID	Yes

Request body

Scroll horizontally to see the full table.

Field	Type	Required
`target_id`	UUID	Yes

Response

Scroll horizontally to see the full table.

Field	Type
`id`	UUID
`tenant_id`	UUID
`workspace_id`	UUID
`knowledge_type`	string
`category`	string
`name`	string
`summary`	string
`content`	string
`has_content`	boolean
`usage_mode`	string
`properties`	object
`confidence`	number
`status`	string
`source_type`	string
`source_ref`	string
`evidence`	string
`created_by_id`	UUID
`created_by_name`	string
`created_at`	datetime
`updated_at`	datetime

Bulk confirm business knowledge

POST /knowledge/business/bulk-confirm

Confirm several business knowledge items at once.

Request body

Scroll horizontally to see the full table.

Field	Type	Required
`knowledge_ids`	list of UUID	Yes

Response

The raw file content.

Bulk archive business knowledge

POST /knowledge/business/bulk-archive

Archive several business knowledge items at once.

Request body

Scroll horizontally to see the full table.

Field	Type	Required
`knowledge_ids`	list of UUID	Yes

Response

The raw file content.

Run business extraction

POST /knowledge/business/extraction

Trigger warehouse business-knowledge extraction for a datasource.

Request body

Scroll horizontally to see the full table.

Field	Type	Required
`datasource_id`	UUID	Yes

Response

The raw file content.

What’s next?

API overview: authentication, worked examples, and error handling
Webhooks: get events pushed to your systems instead of polling
Service accounts: create the key an integration uses