@gpt-platform/admin 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/dist/index.d.mts +35222 -24790
- package/dist/index.d.ts +35222 -24790
- package/dist/index.js +3291 -432
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +3289 -432
- package/dist/index.mjs.map +1 -1
- package/llms.txt +610 -500
- package/package.json +1 -1
package/llms.txt
CHANGED
|
@@ -44,32 +44,6 @@ client.setConfig({
|
|
|
44
44
|
- `patchAccountsByIdCredit()` - /accounts/:id/credit operation on account resource
|
|
45
45
|
- `patchAccountsByIdDebit()` - /accounts/:id/debit operation on account resource
|
|
46
46
|
|
|
47
|
-
## Agent stats
|
|
48
|
-
|
|
49
|
-
- `getAgentsByIdStats()` - /agents/:id/stats operation on agent_stats resource
|
|
50
|
-
|
|
51
|
-
## Agent test result
|
|
52
|
-
|
|
53
|
-
- `postAgent-test-results()` - Run an agent version against a document and return the test result
|
|
54
|
-
|
|
55
|
-
## Agent training stats
|
|
56
|
-
|
|
57
|
-
- `getAgentsByIdTraining-stats()` - /agents/:id/training-stats operation on agent_training_stats resource
|
|
58
|
-
|
|
59
|
-
## Agent usage
|
|
60
|
-
|
|
61
|
-
- `getAgentsByIdUsage()` - /agents/:id/usage operation on agent_usage resource
|
|
62
|
-
- `getAgentsUsage()` - Batch read usage for all accessible agents
|
|
63
|
-
|
|
64
|
-
## Agent version comparison
|
|
65
|
-
|
|
66
|
-
- `postAgent-version-comparisons()` - Compare two agent versions and return the differences
|
|
67
|
-
|
|
68
|
-
## Agent version revision
|
|
69
|
-
|
|
70
|
-
- `getAgent-version-revisions()` - /agent-version-revisions operation on agent_version_revision resource
|
|
71
|
-
- `getAgent-version-revisionsById()` - /agent-version-revisions/:id operation on agent_version_revision resource
|
|
72
|
-
|
|
73
47
|
## Agent-deployment
|
|
74
48
|
|
|
75
49
|
- `getAgent-deployments()` - /agent-deployments operation on agent-deployment resource
|
|
@@ -94,25 +68,56 @@ client.setConfig({
|
|
|
94
68
|
- `patchAgent-soulsById()` - /agent-souls/:id operation on agent-soul resource
|
|
95
69
|
- `deleteAgent-soulsById()` - /agent-souls/:id operation on agent-soul resource
|
|
96
70
|
|
|
71
|
+
## Agent-stats
|
|
72
|
+
|
|
73
|
+
- `getAgentsByIdStats()` - /agents/:id/stats operation on agent-stats resource
|
|
74
|
+
|
|
75
|
+
## Agent-test-result
|
|
76
|
+
|
|
77
|
+
- `postAgent-test-results()` - Run an agent version against a document and return the test result
|
|
78
|
+
|
|
97
79
|
## Agent-tool
|
|
98
80
|
|
|
99
81
|
- `getAgent-tools()` - /agent-tools operation on agent-tool resource
|
|
100
82
|
|
|
101
|
-
##
|
|
83
|
+
## Agent-training-stats
|
|
84
|
+
|
|
85
|
+
- `getAgentsByIdTraining-stats()` - /agents/:id/training-stats operation on agent-training-stats resource
|
|
86
|
+
|
|
87
|
+
## Agent-usage
|
|
88
|
+
|
|
89
|
+
- `getAgentsByIdUsage()` - /agents/:id/usage operation on agent-usage resource
|
|
90
|
+
- `getAgentsUsage()` - Batch read usage for all accessible agents
|
|
91
|
+
|
|
92
|
+
## Agent-version
|
|
102
93
|
|
|
103
94
|
- `getAgent-versions()` - List AgentVersions, optionally filtered to a specific agent
|
|
104
95
|
- `getAgent-versionsById()` - Fetch a single AgentVersion by ID
|
|
105
96
|
- `getAgent-versionsByIdMetrics()` - Get performance metrics for this version
|
|
106
97
|
- `getAgent-versionsByIdRevisions()` - List all revisions for a specific AgentVersion, sorted by revision number descending
|
|
98
|
+
- `postAgent-versions()` - Create a new AgentVersion snapshot
|
|
99
|
+
- `postAgent-versionsByIdAdd-system-field()` - Add a predefined system field to this version's output_schema
|
|
100
|
+
- `postAgent-versionsByIdRemove-system-field()` - Remove a system field from this version's output_schema
|
|
101
|
+
- `postAgent-versionsByIdSet-system-fields()` - Set which system fields are included in this version's output_schema (batch operation)
|
|
102
|
+
- `patchAgent-versionsById()` - Update an AgentVersion's prompt template or changes summary
|
|
103
|
+
- `deleteAgent-versionsById()` - Delete an AgentVersion
|
|
104
|
+
|
|
105
|
+
## Agent-version-comparison
|
|
106
|
+
|
|
107
|
+
- `postAgent-version-comparisons()` - Compare two agent versions and return the differences
|
|
108
|
+
|
|
109
|
+
## Agent-version-revision
|
|
110
|
+
|
|
111
|
+
- `getAgent-version-revisions()` - /agent-version-revisions operation on agent-version-revision resource
|
|
112
|
+
- `getAgent-version-revisionsById()` - /agent-version-revisions/:id operation on agent-version-revision resource
|
|
113
|
+
|
|
114
|
+
## AI Agents
|
|
115
|
+
|
|
107
116
|
- `getAgents()` - List all agents accessible in the current workspace
|
|
108
117
|
- `getAgentsBy-slugBySlug()` - Look up an agent by its system_slug
|
|
109
118
|
- `getAgentsById()` - Fetch a single agent by ID
|
|
110
119
|
- `getAgentsByIdSchema-versions()` - List all schema versions for this agent
|
|
111
120
|
- `getAgentsByIdTraining-examples()` - List training examples for this agent
|
|
112
|
-
- `postAgent-versions()` - Create a new AgentVersion snapshot
|
|
113
|
-
- `postAgent-versionsByIdAdd-system-field()` - Add a predefined system field to this version's output_schema
|
|
114
|
-
- `postAgent-versionsByIdRemove-system-field()` - Remove a system field from this version's output_schema
|
|
115
|
-
- `postAgent-versionsByIdSet-system-fields()` - Set which system fields are included in this version's output_schema (batch operation)
|
|
116
121
|
- `postAgents()` - Create a new agent
|
|
117
122
|
- `postAgentsByIdAnalyze-training()` - Analyze training examples for conflicts, coverage, and quality
|
|
118
123
|
- `postAgentsByIdClone()` - Clone the agent to a new one with a new name
|
|
@@ -126,45 +131,18 @@ client.setConfig({
|
|
|
126
131
|
- `postAgentsByIdValidate()` - Validate sample output against agent schema
|
|
127
132
|
- `postAgentsClone-for-workspace()` - Clone a system agent for workspace-specific customization
|
|
128
133
|
- `postAgentsImport()` - Import an agent from a JSON payload produced by `:export`
|
|
129
|
-
- `patchAgent-versionsById()` - Update an AgentVersion's prompt template or changes summary
|
|
130
134
|
- `patchAgentsById()` - Update agent metadata such as name, description, vertical, tags, and instructions
|
|
131
135
|
- `patchAgentsByIdSchema-versionsByVersionId()` - Update a schema version without creating a new version
|
|
132
|
-
- `deleteAgent-versionsById()` - Delete an AgentVersion
|
|
133
136
|
- `deleteAgentsById()` - Permanently delete an agent and cascade-destroy all associated data
|
|
134
137
|
- `deleteAgentsByIdTraining-examplesByExampleId()` - Delete a training example belonging to this agent
|
|
135
138
|
|
|
136
|
-
## Ai
|
|
139
|
+
## Ai-config
|
|
137
140
|
|
|
138
|
-
- `getSysAi-config()` - /sys/ai-config operation on
|
|
139
|
-
- `getSysAi-configById()` - /sys/ai-config/:id operation on
|
|
141
|
+
- `getSysAi-config()` - /sys/ai-config operation on ai-config resource
|
|
142
|
+
- `getSysAi-configById()` - /sys/ai-config/:id operation on ai-config resource
|
|
140
143
|
- `postSysAi-config()` - Upsert a provider config record; if a record with the same id already exists, its fields are updated
|
|
141
144
|
- `patchSysAi-configById()` - Update platform or application-level LLM provider config (default model, embedding model, domain overrides, fallback chains, pricing floor); validates fallback chain structure
|
|
142
145
|
|
|
143
|
-
## AI Training
|
|
144
|
-
|
|
145
|
-
- `getTraining-examples()` - List training examples with filtering support
|
|
146
|
-
- `getTraining-examplesById()` - Fetch a single TrainingExample by ID.
|
|
147
|
-
- `getTraining-sessions()` - /training-sessions operation on training_session resource
|
|
148
|
-
- `getTraining-sessionsAgentsByAgentIdSessions()` - /training-sessions/agents/:agent_id/sessions operation on training_session resource
|
|
149
|
-
- `getTraining-sessionsById()` - /training-sessions/:id operation on training_session resource
|
|
150
|
-
- `postTraining-examples()` - Create a single training example (golden example for few-shot learning)
|
|
151
|
-
- `postTraining-examplesBulk()` - Create multiple training examples in a single transaction using `Ash.bulk_create`
|
|
152
|
-
- `postTraining-examplesBulk-delete()` - Delete multiple training examples by ID in a single transaction
|
|
153
|
-
- `postTraining-examplesSearch()` - Public entry point for semantic similarity search over training examples
|
|
154
|
-
- `postTraining-sessions()` - /training-sessions operation on training_session resource
|
|
155
|
-
- `patchTraining-examplesById()` - Update an existing training example's input text, expected output JSON, notes,
|
|
156
|
-
correction reasons, or image reference
|
|
157
|
-
- `patchTraining-sessionsByIdRevert()` - /training-sessions/:id/revert operation on training_session resource
|
|
158
|
-
- `deleteTraining-examplesById()` - /training-examples/:id operation on training_example resource
|
|
159
|
-
- `deleteTraining-sessionsById()` - /training-sessions/:id operation on training_session resource
|
|
160
|
-
|
|
161
|
-
## Ai-message
|
|
162
|
-
|
|
163
|
-
- `getAiMessages()` - /ai/messages operation on ai-message resource
|
|
164
|
-
- `getAiMessagesById()` - /ai/messages/:id operation on ai-message resource
|
|
165
|
-
- `postAiMessages()` - Append a new message turn (system, user, or assistant) to a Conversation
|
|
166
|
-
- `deleteAiMessagesById()` - /ai/messages/:id operation on ai-message resource
|
|
167
|
-
|
|
168
146
|
## Amendment-request
|
|
169
147
|
|
|
170
148
|
- `getAmendment-requests()` - /amendment-requests operation on amendment-request resource
|
|
@@ -175,7 +153,7 @@ correction reasons, or image reference
|
|
|
175
153
|
- `patchAmendment-requestsByIdDeny()` - Deny an amendment request with a reason.
|
|
176
154
|
- `patchAmendment-requestsByIdReview()` - Begin reviewing an amendment request.
|
|
177
155
|
|
|
178
|
-
##
|
|
156
|
+
## Api-key
|
|
179
157
|
|
|
180
158
|
- `getApi-keys()` - List or fetch API keys
|
|
181
159
|
- `getApi-keysActive()` - List only active API keys
|
|
@@ -246,19 +224,19 @@ flags, workspace mode, and execution limits
|
|
|
246
224
|
- `deletePlansById()` - /plans/:id operation on plan resource
|
|
247
225
|
- `deleteSubscriptionsById()` - /subscriptions/:id operation on subscription resource
|
|
248
226
|
|
|
249
|
-
## Brand
|
|
227
|
+
## Brand-identity
|
|
250
228
|
|
|
251
|
-
- `getBrand-identities()` - /brand-identities operation on
|
|
252
|
-
- `getBrand-identitiesBy-tenantByTenantId()` - /brand-identities/by-tenant/:tenant_id operation on
|
|
253
|
-
- `getBrand-identitiesBy-workspaceByWorkspaceId()` - /brand-identities/by-workspace/:workspace_id operation on
|
|
254
|
-
- `getBrand-identitiesById()` - /brand-identities/:id operation on
|
|
255
|
-
- `getBrand-identitiesDefaultTenantByTenantId()` - /brand-identities/default/tenant/:tenant_id operation on
|
|
256
|
-
- `getBrand-identitiesDefaultWorkspaceByWorkspaceId()` - /brand-identities/default/workspace/:workspace_id operation on
|
|
257
|
-
- `postBrand-identities()` - /brand-identities operation on
|
|
258
|
-
- `patchBrand-identitiesById()` - /brand-identities/:id operation on
|
|
259
|
-
- `patchBrand-identitiesByIdSet-default()` - /brand-identities/:id/set-default operation on
|
|
260
|
-
- `patchBrand-identitiesByIdUnset-default()` - /brand-identities/:id/unset-default operation on
|
|
261
|
-
- `deleteBrand-identitiesById()` - /brand-identities/:id operation on
|
|
229
|
+
- `getBrand-identities()` - /brand-identities operation on brand-identity resource
|
|
230
|
+
- `getBrand-identitiesBy-tenantByTenantId()` - /brand-identities/by-tenant/:tenant_id operation on brand-identity resource
|
|
231
|
+
- `getBrand-identitiesBy-workspaceByWorkspaceId()` - /brand-identities/by-workspace/:workspace_id operation on brand-identity resource
|
|
232
|
+
- `getBrand-identitiesById()` - /brand-identities/:id operation on brand-identity resource
|
|
233
|
+
- `getBrand-identitiesDefaultTenantByTenantId()` - /brand-identities/default/tenant/:tenant_id operation on brand-identity resource
|
|
234
|
+
- `getBrand-identitiesDefaultWorkspaceByWorkspaceId()` - /brand-identities/default/workspace/:workspace_id operation on brand-identity resource
|
|
235
|
+
- `postBrand-identities()` - /brand-identities operation on brand-identity resource
|
|
236
|
+
- `patchBrand-identitiesById()` - /brand-identities/:id operation on brand-identity resource
|
|
237
|
+
- `patchBrand-identitiesByIdSet-default()` - /brand-identities/:id/set-default operation on brand-identity resource
|
|
238
|
+
- `patchBrand-identitiesByIdUnset-default()` - /brand-identities/:id/unset-default operation on brand-identity resource
|
|
239
|
+
- `deleteBrand-identitiesById()` - /brand-identities/:id operation on brand-identity resource
|
|
262
240
|
|
|
263
241
|
## Breach-incident
|
|
264
242
|
|
|
@@ -280,13 +258,21 @@ flags, workspace mode, and execution limits
|
|
|
280
258
|
- `patchBreach-notification-artifactsById()` - /breach-notification-artifacts/:id operation on breach-notification-artifact resource
|
|
281
259
|
- `patchBreach-notification-artifactsByIdSend()` - Mark artifact as sent and publish BreachNotificationReadyToSend event for Communication domain dispatch.
|
|
282
260
|
|
|
283
|
-
##
|
|
261
|
+
## Browser-session
|
|
284
262
|
|
|
285
|
-
- `
|
|
263
|
+
- `getCrawlerBrowser-sessions()` - /crawler/browser-sessions operation on browser-session resource
|
|
264
|
+
- `getCrawlerBrowser-sessionsById()` - /crawler/browser-sessions/:id operation on browser-session resource
|
|
265
|
+
- `postCrawlerBrowser-sessions()` - /crawler/browser-sessions operation on browser-session resource
|
|
266
|
+
- `patchCrawlerBrowser-sessionsByIdRefresh()` - /crawler/browser-sessions/:id/refresh operation on browser-session resource
|
|
267
|
+
- `deleteCrawlerBrowser-sessionsById()` - /crawler/browser-sessions/:id operation on browser-session resource
|
|
286
268
|
|
|
287
|
-
## Bulk
|
|
269
|
+
## Bulk-dismissal-result
|
|
288
270
|
|
|
289
|
-
- `
|
|
271
|
+
- `postWorkspacesByWorkspaceIdExtractionDocumentsDismiss-all-trained()` - /workspaces/:workspace_id/extraction/documents/dismiss-all-trained operation on bulk-dismissal-result resource
|
|
272
|
+
|
|
273
|
+
## Bulk-reprocess-result
|
|
274
|
+
|
|
275
|
+
- `postExtractionDocumentsBulk-reprocess()` - /extraction/documents/bulk-reprocess operation on bulk-reprocess-result resource
|
|
290
276
|
|
|
291
277
|
## Business-associate-agreement
|
|
292
278
|
|
|
@@ -313,125 +299,125 @@ flags, workspace mode, and execution limits
|
|
|
313
299
|
- `patchEmail-marketingCampaignsById()` - /email-marketing/campaigns/:id operation on campaign resource
|
|
314
300
|
- `deleteEmail-marketingCampaignsById()` - /email-marketing/campaigns/:id operation on campaign resource
|
|
315
301
|
|
|
316
|
-
## Catalog
|
|
302
|
+
## Catalog-classification-suggestion
|
|
317
303
|
|
|
318
|
-
- `getCatalogClassification-suggestionsById()` - /catalog/classification-suggestions/:id operation on
|
|
304
|
+
- `getCatalogClassification-suggestionsById()` - /catalog/classification-suggestions/:id operation on catalog-classification-suggestion resource
|
|
319
305
|
- `getCatalogClassification-suggestionsWorkspaceByWorkspaceIdPending()` - List pending AI classification suggestions for a workspace awaiting ISV review
|
|
320
306
|
- `patchCatalogClassification-suggestionsByIdAccept()` - Accept a pending classification suggestion; publishes ClassificationAccepted event and increments taxonomy node product_count.
|
|
321
307
|
- `patchCatalogClassification-suggestionsByIdReject()` - Reject a pending classification suggestion; sets status to :rejected with no cascading effects.
|
|
322
308
|
|
|
323
|
-
## Catalog
|
|
309
|
+
## Catalog-option-type
|
|
324
310
|
|
|
325
311
|
- `getCatalogOption-typesApplicationByApplicationId()` - List all option types for an application ordered by position
|
|
326
|
-
- `getCatalogOption-typesById()` - /catalog/option-types/:id operation on
|
|
312
|
+
- `getCatalogOption-typesById()` - /catalog/option-types/:id operation on catalog-option-type resource
|
|
327
313
|
- `postCatalogOption-types()` - Create an option type (e.g., Size, Color) for an application; shared across all tenants
|
|
328
314
|
- `patchCatalogOption-typesById()` - Update the name, slug, or display position of an option type
|
|
329
315
|
- `deleteCatalogOption-typesById()` - Permanently delete an option type and all its values; cascades to variant_option_values
|
|
330
316
|
|
|
331
|
-
## Catalog
|
|
317
|
+
## Catalog-option-value
|
|
332
318
|
|
|
333
|
-
- `getCatalogOption-valuesById()` - /catalog/option-values/:id operation on
|
|
319
|
+
- `getCatalogOption-valuesById()` - /catalog/option-values/:id operation on catalog-option-value resource
|
|
334
320
|
- `getCatalogOption-valuesOption-typeByOptionTypeId()` - List all values for an option type ordered by position
|
|
335
321
|
- `postCatalogOption-values()` - Create a specific option value (e.g., 'Large', 'Red') within an option type
|
|
336
322
|
- `patchCatalogOption-valuesById()` - Update the name, slug, position, or metadata of an option value
|
|
337
323
|
- `deleteCatalogOption-valuesById()` - Permanently delete an option value; removes associated variant_option_values
|
|
338
324
|
|
|
339
|
-
## Catalog
|
|
325
|
+
## Catalog-price-list
|
|
340
326
|
|
|
341
327
|
- `getCatalogPrice-listsApplicationByApplicationId()` - List all price lists for an application, ordered by priority
|
|
342
|
-
- `getCatalogPrice-listsById()` - /catalog/price-lists/:id operation on
|
|
328
|
+
- `getCatalogPrice-listsById()` - /catalog/price-lists/:id operation on catalog-price-list resource
|
|
343
329
|
- `postCatalogPrice-lists()` - Create a named price list for an application with a strategy (fixed, percentage_discount, or tiered)
|
|
344
330
|
- `patchCatalogPrice-listsById()` - Update price list metadata, strategy, or validity period
|
|
345
331
|
- `deleteCatalogPrice-listsById()` - Permanently delete a price list and all its entries
|
|
346
332
|
|
|
347
|
-
## Catalog
|
|
333
|
+
## Catalog-price-list-entry
|
|
348
334
|
|
|
349
335
|
- `getCatalogPrice-list-entriesPrice-listByPriceListId()` - List all entries in a price list
|
|
350
336
|
- `postCatalogPrice-list-entries()` - Add a pricing entry to a price list for a product or variant; supply a fixed price, modifier, or tiered structure
|
|
351
337
|
- `patchCatalogPrice-list-entriesById()` - Update the price, modifier, tiers, or floor price for an existing entry
|
|
352
338
|
- `deleteCatalogPrice-list-entriesById()` - Permanently delete a price list entry
|
|
353
339
|
|
|
354
|
-
## Catalog
|
|
340
|
+
## Catalog-price-suggestion
|
|
355
341
|
|
|
356
|
-
- `getCatalogPrice-suggestionsById()` - /catalog/price-suggestions/:id operation on
|
|
342
|
+
- `getCatalogPrice-suggestionsById()` - /catalog/price-suggestions/:id operation on catalog-price-suggestion resource
|
|
357
343
|
- `getCatalogPrice-suggestionsWorkspaceByWorkspaceId()` - List all price suggestions for a workspace (all statuses)
|
|
358
344
|
- `patchCatalogPrice-suggestionsByIdAccept()` - Accept a pending price suggestion; publishes PriceSuggestionAccepted and PriceChanged events, cascading to update the product's effective price.
|
|
359
345
|
- `patchCatalogPrice-suggestionsByIdReject()` - Reject a pending price suggestion; sets status to :rejected with no cascading effects.
|
|
360
346
|
|
|
361
|
-
## Catalog
|
|
347
|
+
## Catalog-product
|
|
362
348
|
|
|
363
|
-
- `getCatalogProductsById()` - /catalog/products/:id operation on
|
|
349
|
+
- `getCatalogProductsById()` - /catalog/products/:id operation on catalog-product resource
|
|
364
350
|
- `getCatalogProductsWorkspaceByWorkspaceId()` - List all active (non-deleted) products in a workspace
|
|
365
351
|
- `postCatalogProducts()` - Create a new catalog product in a workspace; triggers search indexing and enqueues embedding generation
|
|
366
352
|
- `patchCatalogProductsById()` - Update a product's attributes; triggers search re-indexing and embedding refresh
|
|
367
353
|
- `deleteCatalogProductsById()` - Soft-delete a product by stamping deleted_at; excluded from all future reads
|
|
368
354
|
|
|
369
|
-
## Catalog
|
|
355
|
+
## Catalog-product-classification
|
|
370
356
|
|
|
371
357
|
- `postCatalogProduct-classifications()` - Assign a product to a taxonomy node with source tracking (manual, ai_suggested, or ai_auto)
|
|
372
|
-
- `deleteCatalogProduct-classificationsById()` - /catalog/product-classifications/:id operation on
|
|
358
|
+
- `deleteCatalogProduct-classificationsById()` - /catalog/product-classifications/:id operation on catalog-product-classification resource
|
|
373
359
|
|
|
374
|
-
## Catalog
|
|
360
|
+
## Catalog-product-variant
|
|
375
361
|
|
|
376
|
-
- `getCatalogProduct-variantsById()` - /catalog/product-variants/:id operation on
|
|
362
|
+
- `getCatalogProduct-variantsById()` - /catalog/product-variants/:id operation on catalog-product-variant resource
|
|
377
363
|
- `getCatalogProduct-variantsProductByProductId()` - List all active variants for a given product, sorted by position
|
|
378
364
|
- `postCatalogProduct-variants()` - Create a product variant (SKU, price override, option values); enforces max_variants_per_product quota
|
|
379
365
|
- `patchCatalogProduct-variantsById()` - Update a variant's SKU, pricing, properties, or media
|
|
380
366
|
- `deleteCatalogProduct-variantsById()` - Soft-delete a variant by setting deleted_at; excluded from future reads
|
|
381
367
|
|
|
382
|
-
## Catalog
|
|
368
|
+
## Catalog-stock-location
|
|
383
369
|
|
|
384
|
-
- `getCatalogStock-locationsById()` - /catalog/stock-locations/:id operation on
|
|
370
|
+
- `getCatalogStock-locationsById()` - /catalog/stock-locations/:id operation on catalog-stock-location resource
|
|
385
371
|
- `getCatalogStock-locationsWorkspaceByWorkspaceId()` - List all stock locations in a workspace
|
|
386
372
|
- `postCatalogStock-locations()` - Create a stock location (warehouse, store, drop-ship, etc.) in a workspace; enforces max_stock_locations quota
|
|
387
373
|
- `patchCatalogStock-locationsById()` - Update a location's name, address, default flag, status, or valuation method
|
|
388
374
|
|
|
389
|
-
## Catalog
|
|
375
|
+
## Catalog-stock-movement
|
|
390
376
|
|
|
391
|
-
- `getCatalogStock-movementsById()` - /catalog/stock-movements/:id operation on
|
|
377
|
+
- `getCatalogStock-movementsById()` - /catalog/stock-movements/:id operation on catalog-stock-movement resource
|
|
392
378
|
- `getCatalogStock-movementsTransactionByTransactionId()` - Fetch both legs of a double-entry transaction by transaction_id
|
|
393
379
|
|
|
394
|
-
## Catalog
|
|
380
|
+
## Catalog-stock-record
|
|
395
381
|
|
|
396
|
-
- `getCatalogStock-recordsById()` - /catalog/stock-records/:id operation on
|
|
382
|
+
- `getCatalogStock-recordsById()` - /catalog/stock-records/:id operation on catalog-stock-record resource
|
|
397
383
|
- `getCatalogStock-recordsLocationByStockLocationId()` - List all stock records at a location
|
|
398
384
|
|
|
399
|
-
## Catalog
|
|
385
|
+
## Catalog-taxonomy
|
|
400
386
|
|
|
401
387
|
- `getCatalogTaxonomiesApplicationByApplicationId()` - List active taxonomies for an application
|
|
402
|
-
- `getCatalogTaxonomiesById()` - /catalog/taxonomies/:id operation on
|
|
388
|
+
- `getCatalogTaxonomiesById()` - /catalog/taxonomies/:id operation on catalog-taxonomy resource
|
|
403
389
|
- `postCatalogTaxonomies()` - Create a new taxonomy (classification axis) for an application; enforces max_taxonomies quota
|
|
404
390
|
- `patchCatalogTaxonomiesById()` - Update taxonomy metadata (name, slug, hierarchy settings)
|
|
405
391
|
- `deleteCatalogTaxonomiesById()` - Soft-delete a taxonomy by setting deleted_at; cascades to exclude nodes from future reads
|
|
406
392
|
|
|
407
|
-
## Catalog
|
|
393
|
+
## Catalog-taxonomy-node
|
|
408
394
|
|
|
409
|
-
- `getCatalogTaxonomy-nodesById()` - /catalog/taxonomy-nodes/:id operation on
|
|
395
|
+
- `getCatalogTaxonomy-nodesById()` - /catalog/taxonomy-nodes/:id operation on catalog-taxonomy-node resource
|
|
410
396
|
- `getCatalogTaxonomy-nodesTaxonomyByTaxonomyId()` - List all active nodes in a taxonomy
|
|
411
397
|
- `postCatalogTaxonomy-nodes()` - Create a taxonomy node (category) at the given position in the tree; validates hierarchy depth
|
|
412
398
|
- `patchCatalogTaxonomy-nodesById()` - Update a node's name, slug, position, or parent; re-validates tree depth
|
|
413
399
|
- `deleteCatalogTaxonomy-nodesById()` - Soft-delete a taxonomy node by stamping deleted_at; child nodes are not auto-deleted
|
|
414
400
|
|
|
415
|
-
## Catalog
|
|
401
|
+
## Catalog-variant-option-value
|
|
416
402
|
|
|
417
403
|
- `postCatalogVariant-option-values()` - Link a product variant to an option value (e.g., assign 'Red' to a specific variant)
|
|
418
|
-
- `deleteCatalogVariant-option-valuesById()` - /catalog/variant-option-values/:id operation on
|
|
404
|
+
- `deleteCatalogVariant-option-valuesById()` - /catalog/variant-option-values/:id operation on catalog-variant-option-value resource
|
|
419
405
|
|
|
420
|
-
## Catalog
|
|
406
|
+
## Catalog-view
|
|
421
407
|
|
|
422
|
-
- `getCatalogViewsById()` - /catalog/views/:id operation on
|
|
408
|
+
- `getCatalogViewsById()` - /catalog/views/:id operation on catalog-view resource
|
|
423
409
|
- `getCatalogViewsWorkspaceByWorkspaceId()` - List all catalog views in a workspace
|
|
424
410
|
- `postCatalogViews()` - Create a catalog view (named product lens) in a workspace; enforces max_catalog_views quota
|
|
425
411
|
- `patchCatalogViewsById()` - Update view metadata, filtering rules, or pricing association
|
|
426
412
|
- `deleteCatalogViewsById()` - Permanently delete a catalog view and its rules and overrides
|
|
427
413
|
|
|
428
|
-
## Catalog
|
|
414
|
+
## Catalog-view-override
|
|
429
415
|
|
|
430
416
|
- `postCatalogView-overrides()` - Pin or exclude a product in a specific view with optional display overrides (name, description, media)
|
|
431
417
|
- `patchCatalogView-overridesById()` - Update the action (pin/exclude), position, or display overrides for an existing view override
|
|
432
418
|
- `deleteCatalogView-overridesById()` - Remove a product override from a view; the product reverts to standard rule-based inclusion/exclusion on next resolution.
|
|
433
419
|
|
|
434
|
-
## Catalog
|
|
420
|
+
## Catalog-view-rule
|
|
435
421
|
|
|
436
422
|
- `postCatalogView-rules()` - Add a filter rule to a catalog view; rules in the same group are AND'd, multiple groups are OR'd
|
|
437
423
|
- `deleteCatalogView-rulesById()` - Permanently delete a view rule; the view is re-evaluated without this rule on next resolution.
|
|
@@ -443,41 +429,108 @@ flags, workspace mode, and execution limits
|
|
|
443
429
|
- `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
|
|
444
430
|
- `deleteCde-scope-reportsById()` - /cde-scope-reports/:id operation on cde-scope-report resource
|
|
445
431
|
|
|
446
|
-
##
|
|
432
|
+
## Chat-ai-message
|
|
433
|
+
|
|
434
|
+
- `getAiMessages()` - /ai/messages operation on chat-ai-message resource
|
|
435
|
+
- `getAiMessagesById()` - /ai/messages/:id operation on chat-ai-message resource
|
|
436
|
+
- `postAiMessages()` - Append a new message turn (system, user, or assistant) to a Conversation
|
|
437
|
+
- `deleteAiMessagesById()` - /ai/messages/:id operation on chat-ai-message resource
|
|
438
|
+
|
|
439
|
+
## Chat-conversation
|
|
440
|
+
|
|
441
|
+
- `getAiConversations()` - /ai/conversations operation on chat-conversation resource
|
|
442
|
+
- `getAiConversationsById()` - /ai/conversations/:id operation on chat-conversation resource
|
|
443
|
+
- `postAiConversations()` - Start a new AI conversation session with optional structured context data (e.g., prediction results to discuss)
|
|
444
|
+
- `patchAiConversationsById()` - Update the conversation title or replace the context data map
|
|
445
|
+
- `deleteAiConversationsById()` - /ai/conversations/:id operation on chat-conversation resource
|
|
446
|
+
|
|
447
|
+
## Chat-message
|
|
448
|
+
|
|
449
|
+
- `getMessages()` - /messages operation on chat-message resource
|
|
450
|
+
- `getMessagesById()` - /messages/:id operation on chat-message resource
|
|
451
|
+
- `getMessagesSearch()` - Full-text search messages by substring match on content
|
|
452
|
+
- `getMessagesSemantic-search()` - Vector similarity search across messages using a generated embedding of the query string
|
|
453
|
+
- `getThreadsByIdMessages()` - /threads/:id/messages operation on chat-message resource
|
|
454
|
+
- `postMessages()` - Add a new message turn to a thread
|
|
455
|
+
- `patchMessagesById()` - Edit a message's content, role, or metadata
|
|
456
|
+
- `deleteMessagesById()` - /messages/:id operation on chat-message resource
|
|
447
457
|
|
|
448
|
-
|
|
449
|
-
|
|
450
|
-
- `
|
|
451
|
-
- `
|
|
452
|
-
|
|
458
|
+
## Chat-message-feedback
|
|
459
|
+
|
|
460
|
+
- `getMessage-feedback()` - /message-feedback operation on chat-message-feedback resource
|
|
461
|
+
- `postMessage-feedback()` - Submit or update thumbs up/down feedback on a message
|
|
462
|
+
|
|
463
|
+
## Chat-thread
|
|
464
|
+
|
|
465
|
+
- `getThreads()` - /threads operation on chat-thread resource
|
|
466
|
+
- `getThreadsById()` - /threads/:id operation on chat-thread resource
|
|
467
|
+
- `getThreadsMine()` - List only the calling user's threads within their current workspace
|
|
468
|
+
- `getThreadsSearch()` - Full-text search threads by title or context summary within the actor's accessible workspace
|
|
469
|
+
- `postThreads()` - Create a new conversation thread scoped to a tenant, workspace, and user
|
|
470
|
+
- `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)
|
|
471
|
+
- `postThreadsByIdComplete()` - Trigger AI inference on an existing thread without providing new user message content
|
|
472
|
+
- `postThreadsByIdExport()` - Export thread with messages to JSON, Markdown, or plain text format
|
|
473
|
+
- `postThreadsByIdFork()` - Fork a thread by cloning it with all its messages
|
|
474
|
+
- `postThreadsByIdMessages()` - Submit a user message to a thread and receive the AI response synchronously
|
|
475
|
+
- `postThreadsByIdSummarize()` - Generate a 2-3 sentence LLM summary of the thread's message history and persist it as `context_summary`
|
|
476
|
+
- `patchThreadsById()` - Update the thread's title or context summary
|
|
477
|
+
- `patchThreadsByIdArchive()` - Archive a thread by setting `archived_at` to the current timestamp
|
|
478
|
+
- `patchThreadsByIdMetadata()` - Merge the provided metadata map into the thread's existing metadata (shallow merge via Map.merge/2)
|
|
479
|
+
- `patchThreadsByIdUnarchive()` - Restore an archived thread by clearing `archived_at`, making it visible in the default thread list again.
|
|
480
|
+
- `deleteThreadsById()` - /threads/:id operation on chat-thread resource
|
|
481
|
+
|
|
482
|
+
## Chat-thread-stats
|
|
483
|
+
|
|
484
|
+
- `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
|
|
485
|
+
|
|
486
|
+
## Chat-thread-workspace-stats
|
|
487
|
+
|
|
488
|
+
- `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
|
|
489
|
+
|
|
490
|
+
## Chunk-entity-link
|
|
491
|
+
|
|
492
|
+
- `getExtractionChunk-entity-links()` - /extraction/chunk-entity-links operation on chunk-entity-link resource
|
|
493
|
+
- `getExtractionChunk-entity-linksById()` - /extraction/chunk-entity-links/:id operation on chunk-entity-link resource
|
|
494
|
+
- `getExtractionChunk-entity-linksChunkByDocumentChunkId()` - /extraction/chunk-entity-links/chunk/:document_chunk_id operation on chunk-entity-link resource
|
|
495
|
+
- `getExtractionChunk-entity-linksDocumentByDocumentId()` - /extraction/chunk-entity-links/document/:document_id operation on chunk-entity-link resource
|
|
496
|
+
- `getExtractionChunk-entity-linksEntityByGraphNodeId()` - /extraction/chunk-entity-links/entity/:graph_node_id operation on chunk-entity-link resource
|
|
453
497
|
|
|
454
498
|
## Clinical-client-goal
|
|
455
499
|
|
|
456
500
|
- `getClinicalClient-goals()` - /clinical/client-goals operation on clinical-client-goal resource
|
|
501
|
+
- `getClinicalClient-goalsArchived()` - /clinical/client-goals/archived operation on clinical-client-goal resource
|
|
457
502
|
- `getClinicalClient-goalsById()` - /clinical/client-goals/:id operation on clinical-client-goal resource
|
|
458
503
|
- `getClinicalPatientsByIdGoals()` - /clinical/patients/:id/goals operation on clinical-client-goal resource
|
|
459
504
|
- `postClinicalClient-goals()` - /clinical/client-goals operation on clinical-client-goal resource
|
|
460
505
|
- `postClinicalClient-goalsFrom-template()` - /clinical/client-goals/from-template operation on clinical-client-goal resource
|
|
461
506
|
- `patchClinicalClient-goalsById()` - /clinical/client-goals/:id operation on clinical-client-goal resource
|
|
462
|
-
- `
|
|
507
|
+
- `patchClinicalClient-goalsByIdArchive()` - /clinical/client-goals/:id/archive operation on clinical-client-goal resource
|
|
508
|
+
- `patchClinicalClient-goalsByIdRestore()` - /clinical/client-goals/:id/restore operation on clinical-client-goal resource
|
|
509
|
+
- `deleteClinicalClient-goalsByIdPermanent()` - /clinical/client-goals/:id/permanent operation on clinical-client-goal resource
|
|
463
510
|
|
|
464
511
|
## Clinical-client-resource-assignment
|
|
465
512
|
|
|
466
513
|
- `getClinicalClient-resource-assignments()` - /clinical/client-resource-assignments operation on clinical-client-resource-assignment resource
|
|
514
|
+
- `getClinicalClient-resource-assignmentsArchived()` - /clinical/client-resource-assignments/archived operation on clinical-client-resource-assignment resource
|
|
467
515
|
- `getClinicalClient-resource-assignmentsById()` - /clinical/client-resource-assignments/:id operation on clinical-client-resource-assignment resource
|
|
468
516
|
- `getClinicalPatientsByIdResourceAssignments()` - /clinical/patients/:id/resource_assignments operation on clinical-client-resource-assignment resource
|
|
469
517
|
- `postClinicalClient-resource-assignments()` - /clinical/client-resource-assignments operation on clinical-client-resource-assignment resource
|
|
470
518
|
- `patchClinicalClient-resource-assignmentsById()` - /clinical/client-resource-assignments/:id operation on clinical-client-resource-assignment resource
|
|
471
|
-
- `
|
|
519
|
+
- `patchClinicalClient-resource-assignmentsByIdArchive()` - /clinical/client-resource-assignments/:id/archive operation on clinical-client-resource-assignment resource
|
|
520
|
+
- `patchClinicalClient-resource-assignmentsByIdRestore()` - /clinical/client-resource-assignments/:id/restore operation on clinical-client-resource-assignment resource
|
|
521
|
+
- `deleteClinicalClient-resource-assignmentsByIdPermanent()` - /clinical/client-resource-assignments/:id/permanent operation on clinical-client-resource-assignment resource
|
|
472
522
|
|
|
473
523
|
## Clinical-client-supplement
|
|
474
524
|
|
|
475
525
|
- `getClinicalClient-supplements()` - /clinical/client-supplements operation on clinical-client-supplement resource
|
|
526
|
+
- `getClinicalClient-supplementsArchived()` - /clinical/client-supplements/archived operation on clinical-client-supplement resource
|
|
476
527
|
- `getClinicalClient-supplementsById()` - /clinical/client-supplements/:id operation on clinical-client-supplement resource
|
|
477
528
|
- `getClinicalPatientsByIdSupplements()` - /clinical/patients/:id/supplements operation on clinical-client-supplement resource
|
|
478
529
|
- `postClinicalClient-supplements()` - /clinical/client-supplements operation on clinical-client-supplement resource
|
|
479
530
|
- `patchClinicalClient-supplementsById()` - /clinical/client-supplements/:id operation on clinical-client-supplement resource
|
|
480
|
-
- `
|
|
531
|
+
- `patchClinicalClient-supplementsByIdArchive()` - /clinical/client-supplements/:id/archive operation on clinical-client-supplement resource
|
|
532
|
+
- `patchClinicalClient-supplementsByIdRestore()` - /clinical/client-supplements/:id/restore operation on clinical-client-supplement resource
|
|
533
|
+
- `deleteClinicalClient-supplementsByIdPermanent()` - /clinical/client-supplements/:id/permanent operation on clinical-client-supplement resource
|
|
481
534
|
|
|
482
535
|
## Clinical-delivery
|
|
483
536
|
|
|
@@ -490,17 +543,23 @@ flags, workspace mode, and execution limits
|
|
|
490
543
|
## Clinical-goal-template
|
|
491
544
|
|
|
492
545
|
- `getClinicalGoal-templates()` - /clinical/goal-templates operation on clinical-goal-template resource
|
|
546
|
+
- `getClinicalGoal-templatesArchived()` - /clinical/goal-templates/archived operation on clinical-goal-template resource
|
|
493
547
|
- `getClinicalGoal-templatesById()` - /clinical/goal-templates/:id operation on clinical-goal-template resource
|
|
494
548
|
- `getClinicalGoal-templatesCatalog()` - /clinical/goal-templates/catalog operation on clinical-goal-template resource
|
|
549
|
+
- `getClinicalGoal-templatesCatalogArchived()` - /clinical/goal-templates/catalog/archived operation on clinical-goal-template resource
|
|
495
550
|
- `getClinicalGoal-templatesCatalogById()` - /clinical/goal-templates/catalog/:id operation on clinical-goal-template resource
|
|
496
551
|
- `getClinicalGoal-templatesMine()` - /clinical/goal-templates/mine operation on clinical-goal-template resource
|
|
497
552
|
- `postClinicalGoal-templates()` - /clinical/goal-templates operation on clinical-goal-template resource
|
|
498
553
|
- `postClinicalGoal-templatesCatalog()` - /clinical/goal-templates/catalog operation on clinical-goal-template resource
|
|
499
554
|
- `postClinicalGoal-templatesFrom-existing()` - /clinical/goal-templates/from-existing operation on clinical-goal-template resource
|
|
500
555
|
- `patchClinicalGoal-templatesById()` - /clinical/goal-templates/:id operation on clinical-goal-template resource
|
|
556
|
+
- `patchClinicalGoal-templatesByIdArchive()` - /clinical/goal-templates/:id/archive operation on clinical-goal-template resource
|
|
557
|
+
- `patchClinicalGoal-templatesByIdRestore()` - /clinical/goal-templates/:id/restore operation on clinical-goal-template resource
|
|
501
558
|
- `patchClinicalGoal-templatesCatalogById()` - /clinical/goal-templates/catalog/:id operation on clinical-goal-template resource
|
|
502
|
-
- `
|
|
503
|
-
- `
|
|
559
|
+
- `patchClinicalGoal-templatesCatalogByIdArchive()` - /clinical/goal-templates/catalog/:id/archive operation on clinical-goal-template resource
|
|
560
|
+
- `patchClinicalGoal-templatesCatalogByIdRestore()` - /clinical/goal-templates/catalog/:id/restore operation on clinical-goal-template resource
|
|
561
|
+
- `deleteClinicalGoal-templatesByIdPermanent()` - /clinical/goal-templates/:id/permanent operation on clinical-goal-template resource
|
|
562
|
+
- `deleteClinicalGoal-templatesCatalogByIdPermanent()` - /clinical/goal-templates/catalog/:id/permanent operation on clinical-goal-template resource
|
|
504
563
|
|
|
505
564
|
## Clinical-goal-template-category
|
|
506
565
|
|
|
@@ -510,33 +569,42 @@ flags, workspace mode, and execution limits
|
|
|
510
569
|
## Clinical-health-metric
|
|
511
570
|
|
|
512
571
|
- `getClinicalHealth-metrics()` - /clinical/health-metrics operation on clinical-health-metric resource
|
|
572
|
+
- `getClinicalHealth-metricsArchived()` - /clinical/health-metrics/archived operation on clinical-health-metric resource
|
|
513
573
|
- `getClinicalHealth-metricsBy-session()` - /clinical/health-metrics/by-session operation on clinical-health-metric resource
|
|
514
574
|
- `getClinicalHealth-metricsById()` - /clinical/health-metrics/:id operation on clinical-health-metric resource
|
|
515
575
|
- `getClinicalPatientsByIdHealthMetrics()` - /clinical/patients/:id/health_metrics operation on clinical-health-metric resource
|
|
516
576
|
- `postClinicalHealth-metrics()` - /clinical/health-metrics operation on clinical-health-metric resource
|
|
517
577
|
- `patchClinicalHealth-metricsById()` - /clinical/health-metrics/:id operation on clinical-health-metric resource
|
|
518
|
-
- `
|
|
578
|
+
- `patchClinicalHealth-metricsByIdArchive()` - /clinical/health-metrics/:id/archive operation on clinical-health-metric resource
|
|
579
|
+
- `patchClinicalHealth-metricsByIdRestore()` - /clinical/health-metrics/:id/restore operation on clinical-health-metric resource
|
|
580
|
+
- `deleteClinicalHealth-metricsByIdPermanent()` - /clinical/health-metrics/:id/permanent operation on clinical-health-metric resource
|
|
519
581
|
|
|
520
582
|
## Clinical-meal-plan
|
|
521
583
|
|
|
522
584
|
- `getClinicalMeal-plans()` - /clinical/meal-plans operation on clinical-meal-plan resource
|
|
585
|
+
- `getClinicalMeal-plansArchived()` - /clinical/meal-plans/archived operation on clinical-meal-plan resource
|
|
523
586
|
- `getClinicalMeal-plansBy-workspace()` - /clinical/meal-plans/by-workspace operation on clinical-meal-plan resource
|
|
524
587
|
- `getClinicalMeal-plansById()` - /clinical/meal-plans/:id operation on clinical-meal-plan resource
|
|
525
588
|
- `getClinicalSessionsByIdMealPlans()` - /clinical/sessions/:id/meal_plans operation on clinical-meal-plan resource
|
|
526
589
|
- `postClinicalMeal-plans()` - /clinical/meal-plans operation on clinical-meal-plan resource
|
|
527
590
|
- `patchClinicalMeal-plansById()` - /clinical/meal-plans/:id operation on clinical-meal-plan resource
|
|
528
|
-
- `
|
|
591
|
+
- `patchClinicalMeal-plansByIdArchive()` - /clinical/meal-plans/:id/archive operation on clinical-meal-plan resource
|
|
592
|
+
- `patchClinicalMeal-plansByIdRestore()` - /clinical/meal-plans/:id/restore operation on clinical-meal-plan resource
|
|
593
|
+
- `deleteClinicalMeal-plansByIdPermanent()` - /clinical/meal-plans/:id/permanent operation on clinical-meal-plan resource
|
|
529
594
|
|
|
530
595
|
## Clinical-note
|
|
531
596
|
|
|
532
597
|
- `getClinicalNotes()` - /clinical/notes operation on clinical-note resource
|
|
598
|
+
- `getClinicalNotesArchived()` - /clinical/notes/archived operation on clinical-note resource
|
|
533
599
|
- `getClinicalNotesById()` - /clinical/notes/:id operation on clinical-note resource
|
|
534
600
|
- `getClinicalSessionsByIdSessionNotes()` - /clinical/sessions/:id/session_notes operation on clinical-note resource
|
|
535
601
|
- `postClinicalNotes()` - /clinical/notes operation on clinical-note resource
|
|
536
602
|
- `patchClinicalNotesById()` - /clinical/notes/:id operation on clinical-note resource
|
|
537
603
|
- `patchClinicalNotesByIdApprove()` - RD approves the clinical note
|
|
604
|
+
- `patchClinicalNotesByIdArchive()` - /clinical/notes/:id/archive operation on clinical-note resource
|
|
538
605
|
- `patchClinicalNotesByIdReject()` - RD rejects the clinical note.
|
|
539
|
-
- `
|
|
606
|
+
- `patchClinicalNotesByIdRestore()` - /clinical/notes/:id/restore operation on clinical-note resource
|
|
607
|
+
- `deleteClinicalNotesByIdPermanent()` - /clinical/notes/:id/permanent operation on clinical-note resource
|
|
540
608
|
|
|
541
609
|
## Clinical-note-version
|
|
542
610
|
|
|
@@ -554,15 +622,21 @@ flags, workspace mode, and execution limits
|
|
|
554
622
|
## Clinical-practice-resource
|
|
555
623
|
|
|
556
624
|
- `getClinicalPractice-resources()` - /clinical/practice-resources operation on clinical-practice-resource resource
|
|
625
|
+
- `getClinicalPractice-resourcesArchived()` - /clinical/practice-resources/archived operation on clinical-practice-resource resource
|
|
557
626
|
- `getClinicalPractice-resourcesById()` - /clinical/practice-resources/:id operation on clinical-practice-resource resource
|
|
558
627
|
- `getClinicalPractice-resourcesCatalog()` - /clinical/practice-resources/catalog operation on clinical-practice-resource resource
|
|
628
|
+
- `getClinicalPractice-resourcesCatalogArchived()` - /clinical/practice-resources/catalog/archived operation on clinical-practice-resource resource
|
|
559
629
|
- `getClinicalPractice-resourcesCatalogById()` - /clinical/practice-resources/catalog/:id operation on clinical-practice-resource resource
|
|
560
630
|
- `postClinicalPractice-resources()` - /clinical/practice-resources operation on clinical-practice-resource resource
|
|
561
631
|
- `postClinicalPractice-resourcesCatalog()` - /clinical/practice-resources/catalog operation on clinical-practice-resource resource
|
|
562
632
|
- `patchClinicalPractice-resourcesById()` - /clinical/practice-resources/:id operation on clinical-practice-resource resource
|
|
633
|
+
- `patchClinicalPractice-resourcesByIdArchive()` - /clinical/practice-resources/:id/archive operation on clinical-practice-resource resource
|
|
634
|
+
- `patchClinicalPractice-resourcesByIdRestore()` - /clinical/practice-resources/:id/restore operation on clinical-practice-resource resource
|
|
563
635
|
- `patchClinicalPractice-resourcesCatalogById()` - /clinical/practice-resources/catalog/:id operation on clinical-practice-resource resource
|
|
564
|
-
- `
|
|
565
|
-
- `
|
|
636
|
+
- `patchClinicalPractice-resourcesCatalogByIdArchive()` - /clinical/practice-resources/catalog/:id/archive operation on clinical-practice-resource resource
|
|
637
|
+
- `patchClinicalPractice-resourcesCatalogByIdRestore()` - /clinical/practice-resources/catalog/:id/restore operation on clinical-practice-resource resource
|
|
638
|
+
- `deleteClinicalPractice-resourcesByIdPermanent()` - /clinical/practice-resources/:id/permanent operation on clinical-practice-resource resource
|
|
639
|
+
- `deleteClinicalPractice-resourcesCatalogByIdPermanent()` - /clinical/practice-resources/catalog/:id/permanent operation on clinical-practice-resource resource
|
|
566
640
|
|
|
567
641
|
## Clinical-practice-resource-category
|
|
568
642
|
|
|
@@ -572,15 +646,21 @@ flags, workspace mode, and execution limits
|
|
|
572
646
|
## Clinical-practice-tool
|
|
573
647
|
|
|
574
648
|
- `getClinicalPractice-tools()` - /clinical/practice-tools operation on clinical-practice-tool resource
|
|
649
|
+
- `getClinicalPractice-toolsArchived()` - /clinical/practice-tools/archived operation on clinical-practice-tool resource
|
|
575
650
|
- `getClinicalPractice-toolsById()` - /clinical/practice-tools/:id operation on clinical-practice-tool resource
|
|
576
651
|
- `getClinicalPractice-toolsCatalog()` - /clinical/practice-tools/catalog operation on clinical-practice-tool resource
|
|
652
|
+
- `getClinicalPractice-toolsCatalogArchived()` - /clinical/practice-tools/catalog/archived operation on clinical-practice-tool resource
|
|
577
653
|
- `getClinicalPractice-toolsCatalogById()` - /clinical/practice-tools/catalog/:id operation on clinical-practice-tool resource
|
|
578
654
|
- `postClinicalPractice-tools()` - /clinical/practice-tools operation on clinical-practice-tool resource
|
|
579
655
|
- `postClinicalPractice-toolsCatalog()` - /clinical/practice-tools/catalog operation on clinical-practice-tool resource
|
|
580
656
|
- `patchClinicalPractice-toolsById()` - /clinical/practice-tools/:id operation on clinical-practice-tool resource
|
|
657
|
+
- `patchClinicalPractice-toolsByIdArchive()` - /clinical/practice-tools/:id/archive operation on clinical-practice-tool resource
|
|
658
|
+
- `patchClinicalPractice-toolsByIdRestore()` - /clinical/practice-tools/:id/restore operation on clinical-practice-tool resource
|
|
581
659
|
- `patchClinicalPractice-toolsCatalogById()` - /clinical/practice-tools/catalog/:id operation on clinical-practice-tool resource
|
|
582
|
-
- `
|
|
583
|
-
- `
|
|
660
|
+
- `patchClinicalPractice-toolsCatalogByIdArchive()` - /clinical/practice-tools/catalog/:id/archive operation on clinical-practice-tool resource
|
|
661
|
+
- `patchClinicalPractice-toolsCatalogByIdRestore()` - /clinical/practice-tools/catalog/:id/restore operation on clinical-practice-tool resource
|
|
662
|
+
- `deleteClinicalPractice-toolsByIdPermanent()` - /clinical/practice-tools/:id/permanent operation on clinical-practice-tool resource
|
|
663
|
+
- `deleteClinicalPractice-toolsCatalogByIdPermanent()` - /clinical/practice-tools/catalog/:id/permanent operation on clinical-practice-tool resource
|
|
584
664
|
|
|
585
665
|
## Clinical-practice-tool-category
|
|
586
666
|
|
|
@@ -649,17 +729,17 @@ flags, workspace mode, and execution limits
|
|
|
649
729
|
- `postConfigs()` - Create or upsert a platform config entry by key; if the key already exists its value, description, and sensitivity flag are updated
|
|
650
730
|
- `patchConfigsByKey()` - Update the value, description, or sensitivity flag for an existing config entry; automatically invalidates the FetchConfig cache for the key
|
|
651
731
|
|
|
652
|
-
## Config
|
|
732
|
+
## Config-enum
|
|
653
733
|
|
|
654
|
-
- `getExtractionConfig-enums()` - /extraction/config-enums operation on
|
|
655
|
-
- `getExtractionConfig-enumsById()` - /extraction/config-enums/:id operation on
|
|
656
|
-
- `postExtractionConfig-enums()` - /extraction/config-enums operation on
|
|
657
|
-
- `patchExtractionConfig-enumsById()` - /extraction/config-enums/:id operation on
|
|
734
|
+
- `getExtractionConfig-enums()` - /extraction/config-enums operation on config-enum resource
|
|
735
|
+
- `getExtractionConfig-enumsById()` - /extraction/config-enums/:id operation on config-enum resource
|
|
736
|
+
- `postExtractionConfig-enums()` - /extraction/config-enums operation on config-enum resource
|
|
737
|
+
- `patchExtractionConfig-enumsById()` - /extraction/config-enums/:id operation on config-enum resource
|
|
658
738
|
|
|
659
|
-
## Connector
|
|
739
|
+
## Connector-instance
|
|
660
740
|
|
|
661
|
-
- `getConnectors()` - /connectors operation on
|
|
662
|
-
- `getConnectorsById()` - /connectors/:id operation on
|
|
741
|
+
- `getConnectors()` - /connectors operation on connector-instance resource
|
|
742
|
+
- `getConnectorsById()` - /connectors/:id operation on connector-instance resource
|
|
663
743
|
- `postConnectors()` - Install a new connector instance in a workspace
|
|
664
744
|
- `postConnectorsByIdEdamamRecipesGet()` - Get full details for a single recipe by Edamam recipe ID
|
|
665
745
|
- `postConnectorsByIdEdamamRecipesSearch()` - Search for recipes using the Edamam Recipe API
|
|
@@ -667,11 +747,19 @@ flags, workspace mode, and execution limits
|
|
|
667
747
|
- `postConnectorsByIdSync()` - Execute an action on an external connector
|
|
668
748
|
- `postConnectorsFullscriptCheck-patient()` - Check if a patient exists in Fullscript by email
|
|
669
749
|
- `postConnectorsFullscriptCreate-patient()` - Create a patient in Fullscript
|
|
750
|
+
- `postConnectorsFullscriptOrdersGet()` - Get order details from Fullscript
|
|
751
|
+
- `postConnectorsFullscriptOrdersList()` - List orders for a Fullscript patient
|
|
752
|
+
- `postConnectorsFullscriptProductsGet()` - Get product details from Fullscript
|
|
753
|
+
- `postConnectorsFullscriptProductsSearch()` - Search the Fullscript product catalog
|
|
754
|
+
- `postConnectorsFullscriptProductsSimilar()` - List similar products from Fullscript
|
|
670
755
|
- `postConnectorsFullscriptSession-grant()` - Get a Fullscript embed session grant token for the prescribing widget
|
|
756
|
+
- `postConnectorsFullscriptTreatment-plansCancel()` - Cancel an active Fullscript treatment plan
|
|
757
|
+
- `postConnectorsFullscriptTreatment-plansGet()` - Get treatment plan details from Fullscript
|
|
758
|
+
- `postConnectorsFullscriptTreatment-plansList()` - List treatment plans for a Fullscript patient
|
|
671
759
|
- `postConnectorsOauthCallback()` - Exchange OAuth authorization code for credential.
|
|
672
760
|
- `postConnectorsOauthInitiate()` - Initiate OAuth flow for a connector type
|
|
673
761
|
- `patchConnectorsById()` - Update a connector instance's name, configuration, sync interval, health status, or metadata
|
|
674
|
-
- `deleteConnectorsById()` - /connectors/:id operation on
|
|
762
|
+
- `deleteConnectorsById()` - /connectors/:id operation on connector-instance resource
|
|
675
763
|
|
|
676
764
|
## Consent-record
|
|
677
765
|
|
|
@@ -694,45 +782,37 @@ flags, workspace mode, and execution limits
|
|
|
694
782
|
- `postContentShorten()` - Shorten text to a target character count.
|
|
695
783
|
- `postContentSuggest-topics()` - Suggest content topics based on industry and audience.
|
|
696
784
|
|
|
697
|
-
##
|
|
785
|
+
## Crawler-job
|
|
698
786
|
|
|
699
|
-
- `
|
|
700
|
-
- `
|
|
701
|
-
- `postAiConversations()` - Start a new AI conversation session with optional structured context data (e.g., prediction results to discuss)
|
|
702
|
-
- `patchAiConversationsById()` - Update the conversation title or replace the context data map
|
|
703
|
-
- `deleteAiConversationsById()` - /ai/conversations/:id operation on conversation resource
|
|
704
|
-
|
|
705
|
-
## Crawler job
|
|
706
|
-
|
|
707
|
-
- `getCrawlerJobs()` - /crawler/jobs operation on crawler_job resource
|
|
708
|
-
- `getCrawlerJobsById()` - /crawler/jobs/:id operation on crawler_job resource
|
|
787
|
+
- `getCrawlerJobs()` - /crawler/jobs operation on crawler-job resource
|
|
788
|
+
- `getCrawlerJobsById()` - /crawler/jobs/:id operation on crawler-job resource
|
|
709
789
|
- `postCrawlerJobs()` - Create a crawl job for a URL with the specified mode and strategy; performs a credit pre-check and enqueues execution
|
|
710
790
|
- `patchCrawlerJobsByIdCancel()` - Cancel a pending or running job; sets status to :cancelled with completed_at timestamp
|
|
711
|
-
- `deleteCrawlerJobsById()` - /crawler/jobs/:id operation on
|
|
791
|
+
- `deleteCrawlerJobsById()` - /crawler/jobs/:id operation on crawler-job resource
|
|
712
792
|
|
|
713
|
-
## Crawler
|
|
793
|
+
## Crawler-result
|
|
714
794
|
|
|
715
|
-
- `getCrawlerResults()` - /crawler/results operation on
|
|
716
|
-
- `getCrawlerResultsById()` - /crawler/results/:id operation on
|
|
795
|
+
- `getCrawlerResults()` - /crawler/results operation on crawler-result resource
|
|
796
|
+
- `getCrawlerResultsById()` - /crawler/results/:id operation on crawler-result resource
|
|
717
797
|
|
|
718
|
-
## Crawler
|
|
798
|
+
## Crawler-schedule
|
|
719
799
|
|
|
720
|
-
- `getCrawlerSchedules()` - /crawler/schedules operation on
|
|
721
|
-
- `getCrawlerSchedulesById()` - /crawler/schedules/:id operation on
|
|
800
|
+
- `getCrawlerSchedules()` - /crawler/schedules operation on crawler-schedule resource
|
|
801
|
+
- `getCrawlerSchedulesById()` - /crawler/schedules/:id operation on crawler-schedule resource
|
|
722
802
|
- `postCrawlerSchedules()` - Create a recurring crawl schedule for a URL; sets frequency, cron expression, and notification preferences
|
|
723
803
|
- `patchCrawlerSchedulesById()` - Update schedule configuration, URL, frequency, or notification settings
|
|
724
804
|
- `patchCrawlerSchedulesByIdDisable()` - Disable a schedule to pause automatic crawling without deleting the configuration.
|
|
725
805
|
- `patchCrawlerSchedulesByIdEnable()` - Enable a disabled schedule so it resumes automatic crawling on its next_run_at.
|
|
726
806
|
- `patchCrawlerSchedulesByIdTrigger()` - Manually trigger a scheduled crawl immediately.
|
|
727
|
-
- `deleteCrawlerSchedulesById()` - /crawler/schedules/:id operation on
|
|
807
|
+
- `deleteCrawlerSchedulesById()` - /crawler/schedules/:id operation on crawler-schedule resource
|
|
728
808
|
|
|
729
|
-
## Crawler
|
|
809
|
+
## Crawler-site-config
|
|
730
810
|
|
|
731
|
-
- `getCrawlerSite-configs()` - /crawler/site-configs operation on
|
|
732
|
-
- `getCrawlerSite-configsById()` - /crawler/site-configs/:id operation on
|
|
811
|
+
- `getCrawlerSite-configs()` - /crawler/site-configs operation on crawler-site-config resource
|
|
812
|
+
- `getCrawlerSite-configsById()` - /crawler/site-configs/:id operation on crawler-site-config resource
|
|
733
813
|
- `postCrawlerSite-configs()` - Create per-domain crawl settings (rate limit, strategy, custom headers, robots.txt preference) for a workspace
|
|
734
814
|
- `patchCrawlerSite-configsById()` - Update rate limits, strategy preference, JS requirement, or headers for an existing site config
|
|
735
|
-
- `deleteCrawlerSite-configsById()` - /crawler/site-configs/:id operation on
|
|
815
|
+
- `deleteCrawlerSite-configsById()` - /crawler/site-configs/:id operation on crawler-site-config resource
|
|
736
816
|
|
|
737
817
|
## Credential
|
|
738
818
|
|
|
@@ -752,7 +832,7 @@ flags, workspace mode, and execution limits
|
|
|
752
832
|
- `patchCredit-packagesById()` - Update an existing credit package's name, price, or credit amount
|
|
753
833
|
- `deleteCredit-packagesById()` - /credit-packages/:id operation on credit-package resource
|
|
754
834
|
|
|
755
|
-
## Crm
|
|
835
|
+
## Crm-activity
|
|
756
836
|
|
|
757
837
|
- `getCrmActivitiesById()` - Fetch a single active activity by ID; excludes soft-deleted records.
|
|
758
838
|
- `getCrmActivitiesWorkspaceByWorkspaceId()` - List active activities in a workspace with offset pagination
|
|
@@ -760,13 +840,13 @@ flags, workspace mode, and execution limits
|
|
|
760
840
|
- `patchCrmActivitiesById()` - Update an activity's subject, body, sentiment, or AI-generated fields
|
|
761
841
|
- `deleteCrmActivitiesById()` - Soft-delete an activity by setting deleted_at
|
|
762
842
|
|
|
763
|
-
## Crm
|
|
843
|
+
## Crm-channel-capture-config
|
|
764
844
|
|
|
765
|
-
- `getIsvCrmChannel-capture-configById()` - /isv/crm/channel-capture-config/:id operation on
|
|
845
|
+
- `getIsvCrmChannel-capture-configById()` - /isv/crm/channel-capture-config/:id operation on crm-channel-capture-config resource
|
|
766
846
|
- `postIsvCrmChannel-capture-config()` - Create a channel capture configuration for a workspace
|
|
767
847
|
- `patchIsvCrmChannel-capture-configById()` - Update channel capture settings for a workspace
|
|
768
848
|
|
|
769
|
-
## Crm
|
|
849
|
+
## Crm-company
|
|
770
850
|
|
|
771
851
|
- `getCrmCompaniesById()` - Fetch a single active company by ID; excludes soft-deleted records.
|
|
772
852
|
- `getCrmCompaniesWorkspaceByWorkspaceId()` - List active companies in a workspace with offset pagination
|
|
@@ -774,7 +854,7 @@ flags, workspace mode, and execution limits
|
|
|
774
854
|
- `patchCrmCompaniesById()` - Update mutable fields on an existing company
|
|
775
855
|
- `deleteCrmCompaniesById()` - Soft-delete a company by setting deleted_at
|
|
776
856
|
|
|
777
|
-
## Crm
|
|
857
|
+
## Crm-contact
|
|
778
858
|
|
|
779
859
|
- `getCrmContactsById()` - Fetch a single active contact by ID; excludes soft-deleted records.
|
|
780
860
|
- `getCrmContactsWorkspaceByWorkspaceId()` - List active contacts in a workspace with optional lifecycle_stage, tag, and
|
|
@@ -786,7 +866,7 @@ property filters applied Elixir-side
|
|
|
786
866
|
- `patchCrmContactsByIdArchive()` - Soft-archive a contact (sets deleted_at)
|
|
787
867
|
- `deleteCrmContactsById()` - Soft-delete a contact by setting deleted_at
|
|
788
868
|
|
|
789
|
-
## Crm
|
|
869
|
+
## Crm-custom-entity
|
|
790
870
|
|
|
791
871
|
- `getCrmCustom-entitiesById()` - Fetch a single active custom entity by ID; excludes soft-deleted records.
|
|
792
872
|
- `getCrmCustom-entitiesWorkspaceByWorkspaceId()` - List active custom entities in a workspace, optionally filtered by type slug and
|
|
@@ -795,35 +875,35 @@ attribute-level property filters
|
|
|
795
875
|
- `patchCrmCustom-entitiesById()` - Update a custom entity's properties and pipeline assignment
|
|
796
876
|
- `deleteCrmCustom-entitiesById()` - Soft-delete a custom entity by setting deleted_at
|
|
797
877
|
|
|
798
|
-
## Crm
|
|
878
|
+
## Crm-custom-entity-type
|
|
799
879
|
|
|
800
880
|
- `getIsvCrmEntity-typesApplicationByApplicationId()` - List all custom entity types defined for an application
|
|
801
|
-
- `getIsvCrmEntity-typesById()` - /isv/crm/entity-types/:id operation on
|
|
881
|
+
- `getIsvCrmEntity-typesById()` - /isv/crm/entity-types/:id operation on crm-custom-entity-type resource
|
|
802
882
|
- `postIsvCrmEntity-types()` - Define a new custom entity type for the application (e.g., 'client_goals', 'session')
|
|
803
883
|
- `patchIsvCrmEntity-typesById()` - Update a custom entity type's display name, field schema, or capability flags
|
|
804
|
-
- `deleteIsvCrmEntity-typesById()` - /isv/crm/entity-types/:id operation on
|
|
884
|
+
- `deleteIsvCrmEntity-typesById()` - /isv/crm/entity-types/:id operation on crm-custom-entity-type resource
|
|
805
885
|
|
|
806
|
-
## Crm
|
|
886
|
+
## Crm-custom-entity-version
|
|
807
887
|
|
|
808
|
-
- `getCrmCustom-entitiesByEntityIdVersions()` - /crm/custom-entities/:entity_id/versions operation on
|
|
888
|
+
- `getCrmCustom-entitiesByEntityIdVersions()` - /crm/custom-entities/:entity_id/versions operation on crm-custom-entity-version resource
|
|
809
889
|
- `getCrmCustom-entitiesByEntityIdVersionsById()` - Fetch a single version by ID, scoped to a specific entity (IDOR-safe)
|
|
810
890
|
|
|
811
|
-
## Crm
|
|
891
|
+
## Crm-custom-field-definition
|
|
812
892
|
|
|
813
|
-
- `getCrmField-definitionsById()` - /crm/field-definitions/:id operation on
|
|
893
|
+
- `getCrmField-definitionsById()` - /crm/field-definitions/:id operation on crm-custom-field-definition resource
|
|
814
894
|
- `getCrmField-definitionsEntity-typeByEntityType()` - List all custom field definitions for a given application and entity type
|
|
815
895
|
- `postCrmField-definitions()` - Define a custom field for a core CRM entity type (contact, company, deal, activity)
|
|
816
896
|
- `patchCrmField-definitionsById()` - Update display metadata and validation rules for an existing custom field
|
|
817
|
-
- `deleteCrmField-definitionsById()` - /crm/field-definitions/:id operation on
|
|
897
|
+
- `deleteCrmField-definitionsById()` - /crm/field-definitions/:id operation on crm-custom-field-definition resource
|
|
818
898
|
|
|
819
|
-
## Crm
|
|
899
|
+
## Crm-data-export-job
|
|
820
900
|
|
|
821
901
|
- `getCrmExportsById()` - Fetch a single export job by ID
|
|
822
902
|
- `getCrmExportsWorkspaceByWorkspaceId()` - List all export jobs for a workspace, sorted newest first
|
|
823
903
|
- `postCrmExports()` - Enqueue an async CRM data export job
|
|
824
904
|
- `patchCrmExportsByIdRefresh-url()` - Regenerate the presigned download URL for a completed export job
|
|
825
905
|
|
|
826
|
-
## Crm
|
|
906
|
+
## Crm-deal
|
|
827
907
|
|
|
828
908
|
- `getCrmDealsById()` - Fetch a single active deal by ID; excludes soft-deleted records.
|
|
829
909
|
- `getCrmDealsWorkspaceByWorkspaceId()` - List active deals in a workspace with offset pagination
|
|
@@ -832,50 +912,50 @@ attribute-level property filters
|
|
|
832
912
|
- `patchCrmDealsByIdMove-stage()` - Move a deal to a different pipeline stage
|
|
833
913
|
- `deleteCrmDealsById()` - Soft-delete a deal by setting deleted_at
|
|
834
914
|
|
|
835
|
-
## Crm
|
|
915
|
+
## Crm-deal-product
|
|
836
916
|
|
|
837
|
-
- `getCrmDeal-products()` - /crm/deal-products operation on
|
|
838
|
-
- `getCrmDeal-productsById()` - /crm/deal-products/:id operation on
|
|
917
|
+
- `getCrmDeal-products()` - /crm/deal-products operation on crm-deal-product resource
|
|
918
|
+
- `getCrmDeal-productsById()` - /crm/deal-products/:id operation on crm-deal-product resource
|
|
839
919
|
- `postCrmDeal-products()` - Link a catalog product to a deal with quantity and negotiated unit price
|
|
840
|
-
- `deleteCrmDeal-productsById()` - /crm/deal-products/:id operation on
|
|
920
|
+
- `deleteCrmDeal-productsById()` - /crm/deal-products/:id operation on crm-deal-product resource
|
|
841
921
|
|
|
842
|
-
## Crm
|
|
922
|
+
## Crm-pipeline
|
|
843
923
|
|
|
844
|
-
- `getCrmPipelinesById()` - /crm/pipelines/:id operation on
|
|
924
|
+
- `getCrmPipelinesById()` - /crm/pipelines/:id operation on crm-pipeline resource
|
|
845
925
|
- `getCrmPipelinesWorkspaceByWorkspaceId()` - List pipelines available to a workspace — includes both workspace-specific pipelines and application-level templates (workspace_id IS NULL).
|
|
846
926
|
- `postCrmPipelines()` - Create a pipeline scoped to an application (template) or a specific workspace
|
|
847
927
|
- `patchCrmPipelinesById()` - Update a pipeline's name or default status
|
|
848
|
-
- `deleteCrmPipelinesById()` - /crm/pipelines/:id operation on
|
|
928
|
+
- `deleteCrmPipelinesById()` - /crm/pipelines/:id operation on crm-pipeline resource
|
|
849
929
|
|
|
850
|
-
## Crm
|
|
930
|
+
## Crm-pipeline-stage
|
|
851
931
|
|
|
852
|
-
- `getCrmPipeline-stagesById()` - /crm/pipeline-stages/:id operation on
|
|
932
|
+
- `getCrmPipeline-stagesById()` - /crm/pipeline-stages/:id operation on crm-pipeline-stage resource
|
|
853
933
|
- `getCrmPipeline-stagesPipelineByPipelineId()` - List all stages for a specific pipeline, ordered by position.
|
|
854
934
|
- `postCrmPipeline-stages()` - Add a stage to a pipeline with an explicit sort order, optional win probability, and forecast category
|
|
855
935
|
- `patchCrmPipeline-stagesById()` - Update a pipeline stage's name, order, probability, or closed flag
|
|
856
|
-
- `deleteCrmPipeline-stagesById()` - /crm/pipeline-stages/:id operation on
|
|
936
|
+
- `deleteCrmPipeline-stagesById()` - /crm/pipeline-stages/:id operation on crm-pipeline-stage resource
|
|
857
937
|
|
|
858
|
-
## Crm
|
|
938
|
+
## Crm-relationship
|
|
859
939
|
|
|
860
940
|
- `getCrmRelationshipsById()` - Fetch a single CRM relationship by ID
|
|
861
941
|
- `getCrmRelationshipsWorkspaceByWorkspaceId()` - List all relationship edges in a workspace
|
|
862
942
|
- `postCrmRelationships()` - Create a typed relationship edge between two CRM entities
|
|
863
943
|
- `deleteCrmRelationshipsById()` - Permanently remove a relationship edge (hard delete)
|
|
864
944
|
|
|
865
|
-
## Crm
|
|
945
|
+
## Crm-relationship-type
|
|
866
946
|
|
|
867
|
-
- `getCrmRelationship-types()` - /crm/relationship-types operation on
|
|
868
|
-
- `getCrmRelationship-typesById()` - /crm/relationship-types/:id operation on
|
|
947
|
+
- `getCrmRelationship-types()` - /crm/relationship-types operation on crm-relationship-type resource
|
|
948
|
+
- `getCrmRelationship-typesById()` - /crm/relationship-types/:id operation on crm-relationship-type resource
|
|
869
949
|
- `postCrmRelationship-types()` - Define a named relationship category for an application
|
|
870
950
|
- `patchCrmRelationship-typesById()` - Update a relationship type's display name, allowed entity types, or properties schema
|
|
871
|
-
- `deleteCrmRelationship-typesById()` - /crm/relationship-types/:id operation on
|
|
951
|
+
- `deleteCrmRelationship-typesById()` - /crm/relationship-types/:id operation on crm-relationship-type resource
|
|
872
952
|
|
|
873
|
-
## Crm
|
|
953
|
+
## Crm-sync-config
|
|
874
954
|
|
|
875
955
|
- `getCrmSync-configsWorkspaceByWorkspaceId()` - List all sync configurations for a workspace, one per connector instance
|
|
876
956
|
- `postCrmSync-configs()` - Create a CRM sync configuration for a workspace+connector pair
|
|
877
957
|
- `patchCrmSync-configsById()` - Update connector sync settings
|
|
878
|
-
- `deleteCrmSync-configsById()` - /crm/sync-configs/:id operation on
|
|
958
|
+
- `deleteCrmSync-configsById()` - /crm/sync-configs/:id operation on crm-sync-config resource
|
|
879
959
|
|
|
880
960
|
## Customer
|
|
881
961
|
|
|
@@ -913,56 +993,14 @@ attribute-level property filters
|
|
|
913
993
|
- `getDisclosure-logsById()` - /disclosure-logs/:id operation on disclosure-log resource
|
|
914
994
|
- `postDisclosure-logs()` - /disclosure-logs operation on disclosure-log resource
|
|
915
995
|
|
|
916
|
-
## Document
|
|
996
|
+
## Document-chunk
|
|
917
997
|
|
|
918
998
|
- `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.
|
|
919
999
|
- `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.
|
|
920
1000
|
|
|
921
|
-
## Document
|
|
1001
|
+
## Document-stats
|
|
922
1002
|
|
|
923
|
-
- `
|
|
924
|
-
- `getExtractionDocumentsById()` - Primary read for active (non-deleted) documents
|
|
925
|
-
- `getExtractionDocumentsByIdStatus()` - Lightweight poll endpoint: fetches only `id`, `status`, `progress`, and `error_message` for
|
|
926
|
-
a single document
|
|
927
|
-
- `getExtractionDocumentsByIdView()` - Get a document with its presigned view URL
|
|
928
|
-
- `getExtractionDocumentsWorkspaceByWorkspaceId()` - List active (non-deleted) documents in a workspace, sorted by creation date
|
|
929
|
-
- `getExtractionDocumentsWorkspaceByWorkspaceIdBy-statusByStatus()` - Filter documents by workspace_id and processing status
|
|
930
|
-
- `getExtractionDocumentsWorkspaceByWorkspaceIdExcluded()` - List excluded documents
|
|
931
|
-
- `getExtractionDocumentsWorkspaceByWorkspaceIdReview-queue()` - Get prioritized review queue for active learning
|
|
932
|
-
- `getExtractionDocumentsWorkspaceByWorkspaceIdTrained()` - List documents that have been trained and not dismissed
|
|
933
|
-
- `getExtractionDocumentsWorkspaceByWorkspaceIdTrashed()` - List soft-deleted (trashed) documents
|
|
934
|
-
- `postExtractionDocumentsBegin-upload()` - Step 1 of 2 in the two-step upload flow
|
|
935
|
-
- `postExtractionDocumentsFind-or-begin-upload()` - Dedup-aware upload: returns existing document if file_hash matches, otherwise creates new document
|
|
936
|
-
- `postExtractionDocumentsUpload()` - Legacy single-step upload: create a document record and immediately enqueue processing
|
|
937
|
-
- `patchExtractionDocumentsByIdCancel()` - Cancel a processing document
|
|
938
|
-
- `patchExtractionDocumentsByIdDismiss()` - Alias for `:dismiss_training`
|
|
939
|
-
- `patchExtractionDocumentsByIdDismiss-training()` - Dismiss a trained document from the active-learning training dashboard without excluding it
|
|
940
|
-
from future training
|
|
941
|
-
- `patchExtractionDocumentsByIdExclude()` - Mark a document as excluded from agent training
|
|
942
|
-
- `patchExtractionDocumentsByIdFinish-upload()` - Step 2 of 2 in the two-step upload flow
|
|
943
|
-
- `patchExtractionDocumentsByIdInclude()` - Reverse an exclusion: allow a previously excluded document to contribute training examples
|
|
944
|
-
again
|
|
945
|
-
- `patchExtractionDocumentsByIdMark-trained()` - Record that a document has been used for agent training
|
|
946
|
-
- `patchExtractionDocumentsByIdReprocess()` - Re-extract document with current or specified schema version
|
|
947
|
-
- `patchExtractionDocumentsByIdRestore()` - Reverse an exclusion: allow a previously excluded document to contribute training examples
|
|
948
|
-
again
|
|
949
|
-
- `patchExtractionDocumentsByIdStatus()` - Internal-facing status update used by the web layer and API to set processing state
|
|
950
|
-
- `patchExtractionDocumentsByIdVerification()` - Update the human verification status of a completed document
|
|
951
|
-
- `deleteExtractionDocumentsById()` - Soft-delete a document and enqueue storage cleanup
|
|
952
|
-
|
|
953
|
-
## Document stats
|
|
954
|
-
|
|
955
|
-
- `getDocumentsStats()` - /documents/stats operation on document_stats resource
|
|
956
|
-
|
|
957
|
-
## Email template
|
|
958
|
-
|
|
959
|
-
- `getApplicationsByApplicationIdEmail-templates()` - List all email templates for the application, including both system and custom templates
|
|
960
|
-
- `getApplicationsByApplicationIdEmail-templatesBySlug()` - Fetch a single email template by its slug within the given application
|
|
961
|
-
- `postApplicationsByApplicationIdEmail-templates()` - Create a new custom email template for the application
|
|
962
|
-
- `postApplicationsByApplicationIdEmail-templatesBySlugPreview()` - Preview email template with sample data
|
|
963
|
-
- `postApplicationsByApplicationIdEmail-templatesBySlugTest()` - Send a test email using this template
|
|
964
|
-
- `patchApplicationsByApplicationIdEmail-templatesBySlug()` - Update the display name, subject, body, branding color, or enabled state of an existing template
|
|
965
|
-
- `deleteApplicationsByApplicationIdEmail-templatesBySlug()` - /applications/:application_id/email-templates/:slug operation on email_template resource
|
|
1003
|
+
- `getDocumentsStats()` - /documents/stats operation on document-stats resource
|
|
966
1004
|
|
|
967
1005
|
## Email-inbound-address
|
|
968
1006
|
|
|
@@ -1073,6 +1111,16 @@ again
|
|
|
1073
1111
|
- `getEmailSend-limitsById()` - /email/send-limits/:id operation on email-send-limit resource
|
|
1074
1112
|
- `getEmailSend-limitsWorkspaceByWorkspaceId()` - /email/send-limits/workspace/:workspace_id operation on email-send-limit resource
|
|
1075
1113
|
|
|
1114
|
+
## Email-template
|
|
1115
|
+
|
|
1116
|
+
- `getApplicationsByApplicationIdEmail-templates()` - List all email templates for the application, including both system and custom templates
|
|
1117
|
+
- `getApplicationsByApplicationIdEmail-templatesBySlug()` - Fetch a single email template by its slug within the given application
|
|
1118
|
+
- `postApplicationsByApplicationIdEmail-templates()` - Create a new custom email template for the application
|
|
1119
|
+
- `postApplicationsByApplicationIdEmail-templatesBySlugPreview()` - Preview email template with sample data
|
|
1120
|
+
- `postApplicationsByApplicationIdEmail-templatesBySlugTest()` - Send a test email using this template
|
|
1121
|
+
- `patchApplicationsByApplicationIdEmail-templatesBySlug()` - Update the display name, subject, body, branding color, or enabled state of an existing template
|
|
1122
|
+
- `deleteApplicationsByApplicationIdEmail-templatesBySlug()` - /applications/:application_id/email-templates/:slug operation on email-template resource
|
|
1123
|
+
|
|
1076
1124
|
## Email-template-version
|
|
1077
1125
|
|
|
1078
1126
|
- `getEmailTemplate-versionsByTemplateIdVersionsByVersionNumber()` - /email/template-versions/:template_id/versions/:version_number operation on email-template-version resource
|
|
@@ -1106,32 +1154,64 @@ again
|
|
|
1106
1154
|
- `postEphi-data-flows()` - /ephi-data-flows operation on ephi-data-flow resource
|
|
1107
1155
|
- `patchEphi-data-flowsById()` - /ephi-data-flows/:id operation on ephi-data-flow resource
|
|
1108
1156
|
|
|
1109
|
-
## Extraction
|
|
1157
|
+
## Extraction-agent
|
|
1110
1158
|
|
|
1111
|
-
- `getExtractionAgents()` - /extraction/agents operation on
|
|
1112
|
-
- `getExtractionAgentsById()` - /extraction/agents/:id operation on
|
|
1159
|
+
- `getExtractionAgents()` - /extraction/agents operation on extraction-agent resource
|
|
1160
|
+
- `getExtractionAgentsById()` - /extraction/agents/:id operation on extraction-agent resource
|
|
1113
1161
|
- `postExtractionAgentsPredict()` - Predicts the best agents for a given input
|
|
1114
1162
|
|
|
1115
|
-
## Extraction
|
|
1163
|
+
## Extraction-analysis
|
|
1116
1164
|
|
|
1117
|
-
- `getExtractionAnalyses()` - /extraction/analyses operation on
|
|
1118
|
-
- `getExtractionAnalysesById()` - /extraction/analyses/:id operation on
|
|
1165
|
+
- `getExtractionAnalyses()` - /extraction/analyses operation on extraction-analysis resource
|
|
1166
|
+
- `getExtractionAnalysesById()` - /extraction/analyses/:id operation on extraction-analysis resource
|
|
1119
1167
|
|
|
1120
|
-
## Extraction
|
|
1168
|
+
## Extraction-batch
|
|
1121
1169
|
|
|
1122
|
-
- `getExtractionBatchesById()` - /extraction/batches/:id operation on
|
|
1170
|
+
- `getExtractionBatchesById()` - /extraction/batches/:id operation on extraction-batch resource
|
|
1123
1171
|
- `getExtractionBatchesByIdUpload-urls()` - Generate presigned URLs for batch document upload
|
|
1124
1172
|
- `getExtractionBatchesWorkspaceByWorkspaceId()` - List all batches for a workspace, unfiltered and unpaginated
|
|
1125
1173
|
- `postExtractionBatches()` - Create a new extraction batch to group related documents
|
|
1126
|
-
- `deleteExtractionBatchesById()` - /extraction/batches/:id operation on
|
|
1174
|
+
- `deleteExtractionBatchesById()` - /extraction/batches/:id operation on extraction-batch resource
|
|
1175
|
+
|
|
1176
|
+
## Extraction-document
|
|
1177
|
+
|
|
1178
|
+
- `getExtractionDocuments()` - Primary read for active (non-deleted) documents
|
|
1179
|
+
- `getExtractionDocumentsById()` - Primary read for active (non-deleted) documents
|
|
1180
|
+
- `getExtractionDocumentsByIdStatus()` - Lightweight poll endpoint: fetches only `id`, `status`, `progress`, and `error_message` for
|
|
1181
|
+
a single document
|
|
1182
|
+
- `getExtractionDocumentsByIdView()` - Get a document with its presigned view URL
|
|
1183
|
+
- `getExtractionDocumentsWorkspaceByWorkspaceId()` - List active (non-deleted) documents in a workspace, sorted by creation date
|
|
1184
|
+
- `getExtractionDocumentsWorkspaceByWorkspaceIdBy-statusByStatus()` - Filter documents by workspace_id and processing status
|
|
1185
|
+
- `getExtractionDocumentsWorkspaceByWorkspaceIdExcluded()` - List excluded documents
|
|
1186
|
+
- `getExtractionDocumentsWorkspaceByWorkspaceIdReview-queue()` - Get prioritized review queue for active learning
|
|
1187
|
+
- `getExtractionDocumentsWorkspaceByWorkspaceIdTrained()` - List documents that have been trained and not dismissed
|
|
1188
|
+
- `getExtractionDocumentsWorkspaceByWorkspaceIdTrashed()` - List soft-deleted (trashed) documents
|
|
1189
|
+
- `postExtractionDocumentsBegin-upload()` - Step 1 of 2 in the two-step upload flow
|
|
1190
|
+
- `postExtractionDocumentsFind-or-begin-upload()` - Dedup-aware upload: returns existing document if file_hash matches, otherwise creates new document
|
|
1191
|
+
- `postExtractionDocumentsUpload()` - Legacy single-step upload: create a document record and immediately enqueue processing
|
|
1192
|
+
- `patchExtractionDocumentsByIdCancel()` - Cancel a processing document
|
|
1193
|
+
- `patchExtractionDocumentsByIdDismiss()` - Alias for `:dismiss_training`
|
|
1194
|
+
- `patchExtractionDocumentsByIdDismiss-training()` - Dismiss a trained document from the active-learning training dashboard without excluding it
|
|
1195
|
+
from future training
|
|
1196
|
+
- `patchExtractionDocumentsByIdExclude()` - Mark a document as excluded from agent training
|
|
1197
|
+
- `patchExtractionDocumentsByIdFinish-upload()` - Step 2 of 2 in the two-step upload flow
|
|
1198
|
+
- `patchExtractionDocumentsByIdInclude()` - Reverse an exclusion: allow a previously excluded document to contribute training examples
|
|
1199
|
+
again
|
|
1200
|
+
- `patchExtractionDocumentsByIdMark-trained()` - Record that a document has been used for agent training
|
|
1201
|
+
- `patchExtractionDocumentsByIdReprocess()` - Re-extract document with current or specified schema version
|
|
1202
|
+
- `patchExtractionDocumentsByIdRestore()` - Reverse an exclusion: allow a previously excluded document to contribute training examples
|
|
1203
|
+
again
|
|
1204
|
+
- `patchExtractionDocumentsByIdStatus()` - Internal-facing status update used by the web layer and API to set processing state
|
|
1205
|
+
- `patchExtractionDocumentsByIdVerification()` - Update the human verification status of a completed document
|
|
1206
|
+
- `deleteExtractionDocumentsById()` - Soft-delete a document and enqueue storage cleanup
|
|
1127
1207
|
|
|
1128
|
-
## Extraction
|
|
1208
|
+
## Extraction-export
|
|
1129
1209
|
|
|
1130
1210
|
- `getWorkspacesByWorkspaceIdExtractionExports()` - List exports for a workspace, filtered by status
|
|
1131
|
-
- `getWorkspacesByWorkspaceIdExtractionExportsById()` - /workspaces/:workspace_id/extraction/exports/:id operation on
|
|
1132
|
-
- `postWorkspacesByWorkspaceIdExtractionExports()` - /workspaces/:workspace_id/extraction/exports operation on
|
|
1211
|
+
- `getWorkspacesByWorkspaceIdExtractionExportsById()` - /workspaces/:workspace_id/extraction/exports/:id operation on extraction-export resource
|
|
1212
|
+
- `postWorkspacesByWorkspaceIdExtractionExports()` - /workspaces/:workspace_id/extraction/exports operation on extraction-export resource
|
|
1133
1213
|
|
|
1134
|
-
## Extraction
|
|
1214
|
+
## Extraction-result
|
|
1135
1215
|
|
|
1136
1216
|
- `getExtractionResults()` - Primary read for extraction results
|
|
1137
1217
|
- `getExtractionResultsById()` - Fetch a single ExtractionResult by ID
|
|
@@ -1145,13 +1225,13 @@ fields
|
|
|
1145
1225
|
- `patchExtractionResultsByIdSave-corrections()` - Apply human corrections to extracted field values
|
|
1146
1226
|
- `deleteExtractionResultsById()` - Delete an ExtractionResult record
|
|
1147
1227
|
|
|
1148
|
-
## Extraction
|
|
1228
|
+
## Extraction-workflow
|
|
1149
1229
|
|
|
1150
|
-
- `getExtraction-workflows()` - /extraction-workflows operation on
|
|
1151
|
-
- `getExtraction-workflowsById()` - /extraction-workflows/:id operation on
|
|
1152
|
-
- `postExtraction-workflows()` - /extraction-workflows operation on
|
|
1153
|
-
- `patchExtraction-workflowsById()` - /extraction-workflows/:id operation on
|
|
1154
|
-
- `deleteExtraction-workflowsById()` - /extraction-workflows/:id operation on
|
|
1230
|
+
- `getExtraction-workflows()` - /extraction-workflows operation on extraction-workflow resource
|
|
1231
|
+
- `getExtraction-workflowsById()` - /extraction-workflows/:id operation on extraction-workflow resource
|
|
1232
|
+
- `postExtraction-workflows()` - /extraction-workflows operation on extraction-workflow resource
|
|
1233
|
+
- `patchExtraction-workflowsById()` - /extraction-workflows/:id operation on extraction-workflow resource
|
|
1234
|
+
- `deleteExtraction-workflowsById()` - /extraction-workflows/:id operation on extraction-workflow resource
|
|
1155
1235
|
|
|
1156
1236
|
## Feature-definition
|
|
1157
1237
|
|
|
@@ -1162,26 +1242,38 @@ fields
|
|
|
1162
1242
|
- `patchFeature-definitionsById()` - Update a feature definition's configuration.
|
|
1163
1243
|
- `deleteFeature-definitionsById()` - /feature-definitions/:id operation on feature-definition resource
|
|
1164
1244
|
|
|
1245
|
+
## Feature-summary
|
|
1246
|
+
|
|
1247
|
+
- `getWalletFeatures()` - Get all features with their plan allocations and current usage
|
|
1248
|
+
|
|
1165
1249
|
## Feature-usage
|
|
1166
1250
|
|
|
1167
1251
|
- `getFeature-usages()` - List all feature usage records.
|
|
1168
1252
|
- `getFeature-usagesBy-tenantByTenantId()` - List feature usage records for a specific tenant.
|
|
1169
1253
|
- `getFeature-usagesById()` - Fetch a single feature usage record by ID.
|
|
1254
|
+
- `postFeature-usagesIncrement()` - Increment usage for a feature by key
|
|
1255
|
+
|
|
1256
|
+
## Field-mapping-confirmation
|
|
1170
1257
|
|
|
1171
|
-
|
|
1258
|
+
- `postWorkspacesByWorkspaceIdExtractionByDocumentIdMapping()` - /workspaces/:workspace_id/extraction/:document_id/mapping operation on field-mapping-confirmation resource
|
|
1172
1259
|
|
|
1173
|
-
|
|
1260
|
+
## Field-mapping-result
|
|
1174
1261
|
|
|
1175
|
-
|
|
1262
|
+
- `getWorkspacesByWorkspaceIdExtractionByDocumentIdMapping()` - /workspaces/:workspace_id/extraction/:document_id/mapping operation on field-mapping-result resource
|
|
1176
1263
|
|
|
1177
|
-
|
|
1264
|
+
## Field-template
|
|
1178
1265
|
|
|
1179
|
-
|
|
1266
|
+
- `getField-templates()` - /field-templates operation on field-template resource
|
|
1267
|
+
- `getField-templatesById()` - /field-templates/:id operation on field-template resource
|
|
1268
|
+
- `postField-templates()` - /field-templates operation on field-template resource
|
|
1269
|
+
- `deleteField-templatesById()` - /field-templates/:id operation on field-template resource
|
|
1180
1270
|
|
|
1181
|
-
|
|
1182
|
-
|
|
1183
|
-
- `
|
|
1184
|
-
- `
|
|
1271
|
+
## Graph-node
|
|
1272
|
+
|
|
1273
|
+
- `getAiGraphNodes()` - Paginate Entity vertices for the caller's tenant; returns up to 50 nodes per page by default.
|
|
1274
|
+
- `getAiGraphNodesLabelByLabel()` - Find all Entity vertices with an exact label match; use to look up a specific named entity in the knowledge graph.
|
|
1275
|
+
- `postAiGraphNodes()` - Create an Entity vertex in the knowledge graph; tenant_id is always forced from the actor and cannot be supplied by the caller
|
|
1276
|
+
- `deleteAiGraphNodesById()` - /ai/graph/nodes/:id operation on graph-node resource
|
|
1185
1277
|
|
|
1186
1278
|
## Invitations
|
|
1187
1279
|
|
|
@@ -1196,6 +1288,10 @@ fields
|
|
|
1196
1288
|
- `patchInvitationsByIdResend()` - Resend an invitation email with a refreshed token and a new 7-day expiry
|
|
1197
1289
|
- `patchInvitationsByIdRevoke()` - Cancel a pending invitation by setting its status to :revoked
|
|
1198
1290
|
|
|
1291
|
+
## Invoice
|
|
1292
|
+
|
|
1293
|
+
- `getWalletInvoices()` - Read all invoices for the current tenant
|
|
1294
|
+
|
|
1199
1295
|
## Isv-revenue
|
|
1200
1296
|
|
|
1201
1297
|
- `getIsv-revenue()` - /isv-revenue operation on isv-revenue resource
|
|
@@ -1209,13 +1305,6 @@ fields
|
|
|
1209
1305
|
- `postIsv-settlements()` - /isv-settlements operation on isv-settlement resource
|
|
1210
1306
|
- `patchIsv-settlementsById()` - /isv-settlements/:id operation on isv-settlement resource
|
|
1211
1307
|
|
|
1212
|
-
## Knowledge Graph
|
|
1213
|
-
|
|
1214
|
-
- `getAiGraphNodes()` - Paginate Entity vertices for the caller's tenant; returns up to 50 nodes per page by default.
|
|
1215
|
-
- `getAiGraphNodesLabelByLabel()` - Find all Entity vertices with an exact label match; use to look up a specific named entity in the knowledge graph.
|
|
1216
|
-
- `postAiGraphNodes()` - Create an Entity vertex in the knowledge graph; tenant_id is always forced from the actor and cannot be supplied by the caller
|
|
1217
|
-
- `deleteAiGraphNodesById()` - /ai/graph/nodes/:id operation on graph_node resource
|
|
1218
|
-
|
|
1219
1308
|
## Ledger
|
|
1220
1309
|
|
|
1221
1310
|
- `getLedger()` - /ledger operation on ledger resource
|
|
@@ -1251,53 +1340,42 @@ fields
|
|
|
1251
1340
|
- `getLlm-analyticsWorkspace()` - Fetch LLM analytics scoped to a single workspace; use for per-workspace usage dashboards and cost attribution.
|
|
1252
1341
|
- `postLlm-analytics()` - Append a single LLM call analytics record (model, tokens, latency, cost); called by the billing/analytics pipeline after each LLM invocation
|
|
1253
1342
|
|
|
1254
|
-
##
|
|
1343
|
+
## Notification-log
|
|
1255
1344
|
|
|
1256
|
-
- `
|
|
1257
|
-
- `
|
|
1258
|
-
- `getMessagesSearch()` - Full-text search messages by substring match on content within the actor's accessible threads
|
|
1259
|
-
- `getMessagesSemantic-search()` - Vector similarity search across messages using a generated embedding of the query string
|
|
1260
|
-
- `getThreadsByIdMessages()` - /threads/:id/messages operation on message resource
|
|
1261
|
-
- `postMessages()` - Add a new message turn to a thread
|
|
1262
|
-
- `patchMessagesById()` - Edit a message's content, role, or metadata
|
|
1263
|
-
- `deleteMessagesById()` - /messages/:id operation on message resource
|
|
1264
|
-
|
|
1265
|
-
## Notification log
|
|
1266
|
-
|
|
1267
|
-
- `getNotification-logs()` - /notification-logs operation on notification_log resource
|
|
1268
|
-
- `getNotification-logsById()` - /notification-logs/:id operation on notification_log resource
|
|
1345
|
+
- `getNotification-logs()` - /notification-logs operation on notification-log resource
|
|
1346
|
+
- `getNotification-logsById()` - /notification-logs/:id operation on notification-log resource
|
|
1269
1347
|
- `getNotification-logsStats()` - Get notification log statistics
|
|
1270
1348
|
|
|
1271
|
-
## Notification
|
|
1349
|
+
## Notification-method
|
|
1272
1350
|
|
|
1273
|
-
- `getNotification-methods()` - /notification-methods operation on
|
|
1274
|
-
- `getNotification-methodsById()` - /notification-methods/:id operation on
|
|
1351
|
+
- `getNotification-methods()` - /notification-methods operation on notification-method resource
|
|
1352
|
+
- `getNotification-methodsById()` - /notification-methods/:id operation on notification-method resource
|
|
1275
1353
|
- `postNotification-methods()` - Register a new notification delivery channel for a user (email address, phone number, Slack webhook, or generic webhook URL)
|
|
1276
1354
|
- `patchNotification-methodsById()` - Update the display name or connection config for an existing notification method
|
|
1277
1355
|
- `patchNotification-methodsByIdSend-verification()` - Generate a 6-digit verification code, store it as `verification_token`, and record `verification_sent_at`
|
|
1278
1356
|
- `patchNotification-methodsByIdSet-primary()` - Mark this notification method as the primary channel for its type, used when multiple methods of the same type exist.
|
|
1279
1357
|
- `patchNotification-methodsByIdVerify()` - Mark the notification method as verified by setting `verified_at` to the current timestamp
|
|
1280
|
-
- `deleteNotification-methodsById()` - /notification-methods/:id operation on
|
|
1358
|
+
- `deleteNotification-methodsById()` - /notification-methods/:id operation on notification-method resource
|
|
1281
1359
|
|
|
1282
|
-
## Notification
|
|
1360
|
+
## Notification-preference
|
|
1283
1361
|
|
|
1284
|
-
- `getNotification-preferences()` - /notification-preferences operation on
|
|
1285
|
-
- `getNotification-preferencesById()` - /notification-preferences/:id operation on
|
|
1362
|
+
- `getNotification-preferences()` - /notification-preferences operation on notification-preference resource
|
|
1363
|
+
- `getNotification-preferencesById()` - /notification-preferences/:id operation on notification-preference resource
|
|
1286
1364
|
- `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
|
|
1287
1365
|
- `patchNotification-preferencesById()` - Update a user's notification channel list or per-category preferences
|
|
1288
|
-
- `deleteNotification-preferencesById()` - /notification-preferences/:id operation on
|
|
1366
|
+
- `deleteNotification-preferencesById()` - /notification-preferences/:id operation on notification-preference resource
|
|
1289
1367
|
|
|
1290
|
-
## Oauth
|
|
1368
|
+
## Oauth-app-config
|
|
1291
1369
|
|
|
1292
|
-
- `getConnectorsOauth-app-configs()` - /connectors/oauth-app-configs operation on
|
|
1293
|
-
- `getConnectorsOauth-app-configsById()` - /connectors/oauth-app-configs/:id operation on
|
|
1294
|
-
- `postConnectorsOauth-app-configs()` - /connectors/oauth-app-configs operation on
|
|
1295
|
-
- `patchConnectorsOauth-app-configsById()` - /connectors/oauth-app-configs/:id operation on
|
|
1296
|
-
- `deleteConnectorsOauth-app-configsById()` - /connectors/oauth-app-configs/:id operation on
|
|
1370
|
+
- `getConnectorsOauth-app-configs()` - /connectors/oauth-app-configs operation on oauth-app-config resource
|
|
1371
|
+
- `getConnectorsOauth-app-configsById()` - /connectors/oauth-app-configs/:id operation on oauth-app-config resource
|
|
1372
|
+
- `postConnectorsOauth-app-configs()` - /connectors/oauth-app-configs operation on oauth-app-config resource
|
|
1373
|
+
- `patchConnectorsOauth-app-configsById()` - /connectors/oauth-app-configs/:id operation on oauth-app-config resource
|
|
1374
|
+
- `deleteConnectorsOauth-app-configsById()` - /connectors/oauth-app-configs/:id operation on oauth-app-config resource
|
|
1297
1375
|
|
|
1298
|
-
## Operation
|
|
1376
|
+
## Operation-success
|
|
1299
1377
|
|
|
1300
|
-
- `postDocumentsBulk-delete()` - /documents/bulk-delete operation on
|
|
1378
|
+
- `postDocumentsBulk-delete()` - /documents/bulk-delete operation on operation-success resource
|
|
1301
1379
|
|
|
1302
1380
|
## Payment-method
|
|
1303
1381
|
|
|
@@ -1311,14 +1389,14 @@ fields
|
|
|
1311
1389
|
|
|
1312
1390
|
## Permission
|
|
1313
1391
|
|
|
1314
|
-
- `getPermissions()` - List all
|
|
1392
|
+
- `getPermissions()` - List all registered permissions from the PermissionRegistry, optionally filtered by app, context, or category
|
|
1315
1393
|
- `getPermissionsById()` - Fetch all permissions and apply any query filters supplied by the caller; use :by_id for single-record lookup by permission ID string.
|
|
1316
1394
|
|
|
1317
|
-
## Permission
|
|
1395
|
+
## Permission-meta
|
|
1318
1396
|
|
|
1319
1397
|
- `getPermissionsMeta()` - Fetch a single metadata record describing the permission system — schema version, available apps, scopes, categories, and suggested client cache TTL
|
|
1320
1398
|
|
|
1321
|
-
## Permission
|
|
1399
|
+
## Permission-preset
|
|
1322
1400
|
|
|
1323
1401
|
- `getPermissionsPresets()` - List all permission presets (pre-defined role bundles) from the PermissionRegistry, optionally filtered by context and app
|
|
1324
1402
|
- `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.
|
|
@@ -1331,15 +1409,15 @@ fields
|
|
|
1331
1409
|
- `patchPipelinesById()` - Update pipeline metadata or node graph.
|
|
1332
1410
|
- `deletePipelinesById()` - /pipelines/:id operation on pipeline resource
|
|
1333
1411
|
|
|
1334
|
-
## Pipeline
|
|
1412
|
+
## Pipeline-execution
|
|
1335
1413
|
|
|
1336
|
-
- `getPipeline-executions()` - /pipeline-executions operation on
|
|
1337
|
-
- `getPipeline-executionsById()` - /pipeline-executions/:id operation on
|
|
1338
|
-
- `patchPipeline-executionsByIdApprove()` - /pipeline-executions/:id/approve operation on
|
|
1339
|
-
- `patchPipeline-executionsByIdCheckpoint()` - /pipeline-executions/:id/checkpoint operation on
|
|
1340
|
-
- `patchPipeline-executionsByIdNote()` - /pipeline-executions/:id/note operation on
|
|
1341
|
-
- `patchPipeline-executionsByIdRefine()` - /pipeline-executions/:id/refine operation on
|
|
1342
|
-
- `patchPipeline-executionsByIdReject()` - /pipeline-executions/:id/reject operation on
|
|
1414
|
+
- `getPipeline-executions()` - /pipeline-executions operation on pipeline-execution resource
|
|
1415
|
+
- `getPipeline-executionsById()` - /pipeline-executions/:id operation on pipeline-execution resource
|
|
1416
|
+
- `patchPipeline-executionsByIdApprove()` - /pipeline-executions/:id/approve operation on pipeline-execution resource
|
|
1417
|
+
- `patchPipeline-executionsByIdCheckpoint()` - /pipeline-executions/:id/checkpoint operation on pipeline-execution resource
|
|
1418
|
+
- `patchPipeline-executionsByIdNote()` - /pipeline-executions/:id/note operation on pipeline-execution resource
|
|
1419
|
+
- `patchPipeline-executionsByIdRefine()` - /pipeline-executions/:id/refine operation on pipeline-execution resource
|
|
1420
|
+
- `patchPipeline-executionsByIdReject()` - /pipeline-executions/:id/reject operation on pipeline-execution resource
|
|
1343
1421
|
|
|
1344
1422
|
## Plan-feature-allocation
|
|
1345
1423
|
|
|
@@ -1350,15 +1428,6 @@ fields
|
|
|
1350
1428
|
- `patchPlan-feature-allocationsById()` - Update a plan feature allocation's overrides.
|
|
1351
1429
|
- `deletePlan-feature-allocationsById()` - /plan-feature-allocations/:id operation on plan-feature-allocation resource
|
|
1352
1430
|
|
|
1353
|
-
## Platform tone
|
|
1354
|
-
|
|
1355
|
-
- `getPlatform-tones()` - /platform-tones operation on platform_tone resource
|
|
1356
|
-
- `getPlatform-tonesBy-brandByBrandIdentityId()` - /platform-tones/by-brand/:brand_identity_id operation on platform_tone resource
|
|
1357
|
-
- `getPlatform-tonesById()` - /platform-tones/:id operation on platform_tone resource
|
|
1358
|
-
- `postPlatform-tones()` - /platform-tones operation on platform_tone resource
|
|
1359
|
-
- `patchPlatform-tonesById()` - /platform-tones/:id operation on platform_tone resource
|
|
1360
|
-
- `deletePlatform-tonesById()` - /platform-tones/:id operation on platform_tone resource
|
|
1361
|
-
|
|
1362
1431
|
## Platform-pricing-config
|
|
1363
1432
|
|
|
1364
1433
|
- `getPlatform-pricing-configs()` - /platform-pricing-configs operation on platform-pricing-config resource
|
|
@@ -1367,6 +1436,15 @@ fields
|
|
|
1367
1436
|
- `patchPlatform-pricing-configsById()` - /platform-pricing-configs/:id operation on platform-pricing-config resource
|
|
1368
1437
|
- `deletePlatform-pricing-configsById()` - /platform-pricing-configs/:id operation on platform-pricing-config resource
|
|
1369
1438
|
|
|
1439
|
+
## Platform-tone
|
|
1440
|
+
|
|
1441
|
+
- `getPlatform-tones()` - /platform-tones operation on platform-tone resource
|
|
1442
|
+
- `getPlatform-tonesBy-brandByBrandIdentityId()` - /platform-tones/by-brand/:brand_identity_id operation on platform-tone resource
|
|
1443
|
+
- `getPlatform-tonesById()` - /platform-tones/:id operation on platform-tone resource
|
|
1444
|
+
- `postPlatform-tones()` - /platform-tones operation on platform-tone resource
|
|
1445
|
+
- `patchPlatform-tonesById()` - /platform-tones/:id operation on platform-tone resource
|
|
1446
|
+
- `deletePlatform-tonesById()` - /platform-tones/:id operation on platform-tone resource
|
|
1447
|
+
|
|
1370
1448
|
## Policy-review-schedule
|
|
1371
1449
|
|
|
1372
1450
|
- `getPolicy-review-schedules()` - /policy-review-schedules operation on policy-review-schedule resource
|
|
@@ -1388,25 +1466,25 @@ fields
|
|
|
1388
1466
|
- `postPortal-invitations()` - /portal-invitations operation on portal-invitation resource
|
|
1389
1467
|
- `deletePortal-invitationsById()` - /portal-invitations/:id operation on portal-invitation resource
|
|
1390
1468
|
|
|
1391
|
-
## Post
|
|
1469
|
+
## Post-metric
|
|
1392
1470
|
|
|
1393
|
-
- `getSocialMetricsAccountBySocialAccountId()` - /social/metrics/account/:social_account_id operation on
|
|
1394
|
-
- `getSocialMetricsById()` - /social/metrics/:id operation on
|
|
1395
|
-
- `getSocialMetricsCampaignBySocialCampaignId()` - /social/metrics/campaign/:social_campaign_id operation on
|
|
1396
|
-
- `getSocialMetricsPostBySocialPostId()` - /social/metrics/post/:social_post_id operation on
|
|
1397
|
-
- `getSocialMetricsPostBySocialPostIdLatest()` - /social/metrics/post/:social_post_id/latest operation on
|
|
1471
|
+
- `getSocialMetricsAccountBySocialAccountId()` - /social/metrics/account/:social_account_id operation on post-metric resource
|
|
1472
|
+
- `getSocialMetricsById()` - /social/metrics/:id operation on post-metric resource
|
|
1473
|
+
- `getSocialMetricsCampaignBySocialCampaignId()` - /social/metrics/campaign/:social_campaign_id operation on post-metric resource
|
|
1474
|
+
- `getSocialMetricsPostBySocialPostId()` - /social/metrics/post/:social_post_id operation on post-metric resource
|
|
1475
|
+
- `getSocialMetricsPostBySocialPostIdLatest()` - /social/metrics/post/:social_post_id/latest operation on post-metric resource
|
|
1398
1476
|
|
|
1399
|
-
## Post
|
|
1477
|
+
## Post-processing-hook
|
|
1400
1478
|
|
|
1401
|
-
- `getPost-processing-hooks()` - /post-processing-hooks operation on
|
|
1402
|
-
- `getPost-processing-hooksById()` - /post-processing-hooks/:id operation on
|
|
1403
|
-
- `postPost-processing-hooks()` - /post-processing-hooks operation on
|
|
1404
|
-
- `patchPost-processing-hooksById()` - /post-processing-hooks/:id operation on
|
|
1405
|
-
- `deletePost-processing-hooksById()` - /post-processing-hooks/:id operation on
|
|
1479
|
+
- `getPost-processing-hooks()` - /post-processing-hooks operation on post-processing-hook resource
|
|
1480
|
+
- `getPost-processing-hooksById()` - /post-processing-hooks/:id operation on post-processing-hook resource
|
|
1481
|
+
- `postPost-processing-hooks()` - /post-processing-hooks operation on post-processing-hook resource
|
|
1482
|
+
- `patchPost-processing-hooksById()` - /post-processing-hooks/:id operation on post-processing-hook resource
|
|
1483
|
+
- `deletePost-processing-hooksById()` - /post-processing-hooks/:id operation on post-processing-hook resource
|
|
1406
1484
|
|
|
1407
|
-
## Presigned
|
|
1485
|
+
## Presigned-url
|
|
1408
1486
|
|
|
1409
|
-
- `postDocumentsPresigned-upload()` - /documents/presigned-upload operation on
|
|
1487
|
+
- `postDocumentsPresigned-upload()` - /documents/presigned-upload operation on presigned-url resource
|
|
1410
1488
|
|
|
1411
1489
|
## Pricing-rule
|
|
1412
1490
|
|
|
@@ -1454,22 +1532,33 @@ fields
|
|
|
1454
1532
|
- `patchRolesById()` - Update a role's name, description, or permission list; does NOT retroactively update existing AccessGrants
|
|
1455
1533
|
- `deleteRolesById()` - Delete a role; emits a RoleDeleted audit event
|
|
1456
1534
|
|
|
1535
|
+
## Saved-search
|
|
1536
|
+
|
|
1537
|
+
- `getSearchSaved()` - List saved searches accessible to the current actor: the actor's own searches and any searches marked `is_shared` within the same tenant.
|
|
1538
|
+
- `postSearchSaved()` - Persist a named search query for reuse
|
|
1539
|
+
- `postSearchSavedByIdRun()` - Re-execute a saved search by ID and return the saved search metadata enriched with an `executed_at` ISO-8601 timestamp
|
|
1540
|
+
- `patchSearchSavedById()` - Modify the name, query string, search type, filters, or sharing status of an existing saved search
|
|
1541
|
+
- `deleteSearchSavedById()` - /search/saved/:id operation on saved-search resource
|
|
1542
|
+
|
|
1457
1543
|
## Scan-result
|
|
1458
1544
|
|
|
1459
1545
|
- `getScan-results()` - /scan-results operation on scan-result resource
|
|
1460
1546
|
- `getScan-resultsById()` - /scan-results/:id operation on scan-result resource
|
|
1461
1547
|
|
|
1462
|
-
## Scheduling
|
|
1548
|
+
## Scheduling-availability-rule
|
|
1463
1549
|
|
|
1464
1550
|
- `getSchedulingAvailability-rules()` - List all active availability rules for a workspace
|
|
1551
|
+
- `getSchedulingAvailability-rulesBy-event-type()` - List active availability rules scoped to a specific event type
|
|
1552
|
+
- `getSchedulingAvailability-rulesBy-user()` - List active availability rules for a specific user
|
|
1465
1553
|
- `getSchedulingAvailability-rulesById()` - Fetch a single availability rule by ID
|
|
1466
1554
|
- `postSchedulingAvailability-rules()` - Create an availability rule for a user or event type
|
|
1467
1555
|
- `patchSchedulingAvailability-rulesById()` - Update an availability rule's schedule, date overrides, or active period
|
|
1468
1556
|
- `deleteSchedulingAvailability-rulesById()` - Hard-delete an availability rule
|
|
1469
1557
|
|
|
1470
|
-
## Scheduling
|
|
1558
|
+
## Scheduling-booking
|
|
1471
1559
|
|
|
1472
1560
|
- `getSchedulingBookings()` - List all bookings for a workspace
|
|
1561
|
+
- `getSchedulingBookingsBy-booker()` - List all bookings made by a specific email address across the workspace
|
|
1473
1562
|
- `getSchedulingBookingsById()` - Fetch a single booking by ID
|
|
1474
1563
|
- `postSchedulingBookings()` - Create a booking for an external party claiming a time slot
|
|
1475
1564
|
- `patchSchedulingBookingsByIdCancel()` - Cancel a booking, recording cancellation_reason and cancelled_by (:booker/:organizer/:system)
|
|
@@ -1477,7 +1566,7 @@ fields
|
|
|
1477
1566
|
- `patchSchedulingBookingsByIdMark-no-show()` - Mark a booking as :no_show when the booker did not attend
|
|
1478
1567
|
- `patchSchedulingBookingsByIdReschedule()` - Reschedule a booking by moving its linked Event to new_start_time/new_end_time
|
|
1479
1568
|
|
|
1480
|
-
## Scheduling
|
|
1569
|
+
## Scheduling-calendar-sync
|
|
1481
1570
|
|
|
1482
1571
|
- `getSchedulingCalendar-syncs()` - List all calendar sync configurations for a specific user
|
|
1483
1572
|
- `getSchedulingCalendar-syncsById()` - Fetch a single calendar sync configuration by ID
|
|
@@ -1487,7 +1576,7 @@ fields
|
|
|
1487
1576
|
- `patchSchedulingCalendar-syncsByIdResume()` - Resume a paused or errored calendar sync
|
|
1488
1577
|
- `deleteSchedulingCalendar-syncsById()` - Hard-delete a calendar sync configuration, stopping all future sync runs for this calendar
|
|
1489
1578
|
|
|
1490
|
-
## Scheduling
|
|
1579
|
+
## Scheduling-event
|
|
1491
1580
|
|
|
1492
1581
|
- `getSchedulingEvents()` - List all events in a workspace, newest first
|
|
1493
1582
|
- `getSchedulingEventsByDateRange()` - List events in a workspace that overlap a given time window (start_time < end, end_time > start)
|
|
@@ -1499,21 +1588,24 @@ fields
|
|
|
1499
1588
|
- `patchSchedulingEventsByIdComplete()` - Mark a confirmed event as completed
|
|
1500
1589
|
- `patchSchedulingEventsByIdReschedule()` - Move an event to a new time slot
|
|
1501
1590
|
|
|
1502
|
-
## Scheduling
|
|
1591
|
+
## Scheduling-event-type
|
|
1503
1592
|
|
|
1504
1593
|
- `getSchedulingEvent-types()` - List all active event types for a workspace
|
|
1594
|
+
- `getSchedulingEvent-typesBy-slug()` - Fetch a single active event type by its URL-friendly slug
|
|
1505
1595
|
- `getSchedulingEvent-typesById()` - Fetch a single event type by ID
|
|
1506
1596
|
- `postSchedulingEvent-types()` - Create an event type template for a workspace
|
|
1507
1597
|
- `patchSchedulingEvent-typesById()` - Update event type configuration including duration, buffers, location, capacity, and intake form
|
|
1598
|
+
- `patchSchedulingEvent-typesByIdArchive()` - Soft-archive an event type by setting status to :archived
|
|
1508
1599
|
|
|
1509
|
-
## Scheduling
|
|
1600
|
+
## Scheduling-location
|
|
1510
1601
|
|
|
1511
1602
|
- `getSchedulingLocations()` - List all locations for a workspace (both active and inactive)
|
|
1512
1603
|
- `getSchedulingLocationsById()` - Fetch a single location by ID
|
|
1513
1604
|
- `postSchedulingLocations()` - Create a reusable location record (venue, room, virtual link, or resource)
|
|
1514
1605
|
- `patchSchedulingLocationsById()` - Update location details
|
|
1606
|
+
- `patchSchedulingLocationsByIdDeactivate()` - Set a location to inactive (is_active: false)
|
|
1515
1607
|
|
|
1516
|
-
## Scheduling
|
|
1608
|
+
## Scheduling-participant
|
|
1517
1609
|
|
|
1518
1610
|
- `getSchedulingParticipants()` - List all participants for a specific event, including organizer and attendees
|
|
1519
1611
|
- `getSchedulingParticipantsById()` - Fetch a single participant by ID
|
|
@@ -1522,16 +1614,17 @@ fields
|
|
|
1522
1614
|
- `patchSchedulingParticipantsByIdRespond()` - Record a participant's RSVP: :accepted, :declined, or :tentative
|
|
1523
1615
|
- `deleteSchedulingParticipantsById()` - Hard-delete a participant from an event
|
|
1524
1616
|
|
|
1525
|
-
## Scheduling
|
|
1617
|
+
## Scheduling-reminder
|
|
1526
1618
|
|
|
1527
1619
|
- `getSchedulingReminders()` - List all pending reminders across all workspaces
|
|
1528
1620
|
- `getSchedulingRemindersById()` - Fetch a single reminder by ID
|
|
1529
1621
|
- `postSchedulingReminders()` - Create a scheduled reminder for an event participant
|
|
1622
|
+
- `patchSchedulingRemindersByIdCancel()` - Cancel a pending reminder, preventing delivery
|
|
1530
1623
|
|
|
1531
|
-
## Schema
|
|
1624
|
+
## Schema-discovery
|
|
1532
1625
|
|
|
1533
|
-
- `getExtractionSchema-discoveriesById()` - /extraction/schema-discoveries/:id operation on
|
|
1534
|
-
- `postExtractionSchema-discoveries()` - /extraction/schema-discoveries operation on
|
|
1626
|
+
- `getExtractionSchema-discoveriesById()` - /extraction/schema-discoveries/:id operation on schema-discovery resource
|
|
1627
|
+
- `postExtractionSchema-discoveries()` - /extraction/schema-discoveries operation on schema-discovery resource
|
|
1535
1628
|
- `postExtractionSchema-discoveriesBootstrap()` - Bootstrap schema discovery without an agent
|
|
1536
1629
|
|
|
1537
1630
|
## Search
|
|
@@ -1539,7 +1632,6 @@ fields
|
|
|
1539
1632
|
- `getSearch()` - Full-text keyword search via Meilisearch across users, tenants, and documents
|
|
1540
1633
|
- `getSearchHealth()` - Check Meilisearch server health, returning status and latency
|
|
1541
1634
|
- `getSearchIndexes()` - Return the names of all configured Meilisearch indexes
|
|
1542
|
-
- `getSearchSaved()` - List saved searches accessible to the current actor: the actor's own searches and any searches marked `is_shared` within the same tenant.
|
|
1543
1635
|
- `getSearchSemantic()` - Vector similarity search across document chunks using a generated embedding of the query
|
|
1544
1636
|
- `getSearchStats()` - Return Meilisearch database size and per-index document counts
|
|
1545
1637
|
- `getSearchStatus()` - Return the current status and tenant context for the search indexes
|
|
@@ -1548,17 +1640,17 @@ fields
|
|
|
1548
1640
|
- `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.
|
|
1549
1641
|
- `postSearchBatch()` - Execute multiple search queries in a single request and return the combined results
|
|
1550
1642
|
- `postSearchReindex()` - Trigger a Meilisearch reindex for all or a specific subset of indexes (users, tenants, documents)
|
|
1551
|
-
- `postSearchSaved()` - Persist a named search query for reuse
|
|
1552
|
-
- `postSearchSavedByIdRun()` - Re-execute a saved search by ID and return the saved search metadata enriched with an `executed_at` ISO-8601 timestamp
|
|
1553
|
-
- `patchSearchSavedById()` - Modify the name, query string, search type, filters, or sharing status of an existing saved search
|
|
1554
|
-
- `deleteSearchSavedById()` - /search/saved/:id operation on saved_search resource
|
|
1555
1643
|
|
|
1556
|
-
## Search
|
|
1644
|
+
## Search-analytics
|
|
1557
1645
|
|
|
1558
1646
|
- `getSearchAnalytics()` - List search analytics with tenant-based filtering
|
|
1559
1647
|
- `getSearchAnalyticsSummary()` - Aggregated search analytics summary (platform admin only)
|
|
1560
1648
|
|
|
1561
|
-
##
|
|
1649
|
+
## Seat-info
|
|
1650
|
+
|
|
1651
|
+
- `getWalletSeats()` - Get seat billing info for the current tenant
|
|
1652
|
+
|
|
1653
|
+
## Semantic-cache-entry
|
|
1562
1654
|
|
|
1563
1655
|
- `getSysSemantic-cacheById()` - Fetch aggregate statistics for the semantic cache (platform admin only)
|
|
1564
1656
|
- `postSysSemantic-cacheClear()` - Bulk-destroy all semantic cache entries (platform admin only); requires confirm: true as a safety gate
|
|
@@ -1575,53 +1667,53 @@ fields
|
|
|
1575
1667
|
- `patchSettlementsByIdMark-paid()` - /settlements/:id/mark-paid operation on settlement resource
|
|
1576
1668
|
- `patchSettlementsByIdRelease()` - /settlements/:id/release operation on settlement resource
|
|
1577
1669
|
|
|
1578
|
-
## Shadow
|
|
1670
|
+
## Shadow-comparison
|
|
1579
1671
|
|
|
1580
|
-
- `getExtractionShadow-comparisons()` - /extraction/shadow-comparisons operation on
|
|
1672
|
+
- `getExtractionShadow-comparisons()` - /extraction/shadow-comparisons operation on shadow-comparison resource
|
|
1581
1673
|
- `getExtractionShadow-comparisonsAnalysis()` - Retrieve shadow comparison results for analysis
|
|
1582
|
-
- `getExtractionShadow-comparisonsById()` - /extraction/shadow-comparisons/:id operation on
|
|
1583
|
-
- `postExtractionShadow-comparisons()` - /extraction/shadow-comparisons operation on
|
|
1584
|
-
- `deleteExtractionShadow-comparisonsById()` - /extraction/shadow-comparisons/:id operation on
|
|
1585
|
-
|
|
1586
|
-
## Social
|
|
1587
|
-
|
|
1588
|
-
- `getSocialAccountsById()` - /social/accounts/:id operation on
|
|
1589
|
-
- `getSocialAccountsPlatformByPlatform()` - /social/accounts/platform/:platform operation on
|
|
1590
|
-
- `getSocialAccountsWorkspaceByWorkspaceId()` - /social/accounts/workspace/:workspace_id operation on
|
|
1591
|
-
- `postSocialAccounts()` - /social/accounts operation on
|
|
1592
|
-
- `patchSocialAccountsById()` - /social/accounts/:id operation on
|
|
1593
|
-
- `patchSocialAccountsByIdDeactivate()` - /social/accounts/:id/deactivate operation on
|
|
1594
|
-
- `patchSocialAccountsByIdDisable-posting()` - /social/accounts/:id/disable-posting operation on
|
|
1595
|
-
- `patchSocialAccountsByIdEnable-posting()` - /social/accounts/:id/enable-posting operation on
|
|
1596
|
-
- `deleteSocialAccountsById()` - /social/accounts/:id operation on
|
|
1597
|
-
|
|
1598
|
-
## Social
|
|
1599
|
-
|
|
1600
|
-
- `getSocialCampaigns()` - /social/campaigns operation on
|
|
1601
|
-
- `getSocialCampaignsById()` - /social/campaigns/:id operation on
|
|
1602
|
-
- `postSocialCampaigns()` - /social/campaigns operation on
|
|
1674
|
+
- `getExtractionShadow-comparisonsById()` - /extraction/shadow-comparisons/:id operation on shadow-comparison resource
|
|
1675
|
+
- `postExtractionShadow-comparisons()` - /extraction/shadow-comparisons operation on shadow-comparison resource
|
|
1676
|
+
- `deleteExtractionShadow-comparisonsById()` - /extraction/shadow-comparisons/:id operation on shadow-comparison resource
|
|
1677
|
+
|
|
1678
|
+
## Social-account
|
|
1679
|
+
|
|
1680
|
+
- `getSocialAccountsById()` - /social/accounts/:id operation on social-account resource
|
|
1681
|
+
- `getSocialAccountsPlatformByPlatform()` - /social/accounts/platform/:platform operation on social-account resource
|
|
1682
|
+
- `getSocialAccountsWorkspaceByWorkspaceId()` - /social/accounts/workspace/:workspace_id operation on social-account resource
|
|
1683
|
+
- `postSocialAccounts()` - /social/accounts operation on social-account resource
|
|
1684
|
+
- `patchSocialAccountsById()` - /social/accounts/:id operation on social-account resource
|
|
1685
|
+
- `patchSocialAccountsByIdDeactivate()` - /social/accounts/:id/deactivate operation on social-account resource
|
|
1686
|
+
- `patchSocialAccountsByIdDisable-posting()` - /social/accounts/:id/disable-posting operation on social-account resource
|
|
1687
|
+
- `patchSocialAccountsByIdEnable-posting()` - /social/accounts/:id/enable-posting operation on social-account resource
|
|
1688
|
+
- `deleteSocialAccountsById()` - /social/accounts/:id operation on social-account resource
|
|
1689
|
+
|
|
1690
|
+
## Social-campaign
|
|
1691
|
+
|
|
1692
|
+
- `getSocialCampaigns()` - /social/campaigns operation on social-campaign resource
|
|
1693
|
+
- `getSocialCampaignsById()` - /social/campaigns/:id operation on social-campaign resource
|
|
1694
|
+
- `postSocialCampaigns()` - /social/campaigns operation on social-campaign resource
|
|
1603
1695
|
- `postSocialCampaignsByIdAdapt-for-platforms()` - Adapt master copy for each target platform
|
|
1604
1696
|
- `postSocialCampaignsByIdGenerate-master-copy()` - Generate master copy from content brief using AI
|
|
1605
|
-
- `patchSocialCampaignsById()` - /social/campaigns/:id operation on
|
|
1606
|
-
- `patchSocialCampaignsByIdCancel()` - /social/campaigns/:id/cancel operation on
|
|
1607
|
-
- `patchSocialCampaignsByIdSchedule()` - /social/campaigns/:id/schedule operation on
|
|
1608
|
-
- `deleteSocialCampaignsById()` - /social/campaigns/:id operation on
|
|
1609
|
-
|
|
1610
|
-
## Social
|
|
1611
|
-
|
|
1612
|
-
- `getSocialPostsAccountBySocialAccountId()` - /social/posts/account/:social_account_id operation on
|
|
1613
|
-
- `getSocialPostsById()` - /social/posts/:id operation on
|
|
1614
|
-
- `getSocialPostsCampaignBySocialCampaignId()` - /social/posts/campaign/:social_campaign_id operation on
|
|
1615
|
-
- `getSocialPostsScheduled()` - /social/posts/scheduled operation on
|
|
1616
|
-
- `getSocialPostsWorkspaceByWorkspaceId()` - /social/posts/workspace/:workspace_id operation on
|
|
1617
|
-
- `postSocialPosts()` - /social/posts operation on
|
|
1618
|
-
- `patchSocialPostsById()` - /social/posts/:id operation on
|
|
1619
|
-
- `patchSocialPostsByIdCancel()` - /social/posts/:id/cancel operation on
|
|
1620
|
-
- `patchSocialPostsByIdPublish()` - /social/posts/:id/publish operation on
|
|
1621
|
-
- `patchSocialPostsByIdRetry()` - /social/posts/:id/retry operation on
|
|
1622
|
-
- `patchSocialPostsByIdSchedule()` - /social/posts/:id/schedule operation on
|
|
1623
|
-
- `patchSocialPostsByIdSeo()` - /social/posts/:id/seo operation on
|
|
1624
|
-
- `deleteSocialPostsById()` - /social/posts/:id operation on
|
|
1697
|
+
- `patchSocialCampaignsById()` - /social/campaigns/:id operation on social-campaign resource
|
|
1698
|
+
- `patchSocialCampaignsByIdCancel()` - /social/campaigns/:id/cancel operation on social-campaign resource
|
|
1699
|
+
- `patchSocialCampaignsByIdSchedule()` - /social/campaigns/:id/schedule operation on social-campaign resource
|
|
1700
|
+
- `deleteSocialCampaignsById()` - /social/campaigns/:id operation on social-campaign resource
|
|
1701
|
+
|
|
1702
|
+
## Social-post
|
|
1703
|
+
|
|
1704
|
+
- `getSocialPostsAccountBySocialAccountId()` - /social/posts/account/:social_account_id operation on social-post resource
|
|
1705
|
+
- `getSocialPostsById()` - /social/posts/:id operation on social-post resource
|
|
1706
|
+
- `getSocialPostsCampaignBySocialCampaignId()` - /social/posts/campaign/:social_campaign_id operation on social-post resource
|
|
1707
|
+
- `getSocialPostsScheduled()` - /social/posts/scheduled operation on social-post resource
|
|
1708
|
+
- `getSocialPostsWorkspaceByWorkspaceId()` - /social/posts/workspace/:workspace_id operation on social-post resource
|
|
1709
|
+
- `postSocialPosts()` - /social/posts operation on social-post resource
|
|
1710
|
+
- `patchSocialPostsById()` - /social/posts/:id operation on social-post resource
|
|
1711
|
+
- `patchSocialPostsByIdCancel()` - /social/posts/:id/cancel operation on social-post resource
|
|
1712
|
+
- `patchSocialPostsByIdPublish()` - /social/posts/:id/publish operation on social-post resource
|
|
1713
|
+
- `patchSocialPostsByIdRetry()` - /social/posts/:id/retry operation on social-post resource
|
|
1714
|
+
- `patchSocialPostsByIdSchedule()` - /social/posts/:id/schedule operation on social-post resource
|
|
1715
|
+
- `patchSocialPostsByIdSeo()` - /social/posts/:id/seo operation on social-post resource
|
|
1716
|
+
- `deleteSocialPostsById()` - /social/posts/:id operation on social-post resource
|
|
1625
1717
|
|
|
1626
1718
|
## Storage
|
|
1627
1719
|
|
|
@@ -1633,11 +1725,11 @@ fields
|
|
|
1633
1725
|
- `patchBucketsById()` - Update the region of an existing bucket
|
|
1634
1726
|
- `deleteBucketsById()` - Delete a bucket from the database and attempt to remove it from object storage; fails if any StorageFile records still reference this bucket.
|
|
1635
1727
|
|
|
1636
|
-
## Storage
|
|
1728
|
+
## Storage-file
|
|
1637
1729
|
|
|
1638
|
-
- `getStorage-files()` - /storage-files operation on
|
|
1730
|
+
- `getStorage-files()` - /storage-files operation on storage-file resource
|
|
1639
1731
|
- `getStorage-filesBy-checksum()` - Fetch non-deleted files matching a given checksum
|
|
1640
|
-
- `getStorage-filesById()` - /storage-files/:id operation on
|
|
1732
|
+
- `getStorage-filesById()` - /storage-files/:id operation on storage-file resource
|
|
1641
1733
|
- `getStorage-filesChildren()` - List non-deleted files whose parent_id matches the given ID
|
|
1642
1734
|
- `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.
|
|
1643
1735
|
- `patchStorage-filesById()` - Update file metadata, tags, visibility, key, namespace, or status
|
|
@@ -1648,11 +1740,6 @@ fields
|
|
|
1648
1740
|
- `patchStorage-filesByIdTag()` - Replace the tags list on a file
|
|
1649
1741
|
- `patchStorage-filesByIdUpdate-metadata()` - Merge new_metadata into the existing metadata map (shallow merge)
|
|
1650
1742
|
|
|
1651
|
-
## Storage stats
|
|
1652
|
-
|
|
1653
|
-
- `getStorageStats()` - Get platform-wide storage statistics
|
|
1654
|
-
- `getStorageStatsTenantByTenantId()` - Get storage stats for a specific tenant
|
|
1655
|
-
|
|
1656
1743
|
## Storage-recommendation
|
|
1657
1744
|
|
|
1658
1745
|
- `getStorage-recommendations()` - /storage-recommendations operation on storage-recommendation resource
|
|
@@ -1660,69 +1747,74 @@ fields
|
|
|
1660
1747
|
- `patchStorage-recommendationsByIdAccept()` - /storage-recommendations/:id/accept operation on storage-recommendation resource
|
|
1661
1748
|
- `patchStorage-recommendationsByIdDismiss()` - /storage-recommendations/:id/dismiss operation on storage-recommendation resource
|
|
1662
1749
|
|
|
1663
|
-
##
|
|
1750
|
+
## Storage-stats
|
|
1751
|
+
|
|
1752
|
+
- `getStorageStats()` - Get platform-wide storage statistics
|
|
1753
|
+
- `getStorageStatsTenantByTenantId()` - Get storage stats for a specific tenant
|
|
1754
|
+
|
|
1755
|
+
## Support-ai-config
|
|
1664
1756
|
|
|
1665
1757
|
- `getSupportAi-configsWorkspaceByWorkspaceId()` - Fetch the AI configuration for a specific workspace
|
|
1666
1758
|
- `postSupportAi-configs()` - Create or update the AI configuration for a workspace (upsert — one config per workspace)
|
|
1667
1759
|
|
|
1668
|
-
## Support
|
|
1760
|
+
## Support-canned-response
|
|
1669
1761
|
|
|
1670
1762
|
- `getSupportCanned-responsesWorkspaceByWorkspaceId()` - List all canned responses for a workspace
|
|
1671
1763
|
- `postSupportCanned-responses()` - Create a pre-written response template for agent use
|
|
1672
1764
|
- `patchSupportCanned-responsesById()` - Update a canned response's content, category, or shortcut
|
|
1673
|
-
- `deleteSupportCanned-responsesById()` - /support/canned-responses/:id operation on
|
|
1765
|
+
- `deleteSupportCanned-responsesById()` - /support/canned-responses/:id operation on support-canned-response resource
|
|
1674
1766
|
|
|
1675
|
-
## Support
|
|
1767
|
+
## Support-channel-capture-config
|
|
1676
1768
|
|
|
1677
1769
|
- `getSupportChannel-capture-configsWorkspaceByWorkspaceId()` - Fetch the channel capture configuration for a workspace
|
|
1678
1770
|
- `postSupportChannel-capture-configs()` - Create or update the channel capture configuration for a workspace (upsert — one config per workspace)
|
|
1679
1771
|
|
|
1680
|
-
## Support
|
|
1772
|
+
## Support-queue
|
|
1681
1773
|
|
|
1682
1774
|
- `getSupportQueuesApplicationByApplicationId()` - List all queues for an application
|
|
1683
|
-
- `getSupportQueuesById()` - /support/queues/:id operation on
|
|
1775
|
+
- `getSupportQueuesById()` - /support/queues/:id operation on support-queue resource
|
|
1684
1776
|
- `postSupportQueues()` - Create an application-scoped support queue
|
|
1685
1777
|
- `patchSupportQueuesById()` - Update queue settings including ai_mode, SLA policy, priority boost, and business hours
|
|
1686
|
-
- `deleteSupportQueuesById()` - /support/queues/:id operation on
|
|
1778
|
+
- `deleteSupportQueuesById()` - /support/queues/:id operation on support-queue resource
|
|
1687
1779
|
|
|
1688
|
-
## Support
|
|
1780
|
+
## Support-queue-member
|
|
1689
1781
|
|
|
1690
1782
|
- `getSupportQueue-membersApplicationByApplicationId()` - List all queue members across all queues for an application
|
|
1691
1783
|
- `getSupportQueue-membersQueueByQueueId()` - List all members of a specific queue including their role, capacity, and availability
|
|
1692
1784
|
- `postSupportQueue-members()` - Add an agent to a support queue with a role and capacity
|
|
1693
1785
|
- `patchSupportQueue-membersById()` - Update a queue member's role, ticket capacity, or availability status
|
|
1694
|
-
- `deleteSupportQueue-membersById()` - /support/queue-members/:id operation on
|
|
1786
|
+
- `deleteSupportQueue-membersById()` - /support/queue-members/:id operation on support-queue-member resource
|
|
1695
1787
|
|
|
1696
|
-
## Support
|
|
1788
|
+
## Support-routing-rule
|
|
1697
1789
|
|
|
1698
1790
|
- `getSupportRouting-rulesApplicationByApplicationId()` - List all routing rules for an application, sorted by priority ascending (lower first)
|
|
1699
|
-
- `getSupportRouting-rulesById()` - /support/routing-rules/:id operation on
|
|
1791
|
+
- `getSupportRouting-rulesById()` - /support/routing-rules/:id operation on support-routing-rule resource
|
|
1700
1792
|
- `postSupportRouting-rules()` - Create a ticket routing rule for an application
|
|
1701
1793
|
- `patchSupportRouting-rulesById()` - Update a routing rule's conditions, action, parameters, or priority order
|
|
1702
|
-
- `deleteSupportRouting-rulesById()` - /support/routing-rules/:id operation on
|
|
1794
|
+
- `deleteSupportRouting-rulesById()` - /support/routing-rules/:id operation on support-routing-rule resource
|
|
1703
1795
|
|
|
1704
|
-
## Support
|
|
1796
|
+
## Support-sla-policy
|
|
1705
1797
|
|
|
1706
1798
|
- `getSupportSla-policiesApplicationByApplicationId()` - List all SLA policies for an application
|
|
1707
|
-
- `getSupportSla-policiesById()` - /support/sla-policies/:id operation on
|
|
1799
|
+
- `getSupportSla-policiesById()` - /support/sla-policies/:id operation on support-sla-policy resource
|
|
1708
1800
|
- `postSupportSla-policies()` - Create an application-scoped SLA policy defining first_response and resolution targets in minutes
|
|
1709
1801
|
- `patchSupportSla-policiesById()` - Update SLA policy targets or business hours setting
|
|
1710
|
-
- `deleteSupportSla-policiesById()` - /support/sla-policies/:id operation on
|
|
1802
|
+
- `deleteSupportSla-policiesById()` - /support/sla-policies/:id operation on support-sla-policy resource
|
|
1711
1803
|
|
|
1712
|
-
## Support
|
|
1804
|
+
## Support-sync-config
|
|
1713
1805
|
|
|
1714
1806
|
- `getSupportSync-configsWorkspaceByWorkspaceId()` - List all sync configurations for a workspace, one per connector instance
|
|
1715
1807
|
- `postSupportSync-configs()` - Create a connector sync configuration for a workspace+connector pair
|
|
1716
1808
|
- `patchSupportSync-configsById()` - Update sync configuration: toggle enabled, change direction, update status mapping, or adjust interval
|
|
1717
|
-
- `deleteSupportSync-configsById()` - /support/sync-configs/:id operation on
|
|
1809
|
+
- `deleteSupportSync-configsById()` - /support/sync-configs/:id operation on support-sync-config resource
|
|
1718
1810
|
|
|
1719
|
-
## Support
|
|
1811
|
+
## Support-tag
|
|
1720
1812
|
|
|
1721
1813
|
- `getSupportTagsWorkspaceByWorkspaceId()` - List all tags defined for a workspace
|
|
1722
1814
|
- `postSupportTags()` - Create a workspace-scoped ticket tag
|
|
1723
1815
|
- `deleteSupportTagsById()` - Hard-delete a tag
|
|
1724
1816
|
|
|
1725
|
-
## Support
|
|
1817
|
+
## Support-ticket
|
|
1726
1818
|
|
|
1727
1819
|
- `getSupportTicketsById()` - Fetch a single active ticket by ID
|
|
1728
1820
|
- `getSupportTicketsWorkspaceByWorkspaceId()` - List active tickets for a workspace, optionally filtered by status, priority, queue, or agent
|
|
@@ -1735,17 +1827,17 @@ fields
|
|
|
1735
1827
|
- `patchSupportTicketsByIdResolve()` - Mark a ticket as resolved, recording resolved_at timestamp
|
|
1736
1828
|
- `deleteSupportTicketsById()` - Soft-delete a ticket by setting deleted_at
|
|
1737
1829
|
|
|
1738
|
-
## Support
|
|
1830
|
+
## Support-ticket-attachment
|
|
1739
1831
|
|
|
1740
1832
|
- `getSupportTicket-attachmentsMessageByTicketMessageId()` - List all attachments for a specific ticket message
|
|
1741
1833
|
- `postSupportTicket-attachments()` - Register a file attachment on a ticket message
|
|
1742
1834
|
|
|
1743
|
-
## Support
|
|
1835
|
+
## Support-ticket-message
|
|
1744
1836
|
|
|
1745
1837
|
- `getSupportTicket-messagesTicketByTicketId()` - List all messages on a ticket in chronological order
|
|
1746
1838
|
- `postSupportTicket-messages()` - Add a message to a ticket thread
|
|
1747
1839
|
|
|
1748
|
-
## Support
|
|
1840
|
+
## Support-ticket-rating
|
|
1749
1841
|
|
|
1750
1842
|
- `postSupportTicket-ratings()` - Submit or update a CSAT rating (1-5) for a resolved ticket
|
|
1751
1843
|
|
|
@@ -1754,23 +1846,19 @@ fields
|
|
|
1754
1846
|
- `getConnectorsSync-logs()` - /connectors/sync-logs operation on sync-log resource
|
|
1755
1847
|
- `getConnectorsSync-logsById()` - /connectors/sync-logs/:id operation on sync-log resource
|
|
1756
1848
|
|
|
1757
|
-
## System
|
|
1849
|
+
## System-message
|
|
1758
1850
|
|
|
1759
|
-
- `getSystem-messages()` - /system-messages operation on
|
|
1760
|
-
- `getSystem-messagesById()` - /system-messages/:id operation on
|
|
1851
|
+
- `getSystem-messages()` - /system-messages operation on system-message resource
|
|
1852
|
+
- `getSystem-messagesById()` - /system-messages/:id operation on system-message resource
|
|
1761
1853
|
- `postSystem-messages()` - Create a new platform-wide system message (ToS, privacy policy, welcome, or announcement)
|
|
1762
1854
|
- `patchSystem-messagesById()` - Edit a system message's content, title, or version
|
|
1763
1855
|
- `patchSystem-messagesByIdPublish()` - Activate a system message so it is visible to all authenticated users
|
|
1764
1856
|
- `patchSystem-messagesByIdUnpublish()` - Deactivate a system message, removing it from the live feed without deleting it
|
|
1765
|
-
- `deleteSystem-messagesById()` - /system-messages/:id operation on
|
|
1766
|
-
|
|
1767
|
-
## Tenant document stats
|
|
1857
|
+
- `deleteSystem-messagesById()` - /system-messages/:id operation on system-message resource
|
|
1768
1858
|
|
|
1769
|
-
|
|
1859
|
+
## Tenant-document-stats
|
|
1770
1860
|
|
|
1771
|
-
|
|
1772
|
-
|
|
1773
|
-
- `getTenantsByTenantIdStats()` - /tenants/:tenant_id/stats operation on tenant_stats resource
|
|
1861
|
+
- `getTenantsByTenantIdDocumentStats()` - /tenants/:tenant_id/document_stats operation on tenant-document-stats resource
|
|
1774
1862
|
|
|
1775
1863
|
## Tenant-pricing-override
|
|
1776
1864
|
|
|
@@ -1780,6 +1868,10 @@ fields
|
|
|
1780
1868
|
- `patchTenant-pricing-overridesById()` - /tenant-pricing-overrides/:id operation on tenant-pricing-override resource
|
|
1781
1869
|
- `deleteTenant-pricing-overridesById()` - /tenant-pricing-overrides/:id operation on tenant-pricing-override resource
|
|
1782
1870
|
|
|
1871
|
+
## Tenant-stats
|
|
1872
|
+
|
|
1873
|
+
- `getTenantsByTenantIdStats()` - /tenants/:tenant_id/stats operation on tenant-stats resource
|
|
1874
|
+
|
|
1783
1875
|
## Tenants
|
|
1784
1876
|
|
|
1785
1877
|
- `getTenants()` - /tenants operation on tenant resource
|
|
@@ -1803,40 +1895,36 @@ plan tier, vanity slug, and storage spending cap
|
|
|
1803
1895
|
- `patchTenantsByIdUnsuspend()` - Restore a suspended tenant to active status.
|
|
1804
1896
|
- `deleteTenantsById()` - Permanently delete a tenant and all associated data
|
|
1805
1897
|
|
|
1806
|
-
## Thread stats
|
|
1807
|
-
|
|
1808
|
-
- `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
|
|
1809
|
-
|
|
1810
|
-
## Thread workspace stats
|
|
1811
|
-
|
|
1812
|
-
- `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
|
|
1813
|
-
|
|
1814
|
-
## Threads
|
|
1815
|
-
|
|
1816
|
-
- `getThreads()` - /threads operation on thread resource
|
|
1817
|
-
- `getThreadsById()` - /threads/:id operation on thread resource
|
|
1818
|
-
- `getThreadsSearch()` - Full-text search threads by title or context summary within the actor's accessible workspace
|
|
1819
|
-
- `postThreads()` - Create a new conversation thread scoped to a tenant, workspace, and user
|
|
1820
|
-
- `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)
|
|
1821
|
-
- `postThreadsByIdComplete()` - Trigger AI inference on an existing thread without providing new user message content
|
|
1822
|
-
- `postThreadsByIdExport()` - Export thread with messages to JSON, Markdown, or plain text format
|
|
1823
|
-
- `postThreadsByIdFork()` - Fork a thread by cloning it with all its messages
|
|
1824
|
-
- `postThreadsByIdMessages()` - Submit a user message to a thread and receive the AI response synchronously
|
|
1825
|
-
- `postThreadsByIdSummarize()` - Generate a 2-3 sentence LLM summary of the thread's message history and persist it as `context_summary`
|
|
1826
|
-
- `patchThreadsById()` - Update the thread's title or context summary
|
|
1827
|
-
- `patchThreadsByIdArchive()` - Archive a thread by setting `archived_at` to the current timestamp
|
|
1828
|
-
- `patchThreadsByIdUnarchive()` - Restore an archived thread by clearing `archived_at`, making it visible in the default thread list again.
|
|
1829
|
-
- `deleteThreadsById()` - /threads/:id operation on thread resource
|
|
1830
|
-
|
|
1831
1898
|
## Token
|
|
1832
1899
|
|
|
1833
1900
|
- `postTokens()` - Create a payment token
|
|
1834
1901
|
|
|
1835
|
-
## Training
|
|
1902
|
+
## Training-analytics
|
|
1836
1903
|
|
|
1837
1904
|
- `getWorkspacesAnalytics-batch()` - Get training analytics for multiple workspaces in a single request (max 50)
|
|
1838
1905
|
- `getWorkspacesByWorkspaceIdTrainingAnalytics()` - Get training analytics for a specific workspace
|
|
1839
1906
|
|
|
1907
|
+
## Training-example
|
|
1908
|
+
|
|
1909
|
+
- `getTraining-examples()` - List training examples with filtering support
|
|
1910
|
+
- `getTraining-examplesById()` - Fetch a single TrainingExample by ID.
|
|
1911
|
+
- `postTraining-examples()` - Create a single training example (golden example for few-shot learning)
|
|
1912
|
+
- `postTraining-examplesBulk()` - Create multiple training examples in a single transaction using `Ash.bulk_create`
|
|
1913
|
+
- `postTraining-examplesBulk-delete()` - Delete multiple training examples by ID in a single transaction
|
|
1914
|
+
- `postTraining-examplesSearch()` - Public entry point for semantic similarity search over training examples
|
|
1915
|
+
- `patchTraining-examplesById()` - Update an existing training example's input text, expected output JSON, notes,
|
|
1916
|
+
correction reasons, or image reference
|
|
1917
|
+
- `deleteTraining-examplesById()` - /training-examples/:id operation on training-example resource
|
|
1918
|
+
|
|
1919
|
+
## Training-session
|
|
1920
|
+
|
|
1921
|
+
- `getTraining-sessions()` - /training-sessions operation on training-session resource
|
|
1922
|
+
- `getTraining-sessionsAgentsByAgentIdSessions()` - /training-sessions/agents/:agent_id/sessions operation on training-session resource
|
|
1923
|
+
- `getTraining-sessionsById()` - /training-sessions/:id operation on training-session resource
|
|
1924
|
+
- `postTraining-sessions()` - /training-sessions operation on training-session resource
|
|
1925
|
+
- `patchTraining-sessionsByIdRevert()` - /training-sessions/:id/revert operation on training-session resource
|
|
1926
|
+
- `deleteTraining-sessionsById()` - /training-sessions/:id operation on training-session resource
|
|
1927
|
+
|
|
1840
1928
|
## Transaction
|
|
1841
1929
|
|
|
1842
1930
|
- `getTransactions()` - List all transactions belonging to the current tenant, filtered to the actor's tenant
|
|
@@ -1845,6 +1933,15 @@ context
|
|
|
1845
1933
|
- `postPayments()` - Process a payment (Auth + Capture)
|
|
1846
1934
|
- `postTransactionsByIdVoid()` - Void a transaction
|
|
1847
1935
|
|
|
1936
|
+
## Transcription-job
|
|
1937
|
+
|
|
1938
|
+
- `getVoiceTranscription-jobs()` - /voice/transcription-jobs operation on transcription-job resource
|
|
1939
|
+
- `getVoiceTranscription-jobsById()` - /voice/transcription-jobs/:id operation on transcription-job resource
|
|
1940
|
+
- `getVoiceTranscription-jobsMine()` - /voice/transcription-jobs/mine operation on transcription-job resource
|
|
1941
|
+
- `getVoiceTranscription-jobsWorkspaceByWorkspaceId()` - /voice/transcription-jobs/workspace/:workspace_id operation on transcription-job resource
|
|
1942
|
+
- `postVoiceTranscription-jobs()` - /voice/transcription-jobs operation on transcription-job resource
|
|
1943
|
+
- `deleteVoiceTranscription-jobsById()` - /voice/transcription-jobs/:id operation on transcription-job resource
|
|
1944
|
+
|
|
1848
1945
|
## Transfer
|
|
1849
1946
|
|
|
1850
1947
|
- `getTransfers()` - /transfers operation on transfer resource
|
|
@@ -1879,11 +1976,21 @@ context
|
|
|
1879
1976
|
- `getUsage-eventsById()` - /usage-events/:id operation on usage-event resource
|
|
1880
1977
|
- `getUsage-eventsSummary()` - List usage events for a tenant within a date range, intended for summary/dashboard views
|
|
1881
1978
|
|
|
1882
|
-
##
|
|
1979
|
+
## User-profile
|
|
1883
1980
|
|
|
1884
|
-
- `getUser-profiles()` - /user-profiles operation on
|
|
1885
|
-
- `getUser-profilesById()` - /user-profiles/:id operation on
|
|
1981
|
+
- `getUser-profiles()` - /user-profiles operation on user-profile resource
|
|
1982
|
+
- `getUser-profilesById()` - /user-profiles/:id operation on user-profile resource
|
|
1886
1983
|
- `getUser-profilesMe()` - Get the current user's profile
|
|
1984
|
+
- `postUser-profiles()` - Create a user profile record linked to an existing user
|
|
1985
|
+
- `patchUser-profilesById()` - Update the user's display profile fields: name, avatar, bio, social links, and
|
|
1986
|
+
raw preferences map
|
|
1987
|
+
- `patchUser-profilesByIdAccept-tos()` - Accept Terms of Service - merges with existing preferences
|
|
1988
|
+
- `patchUser-profilesByIdDismiss-announcement()` - Dismiss announcement - merges with existing preferences
|
|
1989
|
+
- `patchUser-profilesByIdDismiss-welcome()` - Dismiss welcome message - merges with existing preferences
|
|
1990
|
+
- `deleteUser-profilesById()` - /user-profiles/:id operation on user-profile resource
|
|
1991
|
+
|
|
1992
|
+
## Users
|
|
1993
|
+
|
|
1887
1994
|
- `getUsers()` - /users operation on user resource
|
|
1888
1995
|
- `getUsersBy-email()` - Look up a single user by their email address (case-insensitive)
|
|
1889
1996
|
- `getUsersById()` - /users/:id operation on user resource
|
|
@@ -1892,7 +1999,6 @@ context
|
|
|
1892
1999
|
- `getUsersMeDashboard()` - Get dashboard data for the user's tenant context
|
|
1893
2000
|
- `getUsersMeStats()` - Get stats for the user's tenant context
|
|
1894
2001
|
- `getUsersMeTenants()` - List all tenants the current user belongs to with their roles and permissions
|
|
1895
|
-
- `postUser-profiles()` - Create a user profile record linked to an existing user
|
|
1896
2002
|
- `postUsersAuthConfirm()` - Confirm a user's email address using a confirmation token
|
|
1897
2003
|
- `postUsersAuthLogin()` - Attempt to sign in using a username and password.
|
|
1898
2004
|
- `postUsersAuthMagic-linkLogin()` - /users/auth/magic-link/login operation on user resource
|
|
@@ -1904,65 +2010,69 @@ context
|
|
|
1904
2010
|
Microsoft)
|
|
1905
2011
|
- `postUsersAuthResend-confirmation()` - Resend confirmation email to an unconfirmed user
|
|
1906
2012
|
- `postUsersRegister-isv()` - Platform Admin action to register a new ISV (User + Tenant + App)
|
|
1907
|
-
- `patchUser-profilesById()` - Update the user's display profile fields: name, avatar, bio, social links, and
|
|
1908
|
-
raw preferences map
|
|
1909
|
-
- `patchUser-profilesByIdAccept-tos()` - Accept Terms of Service - merges with existing preferences
|
|
1910
|
-
- `patchUser-profilesByIdDismiss-announcement()` - Dismiss announcement - merges with existing preferences
|
|
1911
|
-
- `patchUser-profilesByIdDismiss-welcome()` - Dismiss welcome message - merges with existing preferences
|
|
1912
2013
|
- `patchUsersAuthPasswordChange()` - Change password for authenticated user with current password verification
|
|
1913
2014
|
- `patchUsersAuthReset-password()` - Reset password using admin-issued reset token
|
|
1914
2015
|
- `patchUsersById()` - Admin-only user management (platform admins) - promotes/demotes admin status
|
|
1915
2016
|
- `patchUsersByIdConfirm-email()` - Admin manually confirms user's email
|
|
1916
2017
|
- `patchUsersByIdEmail()` - Admin-only email update
|
|
1917
2018
|
- `patchUsersByIdReset-password()` - Admin triggers password reset email for user
|
|
1918
|
-
- `deleteUser-profilesById()` - /user-profiles/:id operation on user_profile resource
|
|
1919
2019
|
- `deleteUsersById()` - Permanently delete a user account
|
|
1920
2020
|
|
|
1921
|
-
## Voice
|
|
2021
|
+
## Voice-recording
|
|
1922
2022
|
|
|
1923
|
-
- `getVoiceRecordings()` - /voice/recordings operation on
|
|
1924
|
-
- `getVoiceRecordingsById()` - /voice/recordings/:id operation on
|
|
2023
|
+
- `getVoiceRecordings()` - /voice/recordings operation on voice-recording resource
|
|
2024
|
+
- `getVoiceRecordingsById()` - /voice/recordings/:id operation on voice-recording resource
|
|
1925
2025
|
- `getVoiceRecordingsSessionBySessionId()` - List recordings for a specific voice session
|
|
1926
2026
|
|
|
1927
|
-
## Voice
|
|
2027
|
+
## Voice-session
|
|
1928
2028
|
|
|
1929
|
-
- `getVoiceSessions()` - /voice/sessions operation on
|
|
1930
|
-
- `getVoiceSessionsById()` - /voice/sessions/:id operation on
|
|
2029
|
+
- `getVoiceSessions()` - /voice/sessions operation on voice-session resource
|
|
2030
|
+
- `getVoiceSessionsById()` - /voice/sessions/:id operation on voice-session resource
|
|
1931
2031
|
- `getVoiceSessionsMine()` - List current user's voice sessions
|
|
1932
2032
|
- `getVoiceSessionsWorkspaceByWorkspaceId()` - List all voice sessions in a workspace (ISV admin)
|
|
1933
2033
|
- `postVoiceSessions()` - Start a new voice session with LiveKit room provisioning
|
|
1934
2034
|
- `patchVoiceSessionsByIdFinalize()` - Dispatch accumulated transcript to the blueprint/chat pipeline
|
|
1935
2035
|
- `patchVoiceSessionsByIdStop()` - End a voice session and release the LiveKit room
|
|
1936
|
-
- `deleteVoiceSessionsById()` - /voice/sessions/:id operation on
|
|
2036
|
+
- `deleteVoiceSessionsById()` - /voice/sessions/:id operation on voice-session resource
|
|
1937
2037
|
|
|
1938
|
-
## Voice
|
|
2038
|
+
## Voice-transcription-result
|
|
1939
2039
|
|
|
1940
|
-
- `getVoiceTranscription-results()` - /voice/transcription-results operation on
|
|
1941
|
-
- `getVoiceTranscription-resultsById()` - /voice/transcription-results/:id operation on
|
|
2040
|
+
- `getVoiceTranscription-results()` - /voice/transcription-results operation on voice-transcription-result resource
|
|
2041
|
+
- `getVoiceTranscription-resultsById()` - /voice/transcription-results/:id operation on voice-transcription-result resource
|
|
1942
2042
|
- `getVoiceTranscription-resultsSessionBySessionId()` - List transcription results for a voice session
|
|
1943
|
-
- `postVoiceTranscription-results()` - /voice/transcription-results operation on
|
|
2043
|
+
- `postVoiceTranscription-results()` - /voice/transcription-results operation on voice-transcription-result resource
|
|
1944
2044
|
- `patchVoiceTranscription-resultsById()` - Correct or annotate a transcript's text, segments, or metadata.
|
|
1945
|
-
- `deleteVoiceTranscription-resultsById()` - /voice/transcription-results/:id operation on
|
|
2045
|
+
- `deleteVoiceTranscription-resultsById()` - /voice/transcription-results/:id operation on voice-transcription-result resource
|
|
2046
|
+
|
|
2047
|
+
## Wallet-public
|
|
2048
|
+
|
|
2049
|
+
- `getWalletPlanPreview()` - Preview the cost and effective date of a plan change
|
|
2050
|
+
- `patchWalletAuto-top-up()` - Update auto-top-up settings
|
|
2051
|
+
- `patchWalletPaymentRetry()` - Retry a failed subscription payment
|
|
2052
|
+
- `patchWalletPlanCancel()` - Cancel the current subscription plan
|
|
1946
2053
|
|
|
1947
|
-
##
|
|
2054
|
+
## Webhook-config
|
|
1948
2055
|
|
|
1949
|
-
- `getWebhook-configs()` - /webhook-configs operation on
|
|
1950
|
-
- `getWebhook-configsById()` - /webhook-configs/:id operation on
|
|
2056
|
+
- `getWebhook-configs()` - /webhook-configs operation on webhook-config resource
|
|
2057
|
+
- `getWebhook-configsById()` - /webhook-configs/:id operation on webhook-config resource
|
|
1951
2058
|
- `getWebhook-configsByIdEvents()` - List available events that can be subscribed to
|
|
1952
2059
|
- `getWebhook-configsStats()` - Get webhook configuration statistics
|
|
1953
|
-
- `getWebhook-deliveries()` - /webhook-deliveries operation on webhook_delivery resource
|
|
1954
|
-
- `getWebhook-deliveriesById()` - /webhook-deliveries/:id operation on webhook_delivery resource
|
|
1955
|
-
- `getWebhook-deliveriesStats()` - Return aggregate delivery counts by status (total, delivered, failed, retrying)
|
|
1956
2060
|
- `postWebhook-configs()` - Register a new webhook endpoint to receive platform events
|
|
1957
2061
|
- `postWebhook-configsBulk-disable()` - Disable multiple webhook configs by ID in a single call
|
|
1958
2062
|
- `postWebhook-configsBulk-enable()` - Enable multiple webhook configs by ID in a single call
|
|
1959
2063
|
- `postWebhook-configsByIdReplay()` - Replay historical events to this webhook
|
|
1960
2064
|
- `postWebhook-configsByIdTest()` - Send a realistic sample payload to the webhook URL to verify connectivity and signature verification
|
|
1961
|
-
- `postWebhook-deliveriesBulk-retry()` - Set multiple delivery records to `:retrying` status in bulk
|
|
1962
|
-
- `postWebhook-deliveriesByIdRetry()` - Re-enqueue a failed or pending delivery for immediate re-dispatch
|
|
1963
2065
|
- `patchWebhook-configsById()` - Update webhook endpoint settings such as URL, subscribed events, and enabled state
|
|
1964
2066
|
- `patchWebhook-configsByIdRotate-secret()` - Generate a new `whsec_`-prefixed HMAC secret for this webhook, invalidating the previous secret immediately
|
|
1965
|
-
- `deleteWebhook-configsById()` - /webhook-configs/:id operation on
|
|
2067
|
+
- `deleteWebhook-configsById()` - /webhook-configs/:id operation on webhook-config resource
|
|
2068
|
+
|
|
2069
|
+
## Webhook-delivery
|
|
2070
|
+
|
|
2071
|
+
- `getWebhook-deliveries()` - /webhook-deliveries operation on webhook-delivery resource
|
|
2072
|
+
- `getWebhook-deliveriesById()` - /webhook-deliveries/:id operation on webhook-delivery resource
|
|
2073
|
+
- `getWebhook-deliveriesStats()` - Return aggregate delivery counts by status (total, delivered, failed, retrying)
|
|
2074
|
+
- `postWebhook-deliveriesBulk-retry()` - Set multiple delivery records to `:retrying` status in bulk
|
|
2075
|
+
- `postWebhook-deliveriesByIdRetry()` - Re-enqueue a failed or pending delivery for immediate re-dispatch
|
|
1966
2076
|
|
|
1967
2077
|
## Wholesale-agreement
|
|
1968
2078
|
|
|
@@ -1971,10 +2081,6 @@ raw preferences map
|
|
|
1971
2081
|
- `postWholesale-agreements()` - /wholesale-agreements operation on wholesale-agreement resource
|
|
1972
2082
|
- `patchWholesale-agreementsById()` - /wholesale-agreements/:id operation on wholesale-agreement resource
|
|
1973
2083
|
|
|
1974
|
-
## Workspace document stats
|
|
1975
|
-
|
|
1976
|
-
- `getTenantsByTenantIdWorkspaceStats()` - /tenants/:tenant_id/workspace_stats operation on workspace_document_stats resource
|
|
1977
|
-
|
|
1978
2084
|
## Workspace-agent-config
|
|
1979
2085
|
|
|
1980
2086
|
- `getWorkspace-agent-configs()` - /workspace-agent-configs operation on workspace-agent-config resource
|
|
@@ -1983,6 +2089,10 @@ raw preferences map
|
|
|
1983
2089
|
- `patchWorkspace-agent-configsById()` - /workspace-agent-configs/:id operation on workspace-agent-config resource
|
|
1984
2090
|
- `deleteWorkspace-agent-configsById()` - /workspace-agent-configs/:id operation on workspace-agent-config resource
|
|
1985
2091
|
|
|
2092
|
+
## Workspace-document-stats
|
|
2093
|
+
|
|
2094
|
+
- `getTenantsByTenantIdWorkspaceStats()` - /tenants/:tenant_id/workspace_stats operation on workspace-document-stats resource
|
|
2095
|
+
|
|
1986
2096
|
## Workspaces
|
|
1987
2097
|
|
|
1988
2098
|
- `getWorkspaces()` - List workspaces visible to the actor
|