@gpt-platform/admin 0.9.0 → 0.10.1
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 +27076 -21325
- package/dist/index.d.ts +27076 -21325
- package/dist/index.js +1794 -349
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +1793 -349
- package/dist/index.mjs.map +1 -1
- package/llms.txt +500 -445
- 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,38 +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
146
|
## Amendment-request
|
|
162
147
|
|
|
163
148
|
- `getAmendment-requests()` - /amendment-requests operation on amendment-request resource
|
|
@@ -168,7 +153,7 @@ correction reasons, or image reference
|
|
|
168
153
|
- `patchAmendment-requestsByIdDeny()` - Deny an amendment request with a reason.
|
|
169
154
|
- `patchAmendment-requestsByIdReview()` - Begin reviewing an amendment request.
|
|
170
155
|
|
|
171
|
-
##
|
|
156
|
+
## Api-key
|
|
172
157
|
|
|
173
158
|
- `getApi-keys()` - List or fetch API keys
|
|
174
159
|
- `getApi-keysActive()` - List only active API keys
|
|
@@ -239,19 +224,19 @@ flags, workspace mode, and execution limits
|
|
|
239
224
|
- `deletePlansById()` - /plans/:id operation on plan resource
|
|
240
225
|
- `deleteSubscriptionsById()` - /subscriptions/:id operation on subscription resource
|
|
241
226
|
|
|
242
|
-
## Brand
|
|
227
|
+
## Brand-identity
|
|
243
228
|
|
|
244
|
-
- `getBrand-identities()` - /brand-identities operation on
|
|
245
|
-
- `getBrand-identitiesBy-tenantByTenantId()` - /brand-identities/by-tenant/:tenant_id operation on
|
|
246
|
-
- `getBrand-identitiesBy-workspaceByWorkspaceId()` - /brand-identities/by-workspace/:workspace_id operation on
|
|
247
|
-
- `getBrand-identitiesById()` - /brand-identities/:id operation on
|
|
248
|
-
- `getBrand-identitiesDefaultTenantByTenantId()` - /brand-identities/default/tenant/:tenant_id operation on
|
|
249
|
-
- `getBrand-identitiesDefaultWorkspaceByWorkspaceId()` - /brand-identities/default/workspace/:workspace_id operation on
|
|
250
|
-
- `postBrand-identities()` - /brand-identities operation on
|
|
251
|
-
- `patchBrand-identitiesById()` - /brand-identities/:id operation on
|
|
252
|
-
- `patchBrand-identitiesByIdSet-default()` - /brand-identities/:id/set-default operation on
|
|
253
|
-
- `patchBrand-identitiesByIdUnset-default()` - /brand-identities/:id/unset-default operation on
|
|
254
|
-
- `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
|
|
255
240
|
|
|
256
241
|
## Breach-incident
|
|
257
242
|
|
|
@@ -273,13 +258,21 @@ flags, workspace mode, and execution limits
|
|
|
273
258
|
- `patchBreach-notification-artifactsById()` - /breach-notification-artifacts/:id operation on breach-notification-artifact resource
|
|
274
259
|
- `patchBreach-notification-artifactsByIdSend()` - Mark artifact as sent and publish BreachNotificationReadyToSend event for Communication domain dispatch.
|
|
275
260
|
|
|
276
|
-
##
|
|
261
|
+
## Browser-session
|
|
262
|
+
|
|
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
|
|
277
268
|
|
|
278
|
-
|
|
269
|
+
## Bulk-dismissal-result
|
|
279
270
|
|
|
280
|
-
|
|
271
|
+
- `postWorkspacesByWorkspaceIdExtractionDocumentsDismiss-all-trained()` - /workspaces/:workspace_id/extraction/documents/dismiss-all-trained operation on bulk-dismissal-result resource
|
|
281
272
|
|
|
282
|
-
|
|
273
|
+
## Bulk-reprocess-result
|
|
274
|
+
|
|
275
|
+
- `postExtractionDocumentsBulk-reprocess()` - /extraction/documents/bulk-reprocess operation on bulk-reprocess-result resource
|
|
283
276
|
|
|
284
277
|
## Business-associate-agreement
|
|
285
278
|
|
|
@@ -306,125 +299,125 @@ flags, workspace mode, and execution limits
|
|
|
306
299
|
- `patchEmail-marketingCampaignsById()` - /email-marketing/campaigns/:id operation on campaign resource
|
|
307
300
|
- `deleteEmail-marketingCampaignsById()` - /email-marketing/campaigns/:id operation on campaign resource
|
|
308
301
|
|
|
309
|
-
## Catalog
|
|
302
|
+
## Catalog-classification-suggestion
|
|
310
303
|
|
|
311
|
-
- `getCatalogClassification-suggestionsById()` - /catalog/classification-suggestions/:id operation on
|
|
304
|
+
- `getCatalogClassification-suggestionsById()` - /catalog/classification-suggestions/:id operation on catalog-classification-suggestion resource
|
|
312
305
|
- `getCatalogClassification-suggestionsWorkspaceByWorkspaceIdPending()` - List pending AI classification suggestions for a workspace awaiting ISV review
|
|
313
306
|
- `patchCatalogClassification-suggestionsByIdAccept()` - Accept a pending classification suggestion; publishes ClassificationAccepted event and increments taxonomy node product_count.
|
|
314
307
|
- `patchCatalogClassification-suggestionsByIdReject()` - Reject a pending classification suggestion; sets status to :rejected with no cascading effects.
|
|
315
308
|
|
|
316
|
-
## Catalog
|
|
309
|
+
## Catalog-option-type
|
|
317
310
|
|
|
318
311
|
- `getCatalogOption-typesApplicationByApplicationId()` - List all option types for an application ordered by position
|
|
319
|
-
- `getCatalogOption-typesById()` - /catalog/option-types/:id operation on
|
|
312
|
+
- `getCatalogOption-typesById()` - /catalog/option-types/:id operation on catalog-option-type resource
|
|
320
313
|
- `postCatalogOption-types()` - Create an option type (e.g., Size, Color) for an application; shared across all tenants
|
|
321
314
|
- `patchCatalogOption-typesById()` - Update the name, slug, or display position of an option type
|
|
322
315
|
- `deleteCatalogOption-typesById()` - Permanently delete an option type and all its values; cascades to variant_option_values
|
|
323
316
|
|
|
324
|
-
## Catalog
|
|
317
|
+
## Catalog-option-value
|
|
325
318
|
|
|
326
|
-
- `getCatalogOption-valuesById()` - /catalog/option-values/:id operation on
|
|
319
|
+
- `getCatalogOption-valuesById()` - /catalog/option-values/:id operation on catalog-option-value resource
|
|
327
320
|
- `getCatalogOption-valuesOption-typeByOptionTypeId()` - List all values for an option type ordered by position
|
|
328
321
|
- `postCatalogOption-values()` - Create a specific option value (e.g., 'Large', 'Red') within an option type
|
|
329
322
|
- `patchCatalogOption-valuesById()` - Update the name, slug, position, or metadata of an option value
|
|
330
323
|
- `deleteCatalogOption-valuesById()` - Permanently delete an option value; removes associated variant_option_values
|
|
331
324
|
|
|
332
|
-
## Catalog
|
|
325
|
+
## Catalog-price-list
|
|
333
326
|
|
|
334
327
|
- `getCatalogPrice-listsApplicationByApplicationId()` - List all price lists for an application, ordered by priority
|
|
335
|
-
- `getCatalogPrice-listsById()` - /catalog/price-lists/:id operation on
|
|
328
|
+
- `getCatalogPrice-listsById()` - /catalog/price-lists/:id operation on catalog-price-list resource
|
|
336
329
|
- `postCatalogPrice-lists()` - Create a named price list for an application with a strategy (fixed, percentage_discount, or tiered)
|
|
337
330
|
- `patchCatalogPrice-listsById()` - Update price list metadata, strategy, or validity period
|
|
338
331
|
- `deleteCatalogPrice-listsById()` - Permanently delete a price list and all its entries
|
|
339
332
|
|
|
340
|
-
## Catalog
|
|
333
|
+
## Catalog-price-list-entry
|
|
341
334
|
|
|
342
335
|
- `getCatalogPrice-list-entriesPrice-listByPriceListId()` - List all entries in a price list
|
|
343
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
|
|
344
337
|
- `patchCatalogPrice-list-entriesById()` - Update the price, modifier, tiers, or floor price for an existing entry
|
|
345
338
|
- `deleteCatalogPrice-list-entriesById()` - Permanently delete a price list entry
|
|
346
339
|
|
|
347
|
-
## Catalog
|
|
340
|
+
## Catalog-price-suggestion
|
|
348
341
|
|
|
349
|
-
- `getCatalogPrice-suggestionsById()` - /catalog/price-suggestions/:id operation on
|
|
342
|
+
- `getCatalogPrice-suggestionsById()` - /catalog/price-suggestions/:id operation on catalog-price-suggestion resource
|
|
350
343
|
- `getCatalogPrice-suggestionsWorkspaceByWorkspaceId()` - List all price suggestions for a workspace (all statuses)
|
|
351
344
|
- `patchCatalogPrice-suggestionsByIdAccept()` - Accept a pending price suggestion; publishes PriceSuggestionAccepted and PriceChanged events, cascading to update the product's effective price.
|
|
352
345
|
- `patchCatalogPrice-suggestionsByIdReject()` - Reject a pending price suggestion; sets status to :rejected with no cascading effects.
|
|
353
346
|
|
|
354
|
-
## Catalog
|
|
347
|
+
## Catalog-product
|
|
355
348
|
|
|
356
|
-
- `getCatalogProductsById()` - /catalog/products/:id operation on
|
|
349
|
+
- `getCatalogProductsById()` - /catalog/products/:id operation on catalog-product resource
|
|
357
350
|
- `getCatalogProductsWorkspaceByWorkspaceId()` - List all active (non-deleted) products in a workspace
|
|
358
351
|
- `postCatalogProducts()` - Create a new catalog product in a workspace; triggers search indexing and enqueues embedding generation
|
|
359
352
|
- `patchCatalogProductsById()` - Update a product's attributes; triggers search re-indexing and embedding refresh
|
|
360
353
|
- `deleteCatalogProductsById()` - Soft-delete a product by stamping deleted_at; excluded from all future reads
|
|
361
354
|
|
|
362
|
-
## Catalog
|
|
355
|
+
## Catalog-product-classification
|
|
363
356
|
|
|
364
357
|
- `postCatalogProduct-classifications()` - Assign a product to a taxonomy node with source tracking (manual, ai_suggested, or ai_auto)
|
|
365
|
-
- `deleteCatalogProduct-classificationsById()` - /catalog/product-classifications/:id operation on
|
|
358
|
+
- `deleteCatalogProduct-classificationsById()` - /catalog/product-classifications/:id operation on catalog-product-classification resource
|
|
366
359
|
|
|
367
|
-
## Catalog
|
|
360
|
+
## Catalog-product-variant
|
|
368
361
|
|
|
369
|
-
- `getCatalogProduct-variantsById()` - /catalog/product-variants/:id operation on
|
|
362
|
+
- `getCatalogProduct-variantsById()` - /catalog/product-variants/:id operation on catalog-product-variant resource
|
|
370
363
|
- `getCatalogProduct-variantsProductByProductId()` - List all active variants for a given product, sorted by position
|
|
371
364
|
- `postCatalogProduct-variants()` - Create a product variant (SKU, price override, option values); enforces max_variants_per_product quota
|
|
372
365
|
- `patchCatalogProduct-variantsById()` - Update a variant's SKU, pricing, properties, or media
|
|
373
366
|
- `deleteCatalogProduct-variantsById()` - Soft-delete a variant by setting deleted_at; excluded from future reads
|
|
374
367
|
|
|
375
|
-
## Catalog
|
|
368
|
+
## Catalog-stock-location
|
|
376
369
|
|
|
377
|
-
- `getCatalogStock-locationsById()` - /catalog/stock-locations/:id operation on
|
|
370
|
+
- `getCatalogStock-locationsById()` - /catalog/stock-locations/:id operation on catalog-stock-location resource
|
|
378
371
|
- `getCatalogStock-locationsWorkspaceByWorkspaceId()` - List all stock locations in a workspace
|
|
379
372
|
- `postCatalogStock-locations()` - Create a stock location (warehouse, store, drop-ship, etc.) in a workspace; enforces max_stock_locations quota
|
|
380
373
|
- `patchCatalogStock-locationsById()` - Update a location's name, address, default flag, status, or valuation method
|
|
381
374
|
|
|
382
|
-
## Catalog
|
|
375
|
+
## Catalog-stock-movement
|
|
383
376
|
|
|
384
|
-
- `getCatalogStock-movementsById()` - /catalog/stock-movements/:id operation on
|
|
377
|
+
- `getCatalogStock-movementsById()` - /catalog/stock-movements/:id operation on catalog-stock-movement resource
|
|
385
378
|
- `getCatalogStock-movementsTransactionByTransactionId()` - Fetch both legs of a double-entry transaction by transaction_id
|
|
386
379
|
|
|
387
|
-
## Catalog
|
|
380
|
+
## Catalog-stock-record
|
|
388
381
|
|
|
389
|
-
- `getCatalogStock-recordsById()` - /catalog/stock-records/:id operation on
|
|
382
|
+
- `getCatalogStock-recordsById()` - /catalog/stock-records/:id operation on catalog-stock-record resource
|
|
390
383
|
- `getCatalogStock-recordsLocationByStockLocationId()` - List all stock records at a location
|
|
391
384
|
|
|
392
|
-
## Catalog
|
|
385
|
+
## Catalog-taxonomy
|
|
393
386
|
|
|
394
387
|
- `getCatalogTaxonomiesApplicationByApplicationId()` - List active taxonomies for an application
|
|
395
|
-
- `getCatalogTaxonomiesById()` - /catalog/taxonomies/:id operation on
|
|
388
|
+
- `getCatalogTaxonomiesById()` - /catalog/taxonomies/:id operation on catalog-taxonomy resource
|
|
396
389
|
- `postCatalogTaxonomies()` - Create a new taxonomy (classification axis) for an application; enforces max_taxonomies quota
|
|
397
390
|
- `patchCatalogTaxonomiesById()` - Update taxonomy metadata (name, slug, hierarchy settings)
|
|
398
391
|
- `deleteCatalogTaxonomiesById()` - Soft-delete a taxonomy by setting deleted_at; cascades to exclude nodes from future reads
|
|
399
392
|
|
|
400
|
-
## Catalog
|
|
393
|
+
## Catalog-taxonomy-node
|
|
401
394
|
|
|
402
|
-
- `getCatalogTaxonomy-nodesById()` - /catalog/taxonomy-nodes/:id operation on
|
|
395
|
+
- `getCatalogTaxonomy-nodesById()` - /catalog/taxonomy-nodes/:id operation on catalog-taxonomy-node resource
|
|
403
396
|
- `getCatalogTaxonomy-nodesTaxonomyByTaxonomyId()` - List all active nodes in a taxonomy
|
|
404
397
|
- `postCatalogTaxonomy-nodes()` - Create a taxonomy node (category) at the given position in the tree; validates hierarchy depth
|
|
405
398
|
- `patchCatalogTaxonomy-nodesById()` - Update a node's name, slug, position, or parent; re-validates tree depth
|
|
406
399
|
- `deleteCatalogTaxonomy-nodesById()` - Soft-delete a taxonomy node by stamping deleted_at; child nodes are not auto-deleted
|
|
407
400
|
|
|
408
|
-
## Catalog
|
|
401
|
+
## Catalog-variant-option-value
|
|
409
402
|
|
|
410
403
|
- `postCatalogVariant-option-values()` - Link a product variant to an option value (e.g., assign 'Red' to a specific variant)
|
|
411
|
-
- `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
|
|
412
405
|
|
|
413
|
-
## Catalog
|
|
406
|
+
## Catalog-view
|
|
414
407
|
|
|
415
|
-
- `getCatalogViewsById()` - /catalog/views/:id operation on
|
|
408
|
+
- `getCatalogViewsById()` - /catalog/views/:id operation on catalog-view resource
|
|
416
409
|
- `getCatalogViewsWorkspaceByWorkspaceId()` - List all catalog views in a workspace
|
|
417
410
|
- `postCatalogViews()` - Create a catalog view (named product lens) in a workspace; enforces max_catalog_views quota
|
|
418
411
|
- `patchCatalogViewsById()` - Update view metadata, filtering rules, or pricing association
|
|
419
412
|
- `deleteCatalogViewsById()` - Permanently delete a catalog view and its rules and overrides
|
|
420
413
|
|
|
421
|
-
## Catalog
|
|
414
|
+
## Catalog-view-override
|
|
422
415
|
|
|
423
416
|
- `postCatalogView-overrides()` - Pin or exclude a product in a specific view with optional display overrides (name, description, media)
|
|
424
417
|
- `patchCatalogView-overridesById()` - Update the action (pin/exclude), position, or display overrides for an existing view override
|
|
425
418
|
- `deleteCatalogView-overridesById()` - Remove a product override from a view; the product reverts to standard rule-based inclusion/exclusion on next resolution.
|
|
426
419
|
|
|
427
|
-
## Catalog
|
|
420
|
+
## Catalog-view-rule
|
|
428
421
|
|
|
429
422
|
- `postCatalogView-rules()` - Add a filter rule to a catalog view; rules in the same group are AND'd, multiple groups are OR'd
|
|
430
423
|
- `deleteCatalogView-rulesById()` - Permanently delete a view rule; the view is re-evaluated without this rule on next resolution.
|
|
@@ -455,13 +448,18 @@ flags, workspace mode, and execution limits
|
|
|
455
448
|
|
|
456
449
|
- `getMessages()` - /messages operation on chat-message resource
|
|
457
450
|
- `getMessagesById()` - /messages/:id operation on chat-message resource
|
|
458
|
-
- `getMessagesSearch()` - Full-text search messages by substring match on content
|
|
451
|
+
- `getMessagesSearch()` - Full-text search messages by substring match on content
|
|
459
452
|
- `getMessagesSemantic-search()` - Vector similarity search across messages using a generated embedding of the query string
|
|
460
453
|
- `getThreadsByIdMessages()` - /threads/:id/messages operation on chat-message resource
|
|
461
454
|
- `postMessages()` - Add a new message turn to a thread
|
|
462
455
|
- `patchMessagesById()` - Edit a message's content, role, or metadata
|
|
463
456
|
- `deleteMessagesById()` - /messages/:id operation on chat-message resource
|
|
464
457
|
|
|
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
|
+
|
|
465
463
|
## Chat-thread
|
|
466
464
|
|
|
467
465
|
- `getThreads()` - /threads operation on chat-thread resource
|
|
@@ -477,6 +475,7 @@ flags, workspace mode, and execution limits
|
|
|
477
475
|
- `postThreadsByIdSummarize()` - Generate a 2-3 sentence LLM summary of the thread's message history and persist it as `context_summary`
|
|
478
476
|
- `patchThreadsById()` - Update the thread's title or context summary
|
|
479
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)
|
|
480
479
|
- `patchThreadsByIdUnarchive()` - Restore an archived thread by clearing `archived_at`, making it visible in the default thread list again.
|
|
481
480
|
- `deleteThreadsById()` - /threads/:id operation on chat-thread resource
|
|
482
481
|
|
|
@@ -488,13 +487,13 @@ flags, workspace mode, and execution limits
|
|
|
488
487
|
|
|
489
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
|
|
490
489
|
|
|
491
|
-
## Chunk
|
|
490
|
+
## Chunk-entity-link
|
|
492
491
|
|
|
493
|
-
- `getExtractionChunk-entity-links()` - /extraction/chunk-entity-links operation on
|
|
494
|
-
- `getExtractionChunk-entity-linksById()` - /extraction/chunk-entity-links/:id operation on
|
|
495
|
-
- `getExtractionChunk-entity-linksChunkByDocumentChunkId()` - /extraction/chunk-entity-links/chunk/:document_chunk_id operation on
|
|
496
|
-
- `getExtractionChunk-entity-linksDocumentByDocumentId()` - /extraction/chunk-entity-links/document/:document_id operation on
|
|
497
|
-
- `getExtractionChunk-entity-linksEntityByGraphNodeId()` - /extraction/chunk-entity-links/entity/:graph_node_id operation on
|
|
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
|
|
498
497
|
|
|
499
498
|
## Clinical-client-goal
|
|
500
499
|
|
|
@@ -580,11 +579,6 @@ flags, workspace mode, and execution limits
|
|
|
580
579
|
- `patchClinicalHealth-metricsByIdRestore()` - /clinical/health-metrics/:id/restore operation on clinical-health-metric resource
|
|
581
580
|
- `deleteClinicalHealth-metricsByIdPermanent()` - /clinical/health-metrics/:id/permanent operation on clinical-health-metric resource
|
|
582
581
|
|
|
583
|
-
## Clinical-import
|
|
584
|
-
|
|
585
|
-
- `getClinicalImports()` - /clinical/imports operation on clinical-import resource
|
|
586
|
-
- `getClinicalImportsById()` - /clinical/imports/:id operation on clinical-import resource
|
|
587
|
-
|
|
588
582
|
## Clinical-meal-plan
|
|
589
583
|
|
|
590
584
|
- `getClinicalMeal-plans()` - /clinical/meal-plans operation on clinical-meal-plan resource
|
|
@@ -673,11 +667,6 @@ flags, workspace mode, and execution limits
|
|
|
673
667
|
- `getClinicalPractice-toolsCategories()` - /clinical/practice-tools/categories operation on clinical-practice-tool-category resource
|
|
674
668
|
- `getClinicalPractice-toolsCategoriesCatalog()` - /clinical/practice-tools/categories/catalog operation on clinical-practice-tool-category resource
|
|
675
669
|
|
|
676
|
-
## Clinical-resource-import
|
|
677
|
-
|
|
678
|
-
- `getClinicalResource-imports()` - /clinical/resource-imports operation on clinical-resource-import resource
|
|
679
|
-
- `getClinicalResource-importsById()` - /clinical/resource-imports/:id operation on clinical-resource-import resource
|
|
680
|
-
|
|
681
670
|
## Clinical-session
|
|
682
671
|
|
|
683
672
|
- `getClinicalSessions()` - /clinical/sessions operation on clinical-session resource
|
|
@@ -740,17 +729,17 @@ flags, workspace mode, and execution limits
|
|
|
740
729
|
- `postConfigs()` - Create or upsert a platform config entry by key; if the key already exists its value, description, and sensitivity flag are updated
|
|
741
730
|
- `patchConfigsByKey()` - Update the value, description, or sensitivity flag for an existing config entry; automatically invalidates the FetchConfig cache for the key
|
|
742
731
|
|
|
743
|
-
## Config
|
|
732
|
+
## Config-enum
|
|
744
733
|
|
|
745
|
-
- `getExtractionConfig-enums()` - /extraction/config-enums operation on
|
|
746
|
-
- `getExtractionConfig-enumsById()` - /extraction/config-enums/:id operation on
|
|
747
|
-
- `postExtractionConfig-enums()` - /extraction/config-enums operation on
|
|
748
|
-
- `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
|
|
749
738
|
|
|
750
|
-
## Connector
|
|
739
|
+
## Connector-instance
|
|
751
740
|
|
|
752
|
-
- `getConnectors()` - /connectors operation on
|
|
753
|
-
- `getConnectorsById()` - /connectors/:id operation on
|
|
741
|
+
- `getConnectors()` - /connectors operation on connector-instance resource
|
|
742
|
+
- `getConnectorsById()` - /connectors/:id operation on connector-instance resource
|
|
754
743
|
- `postConnectors()` - Install a new connector instance in a workspace
|
|
755
744
|
- `postConnectorsByIdEdamamRecipesGet()` - Get full details for a single recipe by Edamam recipe ID
|
|
756
745
|
- `postConnectorsByIdEdamamRecipesSearch()` - Search for recipes using the Edamam Recipe API
|
|
@@ -770,7 +759,7 @@ flags, workspace mode, and execution limits
|
|
|
770
759
|
- `postConnectorsOauthCallback()` - Exchange OAuth authorization code for credential.
|
|
771
760
|
- `postConnectorsOauthInitiate()` - Initiate OAuth flow for a connector type
|
|
772
761
|
- `patchConnectorsById()` - Update a connector instance's name, configuration, sync interval, health status, or metadata
|
|
773
|
-
- `deleteConnectorsById()` - /connectors/:id operation on
|
|
762
|
+
- `deleteConnectorsById()` - /connectors/:id operation on connector-instance resource
|
|
774
763
|
|
|
775
764
|
## Consent-record
|
|
776
765
|
|
|
@@ -793,37 +782,37 @@ flags, workspace mode, and execution limits
|
|
|
793
782
|
- `postContentShorten()` - Shorten text to a target character count.
|
|
794
783
|
- `postContentSuggest-topics()` - Suggest content topics based on industry and audience.
|
|
795
784
|
|
|
796
|
-
## Crawler
|
|
785
|
+
## Crawler-job
|
|
797
786
|
|
|
798
|
-
- `getCrawlerJobs()` - /crawler/jobs operation on
|
|
799
|
-
- `getCrawlerJobsById()` - /crawler/jobs/:id operation on
|
|
787
|
+
- `getCrawlerJobs()` - /crawler/jobs operation on crawler-job resource
|
|
788
|
+
- `getCrawlerJobsById()` - /crawler/jobs/:id operation on crawler-job resource
|
|
800
789
|
- `postCrawlerJobs()` - Create a crawl job for a URL with the specified mode and strategy; performs a credit pre-check and enqueues execution
|
|
801
790
|
- `patchCrawlerJobsByIdCancel()` - Cancel a pending or running job; sets status to :cancelled with completed_at timestamp
|
|
802
|
-
- `deleteCrawlerJobsById()` - /crawler/jobs/:id operation on
|
|
791
|
+
- `deleteCrawlerJobsById()` - /crawler/jobs/:id operation on crawler-job resource
|
|
803
792
|
|
|
804
|
-
## Crawler
|
|
793
|
+
## Crawler-result
|
|
805
794
|
|
|
806
|
-
- `getCrawlerResults()` - /crawler/results operation on
|
|
807
|
-
- `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
|
|
808
797
|
|
|
809
|
-
## Crawler
|
|
798
|
+
## Crawler-schedule
|
|
810
799
|
|
|
811
|
-
- `getCrawlerSchedules()` - /crawler/schedules operation on
|
|
812
|
-
- `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
|
|
813
802
|
- `postCrawlerSchedules()` - Create a recurring crawl schedule for a URL; sets frequency, cron expression, and notification preferences
|
|
814
803
|
- `patchCrawlerSchedulesById()` - Update schedule configuration, URL, frequency, or notification settings
|
|
815
804
|
- `patchCrawlerSchedulesByIdDisable()` - Disable a schedule to pause automatic crawling without deleting the configuration.
|
|
816
805
|
- `patchCrawlerSchedulesByIdEnable()` - Enable a disabled schedule so it resumes automatic crawling on its next_run_at.
|
|
817
806
|
- `patchCrawlerSchedulesByIdTrigger()` - Manually trigger a scheduled crawl immediately.
|
|
818
|
-
- `deleteCrawlerSchedulesById()` - /crawler/schedules/:id operation on
|
|
807
|
+
- `deleteCrawlerSchedulesById()` - /crawler/schedules/:id operation on crawler-schedule resource
|
|
819
808
|
|
|
820
|
-
## Crawler
|
|
809
|
+
## Crawler-site-config
|
|
821
810
|
|
|
822
|
-
- `getCrawlerSite-configs()` - /crawler/site-configs operation on
|
|
823
|
-
- `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
|
|
824
813
|
- `postCrawlerSite-configs()` - Create per-domain crawl settings (rate limit, strategy, custom headers, robots.txt preference) for a workspace
|
|
825
814
|
- `patchCrawlerSite-configsById()` - Update rate limits, strategy preference, JS requirement, or headers for an existing site config
|
|
826
|
-
- `deleteCrawlerSite-configsById()` - /crawler/site-configs/:id operation on
|
|
815
|
+
- `deleteCrawlerSite-configsById()` - /crawler/site-configs/:id operation on crawler-site-config resource
|
|
827
816
|
|
|
828
817
|
## Credential
|
|
829
818
|
|
|
@@ -843,7 +832,7 @@ flags, workspace mode, and execution limits
|
|
|
843
832
|
- `patchCredit-packagesById()` - Update an existing credit package's name, price, or credit amount
|
|
844
833
|
- `deleteCredit-packagesById()` - /credit-packages/:id operation on credit-package resource
|
|
845
834
|
|
|
846
|
-
## Crm
|
|
835
|
+
## Crm-activity
|
|
847
836
|
|
|
848
837
|
- `getCrmActivitiesById()` - Fetch a single active activity by ID; excludes soft-deleted records.
|
|
849
838
|
- `getCrmActivitiesWorkspaceByWorkspaceId()` - List active activities in a workspace with offset pagination
|
|
@@ -851,13 +840,13 @@ flags, workspace mode, and execution limits
|
|
|
851
840
|
- `patchCrmActivitiesById()` - Update an activity's subject, body, sentiment, or AI-generated fields
|
|
852
841
|
- `deleteCrmActivitiesById()` - Soft-delete an activity by setting deleted_at
|
|
853
842
|
|
|
854
|
-
## Crm
|
|
843
|
+
## Crm-channel-capture-config
|
|
855
844
|
|
|
856
|
-
- `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
|
|
857
846
|
- `postIsvCrmChannel-capture-config()` - Create a channel capture configuration for a workspace
|
|
858
847
|
- `patchIsvCrmChannel-capture-configById()` - Update channel capture settings for a workspace
|
|
859
848
|
|
|
860
|
-
## Crm
|
|
849
|
+
## Crm-company
|
|
861
850
|
|
|
862
851
|
- `getCrmCompaniesById()` - Fetch a single active company by ID; excludes soft-deleted records.
|
|
863
852
|
- `getCrmCompaniesWorkspaceByWorkspaceId()` - List active companies in a workspace with offset pagination
|
|
@@ -865,7 +854,7 @@ flags, workspace mode, and execution limits
|
|
|
865
854
|
- `patchCrmCompaniesById()` - Update mutable fields on an existing company
|
|
866
855
|
- `deleteCrmCompaniesById()` - Soft-delete a company by setting deleted_at
|
|
867
856
|
|
|
868
|
-
## Crm
|
|
857
|
+
## Crm-contact
|
|
869
858
|
|
|
870
859
|
- `getCrmContactsById()` - Fetch a single active contact by ID; excludes soft-deleted records.
|
|
871
860
|
- `getCrmContactsWorkspaceByWorkspaceId()` - List active contacts in a workspace with optional lifecycle_stage, tag, and
|
|
@@ -877,7 +866,7 @@ property filters applied Elixir-side
|
|
|
877
866
|
- `patchCrmContactsByIdArchive()` - Soft-archive a contact (sets deleted_at)
|
|
878
867
|
- `deleteCrmContactsById()` - Soft-delete a contact by setting deleted_at
|
|
879
868
|
|
|
880
|
-
## Crm
|
|
869
|
+
## Crm-custom-entity
|
|
881
870
|
|
|
882
871
|
- `getCrmCustom-entitiesById()` - Fetch a single active custom entity by ID; excludes soft-deleted records.
|
|
883
872
|
- `getCrmCustom-entitiesWorkspaceByWorkspaceId()` - List active custom entities in a workspace, optionally filtered by type slug and
|
|
@@ -886,35 +875,35 @@ attribute-level property filters
|
|
|
886
875
|
- `patchCrmCustom-entitiesById()` - Update a custom entity's properties and pipeline assignment
|
|
887
876
|
- `deleteCrmCustom-entitiesById()` - Soft-delete a custom entity by setting deleted_at
|
|
888
877
|
|
|
889
|
-
## Crm
|
|
878
|
+
## Crm-custom-entity-type
|
|
890
879
|
|
|
891
880
|
- `getIsvCrmEntity-typesApplicationByApplicationId()` - List all custom entity types defined for an application
|
|
892
|
-
- `getIsvCrmEntity-typesById()` - /isv/crm/entity-types/:id operation on
|
|
881
|
+
- `getIsvCrmEntity-typesById()` - /isv/crm/entity-types/:id operation on crm-custom-entity-type resource
|
|
893
882
|
- `postIsvCrmEntity-types()` - Define a new custom entity type for the application (e.g., 'client_goals', 'session')
|
|
894
883
|
- `patchIsvCrmEntity-typesById()` - Update a custom entity type's display name, field schema, or capability flags
|
|
895
|
-
- `deleteIsvCrmEntity-typesById()` - /isv/crm/entity-types/:id operation on
|
|
884
|
+
- `deleteIsvCrmEntity-typesById()` - /isv/crm/entity-types/:id operation on crm-custom-entity-type resource
|
|
896
885
|
|
|
897
|
-
## Crm
|
|
886
|
+
## Crm-custom-entity-version
|
|
898
887
|
|
|
899
|
-
- `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
|
|
900
889
|
- `getCrmCustom-entitiesByEntityIdVersionsById()` - Fetch a single version by ID, scoped to a specific entity (IDOR-safe)
|
|
901
890
|
|
|
902
|
-
## Crm
|
|
891
|
+
## Crm-custom-field-definition
|
|
903
892
|
|
|
904
|
-
- `getCrmField-definitionsById()` - /crm/field-definitions/:id operation on
|
|
893
|
+
- `getCrmField-definitionsById()` - /crm/field-definitions/:id operation on crm-custom-field-definition resource
|
|
905
894
|
- `getCrmField-definitionsEntity-typeByEntityType()` - List all custom field definitions for a given application and entity type
|
|
906
895
|
- `postCrmField-definitions()` - Define a custom field for a core CRM entity type (contact, company, deal, activity)
|
|
907
896
|
- `patchCrmField-definitionsById()` - Update display metadata and validation rules for an existing custom field
|
|
908
|
-
- `deleteCrmField-definitionsById()` - /crm/field-definitions/:id operation on
|
|
897
|
+
- `deleteCrmField-definitionsById()` - /crm/field-definitions/:id operation on crm-custom-field-definition resource
|
|
909
898
|
|
|
910
|
-
## Crm
|
|
899
|
+
## Crm-data-export-job
|
|
911
900
|
|
|
912
901
|
- `getCrmExportsById()` - Fetch a single export job by ID
|
|
913
902
|
- `getCrmExportsWorkspaceByWorkspaceId()` - List all export jobs for a workspace, sorted newest first
|
|
914
903
|
- `postCrmExports()` - Enqueue an async CRM data export job
|
|
915
904
|
- `patchCrmExportsByIdRefresh-url()` - Regenerate the presigned download URL for a completed export job
|
|
916
905
|
|
|
917
|
-
## Crm
|
|
906
|
+
## Crm-deal
|
|
918
907
|
|
|
919
908
|
- `getCrmDealsById()` - Fetch a single active deal by ID; excludes soft-deleted records.
|
|
920
909
|
- `getCrmDealsWorkspaceByWorkspaceId()` - List active deals in a workspace with offset pagination
|
|
@@ -923,50 +912,50 @@ attribute-level property filters
|
|
|
923
912
|
- `patchCrmDealsByIdMove-stage()` - Move a deal to a different pipeline stage
|
|
924
913
|
- `deleteCrmDealsById()` - Soft-delete a deal by setting deleted_at
|
|
925
914
|
|
|
926
|
-
## Crm
|
|
915
|
+
## Crm-deal-product
|
|
927
916
|
|
|
928
|
-
- `getCrmDeal-products()` - /crm/deal-products operation on
|
|
929
|
-
- `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
|
|
930
919
|
- `postCrmDeal-products()` - Link a catalog product to a deal with quantity and negotiated unit price
|
|
931
|
-
- `deleteCrmDeal-productsById()` - /crm/deal-products/:id operation on
|
|
920
|
+
- `deleteCrmDeal-productsById()` - /crm/deal-products/:id operation on crm-deal-product resource
|
|
932
921
|
|
|
933
|
-
## Crm
|
|
922
|
+
## Crm-pipeline
|
|
934
923
|
|
|
935
|
-
- `getCrmPipelinesById()` - /crm/pipelines/:id operation on
|
|
924
|
+
- `getCrmPipelinesById()` - /crm/pipelines/:id operation on crm-pipeline resource
|
|
936
925
|
- `getCrmPipelinesWorkspaceByWorkspaceId()` - List pipelines available to a workspace — includes both workspace-specific pipelines and application-level templates (workspace_id IS NULL).
|
|
937
926
|
- `postCrmPipelines()` - Create a pipeline scoped to an application (template) or a specific workspace
|
|
938
927
|
- `patchCrmPipelinesById()` - Update a pipeline's name or default status
|
|
939
|
-
- `deleteCrmPipelinesById()` - /crm/pipelines/:id operation on
|
|
928
|
+
- `deleteCrmPipelinesById()` - /crm/pipelines/:id operation on crm-pipeline resource
|
|
940
929
|
|
|
941
|
-
## Crm
|
|
930
|
+
## Crm-pipeline-stage
|
|
942
931
|
|
|
943
|
-
- `getCrmPipeline-stagesById()` - /crm/pipeline-stages/:id operation on
|
|
932
|
+
- `getCrmPipeline-stagesById()` - /crm/pipeline-stages/:id operation on crm-pipeline-stage resource
|
|
944
933
|
- `getCrmPipeline-stagesPipelineByPipelineId()` - List all stages for a specific pipeline, ordered by position.
|
|
945
934
|
- `postCrmPipeline-stages()` - Add a stage to a pipeline with an explicit sort order, optional win probability, and forecast category
|
|
946
935
|
- `patchCrmPipeline-stagesById()` - Update a pipeline stage's name, order, probability, or closed flag
|
|
947
|
-
- `deleteCrmPipeline-stagesById()` - /crm/pipeline-stages/:id operation on
|
|
936
|
+
- `deleteCrmPipeline-stagesById()` - /crm/pipeline-stages/:id operation on crm-pipeline-stage resource
|
|
948
937
|
|
|
949
|
-
## Crm
|
|
938
|
+
## Crm-relationship
|
|
950
939
|
|
|
951
940
|
- `getCrmRelationshipsById()` - Fetch a single CRM relationship by ID
|
|
952
941
|
- `getCrmRelationshipsWorkspaceByWorkspaceId()` - List all relationship edges in a workspace
|
|
953
942
|
- `postCrmRelationships()` - Create a typed relationship edge between two CRM entities
|
|
954
943
|
- `deleteCrmRelationshipsById()` - Permanently remove a relationship edge (hard delete)
|
|
955
944
|
|
|
956
|
-
## Crm
|
|
945
|
+
## Crm-relationship-type
|
|
957
946
|
|
|
958
|
-
- `getCrmRelationship-types()` - /crm/relationship-types operation on
|
|
959
|
-
- `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
|
|
960
949
|
- `postCrmRelationship-types()` - Define a named relationship category for an application
|
|
961
950
|
- `patchCrmRelationship-typesById()` - Update a relationship type's display name, allowed entity types, or properties schema
|
|
962
|
-
- `deleteCrmRelationship-typesById()` - /crm/relationship-types/:id operation on
|
|
951
|
+
- `deleteCrmRelationship-typesById()` - /crm/relationship-types/:id operation on crm-relationship-type resource
|
|
963
952
|
|
|
964
|
-
## Crm
|
|
953
|
+
## Crm-sync-config
|
|
965
954
|
|
|
966
955
|
- `getCrmSync-configsWorkspaceByWorkspaceId()` - List all sync configurations for a workspace, one per connector instance
|
|
967
956
|
- `postCrmSync-configs()` - Create a CRM sync configuration for a workspace+connector pair
|
|
968
957
|
- `patchCrmSync-configsById()` - Update connector sync settings
|
|
969
|
-
- `deleteCrmSync-configsById()` - /crm/sync-configs/:id operation on
|
|
958
|
+
- `deleteCrmSync-configsById()` - /crm/sync-configs/:id operation on crm-sync-config resource
|
|
970
959
|
|
|
971
960
|
## Customer
|
|
972
961
|
|
|
@@ -1004,56 +993,14 @@ attribute-level property filters
|
|
|
1004
993
|
- `getDisclosure-logsById()` - /disclosure-logs/:id operation on disclosure-log resource
|
|
1005
994
|
- `postDisclosure-logs()` - /disclosure-logs operation on disclosure-log resource
|
|
1006
995
|
|
|
1007
|
-
## Document
|
|
996
|
+
## Document-chunk
|
|
1008
997
|
|
|
1009
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.
|
|
1010
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.
|
|
1011
1000
|
|
|
1012
|
-
## Document
|
|
1001
|
+
## Document-stats
|
|
1013
1002
|
|
|
1014
|
-
- `
|
|
1015
|
-
- `getExtractionDocumentsById()` - Primary read for active (non-deleted) documents
|
|
1016
|
-
- `getExtractionDocumentsByIdStatus()` - Lightweight poll endpoint: fetches only `id`, `status`, `progress`, and `error_message` for
|
|
1017
|
-
a single document
|
|
1018
|
-
- `getExtractionDocumentsByIdView()` - Get a document with its presigned view URL
|
|
1019
|
-
- `getExtractionDocumentsWorkspaceByWorkspaceId()` - List active (non-deleted) documents in a workspace, sorted by creation date
|
|
1020
|
-
- `getExtractionDocumentsWorkspaceByWorkspaceIdBy-statusByStatus()` - Filter documents by workspace_id and processing status
|
|
1021
|
-
- `getExtractionDocumentsWorkspaceByWorkspaceIdExcluded()` - List excluded documents
|
|
1022
|
-
- `getExtractionDocumentsWorkspaceByWorkspaceIdReview-queue()` - Get prioritized review queue for active learning
|
|
1023
|
-
- `getExtractionDocumentsWorkspaceByWorkspaceIdTrained()` - List documents that have been trained and not dismissed
|
|
1024
|
-
- `getExtractionDocumentsWorkspaceByWorkspaceIdTrashed()` - List soft-deleted (trashed) documents
|
|
1025
|
-
- `postExtractionDocumentsBegin-upload()` - Step 1 of 2 in the two-step upload flow
|
|
1026
|
-
- `postExtractionDocumentsFind-or-begin-upload()` - Dedup-aware upload: returns existing document if file_hash matches, otherwise creates new document
|
|
1027
|
-
- `postExtractionDocumentsUpload()` - Legacy single-step upload: create a document record and immediately enqueue processing
|
|
1028
|
-
- `patchExtractionDocumentsByIdCancel()` - Cancel a processing document
|
|
1029
|
-
- `patchExtractionDocumentsByIdDismiss()` - Alias for `:dismiss_training`
|
|
1030
|
-
- `patchExtractionDocumentsByIdDismiss-training()` - Dismiss a trained document from the active-learning training dashboard without excluding it
|
|
1031
|
-
from future training
|
|
1032
|
-
- `patchExtractionDocumentsByIdExclude()` - Mark a document as excluded from agent training
|
|
1033
|
-
- `patchExtractionDocumentsByIdFinish-upload()` - Step 2 of 2 in the two-step upload flow
|
|
1034
|
-
- `patchExtractionDocumentsByIdInclude()` - Reverse an exclusion: allow a previously excluded document to contribute training examples
|
|
1035
|
-
again
|
|
1036
|
-
- `patchExtractionDocumentsByIdMark-trained()` - Record that a document has been used for agent training
|
|
1037
|
-
- `patchExtractionDocumentsByIdReprocess()` - Re-extract document with current or specified schema version
|
|
1038
|
-
- `patchExtractionDocumentsByIdRestore()` - Reverse an exclusion: allow a previously excluded document to contribute training examples
|
|
1039
|
-
again
|
|
1040
|
-
- `patchExtractionDocumentsByIdStatus()` - Internal-facing status update used by the web layer and API to set processing state
|
|
1041
|
-
- `patchExtractionDocumentsByIdVerification()` - Update the human verification status of a completed document
|
|
1042
|
-
- `deleteExtractionDocumentsById()` - Soft-delete a document and enqueue storage cleanup
|
|
1043
|
-
|
|
1044
|
-
## Document stats
|
|
1045
|
-
|
|
1046
|
-
- `getDocumentsStats()` - /documents/stats operation on document_stats resource
|
|
1047
|
-
|
|
1048
|
-
## Email template
|
|
1049
|
-
|
|
1050
|
-
- `getApplicationsByApplicationIdEmail-templates()` - List all email templates for the application, including both system and custom templates
|
|
1051
|
-
- `getApplicationsByApplicationIdEmail-templatesBySlug()` - Fetch a single email template by its slug within the given application
|
|
1052
|
-
- `postApplicationsByApplicationIdEmail-templates()` - Create a new custom email template for the application
|
|
1053
|
-
- `postApplicationsByApplicationIdEmail-templatesBySlugPreview()` - Preview email template with sample data
|
|
1054
|
-
- `postApplicationsByApplicationIdEmail-templatesBySlugTest()` - Send a test email using this template
|
|
1055
|
-
- `patchApplicationsByApplicationIdEmail-templatesBySlug()` - Update the display name, subject, body, branding color, or enabled state of an existing template
|
|
1056
|
-
- `deleteApplicationsByApplicationIdEmail-templatesBySlug()` - /applications/:application_id/email-templates/:slug operation on email_template resource
|
|
1003
|
+
- `getDocumentsStats()` - /documents/stats operation on document-stats resource
|
|
1057
1004
|
|
|
1058
1005
|
## Email-inbound-address
|
|
1059
1006
|
|
|
@@ -1164,6 +1111,16 @@ again
|
|
|
1164
1111
|
- `getEmailSend-limitsById()` - /email/send-limits/:id operation on email-send-limit resource
|
|
1165
1112
|
- `getEmailSend-limitsWorkspaceByWorkspaceId()` - /email/send-limits/workspace/:workspace_id operation on email-send-limit resource
|
|
1166
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
|
+
|
|
1167
1124
|
## Email-template-version
|
|
1168
1125
|
|
|
1169
1126
|
- `getEmailTemplate-versionsByTemplateIdVersionsByVersionNumber()` - /email/template-versions/:template_id/versions/:version_number operation on email-template-version resource
|
|
@@ -1197,32 +1154,64 @@ again
|
|
|
1197
1154
|
- `postEphi-data-flows()` - /ephi-data-flows operation on ephi-data-flow resource
|
|
1198
1155
|
- `patchEphi-data-flowsById()` - /ephi-data-flows/:id operation on ephi-data-flow resource
|
|
1199
1156
|
|
|
1200
|
-
## Extraction
|
|
1157
|
+
## Extraction-agent
|
|
1201
1158
|
|
|
1202
|
-
- `getExtractionAgents()` - /extraction/agents operation on
|
|
1203
|
-
- `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
|
|
1204
1161
|
- `postExtractionAgentsPredict()` - Predicts the best agents for a given input
|
|
1205
1162
|
|
|
1206
|
-
## Extraction
|
|
1163
|
+
## Extraction-analysis
|
|
1207
1164
|
|
|
1208
|
-
- `getExtractionAnalyses()` - /extraction/analyses operation on
|
|
1209
|
-
- `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
|
|
1210
1167
|
|
|
1211
|
-
## Extraction
|
|
1168
|
+
## Extraction-batch
|
|
1212
1169
|
|
|
1213
|
-
- `getExtractionBatchesById()` - /extraction/batches/:id operation on
|
|
1170
|
+
- `getExtractionBatchesById()` - /extraction/batches/:id operation on extraction-batch resource
|
|
1214
1171
|
- `getExtractionBatchesByIdUpload-urls()` - Generate presigned URLs for batch document upload
|
|
1215
1172
|
- `getExtractionBatchesWorkspaceByWorkspaceId()` - List all batches for a workspace, unfiltered and unpaginated
|
|
1216
1173
|
- `postExtractionBatches()` - Create a new extraction batch to group related documents
|
|
1217
|
-
- `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
|
|
1218
1207
|
|
|
1219
|
-
## Extraction
|
|
1208
|
+
## Extraction-export
|
|
1220
1209
|
|
|
1221
1210
|
- `getWorkspacesByWorkspaceIdExtractionExports()` - List exports for a workspace, filtered by status
|
|
1222
|
-
- `getWorkspacesByWorkspaceIdExtractionExportsById()` - /workspaces/:workspace_id/extraction/exports/:id operation on
|
|
1223
|
-
- `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
|
|
1224
1213
|
|
|
1225
|
-
## Extraction
|
|
1214
|
+
## Extraction-result
|
|
1226
1215
|
|
|
1227
1216
|
- `getExtractionResults()` - Primary read for extraction results
|
|
1228
1217
|
- `getExtractionResultsById()` - Fetch a single ExtractionResult by ID
|
|
@@ -1236,13 +1225,13 @@ fields
|
|
|
1236
1225
|
- `patchExtractionResultsByIdSave-corrections()` - Apply human corrections to extracted field values
|
|
1237
1226
|
- `deleteExtractionResultsById()` - Delete an ExtractionResult record
|
|
1238
1227
|
|
|
1239
|
-
## Extraction
|
|
1228
|
+
## Extraction-workflow
|
|
1240
1229
|
|
|
1241
|
-
- `getExtraction-workflows()` - /extraction-workflows operation on
|
|
1242
|
-
- `getExtraction-workflowsById()` - /extraction-workflows/:id operation on
|
|
1243
|
-
- `postExtraction-workflows()` - /extraction-workflows operation on
|
|
1244
|
-
- `patchExtraction-workflowsById()` - /extraction-workflows/:id operation on
|
|
1245
|
-
- `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
|
|
1246
1235
|
|
|
1247
1236
|
## Feature-definition
|
|
1248
1237
|
|
|
@@ -1253,6 +1242,10 @@ fields
|
|
|
1253
1242
|
- `patchFeature-definitionsById()` - Update a feature definition's configuration.
|
|
1254
1243
|
- `deleteFeature-definitionsById()` - /feature-definitions/:id operation on feature-definition resource
|
|
1255
1244
|
|
|
1245
|
+
## Feature-summary
|
|
1246
|
+
|
|
1247
|
+
- `getWalletFeatures()` - Get all features with their plan allocations and current usage
|
|
1248
|
+
|
|
1256
1249
|
## Feature-usage
|
|
1257
1250
|
|
|
1258
1251
|
- `getFeature-usages()` - List all feature usage records.
|
|
@@ -1260,20 +1253,27 @@ fields
|
|
|
1260
1253
|
- `getFeature-usagesById()` - Fetch a single feature usage record by ID.
|
|
1261
1254
|
- `postFeature-usagesIncrement()` - Increment usage for a feature by key
|
|
1262
1255
|
|
|
1263
|
-
## Field
|
|
1256
|
+
## Field-mapping-confirmation
|
|
1257
|
+
|
|
1258
|
+
- `postWorkspacesByWorkspaceIdExtractionByDocumentIdMapping()` - /workspaces/:workspace_id/extraction/:document_id/mapping operation on field-mapping-confirmation resource
|
|
1264
1259
|
|
|
1265
|
-
|
|
1260
|
+
## Field-mapping-result
|
|
1266
1261
|
|
|
1267
|
-
|
|
1262
|
+
- `getWorkspacesByWorkspaceIdExtractionByDocumentIdMapping()` - /workspaces/:workspace_id/extraction/:document_id/mapping operation on field-mapping-result resource
|
|
1268
1263
|
|
|
1269
|
-
|
|
1264
|
+
## Field-template
|
|
1270
1265
|
|
|
1271
|
-
|
|
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
|
|
1272
1270
|
|
|
1273
|
-
|
|
1274
|
-
|
|
1275
|
-
- `
|
|
1276
|
-
- `
|
|
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
|
|
1277
1277
|
|
|
1278
1278
|
## Invitations
|
|
1279
1279
|
|
|
@@ -1288,6 +1288,10 @@ fields
|
|
|
1288
1288
|
- `patchInvitationsByIdResend()` - Resend an invitation email with a refreshed token and a new 7-day expiry
|
|
1289
1289
|
- `patchInvitationsByIdRevoke()` - Cancel a pending invitation by setting its status to :revoked
|
|
1290
1290
|
|
|
1291
|
+
## Invoice
|
|
1292
|
+
|
|
1293
|
+
- `getWalletInvoices()` - Read all invoices for the current tenant
|
|
1294
|
+
|
|
1291
1295
|
## Isv-revenue
|
|
1292
1296
|
|
|
1293
1297
|
- `getIsv-revenue()` - /isv-revenue operation on isv-revenue resource
|
|
@@ -1301,13 +1305,6 @@ fields
|
|
|
1301
1305
|
- `postIsv-settlements()` - /isv-settlements operation on isv-settlement resource
|
|
1302
1306
|
- `patchIsv-settlementsById()` - /isv-settlements/:id operation on isv-settlement resource
|
|
1303
1307
|
|
|
1304
|
-
## Knowledge Graph
|
|
1305
|
-
|
|
1306
|
-
- `getAiGraphNodes()` - Paginate Entity vertices for the caller's tenant; returns up to 50 nodes per page by default.
|
|
1307
|
-
- `getAiGraphNodesLabelByLabel()` - Find all Entity vertices with an exact label match; use to look up a specific named entity in the knowledge graph.
|
|
1308
|
-
- `postAiGraphNodes()` - Create an Entity vertex in the knowledge graph; tenant_id is always forced from the actor and cannot be supplied by the caller
|
|
1309
|
-
- `deleteAiGraphNodesById()` - /ai/graph/nodes/:id operation on graph_node resource
|
|
1310
|
-
|
|
1311
1308
|
## Ledger
|
|
1312
1309
|
|
|
1313
1310
|
- `getLedger()` - /ledger operation on ledger resource
|
|
@@ -1343,42 +1340,42 @@ fields
|
|
|
1343
1340
|
- `getLlm-analyticsWorkspace()` - Fetch LLM analytics scoped to a single workspace; use for per-workspace usage dashboards and cost attribution.
|
|
1344
1341
|
- `postLlm-analytics()` - Append a single LLM call analytics record (model, tokens, latency, cost); called by the billing/analytics pipeline after each LLM invocation
|
|
1345
1342
|
|
|
1346
|
-
## Notification
|
|
1343
|
+
## Notification-log
|
|
1347
1344
|
|
|
1348
|
-
- `getNotification-logs()` - /notification-logs operation on
|
|
1349
|
-
- `getNotification-logsById()` - /notification-logs/:id operation on
|
|
1345
|
+
- `getNotification-logs()` - /notification-logs operation on notification-log resource
|
|
1346
|
+
- `getNotification-logsById()` - /notification-logs/:id operation on notification-log resource
|
|
1350
1347
|
- `getNotification-logsStats()` - Get notification log statistics
|
|
1351
1348
|
|
|
1352
|
-
## Notification
|
|
1349
|
+
## Notification-method
|
|
1353
1350
|
|
|
1354
|
-
- `getNotification-methods()` - /notification-methods operation on
|
|
1355
|
-
- `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
|
|
1356
1353
|
- `postNotification-methods()` - Register a new notification delivery channel for a user (email address, phone number, Slack webhook, or generic webhook URL)
|
|
1357
1354
|
- `patchNotification-methodsById()` - Update the display name or connection config for an existing notification method
|
|
1358
1355
|
- `patchNotification-methodsByIdSend-verification()` - Generate a 6-digit verification code, store it as `verification_token`, and record `verification_sent_at`
|
|
1359
1356
|
- `patchNotification-methodsByIdSet-primary()` - Mark this notification method as the primary channel for its type, used when multiple methods of the same type exist.
|
|
1360
1357
|
- `patchNotification-methodsByIdVerify()` - Mark the notification method as verified by setting `verified_at` to the current timestamp
|
|
1361
|
-
- `deleteNotification-methodsById()` - /notification-methods/:id operation on
|
|
1358
|
+
- `deleteNotification-methodsById()` - /notification-methods/:id operation on notification-method resource
|
|
1362
1359
|
|
|
1363
|
-
## Notification
|
|
1360
|
+
## Notification-preference
|
|
1364
1361
|
|
|
1365
|
-
- `getNotification-preferences()` - /notification-preferences operation on
|
|
1366
|
-
- `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
|
|
1367
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
|
|
1368
1365
|
- `patchNotification-preferencesById()` - Update a user's notification channel list or per-category preferences
|
|
1369
|
-
- `deleteNotification-preferencesById()` - /notification-preferences/:id operation on
|
|
1366
|
+
- `deleteNotification-preferencesById()` - /notification-preferences/:id operation on notification-preference resource
|
|
1370
1367
|
|
|
1371
|
-
## Oauth
|
|
1368
|
+
## Oauth-app-config
|
|
1372
1369
|
|
|
1373
|
-
- `getConnectorsOauth-app-configs()` - /connectors/oauth-app-configs operation on
|
|
1374
|
-
- `getConnectorsOauth-app-configsById()` - /connectors/oauth-app-configs/:id operation on
|
|
1375
|
-
- `postConnectorsOauth-app-configs()` - /connectors/oauth-app-configs operation on
|
|
1376
|
-
- `patchConnectorsOauth-app-configsById()` - /connectors/oauth-app-configs/:id operation on
|
|
1377
|
-
- `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
|
|
1378
1375
|
|
|
1379
|
-
## Operation
|
|
1376
|
+
## Operation-success
|
|
1380
1377
|
|
|
1381
|
-
- `postDocumentsBulk-delete()` - /documents/bulk-delete operation on
|
|
1378
|
+
- `postDocumentsBulk-delete()` - /documents/bulk-delete operation on operation-success resource
|
|
1382
1379
|
|
|
1383
1380
|
## Payment-method
|
|
1384
1381
|
|
|
@@ -1407,20 +1404,21 @@ fields
|
|
|
1407
1404
|
## Pipeline
|
|
1408
1405
|
|
|
1409
1406
|
- `getPipelines()` - /pipelines operation on pipeline resource
|
|
1407
|
+
- `getPipelinesBy-slugBySlug()` - Look up a pipeline by its system_slug scoped to an application
|
|
1410
1408
|
- `getPipelinesById()` - /pipelines/:id operation on pipeline resource
|
|
1411
1409
|
- `postPipelines()` - Create a new agent pipeline.
|
|
1412
1410
|
- `patchPipelinesById()` - Update pipeline metadata or node graph.
|
|
1413
1411
|
- `deletePipelinesById()` - /pipelines/:id operation on pipeline resource
|
|
1414
1412
|
|
|
1415
|
-
## Pipeline
|
|
1413
|
+
## Pipeline-execution
|
|
1416
1414
|
|
|
1417
|
-
- `getPipeline-executions()` - /pipeline-executions operation on
|
|
1418
|
-
- `getPipeline-executionsById()` - /pipeline-executions/:id operation on
|
|
1419
|
-
- `patchPipeline-executionsByIdApprove()` - /pipeline-executions/:id/approve operation on
|
|
1420
|
-
- `patchPipeline-executionsByIdCheckpoint()` - /pipeline-executions/:id/checkpoint operation on
|
|
1421
|
-
- `patchPipeline-executionsByIdNote()` - /pipeline-executions/:id/note operation on
|
|
1422
|
-
- `patchPipeline-executionsByIdRefine()` - /pipeline-executions/:id/refine operation on
|
|
1423
|
-
- `patchPipeline-executionsByIdReject()` - /pipeline-executions/:id/reject operation on
|
|
1415
|
+
- `getPipeline-executions()` - /pipeline-executions operation on pipeline-execution resource
|
|
1416
|
+
- `getPipeline-executionsById()` - /pipeline-executions/:id operation on pipeline-execution resource
|
|
1417
|
+
- `patchPipeline-executionsByIdApprove()` - /pipeline-executions/:id/approve operation on pipeline-execution resource
|
|
1418
|
+
- `patchPipeline-executionsByIdCheckpoint()` - /pipeline-executions/:id/checkpoint operation on pipeline-execution resource
|
|
1419
|
+
- `patchPipeline-executionsByIdNote()` - /pipeline-executions/:id/note operation on pipeline-execution resource
|
|
1420
|
+
- `patchPipeline-executionsByIdRefine()` - /pipeline-executions/:id/refine operation on pipeline-execution resource
|
|
1421
|
+
- `patchPipeline-executionsByIdReject()` - /pipeline-executions/:id/reject operation on pipeline-execution resource
|
|
1424
1422
|
|
|
1425
1423
|
## Plan-feature-allocation
|
|
1426
1424
|
|
|
@@ -1431,15 +1429,6 @@ fields
|
|
|
1431
1429
|
- `patchPlan-feature-allocationsById()` - Update a plan feature allocation's overrides.
|
|
1432
1430
|
- `deletePlan-feature-allocationsById()` - /plan-feature-allocations/:id operation on plan-feature-allocation resource
|
|
1433
1431
|
|
|
1434
|
-
## Platform tone
|
|
1435
|
-
|
|
1436
|
-
- `getPlatform-tones()` - /platform-tones operation on platform_tone resource
|
|
1437
|
-
- `getPlatform-tonesBy-brandByBrandIdentityId()` - /platform-tones/by-brand/:brand_identity_id operation on platform_tone resource
|
|
1438
|
-
- `getPlatform-tonesById()` - /platform-tones/:id operation on platform_tone resource
|
|
1439
|
-
- `postPlatform-tones()` - /platform-tones operation on platform_tone resource
|
|
1440
|
-
- `patchPlatform-tonesById()` - /platform-tones/:id operation on platform_tone resource
|
|
1441
|
-
- `deletePlatform-tonesById()` - /platform-tones/:id operation on platform_tone resource
|
|
1442
|
-
|
|
1443
1432
|
## Platform-pricing-config
|
|
1444
1433
|
|
|
1445
1434
|
- `getPlatform-pricing-configs()` - /platform-pricing-configs operation on platform-pricing-config resource
|
|
@@ -1448,6 +1437,15 @@ fields
|
|
|
1448
1437
|
- `patchPlatform-pricing-configsById()` - /platform-pricing-configs/:id operation on platform-pricing-config resource
|
|
1449
1438
|
- `deletePlatform-pricing-configsById()` - /platform-pricing-configs/:id operation on platform-pricing-config resource
|
|
1450
1439
|
|
|
1440
|
+
## Platform-tone
|
|
1441
|
+
|
|
1442
|
+
- `getPlatform-tones()` - /platform-tones operation on platform-tone resource
|
|
1443
|
+
- `getPlatform-tonesBy-brandByBrandIdentityId()` - /platform-tones/by-brand/:brand_identity_id operation on platform-tone resource
|
|
1444
|
+
- `getPlatform-tonesById()` - /platform-tones/:id operation on platform-tone resource
|
|
1445
|
+
- `postPlatform-tones()` - /platform-tones operation on platform-tone resource
|
|
1446
|
+
- `patchPlatform-tonesById()` - /platform-tones/:id operation on platform-tone resource
|
|
1447
|
+
- `deletePlatform-tonesById()` - /platform-tones/:id operation on platform-tone resource
|
|
1448
|
+
|
|
1451
1449
|
## Policy-review-schedule
|
|
1452
1450
|
|
|
1453
1451
|
- `getPolicy-review-schedules()` - /policy-review-schedules operation on policy-review-schedule resource
|
|
@@ -1469,25 +1467,25 @@ fields
|
|
|
1469
1467
|
- `postPortal-invitations()` - /portal-invitations operation on portal-invitation resource
|
|
1470
1468
|
- `deletePortal-invitationsById()` - /portal-invitations/:id operation on portal-invitation resource
|
|
1471
1469
|
|
|
1472
|
-
## Post
|
|
1470
|
+
## Post-metric
|
|
1473
1471
|
|
|
1474
|
-
- `getSocialMetricsAccountBySocialAccountId()` - /social/metrics/account/:social_account_id operation on
|
|
1475
|
-
- `getSocialMetricsById()` - /social/metrics/:id operation on
|
|
1476
|
-
- `getSocialMetricsCampaignBySocialCampaignId()` - /social/metrics/campaign/:social_campaign_id operation on
|
|
1477
|
-
- `getSocialMetricsPostBySocialPostId()` - /social/metrics/post/:social_post_id operation on
|
|
1478
|
-
- `getSocialMetricsPostBySocialPostIdLatest()` - /social/metrics/post/:social_post_id/latest operation on
|
|
1472
|
+
- `getSocialMetricsAccountBySocialAccountId()` - /social/metrics/account/:social_account_id operation on post-metric resource
|
|
1473
|
+
- `getSocialMetricsById()` - /social/metrics/:id operation on post-metric resource
|
|
1474
|
+
- `getSocialMetricsCampaignBySocialCampaignId()` - /social/metrics/campaign/:social_campaign_id operation on post-metric resource
|
|
1475
|
+
- `getSocialMetricsPostBySocialPostId()` - /social/metrics/post/:social_post_id operation on post-metric resource
|
|
1476
|
+
- `getSocialMetricsPostBySocialPostIdLatest()` - /social/metrics/post/:social_post_id/latest operation on post-metric resource
|
|
1479
1477
|
|
|
1480
|
-
## Post
|
|
1478
|
+
## Post-processing-hook
|
|
1481
1479
|
|
|
1482
|
-
- `getPost-processing-hooks()` - /post-processing-hooks operation on
|
|
1483
|
-
- `getPost-processing-hooksById()` - /post-processing-hooks/:id operation on
|
|
1484
|
-
- `postPost-processing-hooks()` - /post-processing-hooks operation on
|
|
1485
|
-
- `patchPost-processing-hooksById()` - /post-processing-hooks/:id operation on
|
|
1486
|
-
- `deletePost-processing-hooksById()` - /post-processing-hooks/:id operation on
|
|
1480
|
+
- `getPost-processing-hooks()` - /post-processing-hooks operation on post-processing-hook resource
|
|
1481
|
+
- `getPost-processing-hooksById()` - /post-processing-hooks/:id operation on post-processing-hook resource
|
|
1482
|
+
- `postPost-processing-hooks()` - /post-processing-hooks operation on post-processing-hook resource
|
|
1483
|
+
- `patchPost-processing-hooksById()` - /post-processing-hooks/:id operation on post-processing-hook resource
|
|
1484
|
+
- `deletePost-processing-hooksById()` - /post-processing-hooks/:id operation on post-processing-hook resource
|
|
1487
1485
|
|
|
1488
|
-
## Presigned
|
|
1486
|
+
## Presigned-url
|
|
1489
1487
|
|
|
1490
|
-
- `postDocumentsPresigned-upload()` - /documents/presigned-upload operation on
|
|
1488
|
+
- `postDocumentsPresigned-upload()` - /documents/presigned-upload operation on presigned-url resource
|
|
1491
1489
|
|
|
1492
1490
|
## Pricing-rule
|
|
1493
1491
|
|
|
@@ -1535,22 +1533,33 @@ fields
|
|
|
1535
1533
|
- `patchRolesById()` - Update a role's name, description, or permission list; does NOT retroactively update existing AccessGrants
|
|
1536
1534
|
- `deleteRolesById()` - Delete a role; emits a RoleDeleted audit event
|
|
1537
1535
|
|
|
1536
|
+
## Saved-search
|
|
1537
|
+
|
|
1538
|
+
- `getSearchSaved()` - List saved searches accessible to the current actor: the actor's own searches and any searches marked `is_shared` within the same tenant.
|
|
1539
|
+
- `postSearchSaved()` - Persist a named search query for reuse
|
|
1540
|
+
- `postSearchSavedByIdRun()` - Re-execute a saved search by ID and return the saved search metadata enriched with an `executed_at` ISO-8601 timestamp
|
|
1541
|
+
- `patchSearchSavedById()` - Modify the name, query string, search type, filters, or sharing status of an existing saved search
|
|
1542
|
+
- `deleteSearchSavedById()` - /search/saved/:id operation on saved-search resource
|
|
1543
|
+
|
|
1538
1544
|
## Scan-result
|
|
1539
1545
|
|
|
1540
1546
|
- `getScan-results()` - /scan-results operation on scan-result resource
|
|
1541
1547
|
- `getScan-resultsById()` - /scan-results/:id operation on scan-result resource
|
|
1542
1548
|
|
|
1543
|
-
## Scheduling
|
|
1549
|
+
## Scheduling-availability-rule
|
|
1544
1550
|
|
|
1545
1551
|
- `getSchedulingAvailability-rules()` - List all active availability rules for a workspace
|
|
1552
|
+
- `getSchedulingAvailability-rulesBy-event-type()` - List active availability rules scoped to a specific event type
|
|
1553
|
+
- `getSchedulingAvailability-rulesBy-user()` - List active availability rules for a specific user
|
|
1546
1554
|
- `getSchedulingAvailability-rulesById()` - Fetch a single availability rule by ID
|
|
1547
1555
|
- `postSchedulingAvailability-rules()` - Create an availability rule for a user or event type
|
|
1548
1556
|
- `patchSchedulingAvailability-rulesById()` - Update an availability rule's schedule, date overrides, or active period
|
|
1549
1557
|
- `deleteSchedulingAvailability-rulesById()` - Hard-delete an availability rule
|
|
1550
1558
|
|
|
1551
|
-
## Scheduling
|
|
1559
|
+
## Scheduling-booking
|
|
1552
1560
|
|
|
1553
1561
|
- `getSchedulingBookings()` - List all bookings for a workspace
|
|
1562
|
+
- `getSchedulingBookingsBy-booker()` - List all bookings made by a specific email address across the workspace
|
|
1554
1563
|
- `getSchedulingBookingsById()` - Fetch a single booking by ID
|
|
1555
1564
|
- `postSchedulingBookings()` - Create a booking for an external party claiming a time slot
|
|
1556
1565
|
- `patchSchedulingBookingsByIdCancel()` - Cancel a booking, recording cancellation_reason and cancelled_by (:booker/:organizer/:system)
|
|
@@ -1558,7 +1567,7 @@ fields
|
|
|
1558
1567
|
- `patchSchedulingBookingsByIdMark-no-show()` - Mark a booking as :no_show when the booker did not attend
|
|
1559
1568
|
- `patchSchedulingBookingsByIdReschedule()` - Reschedule a booking by moving its linked Event to new_start_time/new_end_time
|
|
1560
1569
|
|
|
1561
|
-
## Scheduling
|
|
1570
|
+
## Scheduling-calendar-sync
|
|
1562
1571
|
|
|
1563
1572
|
- `getSchedulingCalendar-syncs()` - List all calendar sync configurations for a specific user
|
|
1564
1573
|
- `getSchedulingCalendar-syncsById()` - Fetch a single calendar sync configuration by ID
|
|
@@ -1568,7 +1577,7 @@ fields
|
|
|
1568
1577
|
- `patchSchedulingCalendar-syncsByIdResume()` - Resume a paused or errored calendar sync
|
|
1569
1578
|
- `deleteSchedulingCalendar-syncsById()` - Hard-delete a calendar sync configuration, stopping all future sync runs for this calendar
|
|
1570
1579
|
|
|
1571
|
-
## Scheduling
|
|
1580
|
+
## Scheduling-event
|
|
1572
1581
|
|
|
1573
1582
|
- `getSchedulingEvents()` - List all events in a workspace, newest first
|
|
1574
1583
|
- `getSchedulingEventsByDateRange()` - List events in a workspace that overlap a given time window (start_time < end, end_time > start)
|
|
@@ -1580,21 +1589,24 @@ fields
|
|
|
1580
1589
|
- `patchSchedulingEventsByIdComplete()` - Mark a confirmed event as completed
|
|
1581
1590
|
- `patchSchedulingEventsByIdReschedule()` - Move an event to a new time slot
|
|
1582
1591
|
|
|
1583
|
-
## Scheduling
|
|
1592
|
+
## Scheduling-event-type
|
|
1584
1593
|
|
|
1585
1594
|
- `getSchedulingEvent-types()` - List all active event types for a workspace
|
|
1595
|
+
- `getSchedulingEvent-typesBy-slug()` - Fetch a single active event type by its URL-friendly slug
|
|
1586
1596
|
- `getSchedulingEvent-typesById()` - Fetch a single event type by ID
|
|
1587
1597
|
- `postSchedulingEvent-types()` - Create an event type template for a workspace
|
|
1588
1598
|
- `patchSchedulingEvent-typesById()` - Update event type configuration including duration, buffers, location, capacity, and intake form
|
|
1599
|
+
- `patchSchedulingEvent-typesByIdArchive()` - Soft-archive an event type by setting status to :archived
|
|
1589
1600
|
|
|
1590
|
-
## Scheduling
|
|
1601
|
+
## Scheduling-location
|
|
1591
1602
|
|
|
1592
1603
|
- `getSchedulingLocations()` - List all locations for a workspace (both active and inactive)
|
|
1593
1604
|
- `getSchedulingLocationsById()` - Fetch a single location by ID
|
|
1594
1605
|
- `postSchedulingLocations()` - Create a reusable location record (venue, room, virtual link, or resource)
|
|
1595
1606
|
- `patchSchedulingLocationsById()` - Update location details
|
|
1607
|
+
- `patchSchedulingLocationsByIdDeactivate()` - Set a location to inactive (is_active: false)
|
|
1596
1608
|
|
|
1597
|
-
## Scheduling
|
|
1609
|
+
## Scheduling-participant
|
|
1598
1610
|
|
|
1599
1611
|
- `getSchedulingParticipants()` - List all participants for a specific event, including organizer and attendees
|
|
1600
1612
|
- `getSchedulingParticipantsById()` - Fetch a single participant by ID
|
|
@@ -1603,16 +1615,17 @@ fields
|
|
|
1603
1615
|
- `patchSchedulingParticipantsByIdRespond()` - Record a participant's RSVP: :accepted, :declined, or :tentative
|
|
1604
1616
|
- `deleteSchedulingParticipantsById()` - Hard-delete a participant from an event
|
|
1605
1617
|
|
|
1606
|
-
## Scheduling
|
|
1618
|
+
## Scheduling-reminder
|
|
1607
1619
|
|
|
1608
1620
|
- `getSchedulingReminders()` - List all pending reminders across all workspaces
|
|
1609
1621
|
- `getSchedulingRemindersById()` - Fetch a single reminder by ID
|
|
1610
1622
|
- `postSchedulingReminders()` - Create a scheduled reminder for an event participant
|
|
1623
|
+
- `patchSchedulingRemindersByIdCancel()` - Cancel a pending reminder, preventing delivery
|
|
1611
1624
|
|
|
1612
|
-
## Schema
|
|
1625
|
+
## Schema-discovery
|
|
1613
1626
|
|
|
1614
|
-
- `getExtractionSchema-discoveriesById()` - /extraction/schema-discoveries/:id operation on
|
|
1615
|
-
- `postExtractionSchema-discoveries()` - /extraction/schema-discoveries operation on
|
|
1627
|
+
- `getExtractionSchema-discoveriesById()` - /extraction/schema-discoveries/:id operation on schema-discovery resource
|
|
1628
|
+
- `postExtractionSchema-discoveries()` - /extraction/schema-discoveries operation on schema-discovery resource
|
|
1616
1629
|
- `postExtractionSchema-discoveriesBootstrap()` - Bootstrap schema discovery without an agent
|
|
1617
1630
|
|
|
1618
1631
|
## Search
|
|
@@ -1620,7 +1633,6 @@ fields
|
|
|
1620
1633
|
- `getSearch()` - Full-text keyword search via Meilisearch across users, tenants, and documents
|
|
1621
1634
|
- `getSearchHealth()` - Check Meilisearch server health, returning status and latency
|
|
1622
1635
|
- `getSearchIndexes()` - Return the names of all configured Meilisearch indexes
|
|
1623
|
-
- `getSearchSaved()` - List saved searches accessible to the current actor: the actor's own searches and any searches marked `is_shared` within the same tenant.
|
|
1624
1636
|
- `getSearchSemantic()` - Vector similarity search across document chunks using a generated embedding of the query
|
|
1625
1637
|
- `getSearchStats()` - Return Meilisearch database size and per-index document counts
|
|
1626
1638
|
- `getSearchStatus()` - Return the current status and tenant context for the search indexes
|
|
@@ -1629,17 +1641,17 @@ fields
|
|
|
1629
1641
|
- `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.
|
|
1630
1642
|
- `postSearchBatch()` - Execute multiple search queries in a single request and return the combined results
|
|
1631
1643
|
- `postSearchReindex()` - Trigger a Meilisearch reindex for all or a specific subset of indexes (users, tenants, documents)
|
|
1632
|
-
- `postSearchSaved()` - Persist a named search query for reuse
|
|
1633
|
-
- `postSearchSavedByIdRun()` - Re-execute a saved search by ID and return the saved search metadata enriched with an `executed_at` ISO-8601 timestamp
|
|
1634
|
-
- `patchSearchSavedById()` - Modify the name, query string, search type, filters, or sharing status of an existing saved search
|
|
1635
|
-
- `deleteSearchSavedById()` - /search/saved/:id operation on saved_search resource
|
|
1636
1644
|
|
|
1637
|
-
## Search
|
|
1645
|
+
## Search-analytics
|
|
1638
1646
|
|
|
1639
1647
|
- `getSearchAnalytics()` - List search analytics with tenant-based filtering
|
|
1640
1648
|
- `getSearchAnalyticsSummary()` - Aggregated search analytics summary (platform admin only)
|
|
1641
1649
|
|
|
1642
|
-
##
|
|
1650
|
+
## Seat-info
|
|
1651
|
+
|
|
1652
|
+
- `getWalletSeats()` - Get seat billing info for the current tenant
|
|
1653
|
+
|
|
1654
|
+
## Semantic-cache-entry
|
|
1643
1655
|
|
|
1644
1656
|
- `getSysSemantic-cacheById()` - Fetch aggregate statistics for the semantic cache (platform admin only)
|
|
1645
1657
|
- `postSysSemantic-cacheClear()` - Bulk-destroy all semantic cache entries (platform admin only); requires confirm: true as a safety gate
|
|
@@ -1656,53 +1668,53 @@ fields
|
|
|
1656
1668
|
- `patchSettlementsByIdMark-paid()` - /settlements/:id/mark-paid operation on settlement resource
|
|
1657
1669
|
- `patchSettlementsByIdRelease()` - /settlements/:id/release operation on settlement resource
|
|
1658
1670
|
|
|
1659
|
-
## Shadow
|
|
1671
|
+
## Shadow-comparison
|
|
1660
1672
|
|
|
1661
|
-
- `getExtractionShadow-comparisons()` - /extraction/shadow-comparisons operation on
|
|
1673
|
+
- `getExtractionShadow-comparisons()` - /extraction/shadow-comparisons operation on shadow-comparison resource
|
|
1662
1674
|
- `getExtractionShadow-comparisonsAnalysis()` - Retrieve shadow comparison results for analysis
|
|
1663
|
-
- `getExtractionShadow-comparisonsById()` - /extraction/shadow-comparisons/:id operation on
|
|
1664
|
-
- `postExtractionShadow-comparisons()` - /extraction/shadow-comparisons operation on
|
|
1665
|
-
- `deleteExtractionShadow-comparisonsById()` - /extraction/shadow-comparisons/:id operation on
|
|
1666
|
-
|
|
1667
|
-
## Social
|
|
1668
|
-
|
|
1669
|
-
- `getSocialAccountsById()` - /social/accounts/:id operation on
|
|
1670
|
-
- `getSocialAccountsPlatformByPlatform()` - /social/accounts/platform/:platform operation on
|
|
1671
|
-
- `getSocialAccountsWorkspaceByWorkspaceId()` - /social/accounts/workspace/:workspace_id operation on
|
|
1672
|
-
- `postSocialAccounts()` - /social/accounts operation on
|
|
1673
|
-
- `patchSocialAccountsById()` - /social/accounts/:id operation on
|
|
1674
|
-
- `patchSocialAccountsByIdDeactivate()` - /social/accounts/:id/deactivate operation on
|
|
1675
|
-
- `patchSocialAccountsByIdDisable-posting()` - /social/accounts/:id/disable-posting operation on
|
|
1676
|
-
- `patchSocialAccountsByIdEnable-posting()` - /social/accounts/:id/enable-posting operation on
|
|
1677
|
-
- `deleteSocialAccountsById()` - /social/accounts/:id operation on
|
|
1678
|
-
|
|
1679
|
-
## Social
|
|
1680
|
-
|
|
1681
|
-
- `getSocialCampaigns()` - /social/campaigns operation on
|
|
1682
|
-
- `getSocialCampaignsById()` - /social/campaigns/:id operation on
|
|
1683
|
-
- `postSocialCampaigns()` - /social/campaigns operation on
|
|
1675
|
+
- `getExtractionShadow-comparisonsById()` - /extraction/shadow-comparisons/:id operation on shadow-comparison resource
|
|
1676
|
+
- `postExtractionShadow-comparisons()` - /extraction/shadow-comparisons operation on shadow-comparison resource
|
|
1677
|
+
- `deleteExtractionShadow-comparisonsById()` - /extraction/shadow-comparisons/:id operation on shadow-comparison resource
|
|
1678
|
+
|
|
1679
|
+
## Social-account
|
|
1680
|
+
|
|
1681
|
+
- `getSocialAccountsById()` - /social/accounts/:id operation on social-account resource
|
|
1682
|
+
- `getSocialAccountsPlatformByPlatform()` - /social/accounts/platform/:platform operation on social-account resource
|
|
1683
|
+
- `getSocialAccountsWorkspaceByWorkspaceId()` - /social/accounts/workspace/:workspace_id operation on social-account resource
|
|
1684
|
+
- `postSocialAccounts()` - /social/accounts operation on social-account resource
|
|
1685
|
+
- `patchSocialAccountsById()` - /social/accounts/:id operation on social-account resource
|
|
1686
|
+
- `patchSocialAccountsByIdDeactivate()` - /social/accounts/:id/deactivate operation on social-account resource
|
|
1687
|
+
- `patchSocialAccountsByIdDisable-posting()` - /social/accounts/:id/disable-posting operation on social-account resource
|
|
1688
|
+
- `patchSocialAccountsByIdEnable-posting()` - /social/accounts/:id/enable-posting operation on social-account resource
|
|
1689
|
+
- `deleteSocialAccountsById()` - /social/accounts/:id operation on social-account resource
|
|
1690
|
+
|
|
1691
|
+
## Social-campaign
|
|
1692
|
+
|
|
1693
|
+
- `getSocialCampaigns()` - /social/campaigns operation on social-campaign resource
|
|
1694
|
+
- `getSocialCampaignsById()` - /social/campaigns/:id operation on social-campaign resource
|
|
1695
|
+
- `postSocialCampaigns()` - /social/campaigns operation on social-campaign resource
|
|
1684
1696
|
- `postSocialCampaignsByIdAdapt-for-platforms()` - Adapt master copy for each target platform
|
|
1685
1697
|
- `postSocialCampaignsByIdGenerate-master-copy()` - Generate master copy from content brief using AI
|
|
1686
|
-
- `patchSocialCampaignsById()` - /social/campaigns/:id operation on
|
|
1687
|
-
- `patchSocialCampaignsByIdCancel()` - /social/campaigns/:id/cancel operation on
|
|
1688
|
-
- `patchSocialCampaignsByIdSchedule()` - /social/campaigns/:id/schedule operation on
|
|
1689
|
-
- `deleteSocialCampaignsById()` - /social/campaigns/:id operation on
|
|
1690
|
-
|
|
1691
|
-
## Social
|
|
1692
|
-
|
|
1693
|
-
- `getSocialPostsAccountBySocialAccountId()` - /social/posts/account/:social_account_id operation on
|
|
1694
|
-
- `getSocialPostsById()` - /social/posts/:id operation on
|
|
1695
|
-
- `getSocialPostsCampaignBySocialCampaignId()` - /social/posts/campaign/:social_campaign_id operation on
|
|
1696
|
-
- `getSocialPostsScheduled()` - /social/posts/scheduled operation on
|
|
1697
|
-
- `getSocialPostsWorkspaceByWorkspaceId()` - /social/posts/workspace/:workspace_id operation on
|
|
1698
|
-
- `postSocialPosts()` - /social/posts operation on
|
|
1699
|
-
- `patchSocialPostsById()` - /social/posts/:id operation on
|
|
1700
|
-
- `patchSocialPostsByIdCancel()` - /social/posts/:id/cancel operation on
|
|
1701
|
-
- `patchSocialPostsByIdPublish()` - /social/posts/:id/publish operation on
|
|
1702
|
-
- `patchSocialPostsByIdRetry()` - /social/posts/:id/retry operation on
|
|
1703
|
-
- `patchSocialPostsByIdSchedule()` - /social/posts/:id/schedule operation on
|
|
1704
|
-
- `patchSocialPostsByIdSeo()` - /social/posts/:id/seo operation on
|
|
1705
|
-
- `deleteSocialPostsById()` - /social/posts/:id operation on
|
|
1698
|
+
- `patchSocialCampaignsById()` - /social/campaigns/:id operation on social-campaign resource
|
|
1699
|
+
- `patchSocialCampaignsByIdCancel()` - /social/campaigns/:id/cancel operation on social-campaign resource
|
|
1700
|
+
- `patchSocialCampaignsByIdSchedule()` - /social/campaigns/:id/schedule operation on social-campaign resource
|
|
1701
|
+
- `deleteSocialCampaignsById()` - /social/campaigns/:id operation on social-campaign resource
|
|
1702
|
+
|
|
1703
|
+
## Social-post
|
|
1704
|
+
|
|
1705
|
+
- `getSocialPostsAccountBySocialAccountId()` - /social/posts/account/:social_account_id operation on social-post resource
|
|
1706
|
+
- `getSocialPostsById()` - /social/posts/:id operation on social-post resource
|
|
1707
|
+
- `getSocialPostsCampaignBySocialCampaignId()` - /social/posts/campaign/:social_campaign_id operation on social-post resource
|
|
1708
|
+
- `getSocialPostsScheduled()` - /social/posts/scheduled operation on social-post resource
|
|
1709
|
+
- `getSocialPostsWorkspaceByWorkspaceId()` - /social/posts/workspace/:workspace_id operation on social-post resource
|
|
1710
|
+
- `postSocialPosts()` - /social/posts operation on social-post resource
|
|
1711
|
+
- `patchSocialPostsById()` - /social/posts/:id operation on social-post resource
|
|
1712
|
+
- `patchSocialPostsByIdCancel()` - /social/posts/:id/cancel operation on social-post resource
|
|
1713
|
+
- `patchSocialPostsByIdPublish()` - /social/posts/:id/publish operation on social-post resource
|
|
1714
|
+
- `patchSocialPostsByIdRetry()` - /social/posts/:id/retry operation on social-post resource
|
|
1715
|
+
- `patchSocialPostsByIdSchedule()` - /social/posts/:id/schedule operation on social-post resource
|
|
1716
|
+
- `patchSocialPostsByIdSeo()` - /social/posts/:id/seo operation on social-post resource
|
|
1717
|
+
- `deleteSocialPostsById()` - /social/posts/:id operation on social-post resource
|
|
1706
1718
|
|
|
1707
1719
|
## Storage
|
|
1708
1720
|
|
|
@@ -1714,11 +1726,11 @@ fields
|
|
|
1714
1726
|
- `patchBucketsById()` - Update the region of an existing bucket
|
|
1715
1727
|
- `deleteBucketsById()` - Delete a bucket from the database and attempt to remove it from object storage; fails if any StorageFile records still reference this bucket.
|
|
1716
1728
|
|
|
1717
|
-
## Storage
|
|
1729
|
+
## Storage-file
|
|
1718
1730
|
|
|
1719
|
-
- `getStorage-files()` - /storage-files operation on
|
|
1731
|
+
- `getStorage-files()` - /storage-files operation on storage-file resource
|
|
1720
1732
|
- `getStorage-filesBy-checksum()` - Fetch non-deleted files matching a given checksum
|
|
1721
|
-
- `getStorage-filesById()` - /storage-files/:id operation on
|
|
1733
|
+
- `getStorage-filesById()` - /storage-files/:id operation on storage-file resource
|
|
1722
1734
|
- `getStorage-filesChildren()` - List non-deleted files whose parent_id matches the given ID
|
|
1723
1735
|
- `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.
|
|
1724
1736
|
- `patchStorage-filesById()` - Update file metadata, tags, visibility, key, namespace, or status
|
|
@@ -1729,11 +1741,6 @@ fields
|
|
|
1729
1741
|
- `patchStorage-filesByIdTag()` - Replace the tags list on a file
|
|
1730
1742
|
- `patchStorage-filesByIdUpdate-metadata()` - Merge new_metadata into the existing metadata map (shallow merge)
|
|
1731
1743
|
|
|
1732
|
-
## Storage stats
|
|
1733
|
-
|
|
1734
|
-
- `getStorageStats()` - Get platform-wide storage statistics
|
|
1735
|
-
- `getStorageStatsTenantByTenantId()` - Get storage stats for a specific tenant
|
|
1736
|
-
|
|
1737
1744
|
## Storage-recommendation
|
|
1738
1745
|
|
|
1739
1746
|
- `getStorage-recommendations()` - /storage-recommendations operation on storage-recommendation resource
|
|
@@ -1741,69 +1748,74 @@ fields
|
|
|
1741
1748
|
- `patchStorage-recommendationsByIdAccept()` - /storage-recommendations/:id/accept operation on storage-recommendation resource
|
|
1742
1749
|
- `patchStorage-recommendationsByIdDismiss()` - /storage-recommendations/:id/dismiss operation on storage-recommendation resource
|
|
1743
1750
|
|
|
1744
|
-
##
|
|
1751
|
+
## Storage-stats
|
|
1752
|
+
|
|
1753
|
+
- `getStorageStats()` - Get platform-wide storage statistics
|
|
1754
|
+
- `getStorageStatsTenantByTenantId()` - Get storage stats for a specific tenant
|
|
1755
|
+
|
|
1756
|
+
## Support-ai-config
|
|
1745
1757
|
|
|
1746
1758
|
- `getSupportAi-configsWorkspaceByWorkspaceId()` - Fetch the AI configuration for a specific workspace
|
|
1747
1759
|
- `postSupportAi-configs()` - Create or update the AI configuration for a workspace (upsert — one config per workspace)
|
|
1748
1760
|
|
|
1749
|
-
## Support
|
|
1761
|
+
## Support-canned-response
|
|
1750
1762
|
|
|
1751
1763
|
- `getSupportCanned-responsesWorkspaceByWorkspaceId()` - List all canned responses for a workspace
|
|
1752
1764
|
- `postSupportCanned-responses()` - Create a pre-written response template for agent use
|
|
1753
1765
|
- `patchSupportCanned-responsesById()` - Update a canned response's content, category, or shortcut
|
|
1754
|
-
- `deleteSupportCanned-responsesById()` - /support/canned-responses/:id operation on
|
|
1766
|
+
- `deleteSupportCanned-responsesById()` - /support/canned-responses/:id operation on support-canned-response resource
|
|
1755
1767
|
|
|
1756
|
-
## Support
|
|
1768
|
+
## Support-channel-capture-config
|
|
1757
1769
|
|
|
1758
1770
|
- `getSupportChannel-capture-configsWorkspaceByWorkspaceId()` - Fetch the channel capture configuration for a workspace
|
|
1759
1771
|
- `postSupportChannel-capture-configs()` - Create or update the channel capture configuration for a workspace (upsert — one config per workspace)
|
|
1760
1772
|
|
|
1761
|
-
## Support
|
|
1773
|
+
## Support-queue
|
|
1762
1774
|
|
|
1763
1775
|
- `getSupportQueuesApplicationByApplicationId()` - List all queues for an application
|
|
1764
|
-
- `getSupportQueuesById()` - /support/queues/:id operation on
|
|
1776
|
+
- `getSupportQueuesById()` - /support/queues/:id operation on support-queue resource
|
|
1765
1777
|
- `postSupportQueues()` - Create an application-scoped support queue
|
|
1766
1778
|
- `patchSupportQueuesById()` - Update queue settings including ai_mode, SLA policy, priority boost, and business hours
|
|
1767
|
-
- `deleteSupportQueuesById()` - /support/queues/:id operation on
|
|
1779
|
+
- `deleteSupportQueuesById()` - /support/queues/:id operation on support-queue resource
|
|
1768
1780
|
|
|
1769
|
-
## Support
|
|
1781
|
+
## Support-queue-member
|
|
1770
1782
|
|
|
1771
1783
|
- `getSupportQueue-membersApplicationByApplicationId()` - List all queue members across all queues for an application
|
|
1772
1784
|
- `getSupportQueue-membersQueueByQueueId()` - List all members of a specific queue including their role, capacity, and availability
|
|
1773
1785
|
- `postSupportQueue-members()` - Add an agent to a support queue with a role and capacity
|
|
1774
1786
|
- `patchSupportQueue-membersById()` - Update a queue member's role, ticket capacity, or availability status
|
|
1775
|
-
- `deleteSupportQueue-membersById()` - /support/queue-members/:id operation on
|
|
1787
|
+
- `deleteSupportQueue-membersById()` - /support/queue-members/:id operation on support-queue-member resource
|
|
1776
1788
|
|
|
1777
|
-
## Support
|
|
1789
|
+
## Support-routing-rule
|
|
1778
1790
|
|
|
1779
1791
|
- `getSupportRouting-rulesApplicationByApplicationId()` - List all routing rules for an application, sorted by priority ascending (lower first)
|
|
1780
|
-
- `getSupportRouting-rulesById()` - /support/routing-rules/:id operation on
|
|
1792
|
+
- `getSupportRouting-rulesById()` - /support/routing-rules/:id operation on support-routing-rule resource
|
|
1781
1793
|
- `postSupportRouting-rules()` - Create a ticket routing rule for an application
|
|
1782
1794
|
- `patchSupportRouting-rulesById()` - Update a routing rule's conditions, action, parameters, or priority order
|
|
1783
|
-
- `deleteSupportRouting-rulesById()` - /support/routing-rules/:id operation on
|
|
1795
|
+
- `deleteSupportRouting-rulesById()` - /support/routing-rules/:id operation on support-routing-rule resource
|
|
1784
1796
|
|
|
1785
|
-
## Support
|
|
1797
|
+
## Support-sla-policy
|
|
1786
1798
|
|
|
1787
1799
|
- `getSupportSla-policiesApplicationByApplicationId()` - List all SLA policies for an application
|
|
1788
|
-
- `getSupportSla-policiesById()` - /support/sla-policies/:id operation on
|
|
1800
|
+
- `getSupportSla-policiesById()` - /support/sla-policies/:id operation on support-sla-policy resource
|
|
1789
1801
|
- `postSupportSla-policies()` - Create an application-scoped SLA policy defining first_response and resolution targets in minutes
|
|
1790
1802
|
- `patchSupportSla-policiesById()` - Update SLA policy targets or business hours setting
|
|
1791
|
-
- `deleteSupportSla-policiesById()` - /support/sla-policies/:id operation on
|
|
1803
|
+
- `deleteSupportSla-policiesById()` - /support/sla-policies/:id operation on support-sla-policy resource
|
|
1792
1804
|
|
|
1793
|
-
## Support
|
|
1805
|
+
## Support-sync-config
|
|
1794
1806
|
|
|
1795
1807
|
- `getSupportSync-configsWorkspaceByWorkspaceId()` - List all sync configurations for a workspace, one per connector instance
|
|
1796
1808
|
- `postSupportSync-configs()` - Create a connector sync configuration for a workspace+connector pair
|
|
1797
1809
|
- `patchSupportSync-configsById()` - Update sync configuration: toggle enabled, change direction, update status mapping, or adjust interval
|
|
1798
|
-
- `deleteSupportSync-configsById()` - /support/sync-configs/:id operation on
|
|
1810
|
+
- `deleteSupportSync-configsById()` - /support/sync-configs/:id operation on support-sync-config resource
|
|
1799
1811
|
|
|
1800
|
-
## Support
|
|
1812
|
+
## Support-tag
|
|
1801
1813
|
|
|
1802
1814
|
- `getSupportTagsWorkspaceByWorkspaceId()` - List all tags defined for a workspace
|
|
1803
1815
|
- `postSupportTags()` - Create a workspace-scoped ticket tag
|
|
1804
1816
|
- `deleteSupportTagsById()` - Hard-delete a tag
|
|
1805
1817
|
|
|
1806
|
-
## Support
|
|
1818
|
+
## Support-ticket
|
|
1807
1819
|
|
|
1808
1820
|
- `getSupportTicketsById()` - Fetch a single active ticket by ID
|
|
1809
1821
|
- `getSupportTicketsWorkspaceByWorkspaceId()` - List active tickets for a workspace, optionally filtered by status, priority, queue, or agent
|
|
@@ -1816,17 +1828,17 @@ fields
|
|
|
1816
1828
|
- `patchSupportTicketsByIdResolve()` - Mark a ticket as resolved, recording resolved_at timestamp
|
|
1817
1829
|
- `deleteSupportTicketsById()` - Soft-delete a ticket by setting deleted_at
|
|
1818
1830
|
|
|
1819
|
-
## Support
|
|
1831
|
+
## Support-ticket-attachment
|
|
1820
1832
|
|
|
1821
1833
|
- `getSupportTicket-attachmentsMessageByTicketMessageId()` - List all attachments for a specific ticket message
|
|
1822
1834
|
- `postSupportTicket-attachments()` - Register a file attachment on a ticket message
|
|
1823
1835
|
|
|
1824
|
-
## Support
|
|
1836
|
+
## Support-ticket-message
|
|
1825
1837
|
|
|
1826
1838
|
- `getSupportTicket-messagesTicketByTicketId()` - List all messages on a ticket in chronological order
|
|
1827
1839
|
- `postSupportTicket-messages()` - Add a message to a ticket thread
|
|
1828
1840
|
|
|
1829
|
-
## Support
|
|
1841
|
+
## Support-ticket-rating
|
|
1830
1842
|
|
|
1831
1843
|
- `postSupportTicket-ratings()` - Submit or update a CSAT rating (1-5) for a resolved ticket
|
|
1832
1844
|
|
|
@@ -1835,23 +1847,19 @@ fields
|
|
|
1835
1847
|
- `getConnectorsSync-logs()` - /connectors/sync-logs operation on sync-log resource
|
|
1836
1848
|
- `getConnectorsSync-logsById()` - /connectors/sync-logs/:id operation on sync-log resource
|
|
1837
1849
|
|
|
1838
|
-
## System
|
|
1850
|
+
## System-message
|
|
1839
1851
|
|
|
1840
|
-
- `getSystem-messages()` - /system-messages operation on
|
|
1841
|
-
- `getSystem-messagesById()` - /system-messages/:id operation on
|
|
1852
|
+
- `getSystem-messages()` - /system-messages operation on system-message resource
|
|
1853
|
+
- `getSystem-messagesById()` - /system-messages/:id operation on system-message resource
|
|
1842
1854
|
- `postSystem-messages()` - Create a new platform-wide system message (ToS, privacy policy, welcome, or announcement)
|
|
1843
1855
|
- `patchSystem-messagesById()` - Edit a system message's content, title, or version
|
|
1844
1856
|
- `patchSystem-messagesByIdPublish()` - Activate a system message so it is visible to all authenticated users
|
|
1845
1857
|
- `patchSystem-messagesByIdUnpublish()` - Deactivate a system message, removing it from the live feed without deleting it
|
|
1846
|
-
- `deleteSystem-messagesById()` - /system-messages/:id operation on
|
|
1847
|
-
|
|
1848
|
-
## Tenant document stats
|
|
1858
|
+
- `deleteSystem-messagesById()` - /system-messages/:id operation on system-message resource
|
|
1849
1859
|
|
|
1850
|
-
|
|
1860
|
+
## Tenant-document-stats
|
|
1851
1861
|
|
|
1852
|
-
|
|
1853
|
-
|
|
1854
|
-
- `getTenantsByTenantIdStats()` - /tenants/:tenant_id/stats operation on tenant_stats resource
|
|
1862
|
+
- `getTenantsByTenantIdDocumentStats()` - /tenants/:tenant_id/document_stats operation on tenant-document-stats resource
|
|
1855
1863
|
|
|
1856
1864
|
## Tenant-pricing-override
|
|
1857
1865
|
|
|
@@ -1861,6 +1869,10 @@ fields
|
|
|
1861
1869
|
- `patchTenant-pricing-overridesById()` - /tenant-pricing-overrides/:id operation on tenant-pricing-override resource
|
|
1862
1870
|
- `deleteTenant-pricing-overridesById()` - /tenant-pricing-overrides/:id operation on tenant-pricing-override resource
|
|
1863
1871
|
|
|
1872
|
+
## Tenant-stats
|
|
1873
|
+
|
|
1874
|
+
- `getTenantsByTenantIdStats()` - /tenants/:tenant_id/stats operation on tenant-stats resource
|
|
1875
|
+
|
|
1864
1876
|
## Tenants
|
|
1865
1877
|
|
|
1866
1878
|
- `getTenants()` - /tenants operation on tenant resource
|
|
@@ -1888,11 +1900,32 @@ plan tier, vanity slug, and storage spending cap
|
|
|
1888
1900
|
|
|
1889
1901
|
- `postTokens()` - Create a payment token
|
|
1890
1902
|
|
|
1891
|
-
## Training
|
|
1903
|
+
## Training-analytics
|
|
1892
1904
|
|
|
1893
1905
|
- `getWorkspacesAnalytics-batch()` - Get training analytics for multiple workspaces in a single request (max 50)
|
|
1894
1906
|
- `getWorkspacesByWorkspaceIdTrainingAnalytics()` - Get training analytics for a specific workspace
|
|
1895
1907
|
|
|
1908
|
+
## Training-example
|
|
1909
|
+
|
|
1910
|
+
- `getTraining-examples()` - List training examples with filtering support
|
|
1911
|
+
- `getTraining-examplesById()` - Fetch a single TrainingExample by ID.
|
|
1912
|
+
- `postTraining-examples()` - Create a single training example (golden example for few-shot learning)
|
|
1913
|
+
- `postTraining-examplesBulk()` - Create multiple training examples in a single transaction using `Ash.bulk_create`
|
|
1914
|
+
- `postTraining-examplesBulk-delete()` - Delete multiple training examples by ID in a single transaction
|
|
1915
|
+
- `postTraining-examplesSearch()` - Public entry point for semantic similarity search over training examples
|
|
1916
|
+
- `patchTraining-examplesById()` - Update an existing training example's input text, expected output JSON, notes,
|
|
1917
|
+
correction reasons, or image reference
|
|
1918
|
+
- `deleteTraining-examplesById()` - /training-examples/:id operation on training-example resource
|
|
1919
|
+
|
|
1920
|
+
## Training-session
|
|
1921
|
+
|
|
1922
|
+
- `getTraining-sessions()` - /training-sessions operation on training-session resource
|
|
1923
|
+
- `getTraining-sessionsAgentsByAgentIdSessions()` - /training-sessions/agents/:agent_id/sessions operation on training-session resource
|
|
1924
|
+
- `getTraining-sessionsById()` - /training-sessions/:id operation on training-session resource
|
|
1925
|
+
- `postTraining-sessions()` - /training-sessions operation on training-session resource
|
|
1926
|
+
- `patchTraining-sessionsByIdRevert()` - /training-sessions/:id/revert operation on training-session resource
|
|
1927
|
+
- `deleteTraining-sessionsById()` - /training-sessions/:id operation on training-session resource
|
|
1928
|
+
|
|
1896
1929
|
## Transaction
|
|
1897
1930
|
|
|
1898
1931
|
- `getTransactions()` - List all transactions belonging to the current tenant, filtered to the actor's tenant
|
|
@@ -1901,6 +1934,15 @@ context
|
|
|
1901
1934
|
- `postPayments()` - Process a payment (Auth + Capture)
|
|
1902
1935
|
- `postTransactionsByIdVoid()` - Void a transaction
|
|
1903
1936
|
|
|
1937
|
+
## Transcription-job
|
|
1938
|
+
|
|
1939
|
+
- `getVoiceTranscription-jobs()` - /voice/transcription-jobs operation on transcription-job resource
|
|
1940
|
+
- `getVoiceTranscription-jobsById()` - /voice/transcription-jobs/:id operation on transcription-job resource
|
|
1941
|
+
- `getVoiceTranscription-jobsMine()` - /voice/transcription-jobs/mine operation on transcription-job resource
|
|
1942
|
+
- `getVoiceTranscription-jobsWorkspaceByWorkspaceId()` - /voice/transcription-jobs/workspace/:workspace_id operation on transcription-job resource
|
|
1943
|
+
- `postVoiceTranscription-jobs()` - /voice/transcription-jobs operation on transcription-job resource
|
|
1944
|
+
- `deleteVoiceTranscription-jobsById()` - /voice/transcription-jobs/:id operation on transcription-job resource
|
|
1945
|
+
|
|
1904
1946
|
## Transfer
|
|
1905
1947
|
|
|
1906
1948
|
- `getTransfers()` - /transfers operation on transfer resource
|
|
@@ -1935,11 +1977,21 @@ context
|
|
|
1935
1977
|
- `getUsage-eventsById()` - /usage-events/:id operation on usage-event resource
|
|
1936
1978
|
- `getUsage-eventsSummary()` - List usage events for a tenant within a date range, intended for summary/dashboard views
|
|
1937
1979
|
|
|
1938
|
-
##
|
|
1980
|
+
## User-profile
|
|
1939
1981
|
|
|
1940
|
-
- `getUser-profiles()` - /user-profiles operation on
|
|
1941
|
-
- `getUser-profilesById()` - /user-profiles/:id operation on
|
|
1982
|
+
- `getUser-profiles()` - /user-profiles operation on user-profile resource
|
|
1983
|
+
- `getUser-profilesById()` - /user-profiles/:id operation on user-profile resource
|
|
1942
1984
|
- `getUser-profilesMe()` - Get the current user's profile
|
|
1985
|
+
- `postUser-profiles()` - Create a user profile record linked to an existing user
|
|
1986
|
+
- `patchUser-profilesById()` - Update the user's display profile fields: name, avatar, bio, social links, and
|
|
1987
|
+
raw preferences map
|
|
1988
|
+
- `patchUser-profilesByIdAccept-tos()` - Accept Terms of Service - merges with existing preferences
|
|
1989
|
+
- `patchUser-profilesByIdDismiss-announcement()` - Dismiss announcement - merges with existing preferences
|
|
1990
|
+
- `patchUser-profilesByIdDismiss-welcome()` - Dismiss welcome message - merges with existing preferences
|
|
1991
|
+
- `deleteUser-profilesById()` - /user-profiles/:id operation on user-profile resource
|
|
1992
|
+
|
|
1993
|
+
## Users
|
|
1994
|
+
|
|
1943
1995
|
- `getUsers()` - /users operation on user resource
|
|
1944
1996
|
- `getUsersBy-email()` - Look up a single user by their email address (case-insensitive)
|
|
1945
1997
|
- `getUsersById()` - /users/:id operation on user resource
|
|
@@ -1948,7 +2000,6 @@ context
|
|
|
1948
2000
|
- `getUsersMeDashboard()` - Get dashboard data for the user's tenant context
|
|
1949
2001
|
- `getUsersMeStats()` - Get stats for the user's tenant context
|
|
1950
2002
|
- `getUsersMeTenants()` - List all tenants the current user belongs to with their roles and permissions
|
|
1951
|
-
- `postUser-profiles()` - Create a user profile record linked to an existing user
|
|
1952
2003
|
- `postUsersAuthConfirm()` - Confirm a user's email address using a confirmation token
|
|
1953
2004
|
- `postUsersAuthLogin()` - Attempt to sign in using a username and password.
|
|
1954
2005
|
- `postUsersAuthMagic-linkLogin()` - /users/auth/magic-link/login operation on user resource
|
|
@@ -1960,65 +2011,69 @@ context
|
|
|
1960
2011
|
Microsoft)
|
|
1961
2012
|
- `postUsersAuthResend-confirmation()` - Resend confirmation email to an unconfirmed user
|
|
1962
2013
|
- `postUsersRegister-isv()` - Platform Admin action to register a new ISV (User + Tenant + App)
|
|
1963
|
-
- `patchUser-profilesById()` - Update the user's display profile fields: name, avatar, bio, social links, and
|
|
1964
|
-
raw preferences map
|
|
1965
|
-
- `patchUser-profilesByIdAccept-tos()` - Accept Terms of Service - merges with existing preferences
|
|
1966
|
-
- `patchUser-profilesByIdDismiss-announcement()` - Dismiss announcement - merges with existing preferences
|
|
1967
|
-
- `patchUser-profilesByIdDismiss-welcome()` - Dismiss welcome message - merges with existing preferences
|
|
1968
2014
|
- `patchUsersAuthPasswordChange()` - Change password for authenticated user with current password verification
|
|
1969
2015
|
- `patchUsersAuthReset-password()` - Reset password using admin-issued reset token
|
|
1970
2016
|
- `patchUsersById()` - Admin-only user management (platform admins) - promotes/demotes admin status
|
|
1971
2017
|
- `patchUsersByIdConfirm-email()` - Admin manually confirms user's email
|
|
1972
2018
|
- `patchUsersByIdEmail()` - Admin-only email update
|
|
1973
2019
|
- `patchUsersByIdReset-password()` - Admin triggers password reset email for user
|
|
1974
|
-
- `deleteUser-profilesById()` - /user-profiles/:id operation on user_profile resource
|
|
1975
2020
|
- `deleteUsersById()` - Permanently delete a user account
|
|
1976
2021
|
|
|
1977
|
-
## Voice
|
|
2022
|
+
## Voice-recording
|
|
1978
2023
|
|
|
1979
|
-
- `getVoiceRecordings()` - /voice/recordings operation on
|
|
1980
|
-
- `getVoiceRecordingsById()` - /voice/recordings/:id operation on
|
|
2024
|
+
- `getVoiceRecordings()` - /voice/recordings operation on voice-recording resource
|
|
2025
|
+
- `getVoiceRecordingsById()` - /voice/recordings/:id operation on voice-recording resource
|
|
1981
2026
|
- `getVoiceRecordingsSessionBySessionId()` - List recordings for a specific voice session
|
|
1982
2027
|
|
|
1983
|
-
## Voice
|
|
2028
|
+
## Voice-session
|
|
1984
2029
|
|
|
1985
|
-
- `getVoiceSessions()` - /voice/sessions operation on
|
|
1986
|
-
- `getVoiceSessionsById()` - /voice/sessions/:id operation on
|
|
2030
|
+
- `getVoiceSessions()` - /voice/sessions operation on voice-session resource
|
|
2031
|
+
- `getVoiceSessionsById()` - /voice/sessions/:id operation on voice-session resource
|
|
1987
2032
|
- `getVoiceSessionsMine()` - List current user's voice sessions
|
|
1988
2033
|
- `getVoiceSessionsWorkspaceByWorkspaceId()` - List all voice sessions in a workspace (ISV admin)
|
|
1989
2034
|
- `postVoiceSessions()` - Start a new voice session with LiveKit room provisioning
|
|
1990
2035
|
- `patchVoiceSessionsByIdFinalize()` - Dispatch accumulated transcript to the blueprint/chat pipeline
|
|
1991
2036
|
- `patchVoiceSessionsByIdStop()` - End a voice session and release the LiveKit room
|
|
1992
|
-
- `deleteVoiceSessionsById()` - /voice/sessions/:id operation on
|
|
2037
|
+
- `deleteVoiceSessionsById()` - /voice/sessions/:id operation on voice-session resource
|
|
1993
2038
|
|
|
1994
|
-
## Voice
|
|
2039
|
+
## Voice-transcription-result
|
|
1995
2040
|
|
|
1996
|
-
- `getVoiceTranscription-results()` - /voice/transcription-results operation on
|
|
1997
|
-
- `getVoiceTranscription-resultsById()` - /voice/transcription-results/:id operation on
|
|
2041
|
+
- `getVoiceTranscription-results()` - /voice/transcription-results operation on voice-transcription-result resource
|
|
2042
|
+
- `getVoiceTranscription-resultsById()` - /voice/transcription-results/:id operation on voice-transcription-result resource
|
|
1998
2043
|
- `getVoiceTranscription-resultsSessionBySessionId()` - List transcription results for a voice session
|
|
1999
|
-
- `postVoiceTranscription-results()` - /voice/transcription-results operation on
|
|
2044
|
+
- `postVoiceTranscription-results()` - /voice/transcription-results operation on voice-transcription-result resource
|
|
2000
2045
|
- `patchVoiceTranscription-resultsById()` - Correct or annotate a transcript's text, segments, or metadata.
|
|
2001
|
-
- `deleteVoiceTranscription-resultsById()` - /voice/transcription-results/:id operation on
|
|
2046
|
+
- `deleteVoiceTranscription-resultsById()` - /voice/transcription-results/:id operation on voice-transcription-result resource
|
|
2002
2047
|
|
|
2003
|
-
##
|
|
2048
|
+
## Wallet-public
|
|
2004
2049
|
|
|
2005
|
-
- `
|
|
2006
|
-
- `
|
|
2050
|
+
- `getWalletPlanPreview()` - Preview the cost and effective date of a plan change
|
|
2051
|
+
- `patchWalletAuto-top-up()` - Update auto-top-up settings
|
|
2052
|
+
- `patchWalletPaymentRetry()` - Retry a failed subscription payment
|
|
2053
|
+
- `patchWalletPlanCancel()` - Cancel the current subscription plan
|
|
2054
|
+
|
|
2055
|
+
## Webhook-config
|
|
2056
|
+
|
|
2057
|
+
- `getWebhook-configs()` - /webhook-configs operation on webhook-config resource
|
|
2058
|
+
- `getWebhook-configsById()` - /webhook-configs/:id operation on webhook-config resource
|
|
2007
2059
|
- `getWebhook-configsByIdEvents()` - List available events that can be subscribed to
|
|
2008
2060
|
- `getWebhook-configsStats()` - Get webhook configuration statistics
|
|
2009
|
-
- `getWebhook-deliveries()` - /webhook-deliveries operation on webhook_delivery resource
|
|
2010
|
-
- `getWebhook-deliveriesById()` - /webhook-deliveries/:id operation on webhook_delivery resource
|
|
2011
|
-
- `getWebhook-deliveriesStats()` - Return aggregate delivery counts by status (total, delivered, failed, retrying)
|
|
2012
2061
|
- `postWebhook-configs()` - Register a new webhook endpoint to receive platform events
|
|
2013
2062
|
- `postWebhook-configsBulk-disable()` - Disable multiple webhook configs by ID in a single call
|
|
2014
2063
|
- `postWebhook-configsBulk-enable()` - Enable multiple webhook configs by ID in a single call
|
|
2015
2064
|
- `postWebhook-configsByIdReplay()` - Replay historical events to this webhook
|
|
2016
2065
|
- `postWebhook-configsByIdTest()` - Send a realistic sample payload to the webhook URL to verify connectivity and signature verification
|
|
2017
|
-
- `postWebhook-deliveriesBulk-retry()` - Set multiple delivery records to `:retrying` status in bulk
|
|
2018
|
-
- `postWebhook-deliveriesByIdRetry()` - Re-enqueue a failed or pending delivery for immediate re-dispatch
|
|
2019
2066
|
- `patchWebhook-configsById()` - Update webhook endpoint settings such as URL, subscribed events, and enabled state
|
|
2020
2067
|
- `patchWebhook-configsByIdRotate-secret()` - Generate a new `whsec_`-prefixed HMAC secret for this webhook, invalidating the previous secret immediately
|
|
2021
|
-
- `deleteWebhook-configsById()` - /webhook-configs/:id operation on
|
|
2068
|
+
- `deleteWebhook-configsById()` - /webhook-configs/:id operation on webhook-config resource
|
|
2069
|
+
|
|
2070
|
+
## Webhook-delivery
|
|
2071
|
+
|
|
2072
|
+
- `getWebhook-deliveries()` - /webhook-deliveries operation on webhook-delivery resource
|
|
2073
|
+
- `getWebhook-deliveriesById()` - /webhook-deliveries/:id operation on webhook-delivery resource
|
|
2074
|
+
- `getWebhook-deliveriesStats()` - Return aggregate delivery counts by status (total, delivered, failed, retrying)
|
|
2075
|
+
- `postWebhook-deliveriesBulk-retry()` - Set multiple delivery records to `:retrying` status in bulk
|
|
2076
|
+
- `postWebhook-deliveriesByIdRetry()` - Re-enqueue a failed or pending delivery for immediate re-dispatch
|
|
2022
2077
|
|
|
2023
2078
|
## Wholesale-agreement
|
|
2024
2079
|
|
|
@@ -2027,10 +2082,6 @@ raw preferences map
|
|
|
2027
2082
|
- `postWholesale-agreements()` - /wholesale-agreements operation on wholesale-agreement resource
|
|
2028
2083
|
- `patchWholesale-agreementsById()` - /wholesale-agreements/:id operation on wholesale-agreement resource
|
|
2029
2084
|
|
|
2030
|
-
## Workspace document stats
|
|
2031
|
-
|
|
2032
|
-
- `getTenantsByTenantIdWorkspaceStats()` - /tenants/:tenant_id/workspace_stats operation on workspace_document_stats resource
|
|
2033
|
-
|
|
2034
2085
|
## Workspace-agent-config
|
|
2035
2086
|
|
|
2036
2087
|
- `getWorkspace-agent-configs()` - /workspace-agent-configs operation on workspace-agent-config resource
|
|
@@ -2039,6 +2090,10 @@ raw preferences map
|
|
|
2039
2090
|
- `patchWorkspace-agent-configsById()` - /workspace-agent-configs/:id operation on workspace-agent-config resource
|
|
2040
2091
|
- `deleteWorkspace-agent-configsById()` - /workspace-agent-configs/:id operation on workspace-agent-config resource
|
|
2041
2092
|
|
|
2093
|
+
## Workspace-document-stats
|
|
2094
|
+
|
|
2095
|
+
- `getTenantsByTenantIdWorkspaceStats()` - /tenants/:tenant_id/workspace_stats operation on workspace-document-stats resource
|
|
2096
|
+
|
|
2042
2097
|
## Workspaces
|
|
2043
2098
|
|
|
2044
2099
|
- `getWorkspaces()` - List workspaces visible to the actor
|