@gpt-platform/client 0.8.5 → 0.10.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.
package/llms.txt CHANGED
@@ -35,56 +35,61 @@ client.setConfig({
35
35
  - `getAccess-logs()` - /access-logs operation on access-log resource
36
36
  - `getAccess-logsById()` - /access-logs/:id operation on access-log resource
37
37
 
38
- ## Agent stats
38
+ ## Agent-deployment
39
+
40
+ - `getAgent-deployments()` - /agent-deployments operation on agent-deployment resource
41
+ - `getAgent-deploymentsById()` - /agent-deployments/:id operation on agent-deployment resource
42
+ - `postAgent-deployments()` - /agent-deployments operation on agent-deployment resource
43
+ - `patchAgent-deploymentsById()` - /agent-deployments/:id operation on agent-deployment resource
44
+ - `patchAgent-deploymentsByIdAccept-update()` - Accept an available version update
45
+ - `deleteAgent-deploymentsById()` - /agent-deployments/:id operation on agent-deployment resource
46
+
47
+ ## Agent-stats
39
48
 
40
- - `getAgentsByIdStats()` - /agents/:id/stats operation on agent_stats resource
49
+ - `getAgentsByIdStats()` - /agents/:id/stats operation on agent-stats resource
41
50
 
42
- ## Agent test result
51
+ ## Agent-test-result
43
52
 
44
53
  - `postAgent-test-results()` - Run an agent version against a document and return the test result
45
54
 
46
- ## Agent training stats
55
+ ## Agent-training-stats
47
56
 
48
- - `getAgentsByIdTraining-stats()` - /agents/:id/training-stats operation on agent_training_stats resource
57
+ - `getAgentsByIdTraining-stats()` - /agents/:id/training-stats operation on agent-training-stats resource
49
58
 
50
- ## Agent usage
59
+ ## Agent-usage
51
60
 
52
- - `getAgentsByIdUsage()` - /agents/:id/usage operation on agent_usage resource
61
+ - `getAgentsByIdUsage()` - /agents/:id/usage operation on agent-usage resource
53
62
  - `getAgentsUsage()` - Batch read usage for all accessible agents
54
63
 
55
- ## Agent version comparison
64
+ ## Agent-version
56
65
 
57
- - `postAgent-version-comparisons()` - Compare two agent versions and return the differences
66
+ - `getAgent-versions()` - List AgentVersions, optionally filtered to a specific agent
67
+ - `getAgent-versionsById()` - Fetch a single AgentVersion by ID
68
+ - `getAgent-versionsByIdMetrics()` - Get performance metrics for this version
69
+ - `getAgent-versionsByIdRevisions()` - List all revisions for a specific AgentVersion, sorted by revision number descending
70
+ - `postAgent-versions()` - Create a new AgentVersion snapshot
71
+ - `postAgent-versionsByIdAdd-system-field()` - Add a predefined system field to this version's output_schema
72
+ - `postAgent-versionsByIdRemove-system-field()` - Remove a system field from this version's output_schema
73
+ - `postAgent-versionsByIdSet-system-fields()` - Set which system fields are included in this version's output_schema (batch operation)
74
+ - `patchAgent-versionsById()` - Update an AgentVersion's prompt template or changes summary
75
+ - `deleteAgent-versionsById()` - Delete an AgentVersion
58
76
 
59
- ## Agent version revision
77
+ ## Agent-version-comparison
60
78
 
61
- - `getAgent-version-revisions()` - /agent-version-revisions operation on agent_version_revision resource
62
- - `getAgent-version-revisionsById()` - /agent-version-revisions/:id operation on agent_version_revision resource
79
+ - `postAgent-version-comparisons()` - Compare two agent versions and return the differences
63
80
 
64
- ## Agent-deployment
81
+ ## Agent-version-revision
65
82
 
66
- - `getAgent-deployments()` - /agent-deployments operation on agent-deployment resource
67
- - `getAgent-deploymentsById()` - /agent-deployments/:id operation on agent-deployment resource
68
- - `postAgent-deployments()` - /agent-deployments operation on agent-deployment resource
69
- - `patchAgent-deploymentsById()` - /agent-deployments/:id operation on agent-deployment resource
70
- - `patchAgent-deploymentsByIdAccept-update()` - Accept an available version update
71
- - `deleteAgent-deploymentsById()` - /agent-deployments/:id operation on agent-deployment resource
83
+ - `getAgent-version-revisions()` - /agent-version-revisions operation on agent-version-revision resource
84
+ - `getAgent-version-revisionsById()` - /agent-version-revisions/:id operation on agent-version-revision resource
72
85
 
73
86
  ## AI Agents
74
87
 
75
- - `getAgent-versions()` - List AgentVersions, optionally filtered to a specific agent
76
- - `getAgent-versionsById()` - Fetch a single AgentVersion by ID
77
- - `getAgent-versionsByIdMetrics()` - Get performance metrics for this version
78
- - `getAgent-versionsByIdRevisions()` - List all revisions for a specific AgentVersion, sorted by revision number descending
79
88
  - `getAgents()` - List all agents accessible in the current workspace
80
89
  - `getAgentsBy-slugBySlug()` - Look up an agent by its system_slug
81
90
  - `getAgentsById()` - Fetch a single agent by ID
82
91
  - `getAgentsByIdSchema-versions()` - List all schema versions for this agent
83
92
  - `getAgentsByIdTraining-examples()` - List training examples for this agent
84
- - `postAgent-versions()` - Create a new AgentVersion snapshot
85
- - `postAgent-versionsByIdAdd-system-field()` - Add a predefined system field to this version's output_schema
86
- - `postAgent-versionsByIdRemove-system-field()` - Remove a system field from this version's output_schema
87
- - `postAgent-versionsByIdSet-system-fields()` - Set which system fields are included in this version's output_schema (batch operation)
88
93
  - `postAgents()` - Create a new agent
89
94
  - `postAgentsByIdAnalyze-training()` - Analyze training examples for conflicts, coverage, and quality
90
95
  - `postAgentsByIdClone()` - Clone the agent to a new one with a new name
@@ -98,38 +103,11 @@ client.setConfig({
98
103
  - `postAgentsByIdValidate()` - Validate sample output against agent schema
99
104
  - `postAgentsClone-for-workspace()` - Clone a system agent for workspace-specific customization
100
105
  - `postAgentsImport()` - Import an agent from a JSON payload produced by `:export`
101
- - `patchAgent-versionsById()` - Update an AgentVersion's prompt template or changes summary
102
106
  - `patchAgentsById()` - Update agent metadata such as name, description, vertical, tags, and instructions
103
107
  - `patchAgentsByIdSchema-versionsByVersionId()` - Update a schema version without creating a new version
104
- - `deleteAgent-versionsById()` - Delete an AgentVersion
105
108
  - `deleteAgentsById()` - Permanently delete an agent and cascade-destroy all associated data
106
109
  - `deleteAgentsByIdTraining-examplesByExampleId()` - Delete a training example belonging to this agent
107
110
 
108
- ## AI Training
109
-
110
- - `getTraining-examples()` - List training examples with filtering support
111
- - `getTraining-examplesById()` - Fetch a single TrainingExample by ID.
112
- - `getTraining-sessions()` - /training-sessions operation on training_session resource
113
- - `getTraining-sessionsAgentsByAgentIdSessions()` - /training-sessions/agents/:agent_id/sessions operation on training_session resource
114
- - `getTraining-sessionsById()` - /training-sessions/:id operation on training_session resource
115
- - `postTraining-examples()` - Create a single training example (golden example for few-shot learning)
116
- - `postTraining-examplesBulk()` - Create multiple training examples in a single transaction using `Ash.bulk_create`
117
- - `postTraining-examplesBulk-delete()` - Delete multiple training examples by ID in a single transaction
118
- - `postTraining-examplesSearch()` - Public entry point for semantic similarity search over training examples
119
- - `postTraining-sessions()` - /training-sessions operation on training_session resource
120
- - `patchTraining-examplesById()` - Update an existing training example's input text, expected output JSON, notes,
121
- correction reasons, or image reference
122
- - `patchTraining-sessionsByIdRevert()` - /training-sessions/:id/revert operation on training_session resource
123
- - `deleteTraining-examplesById()` - /training-examples/:id operation on training_example resource
124
- - `deleteTraining-sessionsById()` - /training-sessions/:id operation on training_session resource
125
-
126
- ## Ai-message
127
-
128
- - `getAiMessages()` - /ai/messages operation on ai-message resource
129
- - `getAiMessagesById()` - /ai/messages/:id operation on ai-message resource
130
- - `postAiMessages()` - Append a new message turn (system, user, or assistant) to a Conversation
131
- - `deleteAiMessagesById()` - /ai/messages/:id operation on ai-message resource
132
-
133
111
  ## Amendment-request
134
112
 
135
113
  - `getAmendment-requests()` - /amendment-requests operation on amendment-request resource
@@ -140,7 +118,7 @@ correction reasons, or image reference
140
118
  - `patchAmendment-requestsByIdDeny()` - Deny an amendment request with a reason.
141
119
  - `patchAmendment-requestsByIdReview()` - Begin reviewing an amendment request.
142
120
 
143
- ## API Keys
121
+ ## Api-key
144
122
 
145
123
  - `getApi-keys()` - List or fetch API keys
146
124
  - `getApi-keysActive()` - List only active API keys
@@ -184,33 +162,21 @@ flags, workspace mode, and execution limits
184
162
 
185
163
  ## Billing
186
164
 
187
- - `getPlans()` - /plans operation on plan resource
188
- - `getPlansById()` - /plans/:id operation on plan resource
189
- - `getPlansSlugBySlug()` - /plans/slug/:slug operation on plan resource
190
- - `getWallet()` - Reads the wallet for the current tenant
191
- - `getWalletPlanPreview()` - Preview the cost and effective date of a plan change
192
165
  - `postPayments()` - Process a payment
193
- - `patchWalletAddons()` - Purchase an add-on for the wallet
194
- - `patchWalletAddonsByAddonSlugCancel()` - Cancel an add-on for the wallet
195
- - `patchWalletAuto-top-up()` - Update auto-top-up settings
196
- - `patchWalletCredits()` - Purchase credits (Top-up)
197
- - `patchWalletPaymentRetry()` - Retry a failed subscription payment
198
- - `patchWalletPlan()` - Change the main plan for the wallet
199
- - `patchWalletPlanCancel()` - Cancel the current subscription plan
200
166
 
201
- ## Brand identity
167
+ ## Brand-identity
202
168
 
203
- - `getBrand-identities()` - /brand-identities operation on brand_identity resource
204
- - `getBrand-identitiesBy-tenantByTenantId()` - /brand-identities/by-tenant/:tenant_id operation on brand_identity resource
205
- - `getBrand-identitiesBy-workspaceByWorkspaceId()` - /brand-identities/by-workspace/:workspace_id operation on brand_identity resource
206
- - `getBrand-identitiesById()` - /brand-identities/:id operation on brand_identity resource
207
- - `getBrand-identitiesDefaultTenantByTenantId()` - /brand-identities/default/tenant/:tenant_id operation on brand_identity resource
208
- - `getBrand-identitiesDefaultWorkspaceByWorkspaceId()` - /brand-identities/default/workspace/:workspace_id operation on brand_identity resource
209
- - `postBrand-identities()` - /brand-identities operation on brand_identity resource
210
- - `patchBrand-identitiesById()` - /brand-identities/:id operation on brand_identity resource
211
- - `patchBrand-identitiesByIdSet-default()` - /brand-identities/:id/set-default operation on brand_identity resource
212
- - `patchBrand-identitiesByIdUnset-default()` - /brand-identities/:id/unset-default operation on brand_identity resource
213
- - `deleteBrand-identitiesById()` - /brand-identities/:id operation on brand_identity resource
169
+ - `getBrand-identities()` - /brand-identities operation on brand-identity resource
170
+ - `getBrand-identitiesBy-tenantByTenantId()` - /brand-identities/by-tenant/:tenant_id operation on brand-identity resource
171
+ - `getBrand-identitiesBy-workspaceByWorkspaceId()` - /brand-identities/by-workspace/:workspace_id operation on brand-identity resource
172
+ - `getBrand-identitiesById()` - /brand-identities/:id operation on brand-identity resource
173
+ - `getBrand-identitiesDefaultTenantByTenantId()` - /brand-identities/default/tenant/:tenant_id operation on brand-identity resource
174
+ - `getBrand-identitiesDefaultWorkspaceByWorkspaceId()` - /brand-identities/default/workspace/:workspace_id operation on brand-identity resource
175
+ - `postBrand-identities()` - /brand-identities operation on brand-identity resource
176
+ - `patchBrand-identitiesById()` - /brand-identities/:id operation on brand-identity resource
177
+ - `patchBrand-identitiesByIdSet-default()` - /brand-identities/:id/set-default operation on brand-identity resource
178
+ - `patchBrand-identitiesByIdUnset-default()` - /brand-identities/:id/unset-default operation on brand-identity resource
179
+ - `deleteBrand-identitiesById()` - /brand-identities/:id operation on brand-identity resource
214
180
 
215
181
  ## Breach-incident
216
182
 
@@ -232,13 +198,13 @@ flags, workspace mode, and execution limits
232
198
  - `patchBreach-notification-artifactsById()` - /breach-notification-artifacts/:id operation on breach-notification-artifact resource
233
199
  - `patchBreach-notification-artifactsByIdSend()` - Mark artifact as sent and publish BreachNotificationReadyToSend event for Communication domain dispatch.
234
200
 
235
- ## Bulk dismissal result
201
+ ## Bulk-dismissal-result
236
202
 
237
- - `postWorkspacesByWorkspaceIdExtractionDocumentsDismiss-all-trained()` - /workspaces/:workspace_id/extraction/documents/dismiss-all-trained operation on bulk_dismissal_result resource
203
+ - `postWorkspacesByWorkspaceIdExtractionDocumentsDismiss-all-trained()` - /workspaces/:workspace_id/extraction/documents/dismiss-all-trained operation on bulk-dismissal-result resource
238
204
 
239
- ## Bulk reprocess result
205
+ ## Bulk-reprocess-result
240
206
 
241
- - `postExtractionDocumentsBulk-reprocess()` - /extraction/documents/bulk-reprocess operation on bulk_reprocess_result resource
207
+ - `postExtractionDocumentsBulk-reprocess()` - /extraction/documents/bulk-reprocess operation on bulk-reprocess-result resource
242
208
 
243
209
  ## Business-associate-agreement
244
210
 
@@ -265,72 +231,72 @@ flags, workspace mode, and execution limits
265
231
  - `patchEmail-marketingCampaignsById()` - /email-marketing/campaigns/:id operation on campaign resource
266
232
  - `deleteEmail-marketingCampaignsById()` - /email-marketing/campaigns/:id operation on campaign resource
267
233
 
268
- ## Catalog option type
234
+ ## Catalog-option-type
269
235
 
270
236
  - `getCatalogOption-typesApplicationByApplicationId()` - List all option types for an application ordered by position
271
- - `getCatalogOption-typesById()` - /catalog/option-types/:id operation on catalog_option_type resource
237
+ - `getCatalogOption-typesById()` - /catalog/option-types/:id operation on catalog-option-type resource
272
238
  - `postCatalogOption-types()` - Create an option type (e.g., Size, Color) for an application; shared across all tenants
273
239
  - `patchCatalogOption-typesById()` - Update the name, slug, or display position of an option type
274
240
  - `deleteCatalogOption-typesById()` - Permanently delete an option type and all its values; cascades to variant_option_values
275
241
 
276
- ## Catalog option value
242
+ ## Catalog-option-value
277
243
 
278
- - `getCatalogOption-valuesById()` - /catalog/option-values/:id operation on catalog_option_value resource
244
+ - `getCatalogOption-valuesById()` - /catalog/option-values/:id operation on catalog-option-value resource
279
245
  - `getCatalogOption-valuesOption-typeByOptionTypeId()` - List all values for an option type ordered by position
280
246
  - `postCatalogOption-values()` - Create a specific option value (e.g., 'Large', 'Red') within an option type
281
247
  - `patchCatalogOption-valuesById()` - Update the name, slug, position, or metadata of an option value
282
248
  - `deleteCatalogOption-valuesById()` - Permanently delete an option value; removes associated variant_option_values
283
249
 
284
- ## Catalog price list
250
+ ## Catalog-price-list
285
251
 
286
252
  - `getCatalogPrice-listsApplicationByApplicationId()` - List all price lists for an application, ordered by priority
287
- - `getCatalogPrice-listsById()` - /catalog/price-lists/:id operation on catalog_price_list resource
253
+ - `getCatalogPrice-listsById()` - /catalog/price-lists/:id operation on catalog-price-list resource
288
254
  - `postCatalogPrice-lists()` - Create a named price list for an application with a strategy (fixed, percentage_discount, or tiered)
289
255
  - `patchCatalogPrice-listsById()` - Update price list metadata, strategy, or validity period
290
256
  - `deleteCatalogPrice-listsById()` - Permanently delete a price list and all its entries
291
257
 
292
- ## Catalog price list entry
258
+ ## Catalog-price-list-entry
293
259
 
294
260
  - `getCatalogPrice-list-entriesPrice-listByPriceListId()` - List all entries in a price list
295
261
  - `postCatalogPrice-list-entries()` - Add a pricing entry to a price list for a product or variant; supply a fixed price, modifier, or tiered structure
296
262
  - `patchCatalogPrice-list-entriesById()` - Update the price, modifier, tiers, or floor price for an existing entry
297
263
  - `deleteCatalogPrice-list-entriesById()` - Permanently delete a price list entry
298
264
 
299
- ## Catalog product
265
+ ## Catalog-product
300
266
 
301
- - `getCatalogProductsById()` - /catalog/products/:id operation on catalog_product resource
267
+ - `getCatalogProductsById()` - /catalog/products/:id operation on catalog-product resource
302
268
  - `getCatalogProductsWorkspaceByWorkspaceId()` - List all active (non-deleted) products in a workspace
303
269
  - `postCatalogProducts()` - Create a new catalog product in a workspace; triggers search indexing and enqueues embedding generation
304
270
  - `patchCatalogProductsById()` - Update a product's attributes; triggers search re-indexing and embedding refresh
305
271
  - `deleteCatalogProductsById()` - Soft-delete a product by stamping deleted_at; excluded from all future reads
306
272
 
307
- ## Catalog product variant
273
+ ## Catalog-product-variant
308
274
 
309
- - `getCatalogProduct-variantsById()` - /catalog/product-variants/:id operation on catalog_product_variant resource
275
+ - `getCatalogProduct-variantsById()` - /catalog/product-variants/:id operation on catalog-product-variant resource
310
276
  - `getCatalogProduct-variantsProductByProductId()` - List all active variants for a given product, sorted by position
311
277
  - `postCatalogProduct-variants()` - Create a product variant (SKU, price override, option values); enforces max_variants_per_product quota
312
278
  - `patchCatalogProduct-variantsById()` - Update a variant's SKU, pricing, properties, or media
313
279
  - `deleteCatalogProduct-variantsById()` - Soft-delete a variant by setting deleted_at; excluded from future reads
314
280
 
315
- ## Catalog taxonomy
281
+ ## Catalog-taxonomy
316
282
 
317
283
  - `getCatalogTaxonomiesApplicationByApplicationId()` - List active taxonomies for an application
318
- - `getCatalogTaxonomiesById()` - /catalog/taxonomies/:id operation on catalog_taxonomy resource
284
+ - `getCatalogTaxonomiesById()` - /catalog/taxonomies/:id operation on catalog-taxonomy resource
319
285
  - `postCatalogTaxonomies()` - Create a new taxonomy (classification axis) for an application; enforces max_taxonomies quota
320
286
  - `patchCatalogTaxonomiesById()` - Update taxonomy metadata (name, slug, hierarchy settings)
321
287
  - `deleteCatalogTaxonomiesById()` - Soft-delete a taxonomy by setting deleted_at; cascades to exclude nodes from future reads
322
288
 
323
- ## Catalog taxonomy node
289
+ ## Catalog-taxonomy-node
324
290
 
325
- - `getCatalogTaxonomy-nodesById()` - /catalog/taxonomy-nodes/:id operation on catalog_taxonomy_node resource
291
+ - `getCatalogTaxonomy-nodesById()` - /catalog/taxonomy-nodes/:id operation on catalog-taxonomy-node resource
326
292
  - `getCatalogTaxonomy-nodesTaxonomyByTaxonomyId()` - List all active nodes in a taxonomy
327
293
  - `postCatalogTaxonomy-nodes()` - Create a taxonomy node (category) at the given position in the tree; validates hierarchy depth
328
294
  - `patchCatalogTaxonomy-nodesById()` - Update a node's name, slug, position, or parent; re-validates tree depth
329
295
  - `deleteCatalogTaxonomy-nodesById()` - Soft-delete a taxonomy node by stamping deleted_at; child nodes are not auto-deleted
330
296
 
331
- ## Catalog view
297
+ ## Catalog-view
332
298
 
333
- - `getCatalogViewsById()` - /catalog/views/:id operation on catalog_view resource
299
+ - `getCatalogViewsById()` - /catalog/views/:id operation on catalog-view resource
334
300
  - `getCatalogViewsWorkspaceByWorkspaceId()` - List all catalog views in a workspace
335
301
  - `postCatalogViews()` - Create a catalog view (named product lens) in a workspace; enforces max_catalog_views quota
336
302
  - `patchCatalogViewsById()` - Update view metadata, filtering rules, or pricing association
@@ -343,33 +309,100 @@ flags, workspace mode, and execution limits
343
309
  - `postCde-scope-reports()` - Generate a PCI-DSS Cardholder Data Environment scope report for a workspace, classifying it as in-scope, out-of-scope, or connected based on ScanResult data
344
310
  - `deleteCde-scope-reportsById()` - /cde-scope-reports/:id operation on cde-scope-report resource
345
311
 
312
+ ## Chat-ai-message
313
+
314
+ - `getAiMessages()` - /ai/messages operation on chat-ai-message resource
315
+ - `getAiMessagesById()` - /ai/messages/:id operation on chat-ai-message resource
316
+ - `postAiMessages()` - Append a new message turn (system, user, or assistant) to a Conversation
317
+ - `deleteAiMessagesById()` - /ai/messages/:id operation on chat-ai-message resource
318
+
319
+ ## Chat-conversation
320
+
321
+ - `getAiConversations()` - /ai/conversations operation on chat-conversation resource
322
+ - `getAiConversationsById()` - /ai/conversations/:id operation on chat-conversation resource
323
+ - `postAiConversations()` - Start a new AI conversation session with optional structured context data (e.g., prediction results to discuss)
324
+ - `patchAiConversationsById()` - Update the conversation title or replace the context data map
325
+ - `deleteAiConversationsById()` - /ai/conversations/:id operation on chat-conversation resource
326
+
327
+ ## Chat-message
328
+
329
+ - `getMessages()` - /messages operation on chat-message resource
330
+ - `getMessagesById()` - /messages/:id operation on chat-message resource
331
+ - `getMessagesSearch()` - Full-text search messages by substring match on content
332
+ - `getMessagesSemantic-search()` - Vector similarity search across messages using a generated embedding of the query string
333
+ - `getThreadsByIdMessages()` - /threads/:id/messages operation on chat-message resource
334
+ - `postMessages()` - Add a new message turn to a thread
335
+ - `patchMessagesById()` - Edit a message's content, role, or metadata
336
+ - `deleteMessagesById()` - /messages/:id operation on chat-message resource
337
+
338
+ ## Chat-message-feedback
339
+
340
+ - `getMessage-feedback()` - /message-feedback operation on chat-message-feedback resource
341
+ - `postMessage-feedback()` - Submit or update thumbs up/down feedback on a message
342
+
343
+ ## Chat-thread
344
+
345
+ - `getThreads()` - /threads operation on chat-thread resource
346
+ - `getThreadsById()` - /threads/:id operation on chat-thread resource
347
+ - `getThreadsMine()` - List only the calling user's threads within their current workspace
348
+ - `getThreadsSearch()` - Full-text search threads by title or context summary within the actor's accessible workspace
349
+ - `postThreads()` - Create a new conversation thread scoped to a tenant, workspace, and user
350
+ - `postThreadsActive()` - Return the current user's active thread for their workspace, creating a new one if none exists or the existing thread has expired (>24h inactive)
351
+ - `postThreadsByIdComplete()` - Trigger AI inference on an existing thread without providing new user message content
352
+ - `postThreadsByIdExport()` - Export thread with messages to JSON, Markdown, or plain text format
353
+ - `postThreadsByIdFork()` - Fork a thread by cloning it with all its messages
354
+ - `postThreadsByIdMessages()` - Submit a user message to a thread and receive the AI response synchronously
355
+ - `postThreadsByIdSummarize()` - Generate a 2-3 sentence LLM summary of the thread's message history and persist it as `context_summary`
356
+ - `patchThreadsById()` - Update the thread's title or context summary
357
+ - `patchThreadsByIdArchive()` - Archive a thread by setting `archived_at` to the current timestamp
358
+ - `patchThreadsByIdMetadata()` - Merge the provided metadata map into the thread's existing metadata (shallow merge via Map.merge/2)
359
+ - `patchThreadsByIdUnarchive()` - Restore an archived thread by clearing `archived_at`, making it visible in the default thread list again.
360
+ - `deleteThreadsById()` - /threads/:id operation on chat-thread resource
361
+
362
+ ## Chat-thread-stats
363
+
364
+ - `getThreadsStats()` - Return platform-wide chat statistics including total threads, total messages, threads active in the last 24h and 7d, message distribution by role, and top 10 workspaces by thread count
365
+
366
+ ## Chat-thread-workspace-stats
367
+
368
+ - `getThreadsWorkspace-stats()` - Return aggregated chat statistics for the actor's current workspace: total threads, total messages, activity counts for 24h and 7d windows, and message distribution by role
369
+
346
370
  ## Clinical-client-goal
347
371
 
348
372
  - `getClinicalClient-goals()` - /clinical/client-goals operation on clinical-client-goal resource
373
+ - `getClinicalClient-goalsArchived()` - /clinical/client-goals/archived operation on clinical-client-goal resource
349
374
  - `getClinicalClient-goalsById()` - /clinical/client-goals/:id operation on clinical-client-goal resource
350
375
  - `getClinicalPatientsByIdGoals()` - /clinical/patients/:id/goals operation on clinical-client-goal resource
351
376
  - `postClinicalClient-goals()` - /clinical/client-goals operation on clinical-client-goal resource
352
377
  - `postClinicalClient-goalsFrom-template()` - /clinical/client-goals/from-template operation on clinical-client-goal resource
353
378
  - `patchClinicalClient-goalsById()` - /clinical/client-goals/:id operation on clinical-client-goal resource
354
- - `deleteClinicalClient-goalsById()` - /clinical/client-goals/:id operation on clinical-client-goal resource
379
+ - `patchClinicalClient-goalsByIdArchive()` - /clinical/client-goals/:id/archive operation on clinical-client-goal resource
380
+ - `patchClinicalClient-goalsByIdRestore()` - /clinical/client-goals/:id/restore operation on clinical-client-goal resource
381
+ - `deleteClinicalClient-goalsByIdPermanent()` - /clinical/client-goals/:id/permanent operation on clinical-client-goal resource
355
382
 
356
383
  ## Clinical-client-resource-assignment
357
384
 
358
385
  - `getClinicalClient-resource-assignments()` - /clinical/client-resource-assignments operation on clinical-client-resource-assignment resource
386
+ - `getClinicalClient-resource-assignmentsArchived()` - /clinical/client-resource-assignments/archived operation on clinical-client-resource-assignment resource
359
387
  - `getClinicalClient-resource-assignmentsById()` - /clinical/client-resource-assignments/:id operation on clinical-client-resource-assignment resource
360
388
  - `getClinicalPatientsByIdResourceAssignments()` - /clinical/patients/:id/resource_assignments operation on clinical-client-resource-assignment resource
361
389
  - `postClinicalClient-resource-assignments()` - /clinical/client-resource-assignments operation on clinical-client-resource-assignment resource
362
390
  - `patchClinicalClient-resource-assignmentsById()` - /clinical/client-resource-assignments/:id operation on clinical-client-resource-assignment resource
363
- - `deleteClinicalClient-resource-assignmentsById()` - /clinical/client-resource-assignments/:id operation on clinical-client-resource-assignment resource
391
+ - `patchClinicalClient-resource-assignmentsByIdArchive()` - /clinical/client-resource-assignments/:id/archive operation on clinical-client-resource-assignment resource
392
+ - `patchClinicalClient-resource-assignmentsByIdRestore()` - /clinical/client-resource-assignments/:id/restore operation on clinical-client-resource-assignment resource
393
+ - `deleteClinicalClient-resource-assignmentsByIdPermanent()` - /clinical/client-resource-assignments/:id/permanent operation on clinical-client-resource-assignment resource
364
394
 
365
395
  ## Clinical-client-supplement
366
396
 
367
397
  - `getClinicalClient-supplements()` - /clinical/client-supplements operation on clinical-client-supplement resource
398
+ - `getClinicalClient-supplementsArchived()` - /clinical/client-supplements/archived operation on clinical-client-supplement resource
368
399
  - `getClinicalClient-supplementsById()` - /clinical/client-supplements/:id operation on clinical-client-supplement resource
369
400
  - `getClinicalPatientsByIdSupplements()` - /clinical/patients/:id/supplements operation on clinical-client-supplement resource
370
401
  - `postClinicalClient-supplements()` - /clinical/client-supplements operation on clinical-client-supplement resource
371
402
  - `patchClinicalClient-supplementsById()` - /clinical/client-supplements/:id operation on clinical-client-supplement resource
372
- - `deleteClinicalClient-supplementsById()` - /clinical/client-supplements/:id operation on clinical-client-supplement resource
403
+ - `patchClinicalClient-supplementsByIdArchive()` - /clinical/client-supplements/:id/archive operation on clinical-client-supplement resource
404
+ - `patchClinicalClient-supplementsByIdRestore()` - /clinical/client-supplements/:id/restore operation on clinical-client-supplement resource
405
+ - `deleteClinicalClient-supplementsByIdPermanent()` - /clinical/client-supplements/:id/permanent operation on clinical-client-supplement resource
373
406
 
374
407
  ## Clinical-delivery
375
408
 
@@ -382,17 +415,23 @@ flags, workspace mode, and execution limits
382
415
  ## Clinical-goal-template
383
416
 
384
417
  - `getClinicalGoal-templates()` - /clinical/goal-templates operation on clinical-goal-template resource
418
+ - `getClinicalGoal-templatesArchived()` - /clinical/goal-templates/archived operation on clinical-goal-template resource
385
419
  - `getClinicalGoal-templatesById()` - /clinical/goal-templates/:id operation on clinical-goal-template resource
386
420
  - `getClinicalGoal-templatesCatalog()` - /clinical/goal-templates/catalog operation on clinical-goal-template resource
421
+ - `getClinicalGoal-templatesCatalogArchived()` - /clinical/goal-templates/catalog/archived operation on clinical-goal-template resource
387
422
  - `getClinicalGoal-templatesCatalogById()` - /clinical/goal-templates/catalog/:id operation on clinical-goal-template resource
388
423
  - `getClinicalGoal-templatesMine()` - /clinical/goal-templates/mine operation on clinical-goal-template resource
389
424
  - `postClinicalGoal-templates()` - /clinical/goal-templates operation on clinical-goal-template resource
390
425
  - `postClinicalGoal-templatesCatalog()` - /clinical/goal-templates/catalog operation on clinical-goal-template resource
391
426
  - `postClinicalGoal-templatesFrom-existing()` - /clinical/goal-templates/from-existing operation on clinical-goal-template resource
392
427
  - `patchClinicalGoal-templatesById()` - /clinical/goal-templates/:id operation on clinical-goal-template resource
428
+ - `patchClinicalGoal-templatesByIdArchive()` - /clinical/goal-templates/:id/archive operation on clinical-goal-template resource
429
+ - `patchClinicalGoal-templatesByIdRestore()` - /clinical/goal-templates/:id/restore operation on clinical-goal-template resource
393
430
  - `patchClinicalGoal-templatesCatalogById()` - /clinical/goal-templates/catalog/:id operation on clinical-goal-template resource
394
- - `deleteClinicalGoal-templatesById()` - /clinical/goal-templates/:id operation on clinical-goal-template resource
395
- - `deleteClinicalGoal-templatesCatalogById()` - /clinical/goal-templates/catalog/:id operation on clinical-goal-template resource
431
+ - `patchClinicalGoal-templatesCatalogByIdArchive()` - /clinical/goal-templates/catalog/:id/archive operation on clinical-goal-template resource
432
+ - `patchClinicalGoal-templatesCatalogByIdRestore()` - /clinical/goal-templates/catalog/:id/restore operation on clinical-goal-template resource
433
+ - `deleteClinicalGoal-templatesByIdPermanent()` - /clinical/goal-templates/:id/permanent operation on clinical-goal-template resource
434
+ - `deleteClinicalGoal-templatesCatalogByIdPermanent()` - /clinical/goal-templates/catalog/:id/permanent operation on clinical-goal-template resource
396
435
 
397
436
  ## Clinical-goal-template-category
398
437
 
@@ -402,33 +441,42 @@ flags, workspace mode, and execution limits
402
441
  ## Clinical-health-metric
403
442
 
404
443
  - `getClinicalHealth-metrics()` - /clinical/health-metrics operation on clinical-health-metric resource
444
+ - `getClinicalHealth-metricsArchived()` - /clinical/health-metrics/archived operation on clinical-health-metric resource
405
445
  - `getClinicalHealth-metricsBy-session()` - /clinical/health-metrics/by-session operation on clinical-health-metric resource
406
446
  - `getClinicalHealth-metricsById()` - /clinical/health-metrics/:id operation on clinical-health-metric resource
407
447
  - `getClinicalPatientsByIdHealthMetrics()` - /clinical/patients/:id/health_metrics operation on clinical-health-metric resource
408
448
  - `postClinicalHealth-metrics()` - /clinical/health-metrics operation on clinical-health-metric resource
409
449
  - `patchClinicalHealth-metricsById()` - /clinical/health-metrics/:id operation on clinical-health-metric resource
410
- - `deleteClinicalHealth-metricsById()` - /clinical/health-metrics/:id operation on clinical-health-metric resource
450
+ - `patchClinicalHealth-metricsByIdArchive()` - /clinical/health-metrics/:id/archive operation on clinical-health-metric resource
451
+ - `patchClinicalHealth-metricsByIdRestore()` - /clinical/health-metrics/:id/restore operation on clinical-health-metric resource
452
+ - `deleteClinicalHealth-metricsByIdPermanent()` - /clinical/health-metrics/:id/permanent operation on clinical-health-metric resource
411
453
 
412
454
  ## Clinical-meal-plan
413
455
 
414
456
  - `getClinicalMeal-plans()` - /clinical/meal-plans operation on clinical-meal-plan resource
457
+ - `getClinicalMeal-plansArchived()` - /clinical/meal-plans/archived operation on clinical-meal-plan resource
415
458
  - `getClinicalMeal-plansBy-workspace()` - /clinical/meal-plans/by-workspace operation on clinical-meal-plan resource
416
459
  - `getClinicalMeal-plansById()` - /clinical/meal-plans/:id operation on clinical-meal-plan resource
417
460
  - `getClinicalSessionsByIdMealPlans()` - /clinical/sessions/:id/meal_plans operation on clinical-meal-plan resource
418
461
  - `postClinicalMeal-plans()` - /clinical/meal-plans operation on clinical-meal-plan resource
419
462
  - `patchClinicalMeal-plansById()` - /clinical/meal-plans/:id operation on clinical-meal-plan resource
420
- - `deleteClinicalMeal-plansById()` - /clinical/meal-plans/:id operation on clinical-meal-plan resource
463
+ - `patchClinicalMeal-plansByIdArchive()` - /clinical/meal-plans/:id/archive operation on clinical-meal-plan resource
464
+ - `patchClinicalMeal-plansByIdRestore()` - /clinical/meal-plans/:id/restore operation on clinical-meal-plan resource
465
+ - `deleteClinicalMeal-plansByIdPermanent()` - /clinical/meal-plans/:id/permanent operation on clinical-meal-plan resource
421
466
 
422
467
  ## Clinical-note
423
468
 
424
469
  - `getClinicalNotes()` - /clinical/notes operation on clinical-note resource
470
+ - `getClinicalNotesArchived()` - /clinical/notes/archived operation on clinical-note resource
425
471
  - `getClinicalNotesById()` - /clinical/notes/:id operation on clinical-note resource
426
472
  - `getClinicalSessionsByIdSessionNotes()` - /clinical/sessions/:id/session_notes operation on clinical-note resource
427
473
  - `postClinicalNotes()` - /clinical/notes operation on clinical-note resource
428
474
  - `patchClinicalNotesById()` - /clinical/notes/:id operation on clinical-note resource
429
475
  - `patchClinicalNotesByIdApprove()` - RD approves the clinical note
476
+ - `patchClinicalNotesByIdArchive()` - /clinical/notes/:id/archive operation on clinical-note resource
430
477
  - `patchClinicalNotesByIdReject()` - RD rejects the clinical note.
431
- - `deleteClinicalNotesById()` - /clinical/notes/:id operation on clinical-note resource
478
+ - `patchClinicalNotesByIdRestore()` - /clinical/notes/:id/restore operation on clinical-note resource
479
+ - `deleteClinicalNotesByIdPermanent()` - /clinical/notes/:id/permanent operation on clinical-note resource
432
480
 
433
481
  ## Clinical-note-version
434
482
 
@@ -446,15 +494,21 @@ flags, workspace mode, and execution limits
446
494
  ## Clinical-practice-resource
447
495
 
448
496
  - `getClinicalPractice-resources()` - /clinical/practice-resources operation on clinical-practice-resource resource
497
+ - `getClinicalPractice-resourcesArchived()` - /clinical/practice-resources/archived operation on clinical-practice-resource resource
449
498
  - `getClinicalPractice-resourcesById()` - /clinical/practice-resources/:id operation on clinical-practice-resource resource
450
499
  - `getClinicalPractice-resourcesCatalog()` - /clinical/practice-resources/catalog operation on clinical-practice-resource resource
500
+ - `getClinicalPractice-resourcesCatalogArchived()` - /clinical/practice-resources/catalog/archived operation on clinical-practice-resource resource
451
501
  - `getClinicalPractice-resourcesCatalogById()` - /clinical/practice-resources/catalog/:id operation on clinical-practice-resource resource
452
502
  - `postClinicalPractice-resources()` - /clinical/practice-resources operation on clinical-practice-resource resource
453
503
  - `postClinicalPractice-resourcesCatalog()` - /clinical/practice-resources/catalog operation on clinical-practice-resource resource
454
504
  - `patchClinicalPractice-resourcesById()` - /clinical/practice-resources/:id operation on clinical-practice-resource resource
505
+ - `patchClinicalPractice-resourcesByIdArchive()` - /clinical/practice-resources/:id/archive operation on clinical-practice-resource resource
506
+ - `patchClinicalPractice-resourcesByIdRestore()` - /clinical/practice-resources/:id/restore operation on clinical-practice-resource resource
455
507
  - `patchClinicalPractice-resourcesCatalogById()` - /clinical/practice-resources/catalog/:id operation on clinical-practice-resource resource
456
- - `deleteClinicalPractice-resourcesById()` - /clinical/practice-resources/:id operation on clinical-practice-resource resource
457
- - `deleteClinicalPractice-resourcesCatalogById()` - /clinical/practice-resources/catalog/:id operation on clinical-practice-resource resource
508
+ - `patchClinicalPractice-resourcesCatalogByIdArchive()` - /clinical/practice-resources/catalog/:id/archive operation on clinical-practice-resource resource
509
+ - `patchClinicalPractice-resourcesCatalogByIdRestore()` - /clinical/practice-resources/catalog/:id/restore operation on clinical-practice-resource resource
510
+ - `deleteClinicalPractice-resourcesByIdPermanent()` - /clinical/practice-resources/:id/permanent operation on clinical-practice-resource resource
511
+ - `deleteClinicalPractice-resourcesCatalogByIdPermanent()` - /clinical/practice-resources/catalog/:id/permanent operation on clinical-practice-resource resource
458
512
 
459
513
  ## Clinical-practice-resource-category
460
514
 
@@ -464,15 +518,21 @@ flags, workspace mode, and execution limits
464
518
  ## Clinical-practice-tool
465
519
 
466
520
  - `getClinicalPractice-tools()` - /clinical/practice-tools operation on clinical-practice-tool resource
521
+ - `getClinicalPractice-toolsArchived()` - /clinical/practice-tools/archived operation on clinical-practice-tool resource
467
522
  - `getClinicalPractice-toolsById()` - /clinical/practice-tools/:id operation on clinical-practice-tool resource
468
523
  - `getClinicalPractice-toolsCatalog()` - /clinical/practice-tools/catalog operation on clinical-practice-tool resource
524
+ - `getClinicalPractice-toolsCatalogArchived()` - /clinical/practice-tools/catalog/archived operation on clinical-practice-tool resource
469
525
  - `getClinicalPractice-toolsCatalogById()` - /clinical/practice-tools/catalog/:id operation on clinical-practice-tool resource
470
526
  - `postClinicalPractice-tools()` - /clinical/practice-tools operation on clinical-practice-tool resource
471
527
  - `postClinicalPractice-toolsCatalog()` - /clinical/practice-tools/catalog operation on clinical-practice-tool resource
472
528
  - `patchClinicalPractice-toolsById()` - /clinical/practice-tools/:id operation on clinical-practice-tool resource
529
+ - `patchClinicalPractice-toolsByIdArchive()` - /clinical/practice-tools/:id/archive operation on clinical-practice-tool resource
530
+ - `patchClinicalPractice-toolsByIdRestore()` - /clinical/practice-tools/:id/restore operation on clinical-practice-tool resource
473
531
  - `patchClinicalPractice-toolsCatalogById()` - /clinical/practice-tools/catalog/:id operation on clinical-practice-tool resource
474
- - `deleteClinicalPractice-toolsById()` - /clinical/practice-tools/:id operation on clinical-practice-tool resource
475
- - `deleteClinicalPractice-toolsCatalogById()` - /clinical/practice-tools/catalog/:id operation on clinical-practice-tool resource
532
+ - `patchClinicalPractice-toolsCatalogByIdArchive()` - /clinical/practice-tools/catalog/:id/archive operation on clinical-practice-tool resource
533
+ - `patchClinicalPractice-toolsCatalogByIdRestore()` - /clinical/practice-tools/catalog/:id/restore operation on clinical-practice-tool resource
534
+ - `deleteClinicalPractice-toolsByIdPermanent()` - /clinical/practice-tools/:id/permanent operation on clinical-practice-tool resource
535
+ - `deleteClinicalPractice-toolsCatalogByIdPermanent()` - /clinical/practice-tools/catalog/:id/permanent operation on clinical-practice-tool resource
476
536
 
477
537
  ## Clinical-practice-tool-category
478
538
 
@@ -527,10 +587,10 @@ flags, workspace mode, and execution limits
527
587
  - `getCompliance-requirement-completionsById()` - /compliance-requirement-completions/:id operation on compliance-requirement-completion resource
528
588
  - `postCompliance-requirement-completions()` - /compliance-requirement-completions operation on compliance-requirement-completion resource
529
589
 
530
- ## Connector instance
590
+ ## Connector-instance
531
591
 
532
- - `getConnectors()` - /connectors operation on connector_instance resource
533
- - `getConnectorsById()` - /connectors/:id operation on connector_instance resource
592
+ - `getConnectors()` - /connectors operation on connector-instance resource
593
+ - `getConnectorsById()` - /connectors/:id operation on connector-instance resource
534
594
  - `postConnectors()` - Install a new connector instance in a workspace
535
595
  - `postConnectorsByIdEdamamRecipesGet()` - Get full details for a single recipe by Edamam recipe ID
536
596
  - `postConnectorsByIdEdamamRecipesSearch()` - Search for recipes using the Edamam Recipe API
@@ -538,11 +598,19 @@ flags, workspace mode, and execution limits
538
598
  - `postConnectorsByIdSync()` - Execute an action on an external connector
539
599
  - `postConnectorsFullscriptCheck-patient()` - Check if a patient exists in Fullscript by email
540
600
  - `postConnectorsFullscriptCreate-patient()` - Create a patient in Fullscript
601
+ - `postConnectorsFullscriptOrdersGet()` - Get order details from Fullscript
602
+ - `postConnectorsFullscriptOrdersList()` - List orders for a Fullscript patient
603
+ - `postConnectorsFullscriptProductsGet()` - Get product details from Fullscript
604
+ - `postConnectorsFullscriptProductsSearch()` - Search the Fullscript product catalog
605
+ - `postConnectorsFullscriptProductsSimilar()` - List similar products from Fullscript
541
606
  - `postConnectorsFullscriptSession-grant()` - Get a Fullscript embed session grant token for the prescribing widget
607
+ - `postConnectorsFullscriptTreatment-plansCancel()` - Cancel an active Fullscript treatment plan
608
+ - `postConnectorsFullscriptTreatment-plansGet()` - Get treatment plan details from Fullscript
609
+ - `postConnectorsFullscriptTreatment-plansList()` - List treatment plans for a Fullscript patient
542
610
  - `postConnectorsOauthCallback()` - Exchange OAuth authorization code for credential.
543
611
  - `postConnectorsOauthInitiate()` - Initiate OAuth flow for a connector type
544
612
  - `patchConnectorsById()` - Update a connector instance's name, configuration, sync interval, health status, or metadata
545
- - `deleteConnectorsById()` - /connectors/:id operation on connector_instance resource
613
+ - `deleteConnectorsById()` - /connectors/:id operation on connector-instance resource
546
614
 
547
615
  ## Consent-record
548
616
 
@@ -565,37 +633,29 @@ flags, workspace mode, and execution limits
565
633
  - `postContentShorten()` - Shorten text to a target character count.
566
634
  - `postContentSuggest-topics()` - Suggest content topics based on industry and audience.
567
635
 
568
- ## Conversations
569
-
570
- - `getAiConversations()` - /ai/conversations operation on conversation resource
571
- - `getAiConversationsById()` - /ai/conversations/:id operation on conversation resource
572
- - `postAiConversations()` - Start a new AI conversation session with optional structured context data (e.g., prediction results to discuss)
573
- - `patchAiConversationsById()` - Update the conversation title or replace the context data map
574
- - `deleteAiConversationsById()` - /ai/conversations/:id operation on conversation resource
575
-
576
- ## Crawler job
636
+ ## Crawler-job
577
637
 
578
- - `getCrawlerJobs()` - /crawler/jobs operation on crawler_job resource
579
- - `getCrawlerJobsById()` - /crawler/jobs/:id operation on crawler_job resource
638
+ - `getCrawlerJobs()` - /crawler/jobs operation on crawler-job resource
639
+ - `getCrawlerJobsById()` - /crawler/jobs/:id operation on crawler-job resource
580
640
  - `postCrawlerJobs()` - Create a crawl job for a URL with the specified mode and strategy; performs a credit pre-check and enqueues execution
581
641
  - `patchCrawlerJobsByIdCancel()` - Cancel a pending or running job; sets status to :cancelled with completed_at timestamp
582
- - `deleteCrawlerJobsById()` - /crawler/jobs/:id operation on crawler_job resource
642
+ - `deleteCrawlerJobsById()` - /crawler/jobs/:id operation on crawler-job resource
583
643
 
584
- ## Crawler result
644
+ ## Crawler-result
585
645
 
586
- - `getCrawlerResults()` - /crawler/results operation on crawler_result resource
587
- - `getCrawlerResultsById()` - /crawler/results/:id operation on crawler_result resource
646
+ - `getCrawlerResults()` - /crawler/results operation on crawler-result resource
647
+ - `getCrawlerResultsById()` - /crawler/results/:id operation on crawler-result resource
588
648
 
589
- ## Crawler schedule
649
+ ## Crawler-schedule
590
650
 
591
- - `getCrawlerSchedules()` - /crawler/schedules operation on crawler_schedule resource
592
- - `getCrawlerSchedulesById()` - /crawler/schedules/:id operation on crawler_schedule resource
651
+ - `getCrawlerSchedules()` - /crawler/schedules operation on crawler-schedule resource
652
+ - `getCrawlerSchedulesById()` - /crawler/schedules/:id operation on crawler-schedule resource
593
653
  - `postCrawlerSchedules()` - Create a recurring crawl schedule for a URL; sets frequency, cron expression, and notification preferences
594
654
  - `patchCrawlerSchedulesById()` - Update schedule configuration, URL, frequency, or notification settings
595
655
  - `patchCrawlerSchedulesByIdDisable()` - Disable a schedule to pause automatic crawling without deleting the configuration.
596
656
  - `patchCrawlerSchedulesByIdEnable()` - Enable a disabled schedule so it resumes automatic crawling on its next_run_at.
597
657
  - `patchCrawlerSchedulesByIdTrigger()` - Manually trigger a scheduled crawl immediately.
598
- - `deleteCrawlerSchedulesById()` - /crawler/schedules/:id operation on crawler_schedule resource
658
+ - `deleteCrawlerSchedulesById()` - /crawler/schedules/:id operation on crawler-schedule resource
599
659
 
600
660
  ## Credential
601
661
 
@@ -605,13 +665,13 @@ flags, workspace mode, and execution limits
605
665
  - `postConnectorsCredentialsDelete-by-type()` - Delete credentials for a connector at a specific scope level
606
666
  - `postConnectorsCredentialsUpsert()` - Create or update credentials for a connector at a specific scope level
607
667
 
608
- ## Credit-package
668
+ ## Credit-package-catalog
609
669
 
610
- - `getCredit-packages()` - /credit-packages operation on credit-package resource
611
- - `getCredit-packagesById()` - /credit-packages/:id operation on credit-package resource
612
- - `getCredit-packagesSlugBySlug()` - /credit-packages/slug/:slug operation on credit-package resource
670
+ - `getCredit-packages()` - /credit-packages operation on credit-package-catalog resource
671
+ - `getCredit-packagesById()` - /credit-packages/:id operation on credit-package-catalog resource
672
+ - `getCredit-packagesSlugBySlug()` - /credit-packages/slug/:slug operation on credit-package-catalog resource
613
673
 
614
- ## Crm activity
674
+ ## Crm-activity
615
675
 
616
676
  - `getCrmActivitiesById()` - Fetch a single active activity by ID; excludes soft-deleted records.
617
677
  - `getCrmActivitiesWorkspaceByWorkspaceId()` - List active activities in a workspace with offset pagination
@@ -619,7 +679,7 @@ flags, workspace mode, and execution limits
619
679
  - `patchCrmActivitiesById()` - Update an activity's subject, body, sentiment, or AI-generated fields
620
680
  - `deleteCrmActivitiesById()` - Soft-delete an activity by setting deleted_at
621
681
 
622
- ## Crm company
682
+ ## Crm-company
623
683
 
624
684
  - `getCrmCompaniesById()` - Fetch a single active company by ID; excludes soft-deleted records.
625
685
  - `getCrmCompaniesWorkspaceByWorkspaceId()` - List active companies in a workspace with offset pagination
@@ -627,7 +687,7 @@ flags, workspace mode, and execution limits
627
687
  - `patchCrmCompaniesById()` - Update mutable fields on an existing company
628
688
  - `deleteCrmCompaniesById()` - Soft-delete a company by setting deleted_at
629
689
 
630
- ## Crm contact
690
+ ## Crm-contact
631
691
 
632
692
  - `getCrmContactsById()` - Fetch a single active contact by ID; excludes soft-deleted records.
633
693
  - `getCrmContactsWorkspaceByWorkspaceId()` - List active contacts in a workspace with optional lifecycle_stage, tag, and
@@ -639,7 +699,7 @@ property filters applied Elixir-side
639
699
  - `patchCrmContactsByIdArchive()` - Soft-archive a contact (sets deleted_at)
640
700
  - `deleteCrmContactsById()` - Soft-delete a contact by setting deleted_at
641
701
 
642
- ## Crm custom entity
702
+ ## Crm-custom-entity
643
703
 
644
704
  - `getCrmCustom-entitiesById()` - Fetch a single active custom entity by ID; excludes soft-deleted records.
645
705
  - `getCrmCustom-entitiesWorkspaceByWorkspaceId()` - List active custom entities in a workspace, optionally filtered by type slug and
@@ -648,19 +708,19 @@ attribute-level property filters
648
708
  - `patchCrmCustom-entitiesById()` - Update a custom entity's properties and pipeline assignment
649
709
  - `deleteCrmCustom-entitiesById()` - Soft-delete a custom entity by setting deleted_at
650
710
 
651
- ## Crm custom entity version
711
+ ## Crm-custom-entity-version
652
712
 
653
- - `getCrmCustom-entitiesByEntityIdVersions()` - /crm/custom-entities/:entity_id/versions operation on crm_custom_entity_version resource
713
+ - `getCrmCustom-entitiesByEntityIdVersions()` - /crm/custom-entities/:entity_id/versions operation on crm-custom-entity-version resource
654
714
  - `getCrmCustom-entitiesByEntityIdVersionsById()` - Fetch a single version by ID, scoped to a specific entity (IDOR-safe)
655
715
 
656
- ## Crm data export job
716
+ ## Crm-data-export-job
657
717
 
658
718
  - `getCrmExportsById()` - Fetch a single export job by ID
659
719
  - `getCrmExportsWorkspaceByWorkspaceId()` - List all export jobs for a workspace, sorted newest first
660
720
  - `postCrmExports()` - Enqueue an async CRM data export job
661
721
  - `patchCrmExportsByIdRefresh-url()` - Regenerate the presigned download URL for a completed export job
662
722
 
663
- ## Crm deal
723
+ ## Crm-deal
664
724
 
665
725
  - `getCrmDealsById()` - Fetch a single active deal by ID; excludes soft-deleted records.
666
726
  - `getCrmDealsWorkspaceByWorkspaceId()` - List active deals in a workspace with offset pagination
@@ -669,46 +729,36 @@ attribute-level property filters
669
729
  - `patchCrmDealsByIdMove-stage()` - Move a deal to a different pipeline stage
670
730
  - `deleteCrmDealsById()` - Soft-delete a deal by setting deleted_at
671
731
 
672
- ## Crm pipeline
732
+ ## Crm-pipeline
673
733
 
674
- - `getCrmPipelinesById()` - /crm/pipelines/:id operation on crm_pipeline resource
734
+ - `getCrmPipelinesById()` - /crm/pipelines/:id operation on crm-pipeline resource
675
735
  - `getCrmPipelinesWorkspaceByWorkspaceId()` - List pipelines available to a workspace — includes both workspace-specific pipelines and application-level templates (workspace_id IS NULL).
676
736
  - `postCrmPipelines()` - Create a pipeline scoped to an application (template) or a specific workspace
677
737
  - `patchCrmPipelinesById()` - Update a pipeline's name or default status
678
- - `deleteCrmPipelinesById()` - /crm/pipelines/:id operation on crm_pipeline resource
738
+ - `deleteCrmPipelinesById()` - /crm/pipelines/:id operation on crm-pipeline resource
679
739
 
680
- ## Crm pipeline stage
740
+ ## Crm-pipeline-stage
681
741
 
682
- - `getCrmPipeline-stagesById()` - /crm/pipeline-stages/:id operation on crm_pipeline_stage resource
742
+ - `getCrmPipeline-stagesById()` - /crm/pipeline-stages/:id operation on crm-pipeline-stage resource
683
743
  - `getCrmPipeline-stagesPipelineByPipelineId()` - List all stages for a specific pipeline, ordered by position.
684
744
  - `postCrmPipeline-stages()` - Add a stage to a pipeline with an explicit sort order, optional win probability, and forecast category
685
745
  - `patchCrmPipeline-stagesById()` - Update a pipeline stage's name, order, probability, or closed flag
686
- - `deleteCrmPipeline-stagesById()` - /crm/pipeline-stages/:id operation on crm_pipeline_stage resource
746
+ - `deleteCrmPipeline-stagesById()` - /crm/pipeline-stages/:id operation on crm-pipeline-stage resource
687
747
 
688
- ## Crm relationship
748
+ ## Crm-relationship
689
749
 
690
750
  - `getCrmRelationshipsById()` - Fetch a single CRM relationship by ID
691
751
  - `getCrmRelationshipsWorkspaceByWorkspaceId()` - List all relationship edges in a workspace
692
752
  - `postCrmRelationships()` - Create a typed relationship edge between two CRM entities
693
753
  - `deleteCrmRelationshipsById()` - Permanently remove a relationship edge (hard delete)
694
754
 
695
- ## Crm relationship type
755
+ ## Crm-relationship-type
696
756
 
697
- - `getCrmRelationship-types()` - /crm/relationship-types operation on crm_relationship_type resource
698
- - `getCrmRelationship-typesById()` - /crm/relationship-types/:id operation on crm_relationship_type resource
757
+ - `getCrmRelationship-types()` - /crm/relationship-types operation on crm-relationship-type resource
758
+ - `getCrmRelationship-typesById()` - /crm/relationship-types/:id operation on crm-relationship-type resource
699
759
  - `postCrmRelationship-types()` - Define a named relationship category for an application
700
760
  - `patchCrmRelationship-typesById()` - Update a relationship type's display name, allowed entity types, or properties schema
701
- - `deleteCrmRelationship-typesById()` - /crm/relationship-types/:id operation on crm_relationship_type resource
702
-
703
- ## Data store record
704
-
705
- - `getDataStoreRecords()` - /data_store/records operation on data_store_record resource
706
- - `getDataStoreRecordsById()` - /data_store/records/:id operation on data_store_record resource
707
- - `getDataStoreRecordsByNamespace()` - List records in a namespace
708
- - `postDataStoreRecords()` - /data_store/records operation on data_store_record resource
709
- - `postDataStoreRecordsUpsert()` - Create or update a record by namespace and key
710
- - `patchDataStoreRecordsById()` - /data_store/records/:id operation on data_store_record resource
711
- - `deleteDataStoreRecordsById()` - /data_store/records/:id operation on data_store_record resource
761
+ - `deleteCrmRelationship-typesById()` - /crm/relationship-types/:id operation on crm-relationship-type resource
712
762
 
713
763
  ## Data-protection-impact-assessment
714
764
 
@@ -718,6 +768,16 @@ attribute-level property filters
718
768
  - `patchImpact-assessmentsById()` - Update the DPIA's title, description, risk level, findings, or mitigations while it is in draft or in_review status
719
769
  - `patchImpact-assessmentsByIdApprove()` - Approve a completed DPIA by recording the approver's name and setting `approved_at` to the current timestamp
720
770
 
771
+ ## Data-store-record
772
+
773
+ - `getDataStoreRecords()` - /data_store/records operation on data-store-record resource
774
+ - `getDataStoreRecordsById()` - /data_store/records/:id operation on data-store-record resource
775
+ - `getDataStoreRecordsByNamespace()` - List records in a namespace
776
+ - `postDataStoreRecords()` - /data_store/records operation on data-store-record resource
777
+ - `postDataStoreRecordsUpsert()` - Create or update a record by namespace and key
778
+ - `patchDataStoreRecordsById()` - /data_store/records/:id operation on data-store-record resource
779
+ - `deleteDataStoreRecordsById()` - /data_store/records/:id operation on data-store-record resource
780
+
721
781
  ## Data-subject-request
722
782
 
723
783
  - `getData-subject-requests()` - /data-subject-requests operation on data-subject-request resource
@@ -739,52 +799,20 @@ attribute-level property filters
739
799
  - `getDisclosure-logsById()` - /disclosure-logs/:id operation on disclosure-log resource
740
800
  - `postDisclosure-logs()` - /disclosure-logs operation on disclosure-log resource
741
801
 
742
- ## Document chunk
802
+ ## Document-chunk
743
803
 
744
804
  - `getAiChunksDocumentByDocumentId()` - Fetch all chunks for a document sorted by chunk_index ascending; equivalent to read_by_document — use for JSON:API access via /ai/chunks/document/:document_id.
745
805
  - `postAiChunksSearch()` - Run a similarity search and return matching chunks via the JSON:API endpoint (/ai/chunks/search); internally calls the :search read action and wraps results in a metadata envelope.
746
806
 
747
- ## Document Extraction
748
-
749
- - `getExtractionDocuments()` - Primary read for active (non-deleted) documents
750
- - `getExtractionDocumentsById()` - Primary read for active (non-deleted) documents
751
- - `getExtractionDocumentsByIdStatus()` - Lightweight poll endpoint: fetches only `id`, `status`, `progress`, and `error_message` for
752
- a single document
753
- - `getExtractionDocumentsByIdView()` - Get a document with its presigned view URL
754
- - `getExtractionDocumentsWorkspaceByWorkspaceId()` - List active (non-deleted) documents in a workspace, sorted by creation date
755
- - `getExtractionDocumentsWorkspaceByWorkspaceIdBy-statusByStatus()` - Filter documents by workspace_id and processing status
756
- - `getExtractionDocumentsWorkspaceByWorkspaceIdExcluded()` - List excluded documents
757
- - `getExtractionDocumentsWorkspaceByWorkspaceIdReview-queue()` - Get prioritized review queue for active learning
758
- - `getExtractionDocumentsWorkspaceByWorkspaceIdTrained()` - List documents that have been trained and not dismissed
759
- - `getExtractionDocumentsWorkspaceByWorkspaceIdTrashed()` - List soft-deleted (trashed) documents
760
- - `postExtractionDocumentsBegin-upload()` - Step 1 of 2 in the two-step upload flow
761
- - `postExtractionDocumentsFind-or-begin-upload()` - Dedup-aware upload: returns existing document if file_hash matches, otherwise creates new document
762
- - `postExtractionDocumentsUpload()` - Legacy single-step upload: create a document record and immediately enqueue processing
763
- - `patchExtractionDocumentsByIdCancel()` - Cancel a processing document
764
- - `patchExtractionDocumentsByIdDismiss()` - Alias for `:dismiss_training`
765
- - `patchExtractionDocumentsByIdDismiss-training()` - Dismiss a trained document from the active-learning training dashboard without excluding it
766
- from future training
767
- - `patchExtractionDocumentsByIdExclude()` - Mark a document as excluded from agent training
768
- - `patchExtractionDocumentsByIdFinish-upload()` - Step 2 of 2 in the two-step upload flow
769
- - `patchExtractionDocumentsByIdInclude()` - Reverse an exclusion: allow a previously excluded document to contribute training examples
770
- again
771
- - `patchExtractionDocumentsByIdMark-trained()` - Record that a document has been used for agent training
772
- - `patchExtractionDocumentsByIdReprocess()` - Re-extract document with current or specified schema version
773
- - `patchExtractionDocumentsByIdRestore()` - Reverse an exclusion: allow a previously excluded document to contribute training examples
774
- again
775
- - `patchExtractionDocumentsByIdStatus()` - Internal-facing status update used by the web layer and API to set processing state
776
- - `patchExtractionDocumentsByIdVerification()` - Update the human verification status of a completed document
777
- - `deleteExtractionDocumentsById()` - Soft-delete a document and enqueue storage cleanup
778
-
779
- ## Document stats
780
-
781
- - `getDocumentsStats()` - /documents/stats operation on document_stats resource
782
-
783
807
  ## Document-section
784
808
 
785
809
  - `getMemoryDocument-sections()` - /memory/document-sections operation on document-section resource
786
810
  - `getMemoryDocument-sectionsById()` - /memory/document-sections/:id operation on document-section resource
787
811
 
812
+ ## Document-stats
813
+
814
+ - `getDocumentsStats()` - /documents/stats operation on document-stats resource
815
+
788
816
  ## Email-inbound-address
789
817
 
790
818
  - `getEmailInbound-addressesById()` - /email/inbound-addresses/:id operation on email-inbound-address resource
@@ -917,27 +945,59 @@ again
917
945
  - `postEphi-data-flows()` - /ephi-data-flows operation on ephi-data-flow resource
918
946
  - `patchEphi-data-flowsById()` - /ephi-data-flows/:id operation on ephi-data-flow resource
919
947
 
920
- ## Extraction agent
948
+ ## Extraction-agent
921
949
 
922
- - `getExtractionAgents()` - /extraction/agents operation on extraction_agent resource
923
- - `getExtractionAgentsById()` - /extraction/agents/:id operation on extraction_agent resource
950
+ - `getExtractionAgents()` - /extraction/agents operation on extraction-agent resource
951
+ - `getExtractionAgentsById()` - /extraction/agents/:id operation on extraction-agent resource
924
952
  - `postExtractionAgentsPredict()` - Predicts the best agents for a given input
925
953
 
926
- ## Extraction Batches
954
+ ## Extraction-batch
927
955
 
928
- - `getExtractionBatchesById()` - /extraction/batches/:id operation on extraction_batch resource
956
+ - `getExtractionBatchesById()` - /extraction/batches/:id operation on extraction-batch resource
929
957
  - `getExtractionBatchesByIdUpload-urls()` - Generate presigned URLs for batch document upload
930
958
  - `getExtractionBatchesWorkspaceByWorkspaceId()` - List all batches for a workspace, unfiltered and unpaginated
931
959
  - `postExtractionBatches()` - Create a new extraction batch to group related documents
932
- - `deleteExtractionBatchesById()` - /extraction/batches/:id operation on extraction_batch resource
960
+ - `deleteExtractionBatchesById()` - /extraction/batches/:id operation on extraction-batch resource
961
+
962
+ ## Extraction-document
963
+
964
+ - `getExtractionDocuments()` - Primary read for active (non-deleted) documents
965
+ - `getExtractionDocumentsById()` - Primary read for active (non-deleted) documents
966
+ - `getExtractionDocumentsByIdStatus()` - Lightweight poll endpoint: fetches only `id`, `status`, `progress`, and `error_message` for
967
+ a single document
968
+ - `getExtractionDocumentsByIdView()` - Get a document with its presigned view URL
969
+ - `getExtractionDocumentsWorkspaceByWorkspaceId()` - List active (non-deleted) documents in a workspace, sorted by creation date
970
+ - `getExtractionDocumentsWorkspaceByWorkspaceIdBy-statusByStatus()` - Filter documents by workspace_id and processing status
971
+ - `getExtractionDocumentsWorkspaceByWorkspaceIdExcluded()` - List excluded documents
972
+ - `getExtractionDocumentsWorkspaceByWorkspaceIdReview-queue()` - Get prioritized review queue for active learning
973
+ - `getExtractionDocumentsWorkspaceByWorkspaceIdTrained()` - List documents that have been trained and not dismissed
974
+ - `getExtractionDocumentsWorkspaceByWorkspaceIdTrashed()` - List soft-deleted (trashed) documents
975
+ - `postExtractionDocumentsBegin-upload()` - Step 1 of 2 in the two-step upload flow
976
+ - `postExtractionDocumentsFind-or-begin-upload()` - Dedup-aware upload: returns existing document if file_hash matches, otherwise creates new document
977
+ - `postExtractionDocumentsUpload()` - Legacy single-step upload: create a document record and immediately enqueue processing
978
+ - `patchExtractionDocumentsByIdCancel()` - Cancel a processing document
979
+ - `patchExtractionDocumentsByIdDismiss()` - Alias for `:dismiss_training`
980
+ - `patchExtractionDocumentsByIdDismiss-training()` - Dismiss a trained document from the active-learning training dashboard without excluding it
981
+ from future training
982
+ - `patchExtractionDocumentsByIdExclude()` - Mark a document as excluded from agent training
983
+ - `patchExtractionDocumentsByIdFinish-upload()` - Step 2 of 2 in the two-step upload flow
984
+ - `patchExtractionDocumentsByIdInclude()` - Reverse an exclusion: allow a previously excluded document to contribute training examples
985
+ again
986
+ - `patchExtractionDocumentsByIdMark-trained()` - Record that a document has been used for agent training
987
+ - `patchExtractionDocumentsByIdReprocess()` - Re-extract document with current or specified schema version
988
+ - `patchExtractionDocumentsByIdRestore()` - Reverse an exclusion: allow a previously excluded document to contribute training examples
989
+ again
990
+ - `patchExtractionDocumentsByIdStatus()` - Internal-facing status update used by the web layer and API to set processing state
991
+ - `patchExtractionDocumentsByIdVerification()` - Update the human verification status of a completed document
992
+ - `deleteExtractionDocumentsById()` - Soft-delete a document and enqueue storage cleanup
933
993
 
934
- ## Extraction export
994
+ ## Extraction-export
935
995
 
936
996
  - `getWorkspacesByWorkspaceIdExtractionExports()` - List exports for a workspace, filtered by status
937
- - `getWorkspacesByWorkspaceIdExtractionExportsById()` - /workspaces/:workspace_id/extraction/exports/:id operation on extraction_export resource
938
- - `postWorkspacesByWorkspaceIdExtractionExports()` - /workspaces/:workspace_id/extraction/exports operation on extraction_export resource
997
+ - `getWorkspacesByWorkspaceIdExtractionExportsById()` - /workspaces/:workspace_id/extraction/exports/:id operation on extraction-export resource
998
+ - `postWorkspacesByWorkspaceIdExtractionExports()` - /workspaces/:workspace_id/extraction/exports operation on extraction-export resource
939
999
 
940
- ## Extraction Results
1000
+ ## Extraction-result
941
1001
 
942
1002
  - `getExtractionResults()` - Primary read for extraction results
943
1003
  - `getExtractionResultsById()` - Fetch a single ExtractionResult by ID
@@ -969,21 +1029,29 @@ fields
969
1029
  - `getFeature-usages()` - List all feature usage records.
970
1030
  - `getFeature-usagesBy-tenantByTenantId()` - List feature usage records for a specific tenant.
971
1031
  - `getFeature-usagesById()` - Fetch a single feature usage record by ID.
1032
+ - `postFeature-usagesIncrement()` - Increment usage for a feature by key
972
1033
 
973
- ## Field mapping confirmation
1034
+ ## Field-mapping-confirmation
974
1035
 
975
- - `postWorkspacesByWorkspaceIdExtractionByDocumentIdMapping()` - /workspaces/:workspace_id/extraction/:document_id/mapping operation on field_mapping_confirmation resource
1036
+ - `postWorkspacesByWorkspaceIdExtractionByDocumentIdMapping()` - /workspaces/:workspace_id/extraction/:document_id/mapping operation on field-mapping-confirmation resource
976
1037
 
977
- ## Field mapping result
1038
+ ## Field-mapping-result
978
1039
 
979
- - `getWorkspacesByWorkspaceIdExtractionByDocumentIdMapping()` - /workspaces/:workspace_id/extraction/:document_id/mapping operation on field_mapping_result resource
1040
+ - `getWorkspacesByWorkspaceIdExtractionByDocumentIdMapping()` - /workspaces/:workspace_id/extraction/:document_id/mapping operation on field-mapping-result resource
980
1041
 
981
- ## Field Templates
1042
+ ## Field-template
982
1043
 
983
- - `getField-templates()` - /field-templates operation on field_template resource
984
- - `getField-templatesById()` - /field-templates/:id operation on field_template resource
985
- - `postField-templates()` - /field-templates operation on field_template resource
986
- - `deleteField-templatesById()` - /field-templates/:id operation on field_template resource
1044
+ - `getField-templates()` - /field-templates operation on field-template resource
1045
+ - `getField-templatesById()` - /field-templates/:id operation on field-template resource
1046
+ - `postField-templates()` - /field-templates operation on field-template resource
1047
+ - `deleteField-templatesById()` - /field-templates/:id operation on field-template resource
1048
+
1049
+ ## Graph-node
1050
+
1051
+ - `getAiGraphNodes()` - Paginate Entity vertices for the caller's tenant; returns up to 50 nodes per page by default.
1052
+ - `getAiGraphNodesLabelByLabel()` - Find all Entity vertices with an exact label match; use to look up a specific named entity in the knowledge graph.
1053
+ - `postAiGraphNodes()` - Create an Entity vertex in the knowledge graph; tenant_id is always forced from the actor and cannot be supplied by the caller
1054
+ - `deleteAiGraphNodesById()` - /ai/graph/nodes/:id operation on graph-node resource
987
1055
 
988
1056
  ## Invitations
989
1057
 
@@ -1002,13 +1070,6 @@ fields
1002
1070
 
1003
1071
  - `getWalletInvoices()` - Read all invoices for the current tenant
1004
1072
 
1005
- ## Knowledge Graph
1006
-
1007
- - `getAiGraphNodes()` - Paginate Entity vertices for the caller's tenant; returns up to 50 nodes per page by default.
1008
- - `getAiGraphNodesLabelByLabel()` - Find all Entity vertices with an exact label match; use to look up a specific named entity in the knowledge graph.
1009
- - `postAiGraphNodes()` - Create an Entity vertex in the knowledge graph; tenant_id is always forced from the actor and cannot be supplied by the caller
1010
- - `deleteAiGraphNodesById()` - /ai/graph/nodes/:id operation on graph_node resource
1011
-
1012
1073
  ## Legal-acceptance
1013
1074
 
1014
1075
  - `getLegal-acceptances()` - /legal-acceptances operation on legal-acceptance resource
@@ -1027,45 +1088,34 @@ fields
1027
1088
  - `patchLegal-documentsByIdUnpublish()` - Deactivate a legal document without deleting it
1028
1089
  - `deleteLegal-documentsById()` - /legal-documents/:id operation on legal-document resource
1029
1090
 
1030
- ## Messages
1091
+ ## Notification-log
1031
1092
 
1032
- - `getMessages()` - /messages operation on message resource
1033
- - `getMessagesById()` - /messages/:id operation on message resource
1034
- - `getMessagesSearch()` - Full-text search messages by substring match on content within the actor's accessible threads
1035
- - `getMessagesSemantic-search()` - Vector similarity search across messages using a generated embedding of the query string
1036
- - `getThreadsByIdMessages()` - /threads/:id/messages operation on message resource
1037
- - `postMessages()` - Add a new message turn to a thread
1038
- - `patchMessagesById()` - Edit a message's content, role, or metadata
1039
- - `deleteMessagesById()` - /messages/:id operation on message resource
1040
-
1041
- ## Notification log
1042
-
1043
- - `getNotification-logs()` - /notification-logs operation on notification_log resource
1044
- - `getNotification-logsById()` - /notification-logs/:id operation on notification_log resource
1093
+ - `getNotification-logs()` - /notification-logs operation on notification-log resource
1094
+ - `getNotification-logsById()` - /notification-logs/:id operation on notification-log resource
1045
1095
  - `getNotification-logsStats()` - Get notification log statistics
1046
1096
 
1047
- ## Notification method
1097
+ ## Notification-method
1048
1098
 
1049
- - `getNotification-methods()` - /notification-methods operation on notification_method resource
1050
- - `getNotification-methodsById()` - /notification-methods/:id operation on notification_method resource
1099
+ - `getNotification-methods()` - /notification-methods operation on notification-method resource
1100
+ - `getNotification-methodsById()` - /notification-methods/:id operation on notification-method resource
1051
1101
  - `postNotification-methods()` - Register a new notification delivery channel for a user (email address, phone number, Slack webhook, or generic webhook URL)
1052
1102
  - `patchNotification-methodsById()` - Update the display name or connection config for an existing notification method
1053
1103
  - `patchNotification-methodsByIdSend-verification()` - Generate a 6-digit verification code, store it as `verification_token`, and record `verification_sent_at`
1054
1104
  - `patchNotification-methodsByIdSet-primary()` - Mark this notification method as the primary channel for its type, used when multiple methods of the same type exist.
1055
1105
  - `patchNotification-methodsByIdVerify()` - Mark the notification method as verified by setting `verified_at` to the current timestamp
1056
- - `deleteNotification-methodsById()` - /notification-methods/:id operation on notification_method resource
1106
+ - `deleteNotification-methodsById()` - /notification-methods/:id operation on notification-method resource
1057
1107
 
1058
- ## Notification preference
1108
+ ## Notification-preference
1059
1109
 
1060
- - `getNotification-preferences()` - /notification-preferences operation on notification_preference resource
1061
- - `getNotification-preferencesById()` - /notification-preferences/:id operation on notification_preference resource
1110
+ - `getNotification-preferences()` - /notification-preferences operation on notification-preference resource
1111
+ - `getNotification-preferencesById()` - /notification-preferences/:id operation on notification-preference resource
1062
1112
  - `postNotification-preferences()` - Create notification preferences for a user, specifying which delivery channels are enabled (e.g., email, SMS) and category-level opt-in/out settings
1063
1113
  - `patchNotification-preferencesById()` - Update a user's notification channel list or per-category preferences
1064
- - `deleteNotification-preferencesById()` - /notification-preferences/:id operation on notification_preference resource
1114
+ - `deleteNotification-preferencesById()` - /notification-preferences/:id operation on notification-preference resource
1065
1115
 
1066
- ## Operation success
1116
+ ## Operation-success
1067
1117
 
1068
- - `postDocumentsBulk-delete()` - /documents/bulk-delete operation on operation_success resource
1118
+ - `postDocumentsBulk-delete()` - /documents/bulk-delete operation on operation-success resource
1069
1119
 
1070
1120
  ## Payment-method
1071
1121
 
@@ -1082,29 +1132,35 @@ fields
1082
1132
  - `getPermissions()` - List all registered permissions from the PermissionRegistry, optionally filtered by app, context, or category
1083
1133
  - `getPermissionsById()` - Fetch all permissions and apply any query filters supplied by the caller; use :by_id for single-record lookup by permission ID string.
1084
1134
 
1085
- ## Permission meta
1135
+ ## Permission-meta
1086
1136
 
1087
1137
  - `getPermissionsMeta()` - Fetch a single metadata record describing the permission system — schema version, available apps, scopes, categories, and suggested client cache TTL
1088
1138
 
1089
- ## Permission preset
1139
+ ## Permission-preset
1090
1140
 
1091
1141
  - `getPermissionsPresets()` - List all permission presets (pre-defined role bundles) from the PermissionRegistry, optionally filtered by context and app
1092
1142
  - `getPermissionsPresetsById()` - Fetch a single permission preset by its composite ID (e.g., 'workspace:org:admin'); returns the preset with its full permission list or a not-found error.
1093
1143
 
1094
- ## Plan-feature-allocation
1144
+ ## Plan-catalog
1145
+
1146
+ - `getPlans()` - /plans operation on plan-catalog resource
1147
+ - `getPlansById()` - /plans/:id operation on plan-catalog resource
1148
+ - `getPlansSlugBySlug()` - /plans/slug/:slug operation on plan-catalog resource
1149
+
1150
+ ## Plan-feature-allocation-catalog
1095
1151
 
1096
1152
  - `getPlan-feature-allocations()` - List all plan feature allocations for the current application.
1097
1153
  - `getPlan-feature-allocationsBy-planByPlanId()` - List feature allocations for a specific plan.
1098
1154
  - `getPlan-feature-allocationsById()` - Fetch a single plan feature allocation by ID.
1099
1155
 
1100
- ## Platform tone
1156
+ ## Platform-tone
1101
1157
 
1102
- - `getPlatform-tones()` - /platform-tones operation on platform_tone resource
1103
- - `getPlatform-tonesBy-brandByBrandIdentityId()` - /platform-tones/by-brand/:brand_identity_id operation on platform_tone resource
1104
- - `getPlatform-tonesById()` - /platform-tones/:id operation on platform_tone resource
1105
- - `postPlatform-tones()` - /platform-tones operation on platform_tone resource
1106
- - `patchPlatform-tonesById()` - /platform-tones/:id operation on platform_tone resource
1107
- - `deletePlatform-tonesById()` - /platform-tones/:id operation on platform_tone resource
1158
+ - `getPlatform-tones()` - /platform-tones operation on platform-tone resource
1159
+ - `getPlatform-tonesBy-brandByBrandIdentityId()` - /platform-tones/by-brand/:brand_identity_id operation on platform-tone resource
1160
+ - `getPlatform-tonesById()` - /platform-tones/:id operation on platform-tone resource
1161
+ - `postPlatform-tones()` - /platform-tones operation on platform-tone resource
1162
+ - `patchPlatform-tonesById()` - /platform-tones/:id operation on platform-tone resource
1163
+ - `deletePlatform-tonesById()` - /platform-tones/:id operation on platform-tone resource
1108
1164
 
1109
1165
  ## Policy-review-schedule
1110
1166
 
@@ -1115,17 +1171,17 @@ fields
1115
1171
  - `patchPolicy-review-schedulesByIdMark-due()` - /policy-review-schedules/:id/mark-due operation on policy-review-schedule resource
1116
1172
  - `patchPolicy-review-schedulesByIdMark-overdue()` - /policy-review-schedules/:id/mark-overdue operation on policy-review-schedule resource
1117
1173
 
1118
- ## Post metric
1174
+ ## Post-metric
1119
1175
 
1120
- - `getSocialMetricsAccountBySocialAccountId()` - /social/metrics/account/:social_account_id operation on post_metric resource
1121
- - `getSocialMetricsById()` - /social/metrics/:id operation on post_metric resource
1122
- - `getSocialMetricsCampaignBySocialCampaignId()` - /social/metrics/campaign/:social_campaign_id operation on post_metric resource
1123
- - `getSocialMetricsPostBySocialPostId()` - /social/metrics/post/:social_post_id operation on post_metric resource
1124
- - `getSocialMetricsPostBySocialPostIdLatest()` - /social/metrics/post/:social_post_id/latest operation on post_metric resource
1176
+ - `getSocialMetricsAccountBySocialAccountId()` - /social/metrics/account/:social_account_id operation on post-metric resource
1177
+ - `getSocialMetricsById()` - /social/metrics/:id operation on post-metric resource
1178
+ - `getSocialMetricsCampaignBySocialCampaignId()` - /social/metrics/campaign/:social_campaign_id operation on post-metric resource
1179
+ - `getSocialMetricsPostBySocialPostId()` - /social/metrics/post/:social_post_id operation on post-metric resource
1180
+ - `getSocialMetricsPostBySocialPostIdLatest()` - /social/metrics/post/:social_post_id/latest operation on post-metric resource
1125
1181
 
1126
- ## Presigned url
1182
+ ## Presigned-url
1127
1183
 
1128
- - `postDocumentsPresigned-upload()` - /documents/presigned-upload operation on presigned_url resource
1184
+ - `postDocumentsPresigned-upload()` - /documents/presigned-upload operation on presigned-url resource
1129
1185
 
1130
1186
  ## Processing-activity
1131
1187
 
@@ -1158,14 +1214,23 @@ fields
1158
1214
  - `patchRolesById()` - Update a role's name, description, or permission list; does NOT retroactively update existing AccessGrants
1159
1215
  - `deleteRolesById()` - Delete a role; emits a RoleDeleted audit event
1160
1216
 
1217
+ ## Saved-search
1218
+
1219
+ - `getSearchSaved()` - List saved searches accessible to the current actor: the actor's own searches and any searches marked `is_shared` within the same tenant.
1220
+ - `postSearchSaved()` - Persist a named search query for reuse
1221
+ - `postSearchSavedByIdRun()` - Re-execute a saved search by ID and return the saved search metadata enriched with an `executed_at` ISO-8601 timestamp
1222
+ - `patchSearchSavedById()` - Modify the name, query string, search type, filters, or sharing status of an existing saved search
1223
+ - `deleteSearchSavedById()` - /search/saved/:id operation on saved-search resource
1224
+
1161
1225
  ## Scan-result
1162
1226
 
1163
1227
  - `getScan-results()` - /scan-results operation on scan-result resource
1164
1228
  - `getScan-resultsById()` - /scan-results/:id operation on scan-result resource
1165
1229
 
1166
- ## Scheduling booking
1230
+ ## Scheduling-booking
1167
1231
 
1168
1232
  - `getSchedulingBookings()` - List all bookings for a workspace
1233
+ - `getSchedulingBookingsBy-booker()` - List all bookings made by a specific email address across the workspace
1169
1234
  - `getSchedulingBookingsById()` - Fetch a single booking by ID
1170
1235
  - `postSchedulingBookings()` - Create a booking for an external party claiming a time slot
1171
1236
  - `patchSchedulingBookingsByIdCancel()` - Cancel a booking, recording cancellation_reason and cancelled_by (:booker/:organizer/:system)
@@ -1173,7 +1238,7 @@ fields
1173
1238
  - `patchSchedulingBookingsByIdMark-no-show()` - Mark a booking as :no_show when the booker did not attend
1174
1239
  - `patchSchedulingBookingsByIdReschedule()` - Reschedule a booking by moving its linked Event to new_start_time/new_end_time
1175
1240
 
1176
- ## Scheduling calendar sync
1241
+ ## Scheduling-calendar-sync
1177
1242
 
1178
1243
  - `getSchedulingCalendar-syncs()` - List all calendar sync configurations for a specific user
1179
1244
  - `getSchedulingCalendar-syncsById()` - Fetch a single calendar sync configuration by ID
@@ -1183,7 +1248,7 @@ fields
1183
1248
  - `patchSchedulingCalendar-syncsByIdResume()` - Resume a paused or errored calendar sync
1184
1249
  - `deleteSchedulingCalendar-syncsById()` - Hard-delete a calendar sync configuration, stopping all future sync runs for this calendar
1185
1250
 
1186
- ## Scheduling event
1251
+ ## Scheduling-event
1187
1252
 
1188
1253
  - `getSchedulingEvents()` - List all events in a workspace, newest first
1189
1254
  - `getSchedulingEventsByDateRange()` - List events in a workspace that overlap a given time window (start_time < end, end_time > start)
@@ -1195,14 +1260,16 @@ fields
1195
1260
  - `patchSchedulingEventsByIdComplete()` - Mark a confirmed event as completed
1196
1261
  - `patchSchedulingEventsByIdReschedule()` - Move an event to a new time slot
1197
1262
 
1198
- ## Scheduling event type
1263
+ ## Scheduling-event-type
1199
1264
 
1200
1265
  - `getSchedulingEvent-types()` - List all active event types for a workspace
1266
+ - `getSchedulingEvent-typesBy-slug()` - Fetch a single active event type by its URL-friendly slug
1201
1267
  - `getSchedulingEvent-typesById()` - Fetch a single event type by ID
1202
1268
  - `postSchedulingEvent-types()` - Create an event type template for a workspace
1203
1269
  - `patchSchedulingEvent-typesById()` - Update event type configuration including duration, buffers, location, capacity, and intake form
1270
+ - `patchSchedulingEvent-typesByIdArchive()` - Soft-archive an event type by setting status to :archived
1204
1271
 
1205
- ## Scheduling participant
1272
+ ## Scheduling-participant
1206
1273
 
1207
1274
  - `getSchedulingParticipants()` - List all participants for a specific event, including organizer and attendees
1208
1275
  - `getSchedulingParticipantsById()` - Fetch a single participant by ID
@@ -1211,10 +1278,10 @@ fields
1211
1278
  - `patchSchedulingParticipantsByIdRespond()` - Record a participant's RSVP: :accepted, :declined, or :tentative
1212
1279
  - `deleteSchedulingParticipantsById()` - Hard-delete a participant from an event
1213
1280
 
1214
- ## Schema discovery
1281
+ ## Schema-discovery
1215
1282
 
1216
- - `getExtractionSchema-discoveriesById()` - /extraction/schema-discoveries/:id operation on schema_discovery resource
1217
- - `postExtractionSchema-discoveries()` - /extraction/schema-discoveries operation on schema_discovery resource
1283
+ - `getExtractionSchema-discoveriesById()` - /extraction/schema-discoveries/:id operation on schema-discovery resource
1284
+ - `postExtractionSchema-discoveries()` - /extraction/schema-discoveries operation on schema-discovery resource
1218
1285
  - `postExtractionSchema-discoveriesBootstrap()` - Bootstrap schema discovery without an agent
1219
1286
 
1220
1287
  ## Search
@@ -1222,7 +1289,6 @@ fields
1222
1289
  - `getSearch()` - Full-text keyword search via Meilisearch across users, tenants, and documents
1223
1290
  - `getSearchHealth()` - Check Meilisearch server health, returning status and latency
1224
1291
  - `getSearchIndexes()` - Return the names of all configured Meilisearch indexes
1225
- - `getSearchSaved()` - List saved searches accessible to the current actor: the actor's own searches and any searches marked `is_shared` within the same tenant.
1226
1292
  - `getSearchSemantic()` - Vector similarity search across document chunks using a generated embedding of the query
1227
1293
  - `getSearchStats()` - Return Meilisearch database size and per-index document counts
1228
1294
  - `getSearchStatus()` - Return the current status and tenant context for the search indexes
@@ -1231,12 +1297,8 @@ fields
1231
1297
  - `postAiSearchAdvanced()` - Run a filtered semantic search with additional constraints on document type, date range, or specific workspace IDs; use when basic search results need to be scoped to a subset of the tenant's content.
1232
1298
  - `postSearchBatch()` - Execute multiple search queries in a single request and return the combined results
1233
1299
  - `postSearchReindex()` - Trigger a Meilisearch reindex for all or a specific subset of indexes (users, tenants, documents)
1234
- - `postSearchSaved()` - Persist a named search query for reuse
1235
- - `postSearchSavedByIdRun()` - Re-execute a saved search by ID and return the saved search metadata enriched with an `executed_at` ISO-8601 timestamp
1236
- - `patchSearchSavedById()` - Modify the name, query string, search type, filters, or sharing status of an existing saved search
1237
- - `deleteSearchSavedById()` - /search/saved/:id operation on saved_search resource
1238
1300
 
1239
- ## Search analytics
1301
+ ## Search-analytics
1240
1302
 
1241
1303
  - `getSearchAnalytics()` - List search analytics with tenant-based filtering
1242
1304
  - `getSearchAnalyticsSummary()` - Aggregated search analytics summary (platform admin only)
@@ -1250,45 +1312,45 @@ fields
1250
1312
  - `getMemorySection-documents()` - /memory/section-documents operation on section-document resource
1251
1313
  - `getMemorySection-documentsById()` - /memory/section-documents/:id operation on section-document resource
1252
1314
 
1253
- ## Social account
1315
+ ## Social-account
1254
1316
 
1255
- - `getSocialAccountsById()` - /social/accounts/:id operation on social_account resource
1256
- - `getSocialAccountsPlatformByPlatform()` - /social/accounts/platform/:platform operation on social_account resource
1257
- - `getSocialAccountsWorkspaceByWorkspaceId()` - /social/accounts/workspace/:workspace_id operation on social_account resource
1258
- - `postSocialAccounts()` - /social/accounts operation on social_account resource
1259
- - `patchSocialAccountsById()` - /social/accounts/:id operation on social_account resource
1260
- - `patchSocialAccountsByIdDeactivate()` - /social/accounts/:id/deactivate operation on social_account resource
1261
- - `patchSocialAccountsByIdDisable-posting()` - /social/accounts/:id/disable-posting operation on social_account resource
1262
- - `patchSocialAccountsByIdEnable-posting()` - /social/accounts/:id/enable-posting operation on social_account resource
1263
- - `deleteSocialAccountsById()` - /social/accounts/:id operation on social_account resource
1317
+ - `getSocialAccountsById()` - /social/accounts/:id operation on social-account resource
1318
+ - `getSocialAccountsPlatformByPlatform()` - /social/accounts/platform/:platform operation on social-account resource
1319
+ - `getSocialAccountsWorkspaceByWorkspaceId()` - /social/accounts/workspace/:workspace_id operation on social-account resource
1320
+ - `postSocialAccounts()` - /social/accounts operation on social-account resource
1321
+ - `patchSocialAccountsById()` - /social/accounts/:id operation on social-account resource
1322
+ - `patchSocialAccountsByIdDeactivate()` - /social/accounts/:id/deactivate operation on social-account resource
1323
+ - `patchSocialAccountsByIdDisable-posting()` - /social/accounts/:id/disable-posting operation on social-account resource
1324
+ - `patchSocialAccountsByIdEnable-posting()` - /social/accounts/:id/enable-posting operation on social-account resource
1325
+ - `deleteSocialAccountsById()` - /social/accounts/:id operation on social-account resource
1264
1326
 
1265
- ## Social campaign
1327
+ ## Social-campaign
1266
1328
 
1267
- - `getSocialCampaigns()` - /social/campaigns operation on social_campaign resource
1268
- - `getSocialCampaignsById()` - /social/campaigns/:id operation on social_campaign resource
1269
- - `postSocialCampaigns()` - /social/campaigns operation on social_campaign resource
1329
+ - `getSocialCampaigns()` - /social/campaigns operation on social-campaign resource
1330
+ - `getSocialCampaignsById()` - /social/campaigns/:id operation on social-campaign resource
1331
+ - `postSocialCampaigns()` - /social/campaigns operation on social-campaign resource
1270
1332
  - `postSocialCampaignsByIdAdapt-for-platforms()` - Adapt master copy for each target platform
1271
1333
  - `postSocialCampaignsByIdGenerate-master-copy()` - Generate master copy from content brief using AI
1272
- - `patchSocialCampaignsById()` - /social/campaigns/:id operation on social_campaign resource
1273
- - `patchSocialCampaignsByIdCancel()` - /social/campaigns/:id/cancel operation on social_campaign resource
1274
- - `patchSocialCampaignsByIdSchedule()` - /social/campaigns/:id/schedule operation on social_campaign resource
1275
- - `deleteSocialCampaignsById()` - /social/campaigns/:id operation on social_campaign resource
1276
-
1277
- ## Social post
1278
-
1279
- - `getSocialPostsAccountBySocialAccountId()` - /social/posts/account/:social_account_id operation on social_post resource
1280
- - `getSocialPostsById()` - /social/posts/:id operation on social_post resource
1281
- - `getSocialPostsCampaignBySocialCampaignId()` - /social/posts/campaign/:social_campaign_id operation on social_post resource
1282
- - `getSocialPostsScheduled()` - /social/posts/scheduled operation on social_post resource
1283
- - `getSocialPostsWorkspaceByWorkspaceId()` - /social/posts/workspace/:workspace_id operation on social_post resource
1284
- - `postSocialPosts()` - /social/posts operation on social_post resource
1285
- - `patchSocialPostsById()` - /social/posts/:id operation on social_post resource
1286
- - `patchSocialPostsByIdCancel()` - /social/posts/:id/cancel operation on social_post resource
1287
- - `patchSocialPostsByIdPublish()` - /social/posts/:id/publish operation on social_post resource
1288
- - `patchSocialPostsByIdRetry()` - /social/posts/:id/retry operation on social_post resource
1289
- - `patchSocialPostsByIdSchedule()` - /social/posts/:id/schedule operation on social_post resource
1290
- - `patchSocialPostsByIdSeo()` - /social/posts/:id/seo operation on social_post resource
1291
- - `deleteSocialPostsById()` - /social/posts/:id operation on social_post resource
1334
+ - `patchSocialCampaignsById()` - /social/campaigns/:id operation on social-campaign resource
1335
+ - `patchSocialCampaignsByIdCancel()` - /social/campaigns/:id/cancel operation on social-campaign resource
1336
+ - `patchSocialCampaignsByIdSchedule()` - /social/campaigns/:id/schedule operation on social-campaign resource
1337
+ - `deleteSocialCampaignsById()` - /social/campaigns/:id operation on social-campaign resource
1338
+
1339
+ ## Social-post
1340
+
1341
+ - `getSocialPostsAccountBySocialAccountId()` - /social/posts/account/:social_account_id operation on social-post resource
1342
+ - `getSocialPostsById()` - /social/posts/:id operation on social-post resource
1343
+ - `getSocialPostsCampaignBySocialCampaignId()` - /social/posts/campaign/:social_campaign_id operation on social-post resource
1344
+ - `getSocialPostsScheduled()` - /social/posts/scheduled operation on social-post resource
1345
+ - `getSocialPostsWorkspaceByWorkspaceId()` - /social/posts/workspace/:workspace_id operation on social-post resource
1346
+ - `postSocialPosts()` - /social/posts operation on social-post resource
1347
+ - `patchSocialPostsById()` - /social/posts/:id operation on social-post resource
1348
+ - `patchSocialPostsByIdCancel()` - /social/posts/:id/cancel operation on social-post resource
1349
+ - `patchSocialPostsByIdPublish()` - /social/posts/:id/publish operation on social-post resource
1350
+ - `patchSocialPostsByIdRetry()` - /social/posts/:id/retry operation on social-post resource
1351
+ - `patchSocialPostsByIdSchedule()` - /social/posts/:id/schedule operation on social-post resource
1352
+ - `patchSocialPostsByIdSeo()` - /social/posts/:id/seo operation on social-post resource
1353
+ - `deleteSocialPostsById()` - /social/posts/:id operation on social-post resource
1292
1354
 
1293
1355
  ## Storage
1294
1356
 
@@ -1300,11 +1362,11 @@ fields
1300
1362
  - `patchBucketsById()` - Update the region of an existing bucket
1301
1363
  - `deleteBucketsById()` - Delete a bucket from the database and attempt to remove it from object storage; fails if any StorageFile records still reference this bucket.
1302
1364
 
1303
- ## Storage file
1365
+ ## Storage-file
1304
1366
 
1305
- - `getStorage-files()` - /storage-files operation on storage_file resource
1367
+ - `getStorage-files()` - /storage-files operation on storage-file resource
1306
1368
  - `getStorage-filesBy-checksum()` - Fetch non-deleted files matching a given checksum
1307
- - `getStorage-filesById()` - /storage-files/:id operation on storage_file resource
1369
+ - `getStorage-filesById()` - /storage-files/:id operation on storage-file resource
1308
1370
  - `getStorage-filesChildren()` - List non-deleted files whose parent_id matches the given ID
1309
1371
  - `postStorage-files()` - Create a StorageFile tracking record; use Storage.request_upload/5 via the facade for the full two-phase upload flow with presigned URLs.
1310
1372
  - `patchStorage-filesById()` - Update file metadata, tags, visibility, key, namespace, or status
@@ -1315,13 +1377,13 @@ fields
1315
1377
  - `patchStorage-filesByIdTag()` - Replace the tags list on a file
1316
1378
  - `patchStorage-filesByIdUpdate-metadata()` - Merge new_metadata into the existing metadata map (shallow merge)
1317
1379
 
1318
- ## Support tag
1380
+ ## Support-tag
1319
1381
 
1320
1382
  - `getSupportTagsWorkspaceByWorkspaceId()` - List all tags defined for a workspace
1321
1383
  - `postSupportTags()` - Create a workspace-scoped ticket tag
1322
1384
  - `deleteSupportTagsById()` - Hard-delete a tag
1323
1385
 
1324
- ## Support ticket
1386
+ ## Support-ticket
1325
1387
 
1326
1388
  - `getSupportTicketsById()` - Fetch a single active ticket by ID
1327
1389
  - `getSupportTicketsWorkspaceByWorkspaceId()` - List active tickets for a workspace, optionally filtered by status, priority, queue, or agent
@@ -1334,17 +1396,17 @@ fields
1334
1396
  - `patchSupportTicketsByIdResolve()` - Mark a ticket as resolved, recording resolved_at timestamp
1335
1397
  - `deleteSupportTicketsById()` - Soft-delete a ticket by setting deleted_at
1336
1398
 
1337
- ## Support ticket attachment
1399
+ ## Support-ticket-attachment
1338
1400
 
1339
1401
  - `getSupportTicket-attachmentsMessageByTicketMessageId()` - List all attachments for a specific ticket message
1340
1402
  - `postSupportTicket-attachments()` - Register a file attachment on a ticket message
1341
1403
 
1342
- ## Support ticket message
1404
+ ## Support-ticket-message
1343
1405
 
1344
1406
  - `getSupportTicket-messagesTicketByTicketId()` - List all messages on a ticket in chronological order
1345
1407
  - `postSupportTicket-messages()` - Add a message to a ticket thread
1346
1408
 
1347
- ## Support ticket rating
1409
+ ## Support-ticket-rating
1348
1410
 
1349
1411
  - `postSupportTicket-ratings()` - Submit or update a CSAT rating (1-5) for a resolved ticket
1350
1412
 
@@ -1353,13 +1415,13 @@ fields
1353
1415
  - `getConnectorsSync-logs()` - /connectors/sync-logs operation on sync-log resource
1354
1416
  - `getConnectorsSync-logsById()` - /connectors/sync-logs/:id operation on sync-log resource
1355
1417
 
1356
- ## Tenant document stats
1418
+ ## Tenant-document-stats
1357
1419
 
1358
- - `getTenantsByTenantIdDocumentStats()` - /tenants/:tenant_id/document_stats operation on tenant_document_stats resource
1420
+ - `getTenantsByTenantIdDocumentStats()` - /tenants/:tenant_id/document_stats operation on tenant-document-stats resource
1359
1421
 
1360
- ## Tenant stats
1422
+ ## Tenant-stats
1361
1423
 
1362
- - `getTenantsByTenantIdStats()` - /tenants/:tenant_id/stats operation on tenant_stats resource
1424
+ - `getTenantsByTenantIdStats()` - /tenants/:tenant_id/stats operation on tenant-stats resource
1363
1425
 
1364
1426
  ## Tenants
1365
1427
 
@@ -1384,45 +1446,50 @@ plan tier, vanity slug, and storage spending cap
1384
1446
  - `patchTenantsByIdUnsuspend()` - Restore a suspended tenant to active status.
1385
1447
  - `deleteTenantsById()` - Permanently delete a tenant and all associated data
1386
1448
 
1387
- ## Thread stats
1388
-
1389
- - `getThreadsStats()` - Return platform-wide chat statistics including total threads, total messages, threads active in the last 24h and 7d, message distribution by role, and top 10 workspaces by thread count
1390
-
1391
- ## Thread workspace stats
1392
-
1393
- - `getThreadsWorkspace-stats()` - Return aggregated chat statistics for the actor's current workspace: total threads, total messages, activity counts for 24h and 7d windows, and message distribution by role
1394
-
1395
- ## Threads
1396
-
1397
- - `getThreads()` - /threads operation on thread resource
1398
- - `getThreadsById()` - /threads/:id operation on thread resource
1399
- - `getThreadsSearch()` - Full-text search threads by title or context summary within the actor's accessible workspace
1400
- - `postThreads()` - Create a new conversation thread scoped to a tenant, workspace, and user
1401
- - `postThreadsActive()` - Return the current user's active thread for their workspace, creating a new one if none exists or the existing thread has expired (>24h inactive)
1402
- - `postThreadsByIdComplete()` - Trigger AI inference on an existing thread without providing new user message content
1403
- - `postThreadsByIdExport()` - Export thread with messages to JSON, Markdown, or plain text format
1404
- - `postThreadsByIdFork()` - Fork a thread by cloning it with all its messages
1405
- - `postThreadsByIdMessages()` - Submit a user message to a thread and receive the AI response synchronously
1406
- - `postThreadsByIdSummarize()` - Generate a 2-3 sentence LLM summary of the thread's message history and persist it as `context_summary`
1407
- - `patchThreadsById()` - Update the thread's title or context summary
1408
- - `patchThreadsByIdArchive()` - Archive a thread by setting `archived_at` to the current timestamp
1409
- - `patchThreadsByIdUnarchive()` - Restore an archived thread by clearing `archived_at`, making it visible in the default thread list again.
1410
- - `deleteThreadsById()` - /threads/:id operation on thread resource
1411
-
1412
1449
  ## Token
1413
1450
 
1414
1451
  - `postTokens()` - Create a payment token
1415
1452
 
1416
- ## Training analytics
1453
+ ## Training-analytics
1417
1454
 
1418
1455
  - `getWorkspacesAnalytics-batch()` - Get training analytics for multiple workspaces in a single request (max 50)
1419
1456
  - `getWorkspacesByWorkspaceIdTrainingAnalytics()` - Get training analytics for a specific workspace
1420
1457
 
1421
- ## Transaction
1458
+ ## Training-example
1459
+
1460
+ - `getTraining-examples()` - List training examples with filtering support
1461
+ - `getTraining-examplesById()` - Fetch a single TrainingExample by ID.
1462
+ - `postTraining-examples()` - Create a single training example (golden example for few-shot learning)
1463
+ - `postTraining-examplesBulk()` - Create multiple training examples in a single transaction using `Ash.bulk_create`
1464
+ - `postTraining-examplesBulk-delete()` - Delete multiple training examples by ID in a single transaction
1465
+ - `postTraining-examplesSearch()` - Public entry point for semantic similarity search over training examples
1466
+ - `patchTraining-examplesById()` - Update an existing training example's input text, expected output JSON, notes,
1467
+ correction reasons, or image reference
1468
+ - `deleteTraining-examplesById()` - /training-examples/:id operation on training-example resource
1469
+
1470
+ ## Training-session
1471
+
1472
+ - `getTraining-sessions()` - /training-sessions operation on training-session resource
1473
+ - `getTraining-sessionsAgentsByAgentIdSessions()` - /training-sessions/agents/:agent_id/sessions operation on training-session resource
1474
+ - `getTraining-sessionsById()` - /training-sessions/:id operation on training-session resource
1475
+ - `postTraining-sessions()` - /training-sessions operation on training-session resource
1476
+ - `patchTraining-sessionsByIdRevert()` - /training-sessions/:id/revert operation on training-session resource
1477
+ - `deleteTraining-sessionsById()` - /training-sessions/:id operation on training-session resource
1478
+
1479
+ ## Transaction-history
1422
1480
 
1423
1481
  - `getTransactions()` - Read user's transactions
1424
1482
  - `getTransactionsById()` - Read user's transactions
1425
1483
 
1484
+ ## Transcription-job
1485
+
1486
+ - `getVoiceTranscription-jobs()` - /voice/transcription-jobs operation on transcription-job resource
1487
+ - `getVoiceTranscription-jobsById()` - /voice/transcription-jobs/:id operation on transcription-job resource
1488
+ - `getVoiceTranscription-jobsMine()` - /voice/transcription-jobs/mine operation on transcription-job resource
1489
+ - `getVoiceTranscription-jobsWorkspaceByWorkspaceId()` - /voice/transcription-jobs/workspace/:workspace_id operation on transcription-job resource
1490
+ - `postVoiceTranscription-jobs()` - /voice/transcription-jobs operation on transcription-job resource
1491
+ - `deleteVoiceTranscription-jobsById()` - /voice/transcription-jobs/:id operation on transcription-job resource
1492
+
1426
1493
  ## Trending-snapshot
1427
1494
 
1428
1495
  - `getSocialTrendingHistoryById()` - /social/trending/history/:id operation on trending-snapshot resource
@@ -1445,11 +1512,21 @@ plan tier, vanity slug, and storage spending cap
1445
1512
  - `patchSocialTrendingWatchesByIdMark-triggered()` - /social/trending/watches/:id/mark-triggered operation on trending-watch resource
1446
1513
  - `deleteSocialTrendingWatchesById()` - /social/trending/watches/:id operation on trending-watch resource
1447
1514
 
1448
- ## Users
1515
+ ## User-profile
1449
1516
 
1450
- - `getUser-profiles()` - /user-profiles operation on user_profile resource
1451
- - `getUser-profilesById()` - /user-profiles/:id operation on user_profile resource
1517
+ - `getUser-profiles()` - /user-profiles operation on user-profile resource
1518
+ - `getUser-profilesById()` - /user-profiles/:id operation on user-profile resource
1452
1519
  - `getUser-profilesMe()` - Get the current user's profile
1520
+ - `postUser-profiles()` - Create a user profile record linked to an existing user
1521
+ - `patchUser-profilesById()` - Update the user's display profile fields: name, avatar, bio, social links, and
1522
+ raw preferences map
1523
+ - `patchUser-profilesByIdAccept-tos()` - Accept Terms of Service - merges with existing preferences
1524
+ - `patchUser-profilesByIdDismiss-announcement()` - Dismiss announcement - merges with existing preferences
1525
+ - `patchUser-profilesByIdDismiss-welcome()` - Dismiss welcome message - merges with existing preferences
1526
+ - `deleteUser-profilesById()` - /user-profiles/:id operation on user-profile resource
1527
+
1528
+ ## Users
1529
+
1453
1530
  - `getUsers()` - /users operation on user resource
1454
1531
  - `getUsersBy-email()` - Look up a single user by their email address (case-insensitive)
1455
1532
  - `getUsersById()` - /users/:id operation on user resource
@@ -1458,7 +1535,6 @@ plan tier, vanity slug, and storage spending cap
1458
1535
  - `getUsersMeDashboard()` - Get dashboard data for the user's tenant context
1459
1536
  - `getUsersMeStats()` - Get stats for the user's tenant context
1460
1537
  - `getUsersMeTenants()` - List all tenants the current user belongs to with their roles and permissions
1461
- - `postUser-profiles()` - Create a user profile record linked to an existing user
1462
1538
  - `postUsersAuthConfirm()` - Confirm a user's email address using a confirmation token
1463
1539
  - `postUsersAuthLogin()` - Attempt to sign in using a username and password.
1464
1540
  - `postUsersAuthMagic-linkLogin()` - /users/auth/magic-link/login operation on user resource
@@ -1470,47 +1546,53 @@ plan tier, vanity slug, and storage spending cap
1470
1546
  Microsoft)
1471
1547
  - `postUsersAuthResend-confirmation()` - Resend confirmation email to an unconfirmed user
1472
1548
  - `postUsersRegister-isv()` - Platform Admin action to register a new ISV (User + Tenant + App)
1473
- - `patchUser-profilesById()` - Update the user's display profile fields: name, avatar, bio, social links, and
1474
- raw preferences map
1475
- - `patchUser-profilesByIdAccept-tos()` - Accept Terms of Service - merges with existing preferences
1476
- - `patchUser-profilesByIdDismiss-announcement()` - Dismiss announcement - merges with existing preferences
1477
- - `patchUser-profilesByIdDismiss-welcome()` - Dismiss welcome message - merges with existing preferences
1478
1549
  - `patchUsersAuthPasswordChange()` - Change password for authenticated user with current password verification
1479
1550
  - `patchUsersAuthReset-password()` - Reset password using admin-issued reset token
1480
1551
  - `patchUsersById()` - Admin-only user management (platform admins) - promotes/demotes admin status
1481
1552
  - `patchUsersByIdConfirm-email()` - Admin manually confirms user's email
1482
1553
  - `patchUsersByIdEmail()` - Admin-only email update
1483
1554
  - `patchUsersByIdReset-password()` - Admin triggers password reset email for user
1484
- - `deleteUser-profilesById()` - /user-profiles/:id operation on user_profile resource
1485
1555
  - `deleteUsersById()` - Permanently delete a user account
1486
1556
 
1487
- ## Voice recording
1557
+ ## Voice-recording
1488
1558
 
1489
- - `getVoiceRecordings()` - /voice/recordings operation on voice_recording resource
1490
- - `getVoiceRecordingsById()` - /voice/recordings/:id operation on voice_recording resource
1559
+ - `getVoiceRecordings()` - /voice/recordings operation on voice-recording resource
1560
+ - `getVoiceRecordingsById()` - /voice/recordings/:id operation on voice-recording resource
1491
1561
  - `getVoiceRecordingsSessionBySessionId()` - List recordings for a specific voice session
1492
1562
 
1493
- ## Voice session
1563
+ ## Voice-session
1494
1564
 
1495
- - `getVoiceSessions()` - /voice/sessions operation on voice_session resource
1496
- - `getVoiceSessionsById()` - /voice/sessions/:id operation on voice_session resource
1565
+ - `getVoiceSessions()` - /voice/sessions operation on voice-session resource
1566
+ - `getVoiceSessionsById()` - /voice/sessions/:id operation on voice-session resource
1497
1567
  - `getVoiceSessionsMine()` - List current user's voice sessions
1498
1568
  - `getVoiceSessionsWorkspaceByWorkspaceId()` - List all voice sessions in a workspace (ISV admin)
1499
1569
  - `postVoiceSessions()` - Start a new voice session with LiveKit room provisioning
1500
1570
  - `patchVoiceSessionsByIdFinalize()` - Dispatch accumulated transcript to the blueprint/chat pipeline
1501
1571
  - `patchVoiceSessionsByIdStop()` - End a voice session and release the LiveKit room
1502
- - `deleteVoiceSessionsById()` - /voice/sessions/:id operation on voice_session resource
1572
+ - `deleteVoiceSessionsById()` - /voice/sessions/:id operation on voice-session resource
1503
1573
 
1504
- ## Voice transcription result
1574
+ ## Voice-transcription-result
1505
1575
 
1506
- - `getVoiceTranscription-results()` - /voice/transcription-results operation on voice_transcription_result resource
1507
- - `getVoiceTranscription-resultsById()` - /voice/transcription-results/:id operation on voice_transcription_result resource
1576
+ - `getVoiceTranscription-results()` - /voice/transcription-results operation on voice-transcription-result resource
1577
+ - `getVoiceTranscription-resultsById()` - /voice/transcription-results/:id operation on voice-transcription-result resource
1508
1578
  - `getVoiceTranscription-resultsSessionBySessionId()` - List transcription results for a voice session
1509
- - `postVoiceTranscription-results()` - /voice/transcription-results operation on voice_transcription_result resource
1579
+ - `postVoiceTranscription-results()` - /voice/transcription-results operation on voice-transcription-result resource
1510
1580
  - `patchVoiceTranscription-resultsById()` - Correct or annotate a transcript's text, segments, or metadata.
1511
- - `deleteVoiceTranscription-resultsById()` - /voice/transcription-results/:id operation on voice_transcription_result resource
1581
+ - `deleteVoiceTranscription-resultsById()` - /voice/transcription-results/:id operation on voice-transcription-result resource
1582
+
1583
+ ## Wallet-public
1584
+
1585
+ - `getWallet()` - Reads the wallet for the current tenant
1586
+ - `getWalletPlanPreview()` - Preview the cost and effective date of a plan change
1587
+ - `patchWalletAddons()` - Purchase an add-on for the wallet
1588
+ - `patchWalletAddonsByAddonSlugCancel()` - Cancel an add-on for the wallet
1589
+ - `patchWalletAuto-top-up()` - Update auto-top-up settings
1590
+ - `patchWalletCredits()` - Purchase credits (Top-up)
1591
+ - `patchWalletPaymentRetry()` - Retry a failed subscription payment
1592
+ - `patchWalletPlan()` - Change the main plan for the wallet
1593
+ - `patchWalletPlanCancel()` - Cancel the current subscription plan
1512
1594
 
1513
- ## Watcher claim
1595
+ ## Watcher-claim
1514
1596
 
1515
1597
  - `getWatcherClaims()` - List claims for a workspace, optionally filtering by one or more statuses (e.g., [:claimed, :processing])
1516
1598
  - `getWatcherClaimsById()` - Paginate all ingestion claims; use by_workspace to scope to a specific workspace and filter by status.
@@ -1521,16 +1603,12 @@ raw preferences map
1521
1603
  - `patchWatcherClaimsByIdRelease()` - Release a claim by setting its status to :expired, allowing another machine to re-claim the file on the next poll cycle.
1522
1604
  - `patchWatcherClaimsByIdRetry()` - Re-open a terminal claim (completed/failed/expired/document_deleted) for re-processing; increments retry_count unless reset_retry_count is true
1523
1605
 
1524
- ## Watcher event
1606
+ ## Watcher-event
1525
1607
 
1526
1608
  - `getWatcherEvents()` - List ingestion events for a workspace, optionally filtered by event_type, machine_id, or a since timestamp
1527
1609
  - `getWatcherEventsById()` - Fetch a single ingestion event by ID; use the :list action to query events by workspace, type, machine, or time range.
1528
1610
  - `postWatcherEvents()` - Create multiple events in batch
1529
1611
 
1530
- ## Workspace document stats
1531
-
1532
- - `getTenantsByTenantIdWorkspaceStats()` - /tenants/:tenant_id/workspace_stats operation on workspace_document_stats resource
1533
-
1534
1612
  ## Workspace-agent-config
1535
1613
 
1536
1614
  - `getWorkspace-agent-configs()` - /workspace-agent-configs operation on workspace-agent-config resource
@@ -1539,6 +1617,10 @@ raw preferences map
1539
1617
  - `patchWorkspace-agent-configsById()` - /workspace-agent-configs/:id operation on workspace-agent-config resource
1540
1618
  - `deleteWorkspace-agent-configsById()` - /workspace-agent-configs/:id operation on workspace-agent-config resource
1541
1619
 
1620
+ ## Workspace-document-stats
1621
+
1622
+ - `getTenantsByTenantIdWorkspaceStats()` - /tenants/:tenant_id/workspace_stats operation on workspace-document-stats resource
1623
+
1542
1624
  ## Workspaces
1543
1625
 
1544
1626
  - `getWorkspaces()` - List workspaces visible to the actor