@graph8/sdk 0.251.0 → 0.262.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (350) hide show
  1. package/README.md +9 -2
  2. package/dist/cli.js +216 -0
  3. package/dist/index.d.mts +105 -7
  4. package/dist/index.d.ts +105 -7
  5. package/dist/index.js +44 -3
  6. package/dist/index.js.map +1 -1
  7. package/dist/index.mjs +44 -3
  8. package/dist/index.mjs.map +1 -1
  9. package/dist/react.d.mts +103 -7
  10. package/dist/react.d.ts +103 -7
  11. package/dist/react.js +62 -11
  12. package/dist/react.js.map +1 -1
  13. package/dist/react.mjs +53 -12
  14. package/dist/react.mjs.map +1 -1
  15. package/dist/types/README.md +7 -0
  16. package/dist/types/agency.d.ts +20 -0
  17. package/dist/types/agentSetup.d.ts +57 -0
  18. package/dist/types/api.d.ts +127 -0
  19. package/dist/types/appClient.d.ts +99 -0
  20. package/dist/types/appPlatform.d.ts +269 -0
  21. package/dist/types/appTokens.d.ts +125 -0
  22. package/dist/types/apps.d.ts +130 -0
  23. package/dist/types/audiences.d.ts +88 -0
  24. package/dist/types/calendar.d.ts +55 -0
  25. package/dist/types/campaigns.d.ts +61 -0
  26. package/dist/types/chat.d.ts +35 -0
  27. package/dist/types/cli.d.ts +14 -0
  28. package/dist/types/companies.d.ts +123 -0
  29. package/dist/types/contacts.d.ts +200 -0
  30. package/dist/types/copilot.d.ts +31 -0
  31. package/dist/types/core.d.ts +1052 -0
  32. package/dist/types/deals.d.ts +215 -0
  33. package/dist/types/enrich.d.ts +51 -0
  34. package/dist/types/fields.d.ts +84 -0
  35. package/dist/types/forms.d.ts +16 -0
  36. package/dist/types/http.d.ts +141 -0
  37. package/dist/types/inbox.d.ts +123 -0
  38. package/dist/types/index.d.ts +63 -0
  39. package/dist/types/intent.d.ts +196 -0
  40. package/dist/types/lists.d.ts +44 -0
  41. package/dist/types/mailboxes.d.ts +240 -0
  42. package/dist/types/marketplace.d.ts +62 -0
  43. package/dist/types/meetings.d.ts +70 -0
  44. package/dist/types/newsletter.d.ts +212 -0
  45. package/dist/types/notes.d.ts +57 -0
  46. package/dist/types/objects.d.ts +281 -0
  47. package/dist/types/pipelines.d.ts +135 -0
  48. package/dist/types/quotes.d.ts +143 -0
  49. package/dist/types/react.d.ts +978 -0
  50. package/dist/types/search.d.ts +99 -0
  51. package/dist/types/sequences.d.ts +255 -0
  52. package/dist/types/signals.d.ts +28 -0
  53. package/dist/types/skills.d.ts +176 -0
  54. package/dist/types/snippet.d.ts +24 -0
  55. package/dist/types/studio.d.ts +161 -0
  56. package/dist/types/tasks.d.ts +101 -0
  57. package/dist/types/types.d.ts +45 -0
  58. package/dist/types/utils.d.ts +21 -0
  59. package/dist/types/version.d.ts +10 -0
  60. package/dist/types/visitors.d.ts +29 -0
  61. package/dist/types/voice.d.ts +304 -0
  62. package/dist/types/webhooks.d.ts +71 -0
  63. package/dist/types/workflows.d.ts +229 -0
  64. package/docs/agents.md +748 -0
  65. package/docs/api/README.md +165 -0
  66. package/docs/api/accounts.d.ts +396 -0
  67. package/docs/api/accounts.md +644 -0
  68. package/docs/api/adCampaigns.d.ts +707 -0
  69. package/docs/api/adCampaigns.md +1091 -0
  70. package/docs/api/adCreatives.d.ts +996 -0
  71. package/docs/api/adCreatives.md +1708 -0
  72. package/docs/api/agency.d.ts +556 -0
  73. package/docs/api/agency.md +845 -0
  74. package/docs/api/agent.d.ts +330 -0
  75. package/docs/api/agent.md +514 -0
  76. package/docs/api/agents.d.ts +1622 -0
  77. package/docs/api/agents.md +2860 -0
  78. package/docs/api/aiInbox.d.ts +1984 -0
  79. package/docs/api/aiInbox.md +3490 -0
  80. package/docs/api/analytics.d.ts +1273 -0
  81. package/docs/api/analytics.md +2095 -0
  82. package/docs/api/apiKeys.d.ts +252 -0
  83. package/docs/api/apiKeys.md +318 -0
  84. package/docs/api/appDeployments.d.ts +236 -0
  85. package/docs/api/appDeployments.md +471 -0
  86. package/docs/api/appDomains.d.ts +171 -0
  87. package/docs/api/appDomains.md +281 -0
  88. package/docs/api/appLogs.d.ts +120 -0
  89. package/docs/api/appLogs.md +159 -0
  90. package/docs/api/appObjects.d.ts +415 -0
  91. package/docs/api/appObjects.md +568 -0
  92. package/docs/api/appPages.d.ts +557 -0
  93. package/docs/api/appPages.md +796 -0
  94. package/docs/api/appPlatformTokens.d.ts +123 -0
  95. package/docs/api/appPlatformTokens.md +172 -0
  96. package/docs/api/appointments.d.ts +2361 -0
  97. package/docs/api/appointments.md +3917 -0
  98. package/docs/api/apps.d.ts +822 -0
  99. package/docs/api/apps.md +1342 -0
  100. package/docs/api/assertUpsert.d.ts +286 -0
  101. package/docs/api/assertUpsert.md +370 -0
  102. package/docs/api/audienceSyncs.d.ts +259 -0
  103. package/docs/api/audienceSyncs.md +395 -0
  104. package/docs/api/brandKit.d.ts +686 -0
  105. package/docs/api/brandKit.md +1133 -0
  106. package/docs/api/bugReports.d.ts +181 -0
  107. package/docs/api/bugReports.md +268 -0
  108. package/docs/api/by-path.md +3260 -0
  109. package/docs/api/calendarInvites.d.ts +117 -0
  110. package/docs/api/calendarInvites.md +148 -0
  111. package/docs/api/campaignWorkflows.d.ts +152 -0
  112. package/docs/api/campaignWorkflows.md +200 -0
  113. package/docs/api/campaigns.d.ts +721 -0
  114. package/docs/api/campaigns.md +1236 -0
  115. package/docs/api/channels.d.ts +171 -0
  116. package/docs/api/channels.md +235 -0
  117. package/docs/api/cliCampaigns.d.ts +205 -0
  118. package/docs/api/cliCampaigns.md +256 -0
  119. package/docs/api/cliPipelines.d.ts +324 -0
  120. package/docs/api/cliPipelines.md +562 -0
  121. package/docs/api/clickHouse.d.ts +115 -0
  122. package/docs/api/clickHouse.md +138 -0
  123. package/docs/api/companies.d.ts +1636 -0
  124. package/docs/api/companies.md +2211 -0
  125. package/docs/api/companyIntelligence.d.ts +299 -0
  126. package/docs/api/companyIntelligence.md +488 -0
  127. package/docs/api/contacts.d.ts +2173 -0
  128. package/docs/api/contacts.md +3143 -0
  129. package/docs/api/content.d.ts +968 -0
  130. package/docs/api/content.md +1667 -0
  131. package/docs/api/contentGridSkills.d.ts +177 -0
  132. package/docs/api/contentGridSkills.md +271 -0
  133. package/docs/api/copilot.d.ts +1017 -0
  134. package/docs/api/copilot.md +1765 -0
  135. package/docs/api/crmSyncs.d.ts +215 -0
  136. package/docs/api/crmSyncs.md +301 -0
  137. package/docs/api/customerSuccess.d.ts +491 -0
  138. package/docs/api/customerSuccess.md +776 -0
  139. package/docs/api/deals.d.ts +1697 -0
  140. package/docs/api/deals.md +2436 -0
  141. package/docs/api/deliverability.d.ts +418 -0
  142. package/docs/api/deliverability.md +677 -0
  143. package/docs/api/desk.d.ts +1765 -0
  144. package/docs/api/desk.md +3007 -0
  145. package/docs/api/dialer.d.ts +1185 -0
  146. package/docs/api/dialer.md +2166 -0
  147. package/docs/api/dialerAnalytics.d.ts +187 -0
  148. package/docs/api/dialerAnalytics.md +257 -0
  149. package/docs/api/documents.d.ts +895 -0
  150. package/docs/api/documents.md +1440 -0
  151. package/docs/api/duplicates.d.ts +195 -0
  152. package/docs/api/duplicates.md +315 -0
  153. package/docs/api/eSign.d.ts +38 -0
  154. package/docs/api/eSign.md +54 -0
  155. package/docs/api/eSignature.d.ts +242 -0
  156. package/docs/api/eSignature.md +341 -0
  157. package/docs/api/enrichment.d.ts +3207 -0
  158. package/docs/api/enrichment.md +5225 -0
  159. package/docs/api/events.d.ts +115 -0
  160. package/docs/api/events.md +105 -0
  161. package/docs/api/fields.d.ts +482 -0
  162. package/docs/api/fields.md +566 -0
  163. package/docs/api/forms.d.ts +1012 -0
  164. package/docs/api/forms.md +1542 -0
  165. package/docs/api/gtmCampaigns.d.ts +662 -0
  166. package/docs/api/gtmCampaigns.md +1044 -0
  167. package/docs/api/gtmContext.d.ts +1187 -0
  168. package/docs/api/gtmContext.md +2112 -0
  169. package/docs/api/gtmDeliverability.d.ts +60 -0
  170. package/docs/api/gtmDeliverability.md +63 -0
  171. package/docs/api/gtmKnowledgeBase.d.ts +76 -0
  172. package/docs/api/gtmKnowledgeBase.md +91 -0
  173. package/docs/api/gtmLaunchHelpers.d.ts +123 -0
  174. package/docs/api/gtmLaunchHelpers.md +148 -0
  175. package/docs/api/gtmLibrary.d.ts +448 -0
  176. package/docs/api/gtmLibrary.md +780 -0
  177. package/docs/api/health.d.ts +39 -0
  178. package/docs/api/health.md +58 -0
  179. package/docs/api/imageLibrary.d.ts +341 -0
  180. package/docs/api/imageLibrary.md +569 -0
  181. package/docs/api/imports.d.ts +157 -0
  182. package/docs/api/imports.md +174 -0
  183. package/docs/api/inbox.d.ts +709 -0
  184. package/docs/api/inbox.md +1067 -0
  185. package/docs/api/install.d.ts +213 -0
  186. package/docs/api/install.md +317 -0
  187. package/docs/api/installedApps.d.ts +131 -0
  188. package/docs/api/installedApps.md +241 -0
  189. package/docs/api/integrationStatus.d.ts +142 -0
  190. package/docs/api/integrationStatus.md +205 -0
  191. package/docs/api/integrations.d.ts +2327 -0
  192. package/docs/api/integrations.md +3791 -0
  193. package/docs/api/intent.d.ts +482 -0
  194. package/docs/api/intent.md +858 -0
  195. package/docs/api/knowledge.d.ts +501 -0
  196. package/docs/api/knowledge.md +843 -0
  197. package/docs/api/knowledgeBase.d.ts +84 -0
  198. package/docs/api/knowledgeBase.md +96 -0
  199. package/docs/api/landingPages.d.ts +1411 -0
  200. package/docs/api/landingPages.md +2488 -0
  201. package/docs/api/leads.d.ts +133 -0
  202. package/docs/api/leads.md +180 -0
  203. package/docs/api/library.d.ts +217 -0
  204. package/docs/api/library.md +338 -0
  205. package/docs/api/linkedIn.d.ts +227 -0
  206. package/docs/api/linkedIn.md +289 -0
  207. package/docs/api/linkedInOutreach.d.ts +727 -0
  208. package/docs/api/linkedInOutreach.md +990 -0
  209. package/docs/api/lists.d.ts +1106 -0
  210. package/docs/api/lists.md +1609 -0
  211. package/docs/api/logs.d.ts +71 -0
  212. package/docs/api/logs.md +70 -0
  213. package/docs/api/mailboxes.d.ts +1050 -0
  214. package/docs/api/mailboxes.md +1690 -0
  215. package/docs/api/marketingIntelligence.d.ts +256 -0
  216. package/docs/api/marketingIntelligence.md +454 -0
  217. package/docs/api/marketplace.d.ts +3173 -0
  218. package/docs/api/marketplace.md +5953 -0
  219. package/docs/api/mcp.d.ts +69 -0
  220. package/docs/api/mcp.md +69 -0
  221. package/docs/api/me.d.ts +54 -0
  222. package/docs/api/me.md +56 -0
  223. package/docs/api/meetings.d.ts +539 -0
  224. package/docs/api/meetings.md +747 -0
  225. package/docs/api/newsletter.d.ts +1613 -0
  226. package/docs/api/newsletter.md +2746 -0
  227. package/docs/api/notes.d.ts +517 -0
  228. package/docs/api/notes.md +888 -0
  229. package/docs/api/notifications.d.ts +94 -0
  230. package/docs/api/notifications.md +105 -0
  231. package/docs/api/objects.d.ts +621 -0
  232. package/docs/api/objects.md +1098 -0
  233. package/docs/api/openSearch.d.ts +234 -0
  234. package/docs/api/openSearch.md +297 -0
  235. package/docs/api/ops.d.ts +299 -0
  236. package/docs/api/ops.md +339 -0
  237. package/docs/api/orgGovernance.d.ts +393 -0
  238. package/docs/api/orgGovernance.md +623 -0
  239. package/docs/api/orgVideos.d.ts +184 -0
  240. package/docs/api/orgVideos.md +252 -0
  241. package/docs/api/organizationSettings.d.ts +626 -0
  242. package/docs/api/organizationSettings.md +911 -0
  243. package/docs/api/phoneNumbers.d.ts +484 -0
  244. package/docs/api/phoneNumbers.md +777 -0
  245. package/docs/api/profile.d.ts +329 -0
  246. package/docs/api/profile.md +540 -0
  247. package/docs/api/programmaticPages.d.ts +400 -0
  248. package/docs/api/programmaticPages.md +626 -0
  249. package/docs/api/providerDomains.d.ts +866 -0
  250. package/docs/api/providerDomains.md +1446 -0
  251. package/docs/api/providerUsage.d.ts +129 -0
  252. package/docs/api/providerUsage.md +186 -0
  253. package/docs/api/public.d.ts +69 -0
  254. package/docs/api/public.md +78 -0
  255. package/docs/api/publicCopilot.d.ts +67 -0
  256. package/docs/api/publicCopilot.md +80 -0
  257. package/docs/api/publicSignals.d.ts +66 -0
  258. package/docs/api/publicSignals.md +71 -0
  259. package/docs/api/publicVisitors.d.ts +97 -0
  260. package/docs/api/publicVisitors.md +118 -0
  261. package/docs/api/quotes.d.ts +1564 -0
  262. package/docs/api/quotes.md +2553 -0
  263. package/docs/api/radar.d.ts +808 -0
  264. package/docs/api/radar.md +1431 -0
  265. package/docs/api/radarReports.d.ts +208 -0
  266. package/docs/api/radarReports.md +306 -0
  267. package/docs/api/recordRoles.d.ts +143 -0
  268. package/docs/api/recordRoles.md +175 -0
  269. package/docs/api/repos.d.ts +146 -0
  270. package/docs/api/repos.md +211 -0
  271. package/docs/api/research.d.ts +295 -0
  272. package/docs/api/research.md +534 -0
  273. package/docs/api/revenue.d.ts +402 -0
  274. package/docs/api/revenue.md +608 -0
  275. package/docs/api/revenueAnalytics.d.ts +147 -0
  276. package/docs/api/revenueAnalytics.md +212 -0
  277. package/docs/api/revenueLifecycle.d.ts +207 -0
  278. package/docs/api/revenueLifecycle.md +274 -0
  279. package/docs/api/revenueRecords.d.ts +372 -0
  280. package/docs/api/revenueRecords.md +563 -0
  281. package/docs/api/roles.d.ts +431 -0
  282. package/docs/api/roles.md +812 -0
  283. package/docs/api/salesCoach.d.ts +877 -0
  284. package/docs/api/salesCoach.md +1540 -0
  285. package/docs/api/sandbox.d.ts +210 -0
  286. package/docs/api/sandbox.md +380 -0
  287. package/docs/api/scans.d.ts +104 -0
  288. package/docs/api/scans.md +136 -0
  289. package/docs/api/scheduleBuy.d.ts +293 -0
  290. package/docs/api/scheduleBuy.md +431 -0
  291. package/docs/api/scraping.d.ts +266 -0
  292. package/docs/api/scraping.md +383 -0
  293. package/docs/api/sdrAnalytics.d.ts +138 -0
  294. package/docs/api/sdrAnalytics.md +246 -0
  295. package/docs/api/search.d.ts +598 -0
  296. package/docs/api/search.md +866 -0
  297. package/docs/api/seo.d.ts +447 -0
  298. package/docs/api/seo.md +660 -0
  299. package/docs/api/sequenceLifecycle.d.ts +439 -0
  300. package/docs/api/sequenceLifecycle.md +513 -0
  301. package/docs/api/sequences.d.ts +1936 -0
  302. package/docs/api/sequences.md +3232 -0
  303. package/docs/api/settings.d.ts +448 -0
  304. package/docs/api/settings.md +731 -0
  305. package/docs/api/signals.d.ts +1441 -0
  306. package/docs/api/signals.md +2526 -0
  307. package/docs/api/signatures.d.ts +719 -0
  308. package/docs/api/signatures.md +1247 -0
  309. package/docs/api/skills.d.ts +230 -0
  310. package/docs/api/skills.md +466 -0
  311. package/docs/api/snippet.d.ts +85 -0
  312. package/docs/api/snippet.md +106 -0
  313. package/docs/api/socialPublishing.d.ts +824 -0
  314. package/docs/api/socialPublishing.md +1245 -0
  315. package/docs/api/studioDocuments.d.ts +244 -0
  316. package/docs/api/studioDocuments.md +348 -0
  317. package/docs/api/support.d.ts +90 -0
  318. package/docs/api/support.md +76 -0
  319. package/docs/api/suppressions.d.ts +241 -0
  320. package/docs/api/suppressions.md +343 -0
  321. package/docs/api/surveys.d.ts +847 -0
  322. package/docs/api/surveys.md +1223 -0
  323. package/docs/api/tasks.d.ts +813 -0
  324. package/docs/api/tasks.md +1344 -0
  325. package/docs/api/teamMembers.d.ts +668 -0
  326. package/docs/api/teamMembers.md +1040 -0
  327. package/docs/api/teams.d.ts +784 -0
  328. package/docs/api/teams.md +1395 -0
  329. package/docs/api/usage.d.ts +277 -0
  330. package/docs/api/usage.md +389 -0
  331. package/docs/api/visitors.d.ts +690 -0
  332. package/docs/api/visitors.md +1075 -0
  333. package/docs/api/voice.d.ts +4661 -0
  334. package/docs/api/voice.md +7905 -0
  335. package/docs/api/webAnalytics.d.ts +964 -0
  336. package/docs/api/webAnalytics.md +1452 -0
  337. package/docs/api/webChat.d.ts +1704 -0
  338. package/docs/api/webChat.md +2048 -0
  339. package/docs/api/webhooks.d.ts +251 -0
  340. package/docs/api/webhooks.md +386 -0
  341. package/docs/api/websiteEditor.d.ts +324 -0
  342. package/docs/api/websiteEditor.md +517 -0
  343. package/docs/api/work.d.ts +2298 -0
  344. package/docs/api/work.md +3096 -0
  345. package/docs/api/workbench.d.ts +2962 -0
  346. package/docs/api/workbench.md +4884 -0
  347. package/docs/api/workflows.d.ts +1218 -0
  348. package/docs/api/workflows.md +2302 -0
  349. package/docs/sdk-clients.md +4339 -0
  350. package/package.json +10 -3
@@ -0,0 +1,843 @@
1
+ <!-- Generated by sdk/js/scripts/generate-agent-docs.ts from developer-contract/openapi.json. Regenerated on every build. -->
2
+
3
+ # `g8.api.knowledge`: Knowledge
4
+
5
+ 21 operations (15 read, 6 write).
6
+
7
+ No hand-written client covers this area. Call it through `g8.api.knowledge.*` as shown below, or by operationId with `g8.api.call(operationId, input)`.
8
+
9
+ Every example below assumes this setup (server-side, API key):
10
+
11
+ ```ts
12
+ import { g8 } from "@graph8/sdk";
13
+
14
+ g8.init({ apiKey: process.env.G8_API_KEY! });
15
+ ```
16
+
17
+ Example values are placeholders that match each field's type. Only required fields are shown. Every example is type-checked against the SDK in CI.
18
+
19
+ Exact TypeScript types for every operation on this page, and every schema they use: [knowledge.d.ts](knowledge.d.ts).
20
+
21
+ ## Operations
22
+
23
+ | Call | HTTP | Tier | Scope | Summary |
24
+ |---|---|---|---|---|
25
+ | [`assembleKnowledgeContext`](#op-assembleknowledgecontext) | `POST /api/v1/knowledge/context` | read | `knowledge:read` | Assemble Knowledge Context |
26
+ | [`browseKnowledgeTree`](#op-browseknowledgetree) | `GET /api/v1/knowledge/tree` | read | `knowledge:read` | Browse Knowledge Tree |
27
+ | [`createAuthoredKnowledge`](#op-createauthoredknowledge) | `POST /api/v1/knowledge/authored` | write | `knowledge:write` | Create Authored Knowledge |
28
+ | [`createAuthoredKnowledgeAmendment`](#op-createauthoredknowledgeamendment) | `POST /api/v1/knowledge/authored/{concept_id}/amendments` | write | `knowledge:write` | Create Authored Knowledge Amendment |
29
+ | [`deprecateAuthoredKnowledge`](#op-deprecateauthoredknowledge) | `POST /api/v1/knowledge/authored/{concept_id}/deprecate` | write | `knowledge:write` | Deprecate Authored Knowledge |
30
+ | [`exportKnowledge`](#op-exportknowledge) | `GET /api/v1/knowledge/export` | read | `knowledge:read` | Export Knowledge |
31
+ | [`getKnowledge`](#op-getknowledge) | `GET /api/v1/knowledge/{concept_id}` | read | `knowledge:read` | Get Knowledge |
32
+ | [`getKnowledgeHistory`](#op-getknowledgehistory) | `GET /api/v1/knowledge/{concept_id}/history` | read | `knowledge:read` | Get Knowledge History |
33
+ | [`getKnowledgeStatus`](#op-getknowledgestatus) | `GET /api/v1/knowledge/status` | read | `knowledge:read` | Get Knowledge Status |
34
+ | [`getOntologyDeviations`](#op-getontologydeviations) | `GET /api/v1/knowledge-ontology/deviations` | read | `knowledge:read` | Get Ontology Deviations |
35
+ | [`getOntologyOverview`](#op-getontologyoverview) | `GET /api/v1/knowledge-ontology` | read | `knowledge:read` | Get Ontology Overview |
36
+ | [`getOntologyReadiness`](#op-getontologyreadiness) | `GET /api/v1/knowledge-ontology/readiness` | read | `knowledge:read` | Get Ontology Readiness |
37
+ | [`getStandardOntology`](#op-getstandardontology) | `GET /api/v1/knowledge-ontology/standard` | read | `knowledge:read` | Get Standard Ontology |
38
+ | [`knowledgeSources`](#op-knowledgesources) | `GET /api/v1/knowledge/{concept_id}/sources` | read | `knowledge:read` | Knowledge Sources |
39
+ | [`listKnowledge`](#op-listknowledge) | `GET /api/v1/knowledge` | read | `knowledge:read` | List Knowledge |
40
+ | [`listKnowledgeGovernanceQueue`](#op-listknowledgegovernancequeue) | `GET /api/v1/knowledge-governance` | read | `knowledge:read` | List Knowledge Governance Queue |
41
+ | [`relatedKnowledge`](#op-relatedknowledge) | `GET /api/v1/knowledge/{concept_id}/related` | read | `knowledge:read` | Related Knowledge |
42
+ | [`searchKnowledge`](#op-searchknowledge) | `GET /api/v1/knowledge/search` | read | `knowledge:read` | Search Knowledge |
43
+ | [`updateAuthoredKnowledgeDraft`](#op-updateauthoredknowledgedraft) | `PATCH /api/v1/knowledge/authored/{concept_id}` | write | `knowledge:write` | Update Authored Knowledge Draft |
44
+ | [`upsertOntologyConcept`](#op-upsertontologyconcept) | `PUT /api/v1/knowledge-ontology/{concept_id}` | write | `knowledge:write` | Upsert Ontology Concept |
45
+ | [`verifyAuthoredKnowledge`](#op-verifyauthoredknowledge) | `POST /api/v1/knowledge/authored/{concept_id}/verify` | write | `knowledge:write` | Verify Authored Knowledge |
46
+
47
+ ---
48
+
49
+ <a id="op-assembleknowledgecontext"></a>
50
+
51
+ ### `g8.api.knowledge.assembleKnowledgeContext(input)`
52
+
53
+ **Assemble Knowledge Context**
54
+
55
+ - HTTP: `POST /api/v1/knowledge/context`
56
+ - operationId: `assemble_knowledge_context_knowledge_context_post` (also callable as `g8.api.call("assemble_knowledge_context_knowledge_context_post", input)`)
57
+ - Tier: `read`: reads data; safe to call and to retry
58
+ - API-key scope: `knowledge:read`
59
+
60
+ **Input**
61
+
62
+ | Field | Type | Required | Description |
63
+ |---|---|---|---|
64
+ | `body` | `KnowledgeContextRequest` | yes | Request body; fields below. |
65
+
66
+ Body fields (`KnowledgeContextRequest`):
67
+
68
+ | Field | Type | Required | Description |
69
+ |---|---|---|---|
70
+ | `body.task` | `string` | yes | min length 1, max length 2000 |
71
+ | `body.entity_concept_ids` | `Array<string>` | no | max items 20 |
72
+ | `body.token_budget` | `integer \| null` | no | min 100, max 100000 |
73
+
74
+ **Returns** `ApiResponse_dict_`: the envelope `{ data: Record<string, unknown>, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
75
+
76
+ Other envelope fields: `pagination` (PaginationMeta).
77
+
78
+ **Example**
79
+
80
+ ```ts
81
+ const result = await g8.api.knowledge.assembleKnowledgeContext({ body: { task: "example" } });
82
+ ```
83
+
84
+ ---
85
+
86
+ <a id="op-browseknowledgetree"></a>
87
+
88
+ ### `g8.api.knowledge.browseKnowledgeTree(input?)`
89
+
90
+ **Browse Knowledge Tree**
91
+
92
+ - HTTP: `GET /api/v1/knowledge/tree`
93
+ - operationId: `browse_knowledge_tree_knowledge_tree_get` (also callable as `g8.api.call("browse_knowledge_tree_knowledge_tree_get", input)`)
94
+ - Tier: `read`: reads data; safe to call and to retry
95
+ - API-key scope: `knowledge:read`
96
+
97
+ Browse the knowledge tree one folder at a time. FREE.
98
+
99
+ The structural read `GET /knowledge` cannot do: that one returns a flat
100
+ filtered list, this one walks the hierarchy the brain is actually organised
101
+ into. Page with `cursor`.
102
+
103
+ **Input**
104
+
105
+ | Field | Type | Required | Description |
106
+ |---|---|---|---|
107
+ | `query.parent` | `string \| null` | no | Folder to list. Omit for the root. |
108
+ | `query.cursor` | `string \| null` | no | |
109
+ | `query.limit` | `integer` | no | default `50` |
110
+
111
+ **Returns** `ApiResponse_StudioContentPayload_`: the envelope `{ data: StudioContentPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
112
+
113
+ Other envelope fields: `pagination` (PaginationMeta).
114
+
115
+ **Example**
116
+
117
+ ```ts
118
+ const result = await g8.api.knowledge.browseKnowledgeTree();
119
+ ```
120
+
121
+ ---
122
+
123
+ <a id="op-createauthoredknowledge"></a>
124
+
125
+ ### `g8.api.knowledge.createAuthoredKnowledge(input)`
126
+
127
+ **Create Authored Knowledge**
128
+
129
+ - HTTP: `POST /api/v1/knowledge/authored`
130
+ - operationId: `create_authored_knowledge_knowledge_authored_post` (also callable as `g8.api.call("create_authored_knowledge_knowledge_authored_post", input)`)
131
+ - Tier: `write`: creates or changes records; the SDK sends an Idempotency-Key and retries transient failures
132
+ - API-key scope: `knowledge:write`
133
+
134
+ Write a knowledge concept by hand. FREE.
135
+
136
+ GOVERNED, not immediate: the entry lands as a draft in the review queue at
137
+ `GET /knowledge/governance` and does not project into the brain's answers
138
+ until it is approved there. Writing here is proposing, not publishing.
139
+
140
+ **Input**
141
+
142
+ | Field | Type | Required | Description |
143
+ |---|---|---|---|
144
+ | `body` | `AuthoredKnowledgeRequest` | yes | Request body; fields below. |
145
+
146
+ Body fields (`AuthoredKnowledgeRequest`):
147
+
148
+ | Field | Type | Required | Description |
149
+ |---|---|---|---|
150
+ | `body.body` | `string` | yes | max length 2000000 |
151
+ | `body.concept_type` | `string` | yes | min length 1, max length 100 |
152
+ | `body.title` | `string` | yes | min length 1, max length 500 |
153
+ | `body.owner_id` | `string \| null` | no | max length 255 |
154
+ | `body.review_at` | `string (date-time) \| null` | no | |
155
+ | `body.sources` | `Array<SourceInput>` | no | max items 50 |
156
+ | `body.stale_after` | `string (date-time) \| null` | no | |
157
+ | `body.visibility` | `string` | no | default `"organization"`, max length 32 |
158
+
159
+ **Returns** `ApiResponse_StudioContentPayload_`: the envelope `{ data: StudioContentPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
160
+
161
+ Other envelope fields: `pagination` (PaginationMeta).
162
+
163
+ **Example**
164
+
165
+ ```ts
166
+ const result = await g8.api.knowledge.createAuthoredKnowledge({
167
+ body: { body: "example", concept_type: "example", title: "Example" },
168
+ });
169
+ ```
170
+
171
+ ---
172
+
173
+ <a id="op-createauthoredknowledgeamendment"></a>
174
+
175
+ ### `g8.api.knowledge.createAuthoredKnowledgeAmendment(input)`
176
+
177
+ **Create Authored Knowledge Amendment**
178
+
179
+ - HTTP: `POST /api/v1/knowledge/authored/{concept_id}/amendments`
180
+ - operationId: `create_authored_knowledge_amendment_knowledge_authored__concept_id__amendments_post` (also callable as `g8.api.call("create_authored_knowledge_amendment_knowledge_authored__concept_id__amendments_post", input)`)
181
+ - Tier: `write`: creates or changes records; the SDK sends an Idempotency-Key and retries transient failures
182
+ - API-key scope: `knowledge:write`
183
+
184
+ Propose a revision to an APPROVED concept. FREE.
185
+
186
+ The approved version keeps answering until the amendment is approved in
187
+ its turn, so proposing one never leaves the brain with a gap.
188
+
189
+ **Input**
190
+
191
+ | Field | Type | Required | Description |
192
+ |---|---|---|---|
193
+ | `path.concept_id` | `string` | yes | Concept id. |
194
+ | `body` | `AuthoredKnowledgeRequest` | yes | Request body; fields below. |
195
+
196
+ Body fields (`AuthoredKnowledgeRequest`):
197
+
198
+ | Field | Type | Required | Description |
199
+ |---|---|---|---|
200
+ | `body.body` | `string` | yes | max length 2000000 |
201
+ | `body.concept_type` | `string` | yes | min length 1, max length 100 |
202
+ | `body.title` | `string` | yes | min length 1, max length 500 |
203
+ | `body.owner_id` | `string \| null` | no | max length 255 |
204
+ | `body.review_at` | `string (date-time) \| null` | no | |
205
+ | `body.sources` | `Array<SourceInput>` | no | max items 50 |
206
+ | `body.stale_after` | `string (date-time) \| null` | no | |
207
+ | `body.visibility` | `string` | no | default `"organization"`, max length 32 |
208
+
209
+ **Returns** `ApiResponse_StudioContentPayload_`: the envelope `{ data: StudioContentPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
210
+
211
+ Other envelope fields: `pagination` (PaginationMeta).
212
+
213
+ **Example**
214
+
215
+ ```ts
216
+ const result = await g8.api.knowledge.createAuthoredKnowledgeAmendment({
217
+ path: { concept_id: "id" },
218
+ body: { body: "example", concept_type: "example", title: "Example" },
219
+ });
220
+ ```
221
+
222
+ ---
223
+
224
+ <a id="op-deprecateauthoredknowledge"></a>
225
+
226
+ ### `g8.api.knowledge.deprecateAuthoredKnowledge(input)`
227
+
228
+ **Deprecate Authored Knowledge**
229
+
230
+ - HTTP: `POST /api/v1/knowledge/authored/{concept_id}/deprecate`
231
+ - operationId: `deprecate_authored_knowledge_knowledge_authored__concept_id__deprecate_post` (also callable as `g8.api.call("deprecate_authored_knowledge_knowledge_authored__concept_id__deprecate_post", input)`)
232
+ - Tier: `write`: creates or changes records; the SDK sends an Idempotency-Key and retries transient failures
233
+ - API-key scope: `knowledge:write`
234
+
235
+ Retire a concept so the brain stops answering from it.
236
+
237
+ The record and its history survive - this removes it from retrieval, it
238
+ does not delete it. `reason` is required and is kept on the record, which
239
+ is the point: a retired concept with no stated reason is indistinguishable
240
+ from one retired by mistake. Name `superseded_by` when something replaces
241
+ it.
242
+
243
+ Spends nothing.
244
+
245
+ **Input**
246
+
247
+ | Field | Type | Required | Description |
248
+ |---|---|---|---|
249
+ | `path.concept_id` | `string` | yes | Concept id. |
250
+ | `body` | `DeprecateKnowledgeRequest` | yes | Request body; fields below. |
251
+
252
+ Body fields (`DeprecateKnowledgeRequest`):
253
+
254
+ | Field | Type | Required | Description |
255
+ |---|---|---|---|
256
+ | `body.reason` | `string` | yes | min length 1, max length 2000 |
257
+ | `body.superseded_by` | `string \| null` | no | max length 255 |
258
+
259
+ **Returns** `ApiResponse_StudioContentPayload_`: the envelope `{ data: StudioContentPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
260
+
261
+ Other envelope fields: `pagination` (PaginationMeta).
262
+
263
+ **Example**
264
+
265
+ ```ts
266
+ const result = await g8.api.knowledge.deprecateAuthoredKnowledge({ path: { concept_id: "id" }, body: { reason: "example" } });
267
+ ```
268
+
269
+ ---
270
+
271
+ <a id="op-exportknowledge"></a>
272
+
273
+ ### `g8.api.knowledge.exportKnowledge(input?)`
274
+
275
+ **Export Knowledge**
276
+
277
+ - HTTP: `GET /api/v1/knowledge/export`
278
+ - operationId: `export_knowledge_knowledge_export_get` (also callable as `g8.api.call("export_knowledge_knowledge_export_get", input)`)
279
+ - Tier: `read`: reads data; safe to call and to retry
280
+ - API-key scope: `knowledge:read`
281
+
282
+ **Input**: none.
283
+
284
+ **Returns** `unknown`.
285
+
286
+ **Example**
287
+
288
+ ```ts
289
+ const result = await g8.api.knowledge.exportKnowledge();
290
+ ```
291
+
292
+ ---
293
+
294
+ <a id="op-getknowledge"></a>
295
+
296
+ ### `g8.api.knowledge.getKnowledge(input)`
297
+
298
+ **Get Knowledge**
299
+
300
+ - HTTP: `GET /api/v1/knowledge/{concept_id}`
301
+ - operationId: `get_knowledge_knowledge__concept_id__get` (also callable as `g8.api.call("get_knowledge_knowledge__concept_id__get", input)`)
302
+ - Tier: `read`: reads data; safe to call and to retry
303
+ - API-key scope: `knowledge:read`
304
+
305
+ **Input**
306
+
307
+ | Field | Type | Required | Description |
308
+ |---|---|---|---|
309
+ | `path.concept_id` | `string` | yes | |
310
+
311
+ **Returns** `ApiResponse_dict_`: the envelope `{ data: Record<string, unknown>, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
312
+
313
+ Other envelope fields: `pagination` (PaginationMeta).
314
+
315
+ **Example**
316
+
317
+ ```ts
318
+ const result = await g8.api.knowledge.getKnowledge({ path: { concept_id: "id" } });
319
+ ```
320
+
321
+ ---
322
+
323
+ <a id="op-getknowledgehistory"></a>
324
+
325
+ ### `g8.api.knowledge.getKnowledgeHistory(input)`
326
+
327
+ **Get Knowledge History**
328
+
329
+ - HTTP: `GET /api/v1/knowledge/{concept_id}/history`
330
+ - operationId: `get_knowledge_history_knowledge__concept_id__history_get` (also callable as `g8.api.call("get_knowledge_history_knowledge__concept_id__history_get", input)`)
331
+ - Tier: `read`: reads data; safe to call and to retry
332
+ - API-key scope: `knowledge:read`
333
+
334
+ A concept's revision history - every authored version, amendment,
335
+ verification and deprecation, newest first. FREE. Page with `cursor`.
336
+
337
+ **Input**
338
+
339
+ | Field | Type | Required | Description |
340
+ |---|---|---|---|
341
+ | `path.concept_id` | `string` | yes | Concept id. |
342
+ | `query.cursor` | `string \| null` | no | |
343
+ | `query.limit` | `integer` | no | default `50` |
344
+
345
+ **Returns** `ApiResponse_StudioContentPayload_`: the envelope `{ data: StudioContentPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
346
+
347
+ Other envelope fields: `pagination` (PaginationMeta).
348
+
349
+ **Example**
350
+
351
+ ```ts
352
+ const result = await g8.api.knowledge.getKnowledgeHistory({ path: { concept_id: "id" } });
353
+ ```
354
+
355
+ ---
356
+
357
+ <a id="op-getknowledgestatus"></a>
358
+
359
+ ### `g8.api.knowledge.getKnowledgeStatus(input?)`
360
+
361
+ **Get Knowledge Status**
362
+
363
+ - HTTP: `GET /api/v1/knowledge/status`
364
+ - operationId: `get_knowledge_status_knowledge_status_get` (also callable as `g8.api.call("get_knowledge_status_knowledge_status_get", input)`)
365
+ - Tier: `read`: reads data; safe to call and to retry
366
+ - API-key scope: `knowledge:read`
367
+
368
+ How complete and how fresh the knowledge brain is. FREE.
369
+
370
+ Counts by trust tier and freshness, restricted to what this credential's
371
+ record scopes can see.
372
+
373
+ **Input**: none.
374
+
375
+ **Returns** `ApiResponse_StudioContentPayload_`: the envelope `{ data: StudioContentPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
376
+
377
+ Other envelope fields: `pagination` (PaginationMeta).
378
+
379
+ **Example**
380
+
381
+ ```ts
382
+ const result = await g8.api.knowledge.getKnowledgeStatus();
383
+ ```
384
+
385
+ ---
386
+
387
+ <a id="op-getontologydeviations"></a>
388
+
389
+ ### `g8.api.knowledge.getOntologyDeviations(input?)`
390
+
391
+ **Get Ontology Deviations**
392
+
393
+ - HTTP: `GET /api/v1/knowledge-ontology/deviations`
394
+ - operationId: `get_ontology_deviations_knowledge_ontology_deviations_get` (also callable as `g8.api.call("get_ontology_deviations_knowledge_ontology_deviations_get", input)`)
395
+ - Tier: `read`: reads data; safe to call and to retry
396
+ - API-key scope: `knowledge:read`
397
+
398
+ Where your ontology differs from the standard.
399
+
400
+ A deviation is not automatically wrong - it is where your business calls
401
+ something by its own name. This is the read that tells you which is which.
402
+
403
+ **Input**: none.
404
+
405
+ **Returns** `ApiResponse_SettingsPayload_`: the envelope `{ data: SettingsPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
406
+
407
+ Other envelope fields: `pagination` (PaginationMeta).
408
+
409
+ **Example**
410
+
411
+ ```ts
412
+ const result = await g8.api.knowledge.getOntologyDeviations();
413
+ ```
414
+
415
+ ---
416
+
417
+ <a id="op-getontologyoverview"></a>
418
+
419
+ ### `g8.api.knowledge.getOntologyOverview(input?)`
420
+
421
+ **Get Ontology Overview**
422
+
423
+ - HTTP: `GET /api/v1/knowledge-ontology`
424
+ - operationId: `get_ontology_overview_knowledge_ontology_get` (also callable as `g8.api.call("get_ontology_overview_knowledge_ontology_get", input)`)
425
+ - Tier: `read`: reads data; safe to call and to retry
426
+ - API-key scope: `knowledge:read`
427
+
428
+ The org's ontology as it stands.
429
+
430
+ **Input**: none.
431
+
432
+ **Returns** `ApiResponse_SettingsPayload_`: the envelope `{ data: SettingsPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
433
+
434
+ Other envelope fields: `pagination` (PaginationMeta).
435
+
436
+ **Example**
437
+
438
+ ```ts
439
+ const result = await g8.api.knowledge.getOntologyOverview();
440
+ ```
441
+
442
+ ---
443
+
444
+ <a id="op-getontologyreadiness"></a>
445
+
446
+ ### `g8.api.knowledge.getOntologyReadiness(input?)`
447
+
448
+ **Get Ontology Readiness**
449
+
450
+ - HTTP: `GET /api/v1/knowledge-ontology/readiness`
451
+ - operationId: `get_ontology_readiness_knowledge_ontology_readiness_get` (also callable as `g8.api.call("get_ontology_readiness_knowledge_ontology_readiness_get", input)`)
452
+ - Tier: `read`: reads data; safe to call and to retry
453
+ - API-key scope: `knowledge:read`
454
+
455
+ Whether the ontology is complete enough to rely on.
456
+
457
+ **Input**: none.
458
+
459
+ **Returns** `ApiResponse_SettingsPayload_`: the envelope `{ data: SettingsPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
460
+
461
+ Other envelope fields: `pagination` (PaginationMeta).
462
+
463
+ **Example**
464
+
465
+ ```ts
466
+ const result = await g8.api.knowledge.getOntologyReadiness();
467
+ ```
468
+
469
+ ---
470
+
471
+ <a id="op-getstandardontology"></a>
472
+
473
+ ### `g8.api.knowledge.getStandardOntology(input?)`
474
+
475
+ **Get Standard Ontology**
476
+
477
+ - HTTP: `GET /api/v1/knowledge-ontology/standard`
478
+ - operationId: `get_standard_ontology_knowledge_ontology_standard_get` (also callable as `g8.api.call("get_standard_ontology_knowledge_ontology_standard_get", input)`)
479
+ - Tier: `read`: reads data; safe to call and to retry
480
+ - API-key scope: `knowledge:read`
481
+
482
+ The standard ontology yours is compared against.
483
+
484
+ **Input**: none.
485
+
486
+ **Returns** `ApiResponse_SettingsPayload_`: the envelope `{ data: SettingsPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
487
+
488
+ Other envelope fields: `pagination` (PaginationMeta).
489
+
490
+ **Example**
491
+
492
+ ```ts
493
+ const result = await g8.api.knowledge.getStandardOntology();
494
+ ```
495
+
496
+ ---
497
+
498
+ <a id="op-knowledgesources"></a>
499
+
500
+ ### `g8.api.knowledge.knowledgeSources(input)`
501
+
502
+ **Knowledge Sources**
503
+
504
+ - HTTP: `GET /api/v1/knowledge/{concept_id}/sources`
505
+ - operationId: `knowledge_sources_knowledge__concept_id__sources_get` (also callable as `g8.api.call("knowledge_sources_knowledge__concept_id__sources_get", input)`)
506
+ - Tier: `read`: reads data; safe to call and to retry
507
+ - API-key scope: `knowledge:read`
508
+
509
+ **Input**
510
+
511
+ | Field | Type | Required | Description |
512
+ |---|---|---|---|
513
+ | `path.concept_id` | `string` | yes | |
514
+
515
+ **Returns** `ApiResponse_list_dict__`: the envelope `{ data: Array<Record<string, unknown>>, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
516
+
517
+ Other envelope fields: `pagination` (PaginationMeta).
518
+
519
+ **Example**
520
+
521
+ ```ts
522
+ const result = await g8.api.knowledge.knowledgeSources({ path: { concept_id: "id" } });
523
+ ```
524
+
525
+ ---
526
+
527
+ <a id="op-listknowledge"></a>
528
+
529
+ ### `g8.api.knowledge.listKnowledge(input?)`
530
+
531
+ **List Knowledge**
532
+
533
+ - HTTP: `GET /api/v1/knowledge`
534
+ - operationId: `list_knowledge_knowledge_get` (also callable as `g8.api.call("list_knowledge_knowledge_get", input)`)
535
+ - Tier: `read`: reads data; safe to call and to retry
536
+ - API-key scope: `knowledge:read`
537
+
538
+ **Input**
539
+
540
+ | Field | Type | Required | Description |
541
+ |---|---|---|---|
542
+ | `query.concept_type` | `string \| null` | no | |
543
+ | `query.lifecycle` | `string \| null` | no | |
544
+ | `query.limit` | `integer` | no | default `50` |
545
+
546
+ **Returns** `ApiResponse_list_dict__`: the envelope `{ data: Array<Record<string, unknown>>, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
547
+
548
+ Other envelope fields: `pagination` (PaginationMeta).
549
+
550
+ **Example**
551
+
552
+ ```ts
553
+ const result = await g8.api.knowledge.listKnowledge();
554
+ ```
555
+
556
+ ---
557
+
558
+ <a id="op-listknowledgegovernancequeue"></a>
559
+
560
+ ### `g8.api.knowledge.listKnowledgeGovernanceQueue(input?)`
561
+
562
+ **List Knowledge Governance Queue**
563
+
564
+ - HTTP: `GET /api/v1/knowledge-governance`
565
+ - operationId: `list_knowledge_governance_queue_knowledge_governance_get` (also callable as `g8.api.call("list_knowledge_governance_queue_knowledge_governance_get", input)`)
566
+ - Tier: `read`: reads data; safe to call and to retry
567
+ - API-key scope: `knowledge:read`
568
+
569
+ What is waiting for review in Knowledge Governance.
570
+
571
+ **Input**
572
+
573
+ | Field | Type | Required | Description |
574
+ |---|---|---|---|
575
+ | `query.queue` | `string` | no | Which governance queue to read. default `"review"` |
576
+ | `query.cursor` | `string \| null` | no | Opaque cursor from the previous page. |
577
+ | `query.limit` | `integer` | no | default `50` |
578
+
579
+ **Returns** `ApiResponse_SettingsPayload_`: the envelope `{ data: SettingsPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
580
+
581
+ Other envelope fields: `pagination` (PaginationMeta).
582
+
583
+ **Example**
584
+
585
+ ```ts
586
+ const result = await g8.api.knowledge.listKnowledgeGovernanceQueue();
587
+ ```
588
+
589
+ ---
590
+
591
+ <a id="op-relatedknowledge"></a>
592
+
593
+ ### `g8.api.knowledge.relatedKnowledge(input)`
594
+
595
+ **Related Knowledge**
596
+
597
+ - HTTP: `GET /api/v1/knowledge/{concept_id}/related`
598
+ - operationId: `related_knowledge_knowledge__concept_id__related_get` (also callable as `g8.api.call("related_knowledge_knowledge__concept_id__related_get", input)`)
599
+ - Tier: `read`: reads data; safe to call and to retry
600
+ - API-key scope: `knowledge:read`
601
+
602
+ **Input**
603
+
604
+ | Field | Type | Required | Description |
605
+ |---|---|---|---|
606
+ | `path.concept_id` | `string` | yes | |
607
+ | `query.depth` | `integer` | no | default `1` |
608
+ | `query.limit` | `integer` | no | default `25` |
609
+
610
+ **Returns** `ApiResponse_list_dict__`: the envelope `{ data: Array<Record<string, unknown>>, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
611
+
612
+ Other envelope fields: `pagination` (PaginationMeta).
613
+
614
+ **Example**
615
+
616
+ ```ts
617
+ const result = await g8.api.knowledge.relatedKnowledge({ path: { concept_id: "id" } });
618
+ ```
619
+
620
+ ---
621
+
622
+ <a id="op-searchknowledge"></a>
623
+
624
+ ### `g8.api.knowledge.searchKnowledge(input)`
625
+
626
+ **Search Knowledge**
627
+
628
+ - HTTP: `GET /api/v1/knowledge/search`
629
+ - operationId: `search_knowledge_knowledge_search_get` (also callable as `g8.api.call("search_knowledge_knowledge_search_get", input)`)
630
+ - Tier: `read`: reads data; safe to call and to retry
631
+ - API-key scope: `knowledge:read`
632
+
633
+ **Input**
634
+
635
+ | Field | Type | Required | Description |
636
+ |---|---|---|---|
637
+ | `query.query` | `string` | yes | |
638
+ | `query.limit` | `integer` | no | default `10` |
639
+
640
+ **Returns** `ApiResponse_list_dict__`: the envelope `{ data: Array<Record<string, unknown>>, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
641
+
642
+ Other envelope fields: `pagination` (PaginationMeta).
643
+
644
+ **Example**
645
+
646
+ ```ts
647
+ const result = await g8.api.knowledge.searchKnowledge({ query: { query: "example" } });
648
+ ```
649
+
650
+ ---
651
+
652
+ <a id="op-updateauthoredknowledgedraft"></a>
653
+
654
+ ### `g8.api.knowledge.updateAuthoredKnowledgeDraft(input)`
655
+
656
+ **Update Authored Knowledge Draft**
657
+
658
+ - HTTP: `PATCH /api/v1/knowledge/authored/{concept_id}`
659
+ - operationId: `update_authored_knowledge_draft_knowledge_authored__concept_id__patch` (also callable as `g8.api.call("update_authored_knowledge_draft_knowledge_authored__concept_id__patch", input)`)
660
+ - Tier: `write`: creates or changes records; the SDK sends an Idempotency-Key and retries transient failures
661
+ - API-key scope: `knowledge:write`
662
+
663
+ Edit a concept that is still a DRAFT. FREE.
664
+
665
+ Only while it is unapproved. Once it has been approved, changing it is an
666
+ AMENDMENT - `POST /authored/{id}/amendments` - which is a new governed
667
+ revision rather than an edit in place.
668
+
669
+ **Input**
670
+
671
+ | Field | Type | Required | Description |
672
+ |---|---|---|---|
673
+ | `path.concept_id` | `string` | yes | Concept id. |
674
+ | `body` | `AuthoredKnowledgeRequest` | yes | Request body; fields below. |
675
+
676
+ Body fields (`AuthoredKnowledgeRequest`):
677
+
678
+ | Field | Type | Required | Description |
679
+ |---|---|---|---|
680
+ | `body.body` | `string` | yes | max length 2000000 |
681
+ | `body.concept_type` | `string` | yes | min length 1, max length 100 |
682
+ | `body.title` | `string` | yes | min length 1, max length 500 |
683
+ | `body.owner_id` | `string \| null` | no | max length 255 |
684
+ | `body.review_at` | `string (date-time) \| null` | no | |
685
+ | `body.sources` | `Array<SourceInput>` | no | max items 50 |
686
+ | `body.stale_after` | `string (date-time) \| null` | no | |
687
+ | `body.visibility` | `string` | no | default `"organization"`, max length 32 |
688
+
689
+ **Returns** `ApiResponse_StudioContentPayload_`: the envelope `{ data: StudioContentPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
690
+
691
+ Other envelope fields: `pagination` (PaginationMeta).
692
+
693
+ **Example**
694
+
695
+ ```ts
696
+ const result = await g8.api.knowledge.updateAuthoredKnowledgeDraft({
697
+ path: { concept_id: "id" },
698
+ body: { body: "example", concept_type: "example", title: "Example" },
699
+ });
700
+ ```
701
+
702
+ ---
703
+
704
+ <a id="op-upsertontologyconcept"></a>
705
+
706
+ ### `g8.api.knowledge.upsertOntologyConcept(input)`
707
+
708
+ **Upsert Ontology Concept**
709
+
710
+ - HTTP: `PUT /api/v1/knowledge-ontology/{concept_id}`
711
+ - operationId: `upsert_ontology_concept_knowledge_ontology__concept_id__put` (also callable as `g8.api.call("upsert_ontology_concept_knowledge_ontology__concept_id__put", input)`)
712
+ - Tier: `write`: creates or changes records; the SDK sends an Idempotency-Key and retries transient failures
713
+ - API-key scope: `knowledge:write`
714
+
715
+ Define or redefine one concept in the ontology.
716
+
717
+ An upsert: the same `concept_id` twice edits rather than duplicating, which
718
+ makes it safe to retry.
719
+
720
+ **Input**
721
+
722
+ | Field | Type | Required | Description |
723
+ |---|---|---|---|
724
+ | `path.concept_id` | `string` | yes | |
725
+ | `body` | `OntologyConceptRequest` | yes | Request body; fields below. |
726
+
727
+ Body fields (`OntologyConceptRequest`):
728
+
729
+ | Field | Type | Required | Description |
730
+ |---|---|---|---|
731
+ | `body.body` | `string` | yes | min length 1, max length 2000000 |
732
+ | `body.concept_id` | `string` | yes | min length 1, max length 255 |
733
+ | `body.concept_type` | `string` | yes | min length 1, max length 100 |
734
+ | `body.title` | `string` | yes | min length 1, max length 500 |
735
+ | `body.definition_override` | `string \| null` | no | max length 10000 |
736
+ | `body.extensions` | `Record<string, unknown>` | no | |
737
+ | `body.ontology` | `Record<string, unknown>` | no | |
738
+ | `body.relationships` | `Array<OntologyRelationship>` | no | max items 100 |
739
+ | `body.review_at` | `string (date-time) \| null` | no | |
740
+ | `body.source_owner` | `string \| null` | no | max length 255 |
741
+ | `body.sources` | `Array<OntologySource>` | no | max items 50 |
742
+ | `body.stale_after` | `string (date-time) \| null` | no | After this, the concept is treated as stale. |
743
+ | `body.standard_component_id` | `string \| null` | no | The standard-ontology component this maps to, if any. max length 100 |
744
+ | `body.trust_tier` | `string` | no | How much to trust this definition. Defaults to human-reviewed, matching the app — a concept written through the API is treated as authored, not inferred. default `"human_reviewed"` |
745
+
746
+ **Returns** `ApiResponse_SettingsPayload_`: the envelope `{ data: SettingsPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
747
+
748
+ Other envelope fields: `pagination` (PaginationMeta).
749
+
750
+ **Example**
751
+
752
+ ```ts
753
+ const result = await g8.api.knowledge.upsertOntologyConcept({
754
+ path: { concept_id: "id" },
755
+ body: {
756
+ body: "example",
757
+ concept_id: "id",
758
+ concept_type: "example",
759
+ title: "Example",
760
+ },
761
+ });
762
+ ```
763
+
764
+ ---
765
+
766
+ <a id="op-verifyauthoredknowledge"></a>
767
+
768
+ ### `g8.api.knowledge.verifyAuthoredKnowledge(input)`
769
+
770
+ **Verify Authored Knowledge**
771
+
772
+ - HTTP: `POST /api/v1/knowledge/authored/{concept_id}/verify`
773
+ - operationId: `verify_authored_knowledge_knowledge_authored__concept_id__verify_post` (also callable as `g8.api.call("verify_authored_knowledge_knowledge_authored__concept_id__verify_post", input)`)
774
+ - Tier: `write`: creates or changes records; the SDK sends an Idempotency-Key and retries transient failures
775
+ - API-key scope: `knowledge:write`
776
+
777
+ Approve or reject a PROPOSED concept. FREE.
778
+
779
+ Approving makes it answerable - every retrieval grounded on knowledge can
780
+ quote it from this moment - and records `authority` as who vouched for it.
781
+ Rejecting keeps it out of the brain.
782
+
783
+ **Input**
784
+
785
+ | Field | Type | Required | Description |
786
+ |---|---|---|---|
787
+ | `path.concept_id` | `string` | yes | Concept id. |
788
+ | `body` | `VerifyKnowledgeRequest` | yes | Request body; fields below. |
789
+
790
+ Body fields (`VerifyKnowledgeRequest`):
791
+
792
+ | Field | Type | Required | Description |
793
+ |---|---|---|---|
794
+ | `body.approve` | `boolean` | yes | |
795
+ | `body.authority` | `string` | yes | min length 1, max length 255 |
796
+
797
+ **Returns** `ApiResponse_StudioContentPayload_`: the envelope `{ data: StudioContentPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
798
+
799
+ Other envelope fields: `pagination` (PaginationMeta).
800
+
801
+ **Example**
802
+
803
+ ```ts
804
+ const result = await g8.api.knowledge.verifyAuthoredKnowledge({
805
+ path: { concept_id: "id" },
806
+ body: { approve: true, authority: "example" },
807
+ });
808
+ ```
809
+
810
+ ---
811
+
812
+ ## Referenced types
813
+
814
+ Named types that appear in the tables above. Full TypeScript definitions: `G8Contract.<Name>` (`import type { G8Contract } from "@graph8/sdk"`).
815
+
816
+ <a id="type-ontologyrelationship"></a>
817
+
818
+ ### `OntologyRelationship`
819
+
820
+ How one concept relates to another. Open-shaped, matching the app.
821
+
822
+ Type: `Record<string, unknown>`.
823
+
824
+ <a id="type-ontologysource"></a>
825
+
826
+ ### `OntologySource`
827
+
828
+ Where a concept came from. Open-shaped, matching the app's `SourceInput`.
829
+
830
+ Type: `Record<string, unknown>`.
831
+
832
+ <a id="type-sourceinput"></a>
833
+
834
+ ### `SourceInput`
835
+
836
+ A citation behind an authored concept.
837
+
838
+ | Field | Type | Required | Description |
839
+ |---|---|---|---|
840
+ | `resource` | `string` | yes | min length 1, max length 1000 |
841
+ | `checksum` | `string \| null` | no | max length 255 |
842
+ | `locator` | `string \| null` | no | max length 1000 |
843
+ | `title` | `string \| null` | no | max length 500 |