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