@gpt-platform/client 0.3.3 → 0.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/llms.txt CHANGED
@@ -24,1001 +24,1069 @@ client.setConfig({
24
24
 
25
25
  ## Access log
26
26
 
27
- - `getAccess-logs()` - List access logs
28
- - `getAccess-logsById()` - Get access logs
27
+ - `getAccess-logs()` - /access-logs operation on access_log resource
28
+ - `getAccess-logsById()` - /access-logs/:id operation on access_log resource
29
29
 
30
30
  ## Agent stats
31
31
 
32
- - `getAgentsByIdStats()` - Get stats
32
+ - `getAgentsByIdStats()` - /agents/:id/stats operation on agent_stats resource
33
33
 
34
34
  ## Agent test result
35
35
 
36
- - `postAgent-test-results()` - Create agent test results
36
+ - `postAgent-test-results()` - Run an agent version against a document and return the test result
37
37
 
38
38
  ## Agent training stats
39
39
 
40
- - `getAgentsByIdTraining-stats()` - Get training stats
40
+ - `getAgentsByIdTraining-stats()` - /agents/:id/training-stats operation on agent_training_stats resource
41
41
 
42
42
  ## Agent usage
43
43
 
44
- - `getAgentsByIdUsage()` - Get usage
45
- - `getAgentsUsage()` - List usage
44
+ - `getAgentsByIdUsage()` - /agents/:id/usage operation on agent_usage resource
45
+ - `getAgentsUsage()` - Batch read usage for all accessible agents
46
46
 
47
47
  ## Agent version comparison
48
48
 
49
- - `postAgent-version-comparisons()` - Create agent version comparisons
49
+ - `postAgent-version-comparisons()` - Compare two agent versions and return the differences
50
50
 
51
51
  ## Agent version revision
52
52
 
53
- - `getAgent-version-revisions()` - List agent version revisions
54
- - `getAgent-version-revisionsById()` - Get agent version revisions
53
+ - `getAgent-version-revisions()` - /agent-version-revisions operation on agent_version_revision resource
54
+ - `getAgent-version-revisionsById()` - /agent-version-revisions/:id operation on agent_version_revision resource
55
55
 
56
56
  ## AI Agents
57
57
 
58
- - `getAgent-versions()` - List agent versions
59
- - `getAgent-versionsById()` - Get agent versions
60
- - `getAgent-versionsByIdMetrics()` - Get metrics
61
- - `getAgent-versionsByIdRevisions()` - Get revisions
62
- - `getAgents()` - List agents
63
- - `getAgentsById()` - Get agents
64
- - `getAgentsByIdSchema-versions()` - Get schema versions
65
- - `getAgentsByIdTraining-examples()` - Get training examples
66
- - `postAgent-versions()` - Create agent versions
67
- - `postAgent-versionsByIdAdd-system-field()` - Create add system field
68
- - `postAgent-versionsByIdRemove-system-field()` - Create remove system field
69
- - `postAgent-versionsByIdSet-system-fields()` - Create set system fields
70
- - `postAgents()` - Create agents
71
- - `postAgentsByIdAnalyze-training()` - Create analyze training
72
- - `postAgentsByIdClone()` - Create clone
73
- - `postAgentsByIdExport()` - Create export
74
- - `postAgentsByIdPublish-version()` - Create publish version
75
- - `postAgentsByIdRestore-version()` - Create restore version
76
- - `postAgentsByIdSchema-versions()` - Create schema versions
77
- - `postAgentsByIdSchema-versionsByVersionIdActivate()` - Create activate
78
- - `postAgentsByIdTeach()` - Create teach
79
- - `postAgentsByIdTest()` - Create test
80
- - `postAgentsByIdValidate()` - Create validate
81
- - `postAgentsClone-for-workspace()` - Create clone for workspace
82
- - `postAgentsImport()` - Create import
83
- - `postAgentsPredict()` - Create predict
84
- - `patchAgentsById()` - Update agents
85
- - `patchAgentsByIdSchema-versionsByVersionId()` - Update schema versions
86
- - `deleteAgent-versionsById()` - Delete agent versions
87
- - `deleteAgentsById()` - Delete agents
88
- - `deleteAgentsByIdTraining-examplesByExampleId()` - Delete training examples
58
+ - `getAgent-versions()` - List AgentVersions, optionally filtered to a specific agent
59
+ - `getAgent-versionsById()` - Fetch a single AgentVersion by ID
60
+ - `getAgent-versionsByIdMetrics()` - Get performance metrics for this version
61
+ - `getAgent-versionsByIdRevisions()` - List all revisions for a specific AgentVersion, sorted by revision number descending
62
+ - `getAgents()` - List all agents accessible in the current workspace
63
+ - `getAgentsById()` - Fetch a single agent by ID
64
+ - `getAgentsByIdSchema-versions()` - List all schema versions for this agent
65
+ - `getAgentsByIdTraining-examples()` - List training examples for this agent
66
+ - `postAgent-versions()` - Create a new AgentVersion snapshot
67
+ - `postAgent-versionsByIdAdd-system-field()` - Add a predefined system field to this version's schema
68
+ - `postAgent-versionsByIdRemove-system-field()` - Remove a system field from this version's schema
69
+ - `postAgent-versionsByIdSet-system-fields()` - Set which system fields are included in this version's schema (batch operation)
70
+ - `postAgents()` - Create a new agent
71
+ - `postAgentsByIdAnalyze-training()` - Analyze training examples for conflicts, coverage, and quality
72
+ - `postAgentsByIdClone()` - Clone the agent to a new one with a new name
73
+ - `postAgentsByIdExport()` - Export agent configuration and training examples
74
+ - `postAgentsByIdPublish-version()` - Create a new immutable version from current agent state
75
+ - `postAgentsByIdRestore-version()` - Restore the agent to a previously used version by activating it
76
+ - `postAgentsByIdSchema-versions()` - Create a new schema version for this agent
77
+ - `postAgentsByIdSchema-versionsByVersionIdActivate()` - Activate a specific schema version
78
+ - `postAgentsByIdTeach()` - Submit human corrections to improve agent training
79
+ - `postAgentsByIdTest()` - Run the agent against sample input
80
+ - `postAgentsByIdValidate()` - Validate sample output against agent schema
81
+ - `postAgentsClone-for-workspace()` - Clone a system agent for workspace-specific customization
82
+ - `postAgentsImport()` - Import an agent from a JSON payload produced by `:export`
83
+ - `postAgentsPredict()` - Predicts the best agents for a given input
84
+ - `patchAgentsById()` - Update agent metadata such as name, description, domain, tags, and instructions
85
+ - `patchAgentsByIdSchema-versionsByVersionId()` - Update a schema version without creating a new version
86
+ - `deleteAgent-versionsById()` - Delete an AgentVersion
87
+ - `deleteAgentsById()` - Permanently delete an agent and cascade-destroy all associated data
88
+ - `deleteAgentsByIdTraining-examplesByExampleId()` - Delete a training example belonging to this agent
89
89
 
90
90
  ## AI Training
91
91
 
92
- - `getTraining-examples()` - List training examples
93
- - `getTraining-examplesById()` - Get training examples
94
- - `getTraining-sessionsAgentsByAgentIdSessions()` - Get sessions
95
- - `getTraining-sessionsById()` - Get training sessions
96
- - `postTraining-examples()` - Create training examples
97
- - `postTraining-examplesBulk()` - Create bulk
98
- - `postTraining-examplesBulk-delete()` - Create bulk delete
99
- - `postTraining-examplesSearch()` - Create search
100
- - `patchTraining-examplesById()` - Update training examples
101
- - `deleteTraining-examplesById()` - Delete training examples
102
- - `deleteTraining-sessionsById()` - Delete training sessions
92
+ - `getTraining-examples()` - List training examples with filtering support
93
+ - `getTraining-examplesById()` - Fetch a single TrainingExample by ID.
94
+ - `getTraining-sessionsAgentsByAgentIdSessions()` - /training-sessions/agents/:agent_id/sessions operation on training_session resource
95
+ - `getTraining-sessionsById()` - /training-sessions/:id operation on training_session resource
96
+ - `postTraining-examples()` - Create a single training example (golden example for few-shot learning)
97
+ - `postTraining-examplesBulk()` - Create multiple training examples in a single transaction using `Ash.bulk_create`
98
+ - `postTraining-examplesBulk-delete()` - Delete multiple training examples by ID in a single transaction
99
+ - `postTraining-examplesSearch()` - Public entry point for semantic similarity search over training examples
100
+ - `patchTraining-examplesById()` - Update an existing training example's input text, expected output JSON, notes,
101
+ correction reasons, or image reference
102
+ - `deleteTraining-examplesById()` - /training-examples/:id operation on training_example resource
103
+ - `deleteTraining-sessionsById()` - /training-sessions/:id operation on training_session resource
103
104
 
104
105
  ## Analytics
105
106
 
106
- - `getLlmAnalytics()` - List llm analytics
107
- - `getLlmAnalyticsById()` - Get llm analytics
108
- - `getLlmAnalyticsCosts()` - List costs
109
- - `getLlmAnalyticsPlatform()` - List platform
110
- - `getLlmAnalyticsSummary()` - List summary
111
- - `getLlmAnalyticsUsage()` - List usage
112
- - `getLlmAnalyticsWorkspace()` - List workspace
113
- - `postLlmAnalytics()` - Create llm analytics
107
+ - `getLlmAnalytics()` - List LLM analytics records sorted by created_at descending; scoped to the caller's tenant.
108
+ - `getLlmAnalyticsById()` - /llm_analytics/:id operation on llm_analytics resource
109
+ - `getLlmAnalyticsCosts()` - Retrieve cost-focused analytics records for the caller's tenant; use for billing reconciliation and cost analysis.
110
+ - `getLlmAnalyticsPlatform()` - Platform-wide analytics summary (platform admin only)
111
+ - `getLlmAnalyticsSummary()` - Aggregate LLM usage and cost statistics optionally filtered by a date range; returns a single summary record.
112
+ - `getLlmAnalyticsUsage()` - Return token usage summary analytics for the caller's tenant; useful for quota monitoring and capacity planning.
113
+ - `getLlmAnalyticsWorkspace()` - Fetch LLM analytics scoped to a single workspace; use for per-workspace usage dashboards and cost attribution.
114
+ - `postLlmAnalytics()` - Append a single LLM call analytics record (model, tokens, latency, cost); called by the billing/analytics pipeline after each LLM invocation
114
115
 
115
116
  ## API Keys
116
117
 
117
- - `getApi-keys()` - List api keys
118
- - `getApi-keysActive()` - List active
119
- - `getApi-keysById()` - Get api keys
120
- - `getApi-keysStats()` - List stats
121
- - `postApi-keys()` - Create api keys
122
- - `patchApi-keysById()` - Update api keys
123
- - `patchApi-keysByIdAllocate()` - Update allocate
124
- - `patchApi-keysByIdReset-period()` - Update reset period
125
- - `patchApi-keysByIdRevoke()` - Update revoke
126
- - `patchApi-keysByIdRotate()` - Update rotate
127
- - `patchApi-keysByIdSet-budget()` - Update set budget
128
- - `deleteApi-keysById()` - Delete api keys
118
+ - `getApi-keys()` - List or fetch API keys
119
+ - `getApi-keysActive()` - List only active API keys
120
+ - `getApi-keysById()` - List or fetch API keys
121
+ - `getApi-keysStats()` - Get API keys with usage statistics for a tenant
122
+ - `postApi-keys()` - Create a new API key for the authenticated actor
123
+ - `patchApi-keysById()` - Update mutable API key properties: name, scopes, rate limit, and credit limit
124
+ - `patchApi-keysByIdReset-period()` - Reset budget period (for testing or manual reset)
125
+ - `patchApi-keysByIdRevoke()` - Revoke an API key, setting its status to :revoked and recording the revocation
126
+ timestamp
127
+ - `patchApi-keysByIdRotate()` - Rotate an API key by generating a new token while preserving the key's id,
128
+ metadata, and configuration
129
+ - `patchApi-keysByIdSet-budget()` - Set or remove credit budget for this API key
130
+ - `deleteApi-keysById()` - Permanently delete an API key record
129
131
 
130
132
  ## Applications
131
133
 
132
- - `getApplications()` - List applications
133
- - `getApplicationsBy-slugBySlug()` - Get by slug
134
- - `getApplicationsById()` - Get applications
135
- - `getApplicationsCurrent()` - List current
136
- - `postApplications()` - Create applications
137
- - `patchApplicationsById()` - Update applications
138
- - `patchApplicationsByIdAllocate-credits()` - Update allocate credits
139
- - `patchApplicationsByIdGrant-credits()` - Update grant credits
140
- - `deleteApplicationsById()` - Delete applications
134
+ - `getApplications()` - /applications operation on application resource
135
+ - `getApplicationsBy-slugBySlug()` - Fetch a single application by its unique slug
136
+ - `getApplicationsById()` - /applications/:id operation on application resource
137
+ - `getApplicationsCurrent()` - Get the current application based on x-application-key header context
138
+ - `postApplications()` - Register a new ISV application on the platform
139
+ - `patchApplicationsById()` - Update application configuration including branding, email settings, capability
140
+ flags, workspace mode, and execution limits
141
+ - `patchApplicationsByIdAllocate-credits()` - Allocate credits to the account associated with this Application
142
+ - `patchApplicationsByIdGrant-credits()` - Allocates promotional credits to a specific tenant on behalf of the application
143
+ - `deleteApplicationsById()` - Permanently delete an application and all associated data
141
144
 
142
145
  ## Audit chain entry
143
146
 
144
- - `getAudit-chain-entries()` - List audit chain entries
145
- - `getAudit-chain-entriesById()` - Get audit chain entries
147
+ - `getAudit-chain-entries()` - /audit-chain-entries operation on audit_chain_entry resource
148
+ - `getAudit-chain-entriesById()` - /audit-chain-entries/:id operation on audit_chain_entry resource
146
149
 
147
150
  ## Audit-log
148
151
 
149
- - `getAudit-logs()` - List audit logs
150
- - `getAudit-logsActivity()` - List activity
152
+ - `getAudit-logs()` - List audit log entries
153
+ - `getAudit-logsActivity()` - Fetch a scoped, paginated activity feed for a tenant; optionally filter by workspace_id, activity_type, date range, or actor
154
+ - `getAudit-logsCount-by-action()` - Return a per-action count for a tenant's audit logs
155
+ - `postAudit-logsExport()` - Enqueue a bulk export job for audit logs
151
156
 
152
157
  ## Billing
153
158
 
154
- - `getCredit-packages()` - List credit packages
155
- - `getCredit-packagesById()` - Get credit packages
156
- - `getCredit-packagesSlugBySlug()` - Get slug
157
- - `getPlans()` - List plans
158
- - `getPlansById()` - Get plans
159
- - `getPlansSlugBySlug()` - Get slug
160
- - `getWallet()` - List wallet
161
- - `getWalletPlanPreview()` - List preview
162
- - `postPayments()` - Create payments
163
- - `patchWalletAddons()` - Update addons
164
- - `patchWalletAddonsByAddonSlugCancel()` - Update cancel
165
- - `patchWalletAuto-top-up()` - Update auto top up
166
- - `patchWalletCredits()` - Update credits
167
- - `patchWalletPlan()` - Update plan
159
+ - `getCredit-packages()` - /credit-packages operation on credit_package resource
160
+ - `getCredit-packagesById()` - /credit-packages/:id operation on credit_package resource
161
+ - `getCredit-packagesSlugBySlug()` - /credit-packages/slug/:slug operation on credit_package resource
162
+ - `getPlans()` - /plans operation on plan resource
163
+ - `getPlansById()` - /plans/:id operation on plan resource
164
+ - `getPlansSlugBySlug()` - /plans/slug/:slug operation on plan resource
165
+ - `getWallet()` - Reads the wallet for the current tenant
166
+ - `getWalletPlanPreview()` - Preview the cost and effective date of a plan change
167
+ - `postPayments()` - Process a payment
168
+ - `patchWalletAddons()` - Purchase an add-on for the wallet
169
+ - `patchWalletAddonsByAddonSlugCancel()` - Cancel an add-on for the wallet
170
+ - `patchWalletAuto-top-up()` - Update auto-top-up settings
171
+ - `patchWalletCredits()` - Purchase credits (Top-up)
172
+ - `patchWalletPlan()` - Change the main plan for the wallet
168
173
 
169
174
  ## Breach incident
170
175
 
171
- - `getBreach-incidents()` - List breach incidents
172
- - `getBreach-incidentsById()` - Get breach incidents
173
- - `postBreach-incidents()` - Create breach incidents
174
- - `patchBreach-incidentsByIdStatus()` - Update status
176
+ - `getBreach-incidents()` - /breach-incidents operation on breach_incident resource
177
+ - `getBreach-incidentsById()` - /breach-incidents/:id operation on breach_incident resource
178
+ - `postBreach-incidents()` - Report a new data breach or security incident
179
+ - `patchBreach-incidentsByIdStatus()` - Advance a breach incident through its lifecycle (identified → investigating → notifying → resolved / false_positive) and record officer notification and remediation notes.
175
180
 
176
181
  ## Breach notification
177
182
 
178
- - `getBreach-notifications()` - List breach notifications
179
- - `getBreach-notificationsById()` - Get breach notifications
183
+ - `getBreach-notifications()` - /breach-notifications operation on breach_notification resource
184
+ - `getBreach-notificationsById()` - /breach-notifications/:id operation on breach_notification resource
180
185
 
181
186
  ## Bulk dismissal result
182
187
 
183
- - `postWorkspacesByWorkspaceIdExtractionDocumentsDismiss-all-trained()` - Create dismiss all trained
188
+ - `postWorkspacesByWorkspaceIdExtractionDocumentsDismiss-all-trained()` - /workspaces/:workspace_id/extraction/documents/dismiss-all-trained operation on bulk_dismissal_result resource
184
189
 
185
190
  ## Bulk reprocess result
186
191
 
187
- - `postExtractionDocumentsBulk-reprocess()` - Create bulk reprocess
192
+ - `postExtractionDocumentsBulk-reprocess()` - /extraction/documents/bulk-reprocess operation on bulk_reprocess_result resource
193
+
194
+ ## Campaign
195
+
196
+ - `getEmail-marketingCampaignsById()` - /email-marketing/campaigns/:id operation on campaign resource
197
+ - `getEmail-marketingCampaignsWorkspaceByWorkspaceId()` - /email-marketing/campaigns/workspace/:workspace_id operation on campaign resource
198
+ - `postEmail-marketingCampaigns()` - /email-marketing/campaigns operation on campaign resource
199
+ - `postEmail-marketingCampaignsByIdAnalyze()` - Run post-campaign AI analysis with insights and recommendations
200
+ - `postEmail-marketingCampaignsByIdCreate-followup()` - Create a re-engagement campaign for non-engaged recipients
201
+ - `postEmail-marketingCampaignsByIdExport()` - Export campaign data (recipients, results, or tracking) as CSV
202
+ - `postEmail-marketingCampaignsByIdGenerate-emails()` - /email-marketing/campaigns/:id/generate-emails operation on campaign resource
203
+ - `postEmail-marketingCampaignsByIdImport-recipients()` - /email-marketing/campaigns/:id/import-recipients operation on campaign resource
204
+ - `postEmail-marketingCampaignsByIdOptimize-send-times()` - Predict optimal send times per recipient using AI
205
+ - `postEmail-marketingCampaignsByIdOptimize-subjects()` - Generate A/B test subject line variants using AI
206
+ - `postEmail-marketingCampaignsByIdSend()` - Triggers batch sending for approved emails
207
+ - `patchEmail-marketingCampaignsById()` - /email-marketing/campaigns/:id operation on campaign resource
208
+ - `deleteEmail-marketingCampaignsById()` - /email-marketing/campaigns/:id operation on campaign resource
188
209
 
189
210
  ## Catalog option type
190
211
 
191
- - `getCatalogOption-typesApplicationByApplicationId()` - Get application
192
- - `getCatalogOption-typesById()` - Get option types
193
- - `postCatalogOption-types()` - Create option types
194
- - `patchCatalogOption-typesById()` - Update option types
195
- - `deleteCatalogOption-typesById()` - Delete option types
212
+ - `getCatalogOption-typesApplicationByApplicationId()` - List all option types for an application ordered by position
213
+ - `getCatalogOption-typesById()` - /catalog/option-types/:id operation on catalog_option_type resource
214
+ - `postCatalogOption-types()` - Create an option type (e.g., Size, Color) for an application; shared across all tenants
215
+ - `patchCatalogOption-typesById()` - Update the name, slug, or display position of an option type
216
+ - `deleteCatalogOption-typesById()` - Permanently delete an option type and all its values; cascades to variant_option_values
196
217
 
197
218
  ## Catalog option value
198
219
 
199
- - `getCatalogOption-valuesById()` - Get option values
200
- - `getCatalogOption-valuesOption-typeByOptionTypeId()` - Get option type
201
- - `postCatalogOption-values()` - Create option values
202
- - `patchCatalogOption-valuesById()` - Update option values
203
- - `deleteCatalogOption-valuesById()` - Delete option values
220
+ - `getCatalogOption-valuesById()` - /catalog/option-values/:id operation on catalog_option_value resource
221
+ - `getCatalogOption-valuesOption-typeByOptionTypeId()` - List all values for an option type ordered by position
222
+ - `postCatalogOption-values()` - Create a specific option value (e.g., 'Large', 'Red') within an option type
223
+ - `patchCatalogOption-valuesById()` - Update the name, slug, position, or metadata of an option value
224
+ - `deleteCatalogOption-valuesById()` - Permanently delete an option value; removes associated variant_option_values
204
225
 
205
226
  ## Catalog price list
206
227
 
207
- - `getCatalogPrice-listsApplicationByApplicationId()` - Get application
208
- - `getCatalogPrice-listsById()` - Get price lists
209
- - `postCatalogPrice-lists()` - Create price lists
210
- - `patchCatalogPrice-listsById()` - Update price lists
211
- - `deleteCatalogPrice-listsById()` - Delete price lists
228
+ - `getCatalogPrice-listsApplicationByApplicationId()` - List all price lists for an application, ordered by priority
229
+ - `getCatalogPrice-listsById()` - /catalog/price-lists/:id operation on catalog_price_list resource
230
+ - `postCatalogPrice-lists()` - Create a named price list for an application with a strategy (fixed, percentage_discount, or tiered)
231
+ - `patchCatalogPrice-listsById()` - Update price list metadata, strategy, or validity period
232
+ - `deleteCatalogPrice-listsById()` - Permanently delete a price list and all its entries
212
233
 
213
234
  ## Catalog price list entry
214
235
 
215
- - `getCatalogPrice-list-entriesPrice-listByPriceListId()` - Get price list
216
- - `postCatalogPrice-list-entries()` - Create price list entries
217
- - `patchCatalogPrice-list-entriesById()` - Update price list entries
218
- - `deleteCatalogPrice-list-entriesById()` - Delete price list entries
236
+ - `getCatalogPrice-list-entriesPrice-listByPriceListId()` - List all entries in a price list
237
+ - `postCatalogPrice-list-entries()` - Add a pricing entry to a price list for a product or variant; supply a fixed price, modifier, or tiered structure
238
+ - `patchCatalogPrice-list-entriesById()` - Update the price, modifier, tiers, or floor price for an existing entry
239
+ - `deleteCatalogPrice-list-entriesById()` - Permanently delete a price list entry
219
240
 
220
241
  ## Catalog product
221
242
 
222
- - `getCatalogProductsById()` - Get products
223
- - `getCatalogProductsWorkspaceByWorkspaceId()` - Get workspace
224
- - `postCatalogProducts()` - Create products
225
- - `patchCatalogProductsById()` - Update products
226
- - `deleteCatalogProductsById()` - Delete products
243
+ - `getCatalogProductsById()` - /catalog/products/:id operation on catalog_product resource
244
+ - `getCatalogProductsWorkspaceByWorkspaceId()` - List all active (non-deleted) products in a workspace
245
+ - `postCatalogProducts()` - Create a new catalog product in a workspace; triggers search indexing and enqueues embedding generation
246
+ - `patchCatalogProductsById()` - Update a product's attributes; triggers search re-indexing and embedding refresh
247
+ - `deleteCatalogProductsById()` - Soft-delete a product by stamping deleted_at; excluded from all future reads
227
248
 
228
249
  ## Catalog product variant
229
250
 
230
- - `getCatalogProduct-variantsById()` - Get product variants
231
- - `getCatalogProduct-variantsProductByProductId()` - Get product
232
- - `postCatalogProduct-variants()` - Create product variants
233
- - `patchCatalogProduct-variantsById()` - Update product variants
234
- - `deleteCatalogProduct-variantsById()` - Delete product variants
251
+ - `getCatalogProduct-variantsById()` - /catalog/product-variants/:id operation on catalog_product_variant resource
252
+ - `getCatalogProduct-variantsProductByProductId()` - List all active variants for a given product, sorted by position
253
+ - `postCatalogProduct-variants()` - Create a product variant (SKU, price override, option values); enforces max_variants_per_product quota
254
+ - `patchCatalogProduct-variantsById()` - Update a variant's SKU, pricing, properties, or media
255
+ - `deleteCatalogProduct-variantsById()` - Soft-delete a variant by setting deleted_at; excluded from future reads
235
256
 
236
257
  ## Catalog taxonomy
237
258
 
238
- - `getCatalogTaxonomiesApplicationByApplicationId()` - Get application
239
- - `getCatalogTaxonomiesById()` - Get taxonomies
240
- - `postCatalogTaxonomies()` - Create taxonomies
241
- - `patchCatalogTaxonomiesById()` - Update taxonomies
242
- - `deleteCatalogTaxonomiesById()` - Delete taxonomies
259
+ - `getCatalogTaxonomiesApplicationByApplicationId()` - List active taxonomies for an application
260
+ - `getCatalogTaxonomiesById()` - /catalog/taxonomies/:id operation on catalog_taxonomy resource
261
+ - `postCatalogTaxonomies()` - Create a new taxonomy (classification axis) for an application; enforces max_taxonomies quota
262
+ - `patchCatalogTaxonomiesById()` - Update taxonomy metadata (name, slug, hierarchy settings)
263
+ - `deleteCatalogTaxonomiesById()` - Soft-delete a taxonomy by setting deleted_at; cascades to exclude nodes from future reads
243
264
 
244
265
  ## Catalog taxonomy node
245
266
 
246
- - `getCatalogTaxonomy-nodesById()` - Get taxonomy nodes
247
- - `getCatalogTaxonomy-nodesTaxonomyByTaxonomyId()` - Get taxonomy
248
- - `postCatalogTaxonomy-nodes()` - Create taxonomy nodes
249
- - `patchCatalogTaxonomy-nodesById()` - Update taxonomy nodes
250
- - `deleteCatalogTaxonomy-nodesById()` - Delete taxonomy nodes
267
+ - `getCatalogTaxonomy-nodesById()` - /catalog/taxonomy-nodes/:id operation on catalog_taxonomy_node resource
268
+ - `getCatalogTaxonomy-nodesTaxonomyByTaxonomyId()` - List all active nodes in a taxonomy
269
+ - `postCatalogTaxonomy-nodes()` - Create a taxonomy node (category) at the given position in the tree; validates hierarchy depth
270
+ - `patchCatalogTaxonomy-nodesById()` - Update a node's name, slug, position, or parent; re-validates tree depth
271
+ - `deleteCatalogTaxonomy-nodesById()` - Soft-delete a taxonomy node by stamping deleted_at; child nodes are not auto-deleted
251
272
 
252
273
  ## Catalog view
253
274
 
254
- - `getCatalogViewsById()` - Get views
255
- - `getCatalogViewsWorkspaceByWorkspaceId()` - Get workspace
256
- - `postCatalogViews()` - Create views
257
- - `patchCatalogViewsById()` - Update views
258
- - `deleteCatalogViewsById()` - Delete views
275
+ - `getCatalogViewsById()` - /catalog/views/:id operation on catalog_view resource
276
+ - `getCatalogViewsWorkspaceByWorkspaceId()` - List all catalog views in a workspace
277
+ - `postCatalogViews()` - Create a catalog view (named product lens) in a workspace; enforces max_catalog_views quota
278
+ - `patchCatalogViewsById()` - Update view metadata, filtering rules, or pricing association
279
+ - `deleteCatalogViewsById()` - Permanently delete a catalog view and its rules and overrides
259
280
 
260
281
  ## Config
261
282
 
262
- - `getConfigs()` - List configs
263
- - `postConfigs()` - Create configs
264
- - `patchConfigsByKey()` - Update configs
283
+ - `getConfigs()` - /configs operation on config resource
284
+ - `postConfigs()` - Create or upsert a platform config entry by key; if the key already exists its value, description, and sensitivity flag are updated
285
+ - `patchConfigsByKey()` - Update the value, description, or sensitivity flag for an existing config entry; automatically invalidates the FetchConfig cache for the key
265
286
 
266
287
  ## Connector instance
267
288
 
268
- - `getConnectors()` - List connectors
269
- - `getConnectorsById()` - Get connectors
270
- - `postConnectors()` - Create connectors
271
- - `postConnectorsFullscriptCheck-patient()` - Create check patient
272
- - `postConnectorsFullscriptCreate-patient()` - Create create patient
273
- - `postConnectorsFullscriptSession-grant()` - Create session grant
274
- - `postConnectorsOauthCallback()` - Create callback
275
- - `postConnectorsOauthInitiate()` - Create initiate
276
- - `patchConnectorsById()` - Update connectors
277
- - `deleteConnectorsById()` - Delete connectors
289
+ - `getConnectors()` - /connectors operation on connector_instance resource
290
+ - `getConnectorsById()` - /connectors/:id operation on connector_instance resource
291
+ - `postConnectors()` - Install a new connector instance in a workspace
292
+ - `postConnectorsByIdEdamamRecipesGet()` - Get full details for a single recipe by Edamam recipe ID
293
+ - `postConnectorsByIdEdamamRecipesSearch()` - Search for recipes using the Edamam Recipe API
294
+ - `postConnectorsFullscriptCheck-patient()` - Check if a patient exists in Fullscript by email
295
+ - `postConnectorsFullscriptCreate-patient()` - Create a patient in Fullscript
296
+ - `postConnectorsFullscriptSession-grant()` - Get a Fullscript embed session grant token for the prescribing widget
297
+ - `postConnectorsOauthCallback()` - Exchange OAuth authorization code for credential.
298
+ - `postConnectorsOauthInitiate()` - Initiate OAuth flow for a connector type
299
+ - `patchConnectorsById()` - Update a connector instance's name, configuration, sync interval, health status, or metadata
300
+ - `deleteConnectorsById()` - /connectors/:id operation on connector_instance resource
278
301
 
279
302
  ## Consent record
280
303
 
281
- - `getConsent-records()` - List consent records
282
- - `getConsent-recordsActive()` - List active
283
- - `getConsent-recordsById()` - Get consent records
284
- - `postConsent-records()` - Create consent records
285
- - `patchConsent-recordsByIdWithdraw()` - Update withdraw
304
+ - `getConsent-records()` - /consent-records operation on consent_record resource
305
+ - `getConsent-recordsActive()` - List all currently granted (non-withdrawn) consents for a given user
306
+ - `getConsent-recordsById()` - /consent-records/:id operation on consent_record resource
307
+ - `postConsent-records()` - Record a new consent grant for a specific processing purpose (AI document processing, analytics, marketing, or third-party sharing)
308
+ - `patchConsent-recordsByIdWithdraw()` - Revoke an existing consent grant
286
309
 
287
310
  ## Conversations
288
311
 
289
- - `getAiConversations()` - List conversations
290
- - `getAiConversationsById()` - Get conversations
291
- - `postAiConversations()` - Create conversations
292
- - `patchAiConversationsById()` - Update conversations
293
- - `deleteAiConversationsById()` - Delete conversations
312
+ - `getAiConversations()` - /ai/conversations operation on conversation resource
313
+ - `getAiConversationsById()` - /ai/conversations/:id operation on conversation resource
314
+ - `postAiConversations()` - Start a new AI conversation session with optional structured context data (e.g., prediction results to discuss)
315
+ - `patchAiConversationsById()` - Update the conversation title or replace the context data map
316
+ - `deleteAiConversationsById()` - /ai/conversations/:id operation on conversation resource
294
317
 
295
318
  ## Crawler job
296
319
 
297
- - `getCrawlerJobs()` - List jobs
298
- - `getCrawlerJobsById()` - Get jobs
299
- - `postCrawlerJobs()` - Create jobs
300
- - `patchCrawlerJobsByIdCancel()` - Update cancel
301
- - `deleteCrawlerJobsById()` - Delete jobs
320
+ - `getCrawlerJobs()` - /crawler/jobs operation on crawler_job resource
321
+ - `getCrawlerJobsById()` - /crawler/jobs/:id operation on crawler_job resource
322
+ - `postCrawlerJobs()` - Create a crawl job for a URL with the specified mode and strategy; performs a credit pre-check and enqueues execution
323
+ - `patchCrawlerJobsByIdCancel()` - Cancel a pending or running job; sets status to :cancelled with completed_at timestamp
324
+ - `deleteCrawlerJobsById()` - /crawler/jobs/:id operation on crawler_job resource
302
325
 
303
326
  ## Crawler result
304
327
 
305
- - `getCrawlerResults()` - List results
306
- - `getCrawlerResultsById()` - Get results
328
+ - `getCrawlerResults()` - /crawler/results operation on crawler_result resource
329
+ - `getCrawlerResultsById()` - /crawler/results/:id operation on crawler_result resource
307
330
 
308
331
  ## Crawler schedule
309
332
 
310
- - `getCrawlerSchedules()` - List schedules
311
- - `getCrawlerSchedulesById()` - Get schedules
312
- - `postCrawlerSchedules()` - Create schedules
313
- - `patchCrawlerSchedulesById()` - Update schedules
314
- - `patchCrawlerSchedulesByIdDisable()` - Update disable
315
- - `patchCrawlerSchedulesByIdEnable()` - Update enable
316
- - `patchCrawlerSchedulesByIdTrigger()` - Update trigger
317
- - `deleteCrawlerSchedulesById()` - Delete schedules
333
+ - `getCrawlerSchedules()` - /crawler/schedules operation on crawler_schedule resource
334
+ - `getCrawlerSchedulesById()` - /crawler/schedules/:id operation on crawler_schedule resource
335
+ - `postCrawlerSchedules()` - Create a recurring crawl schedule for a URL; sets frequency, cron expression, and notification preferences
336
+ - `patchCrawlerSchedulesById()` - Update schedule configuration, URL, frequency, or notification settings
337
+ - `patchCrawlerSchedulesByIdDisable()` - Disable a schedule to pause automatic crawling without deleting the configuration.
338
+ - `patchCrawlerSchedulesByIdEnable()` - Enable a disabled schedule so it resumes automatic crawling on its next_run_at.
339
+ - `patchCrawlerSchedulesByIdTrigger()` - Manually trigger a scheduled crawl immediately.
340
+ - `deleteCrawlerSchedulesById()` - /crawler/schedules/:id operation on crawler_schedule resource
318
341
 
319
342
  ## Credential
320
343
 
321
- - `getConnectorsCredentials()` - List credentials
322
- - `getConnectorsCredentialsById()` - Get credentials
323
- - `postConnectorsCredentialsByIdRefresh()` - Create refresh
344
+ - `getConnectorsCredentials()` - /connectors/credentials operation on credential resource
345
+ - `getConnectorsCredentialsById()` - /connectors/credentials/:id operation on credential resource
346
+ - `postConnectorsCredentialsByIdRefresh()` - Refresh OAuth credential token.
324
347
 
325
348
  ## Crm activity
326
349
 
327
- - `getCrmActivitiesById()` - Get activities
328
- - `getCrmActivitiesWorkspaceByWorkspaceId()` - Get workspace
329
- - `postCrmActivities()` - Create activities
330
- - `deleteCrmActivitiesById()` - Delete activities
350
+ - `getCrmActivitiesById()` - Fetch a single active activity by ID; excludes soft-deleted records.
351
+ - `getCrmActivitiesWorkspaceByWorkspaceId()` - List active activities in a workspace with offset pagination
352
+ - `postCrmActivities()` - Log a CRM activity (call, email, meeting, note, etc.) linked to the workspace
353
+ - `deleteCrmActivitiesById()` - Soft-delete an activity by setting deleted_at
331
354
 
332
355
  ## Crm company
333
356
 
334
- - `getCrmCompaniesById()` - Get companies
335
- - `getCrmCompaniesWorkspaceByWorkspaceId()` - Get workspace
336
- - `postCrmCompanies()` - Create companies
337
- - `patchCrmCompaniesById()` - Update companies
338
- - `deleteCrmCompaniesById()` - Delete companies
357
+ - `getCrmCompaniesById()` - Fetch a single active company by ID; excludes soft-deleted records.
358
+ - `getCrmCompaniesWorkspaceByWorkspaceId()` - List active companies in a workspace with offset pagination
359
+ - `postCrmCompanies()` - Create a new CRM company
360
+ - `patchCrmCompaniesById()` - Update mutable fields on an existing company
361
+ - `deleteCrmCompaniesById()` - Soft-delete a company by setting deleted_at
339
362
 
340
363
  ## Crm contact
341
364
 
342
- - `getCrmContactsById()` - Get contacts
343
- - `getCrmContactsWorkspaceByWorkspaceId()` - Get workspace
344
- - `postCrmContacts()` - Create contacts
345
- - `patchCrmContactsById()` - Update contacts
346
- - `deleteCrmContactsById()` - Delete contacts
365
+ - `getCrmContactsById()` - Fetch a single active contact by ID; excludes soft-deleted records.
366
+ - `getCrmContactsWorkspaceByWorkspaceId()` - List active contacts in a workspace with optional lifecycle_stage, tag, and
367
+ property filters applied Elixir-side
368
+ - `getCrmContactsWorkspaceByWorkspaceIdArchived()` - List contacts that have been soft-archived (deleted_at is set) in a workspace.
369
+ - `postCrmContacts()` - Create a new CRM contact
370
+ - `postCrmContactsByIdUnarchive()` - Restore an archived contact (clears deleted_at)
371
+ - `patchCrmContactsById()` - Update mutable fields on an existing contact
372
+ - `patchCrmContactsByIdArchive()` - Soft-archive a contact (sets deleted_at)
373
+ - `deleteCrmContactsById()` - Soft-delete a contact by setting deleted_at
347
374
 
348
375
  ## Crm custom entity
349
376
 
350
- - `getCrmCustom-entitiesById()` - Get custom entities
351
- - `getCrmCustom-entitiesWorkspaceByWorkspaceId()` - Get workspace
352
- - `postCrmCustom-entities()` - Create custom entities
353
- - `patchCrmCustom-entitiesById()` - Update custom entities
354
- - `deleteCrmCustom-entitiesById()` - Delete custom entities
377
+ - `getCrmCustom-entitiesById()` - Fetch a single active custom entity by ID; excludes soft-deleted records.
378
+ - `getCrmCustom-entitiesWorkspaceByWorkspaceId()` - List active custom entities in a workspace, optionally filtered by type slug and
379
+ attribute-level property filters
380
+ - `postCrmCustom-entities()` - Create an instance of a custom entity type
381
+ - `patchCrmCustom-entitiesById()` - Update a custom entity's properties and pipeline assignment
382
+ - `deleteCrmCustom-entitiesById()` - Soft-delete a custom entity by setting deleted_at
355
383
 
356
384
  ## Crm custom entity version
357
385
 
358
- - `getCrmCustom-entitiesByEntityIdVersions()` - Get versions
359
- - `getCrmCustom-entitiesByEntityIdVersionsById()` - Get versions
386
+ - `getCrmCustom-entitiesByEntityIdVersions()` - /crm/custom-entities/:entity_id/versions operation on crm_custom_entity_version resource
387
+ - `getCrmCustom-entitiesByEntityIdVersionsById()` - Fetch a single version by ID, scoped to a specific entity (IDOR-safe)
360
388
 
361
389
  ## Crm data export job
362
390
 
363
- - `getCrmExportsById()` - Get exports
364
- - `getCrmExportsWorkspaceByWorkspaceId()` - Get workspace
365
- - `postCrmExports()` - Create exports
391
+ - `getCrmExportsById()` - Fetch a single export job by ID
392
+ - `getCrmExportsWorkspaceByWorkspaceId()` - List all export jobs for a workspace, sorted newest first
393
+ - `postCrmExports()` - Enqueue an async CRM data export job
366
394
 
367
395
  ## Crm deal
368
396
 
369
- - `getCrmDealsById()` - Get deals
370
- - `getCrmDealsWorkspaceByWorkspaceId()` - Get workspace
371
- - `postCrmDeals()` - Create deals
372
- - `patchCrmDealsById()` - Update deals
373
- - `deleteCrmDealsById()` - Delete deals
397
+ - `getCrmDealsById()` - Fetch a single active deal by ID; excludes soft-deleted records.
398
+ - `getCrmDealsWorkspaceByWorkspaceId()` - List active deals in a workspace with offset pagination
399
+ - `postCrmDeals()` - Create a new CRM deal and place it in a pipeline stage
400
+ - `patchCrmDealsById()` - Update deal fields including status, AI scores, and pipeline assignment
401
+ - `deleteCrmDealsById()` - Soft-delete a deal by setting deleted_at
374
402
 
375
403
  ## Crm pipeline
376
404
 
377
- - `getCrmPipelinesById()` - Get pipelines
378
- - `getCrmPipelinesWorkspaceByWorkspaceId()` - Get workspace
379
- - `postCrmPipelines()` - Create pipelines
380
- - `patchCrmPipelinesById()` - Update pipelines
381
- - `deleteCrmPipelinesById()` - Delete pipelines
405
+ - `getCrmPipelinesById()` - /crm/pipelines/:id operation on crm_pipeline resource
406
+ - `getCrmPipelinesWorkspaceByWorkspaceId()` - List pipelines available to a workspace — includes both workspace-specific pipelines and application-level templates (workspace_id IS NULL).
407
+ - `postCrmPipelines()` - Create a pipeline scoped to an application (template) or a specific workspace
408
+ - `patchCrmPipelinesById()` - Update a pipeline's name or default status
409
+ - `deleteCrmPipelinesById()` - /crm/pipelines/:id operation on crm_pipeline resource
382
410
 
383
411
  ## Crm pipeline stage
384
412
 
385
- - `getCrmPipeline-stagesById()` - Get pipeline stages
386
- - `postCrmPipeline-stages()` - Create pipeline stages
387
- - `patchCrmPipeline-stagesById()` - Update pipeline stages
388
- - `deleteCrmPipeline-stagesById()` - Delete pipeline stages
413
+ - `getCrmPipeline-stagesById()` - /crm/pipeline-stages/:id operation on crm_pipeline_stage resource
414
+ - `postCrmPipeline-stages()` - Add a stage to a pipeline with an explicit sort order, optional win probability, and forecast category
415
+ - `patchCrmPipeline-stagesById()` - Update a pipeline stage's name, order, probability, or closed flag
416
+ - `deleteCrmPipeline-stagesById()` - /crm/pipeline-stages/:id operation on crm_pipeline_stage resource
389
417
 
390
418
  ## Crm relationship
391
419
 
392
- - `getCrmRelationshipsById()` - Get relationships
393
- - `getCrmRelationshipsWorkspaceByWorkspaceId()` - Get workspace
394
- - `postCrmRelationships()` - Create relationships
395
- - `deleteCrmRelationshipsById()` - Delete relationships
420
+ - `getCrmRelationshipsById()` - Fetch a single CRM relationship by ID
421
+ - `getCrmRelationshipsWorkspaceByWorkspaceId()` - List all relationship edges in a workspace
422
+ - `postCrmRelationships()` - Create a typed relationship edge between two CRM entities
423
+ - `deleteCrmRelationshipsById()` - Permanently remove a relationship edge (hard delete)
396
424
 
397
425
  ## Crm relationship type
398
426
 
399
- - `getCrmRelationship-types()` - List relationship types
400
- - `getCrmRelationship-typesById()` - Get relationship types
401
- - `postCrmRelationship-types()` - Create relationship types
402
- - `patchCrmRelationship-typesById()` - Update relationship types
403
- - `deleteCrmRelationship-typesById()` - Delete relationship types
427
+ - `getCrmRelationship-types()` - /crm/relationship-types operation on crm_relationship_type resource
428
+ - `getCrmRelationship-typesById()` - /crm/relationship-types/:id operation on crm_relationship_type resource
429
+ - `postCrmRelationship-types()` - Define a named relationship category for an application
430
+ - `patchCrmRelationship-typesById()` - Update a relationship type's display name, allowed entity types, or properties schema
431
+ - `deleteCrmRelationship-typesById()` - /crm/relationship-types/:id operation on crm_relationship_type resource
404
432
 
405
433
  ## Data protection impact assessment
406
434
 
407
- - `getImpact-assessments()` - List impact assessments
408
- - `getImpact-assessmentsById()` - Get impact assessments
409
- - `postImpact-assessments()` - Create impact assessments
410
- - `patchImpact-assessmentsById()` - Update impact assessments
411
- - `patchImpact-assessmentsByIdApprove()` - Update approve
435
+ - `getImpact-assessments()` - /impact-assessments operation on data_protection_impact_assessment resource
436
+ - `getImpact-assessmentsById()` - /impact-assessments/:id operation on data_protection_impact_assessment resource
437
+ - `postImpact-assessments()` - Open a new GDPR Article 35 Data Protection Impact Assessment for a high-risk processing activity
438
+ - `patchImpact-assessmentsById()` - Update the DPIA's title, description, risk level, findings, or mitigations while it is in draft or in_review status
439
+ - `patchImpact-assessmentsByIdApprove()` - Approve a completed DPIA by recording the approver's name and setting `approved_at` to the current timestamp
412
440
 
413
441
  ## Data subject request
414
442
 
415
- - `getData-subject-requests()` - List data subject requests
416
- - `getData-subject-requestsById()` - Get data subject requests
417
- - `postData-subject-requests()` - Create data subject requests
418
- - `patchData-subject-requestsByIdStatus()` - Update status
443
+ - `getData-subject-requests()` - /data-subject-requests operation on data_subject_request resource
444
+ - `getData-subject-requestsById()` - /data-subject-requests/:id operation on data_subject_request resource
445
+ - `postData-subject-requests()` - Open a new GDPR/CCPA data subject request (access, erasure, portability, rectification, or restriction)
446
+ - `patchData-subject-requestsByIdStatus()` - Advance a data subject request through its lifecycle (pending → in_progress → completed / rejected / expired) and record notes or a completion timestamp.
419
447
 
420
448
  ## Document chunk
421
449
 
422
- - `getAiChunksDocumentByDocumentId()` - Get document
423
- - `postAiChunksSearch()` - Create search
450
+ - `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.
451
+ - `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.
424
452
 
425
453
  ## Document Extraction
426
454
 
427
- - `getExtractionDocuments()` - List documents
428
- - `getExtractionDocumentsById()` - Get documents
429
- - `getExtractionDocumentsByIdStatus()` - Get status
430
- - `getExtractionDocumentsByIdView()` - Get view
431
- - `getExtractionDocumentsWorkspaceByWorkspaceId()` - Get workspace
432
- - `getExtractionDocumentsWorkspaceByWorkspaceIdBy-statusByStatus()` - Get by status
433
- - `getExtractionDocumentsWorkspaceByWorkspaceIdExcluded()` - Get excluded
434
- - `getExtractionDocumentsWorkspaceByWorkspaceIdReview-queue()` - Get review queue
435
- - `getExtractionDocumentsWorkspaceByWorkspaceIdTrained()` - Get trained
436
- - `getExtractionDocumentsWorkspaceByWorkspaceIdTrashed()` - Get trashed
437
- - `postExtractionDocumentsBegin-upload()` - Create begin upload
438
- - `postExtractionDocumentsFind-or-begin-upload()` - Create find or begin upload
439
- - `postExtractionDocumentsUpload()` - Create upload
440
- - `patchExtractionDocumentsByIdCancel()` - Update cancel
441
- - `patchExtractionDocumentsByIdDismiss()` - Update dismiss
442
- - `patchExtractionDocumentsByIdDismiss-training()` - Update dismiss training
443
- - `patchExtractionDocumentsByIdExclude()` - Update exclude
444
- - `patchExtractionDocumentsByIdFinish-upload()` - Update finish upload
445
- - `patchExtractionDocumentsByIdInclude()` - Update include
446
- - `patchExtractionDocumentsByIdMark-trained()` - Update mark trained
447
- - `patchExtractionDocumentsByIdReprocess()` - Update reprocess
448
- - `patchExtractionDocumentsByIdRestore()` - Update restore
449
- - `patchExtractionDocumentsByIdStatus()` - Update status
450
- - `patchExtractionDocumentsByIdVerification()` - Update verification
451
- - `deleteExtractionDocumentsById()` - Delete documents
455
+ - `getExtractionDocuments()` - Primary read for active (non-deleted) documents
456
+ - `getExtractionDocumentsById()` - Primary read for active (non-deleted) documents
457
+ - `getExtractionDocumentsByIdStatus()` - Lightweight poll endpoint: fetches only `id`, `status`, `progress`, and `error_message` for
458
+ a single document
459
+ - `getExtractionDocumentsByIdView()` - Get a document with its presigned view URL
460
+ - `getExtractionDocumentsWorkspaceByWorkspaceId()` - List active (non-deleted) documents in a workspace, sorted by creation date
461
+ - `getExtractionDocumentsWorkspaceByWorkspaceIdBy-statusByStatus()` - Filter documents by workspace_id and processing status
462
+ - `getExtractionDocumentsWorkspaceByWorkspaceIdExcluded()` - List excluded documents
463
+ - `getExtractionDocumentsWorkspaceByWorkspaceIdReview-queue()` - Get prioritized review queue for active learning
464
+ - `getExtractionDocumentsWorkspaceByWorkspaceIdTrained()` - List documents that have been trained and not dismissed
465
+ - `getExtractionDocumentsWorkspaceByWorkspaceIdTrashed()` - List soft-deleted (trashed) documents
466
+ - `postExtractionDocumentsBegin-upload()` - Step 1 of 2 in the two-step upload flow
467
+ - `postExtractionDocumentsFind-or-begin-upload()` - Dedup-aware upload: returns existing document if file_hash matches, otherwise creates new document
468
+ - `postExtractionDocumentsUpload()` - Legacy single-step upload: create a document record and immediately enqueue processing
469
+ - `patchExtractionDocumentsByIdCancel()` - Cancel a processing document
470
+ - `patchExtractionDocumentsByIdDismiss()` - Alias for `:dismiss_training`
471
+ - `patchExtractionDocumentsByIdDismiss-training()` - Dismiss a trained document from the active-learning training dashboard without excluding it
472
+ from future training
473
+ - `patchExtractionDocumentsByIdExclude()` - Mark a document as excluded from agent training
474
+ - `patchExtractionDocumentsByIdFinish-upload()` - Step 2 of 2 in the two-step upload flow
475
+ - `patchExtractionDocumentsByIdInclude()` - Reverse an exclusion: allow a previously excluded document to contribute training examples
476
+ again
477
+ - `patchExtractionDocumentsByIdMark-trained()` - Record that a document has been used for agent training
478
+ - `patchExtractionDocumentsByIdReprocess()` - Re-extract document with current or specified schema version
479
+ - `patchExtractionDocumentsByIdRestore()` - Reverse an exclusion: allow a previously excluded document to contribute training examples
480
+ again
481
+ - `patchExtractionDocumentsByIdStatus()` - Internal-facing status update used by the web layer and API to set processing state
482
+ - `patchExtractionDocumentsByIdVerification()` - Update the human verification status of a completed document
483
+ - `deleteExtractionDocumentsById()` - Soft-delete a document and enqueue storage cleanup
452
484
 
453
485
  ## Document stats
454
486
 
455
- - `getDocumentsStats()` - List stats
487
+ - `getDocumentsStats()` - /documents/stats operation on document_stats resource
456
488
 
457
489
  ## Email template
458
490
 
459
- - `getApplicationsByApplicationIdEmail-templates()` - Get email templates
460
- - `getApplicationsByApplicationIdEmail-templatesBySlug()` - Get email templates
461
- - `postApplicationsByApplicationIdEmail-templates()` - Create email templates
462
- - `postApplicationsByApplicationIdEmail-templatesBySlugPreview()` - Create preview
463
- - `postApplicationsByApplicationIdEmail-templatesBySlugTest()` - Create test
464
- - `patchApplicationsByApplicationIdEmail-templatesBySlug()` - Update email templates
465
- - `deleteApplicationsByApplicationIdEmail-templatesBySlug()` - Delete email templates
466
-
467
- ## Email-marketing-campaign
468
-
469
- - `getEmail-marketingCampaignsById()` - Get campaigns
470
- - `getEmail-marketingCampaignsWorkspaceByWorkspaceId()` - Get workspace
471
- - `postEmail-marketingCampaigns()` - Create campaigns
472
- - `postEmail-marketingCampaignsByIdAnalyze()` - Create analyze
473
- - `postEmail-marketingCampaignsByIdCreate-followup()` - Create create followup
474
- - `postEmail-marketingCampaignsByIdExport()` - Create export
475
- - `postEmail-marketingCampaignsByIdGenerate-emails()` - Create generate emails
476
- - `postEmail-marketingCampaignsByIdImport-recipients()` - Create import recipients
477
- - `postEmail-marketingCampaignsByIdOptimize-send-times()` - Create optimize send times
478
- - `postEmail-marketingCampaignsByIdOptimize-subjects()` - Create optimize subjects
479
- - `postEmail-marketingCampaignsByIdSend()` - Create send
480
- - `patchEmail-marketingCampaignsById()` - Update campaigns
481
- - `deleteEmail-marketingCampaignsById()` - Delete campaigns
491
+ - `getApplicationsByApplicationIdEmail-templates()` - List all email templates for the application, including both system and custom templates
492
+ - `getApplicationsByApplicationIdEmail-templatesBySlug()` - Fetch a single email template by its slug within the given application
493
+ - `postApplicationsByApplicationIdEmail-templates()` - Create a new custom email template for the application
494
+ - `postApplicationsByApplicationIdEmail-templatesBySlugPreview()` - Preview email template with sample data
495
+ - `postApplicationsByApplicationIdEmail-templatesBySlugTest()` - Send a test email using this template
496
+ - `patchApplicationsByApplicationIdEmail-templatesBySlug()` - Update the display name, subject, body, branding color, or enabled state of an existing template
497
+ - `deleteApplicationsByApplicationIdEmail-templatesBySlug()` - /applications/:application_id/email-templates/:slug operation on email_template resource
482
498
 
483
- ## Email-marketing-generated-email
499
+ ## Email-inclusion
484
500
 
485
- - `getEmail-marketingGenerated-emailsById()` - Get generated emails
486
- - `getEmail-marketingGenerated-emailsCampaignByCampaignId()` - Get campaign
487
- - `patchEmail-marketingGenerated-emailsById()` - Update generated emails
488
- - `patchEmail-marketingGenerated-emailsByIdApprove()` - Update approve
489
- - `patchEmail-marketingGenerated-emailsByIdReject()` - Update reject
490
- - `patchEmail-marketingGenerated-emailsByIdSchedule()` - Update schedule
501
+ - `getEmailInclusionsById()` - /email/inclusions/:id operation on email-inclusion resource
502
+ - `getEmailInclusionsEmailByOutboundEmailId()` - /email/inclusions/email/:outbound_email_id operation on email-inclusion resource
503
+ - `postEmailInclusions()` - /email/inclusions operation on email-inclusion resource
504
+ - `patchEmailInclusionsById()` - /email/inclusions/:id operation on email-inclusion resource
505
+ - `deleteEmailInclusionsById()` - /email/inclusions/:id operation on email-inclusion resource
491
506
 
492
- ## Email-marketing-recipient
507
+ ## Email-marketing-generated-email
493
508
 
494
- - `getEmail-marketingRecipientsById()` - Get recipients
495
- - `getEmail-marketingRecipientsCampaignByCampaignId()` - Get campaign
509
+ - `getEmail-marketingGenerated-emailsById()` - /email-marketing/generated-emails/:id operation on email-marketing-generated-email resource
510
+ - `getEmail-marketingGenerated-emailsCampaignByCampaignId()` - /email-marketing/generated-emails/campaign/:campaign_id operation on email-marketing-generated-email resource
511
+ - `patchEmail-marketingGenerated-emailsById()` - /email-marketing/generated-emails/:id operation on email-marketing-generated-email resource
512
+ - `patchEmail-marketingGenerated-emailsByIdApprove()` - /email-marketing/generated-emails/:id/approve operation on email-marketing-generated-email resource
513
+ - `patchEmail-marketingGenerated-emailsByIdReject()` - /email-marketing/generated-emails/:id/reject operation on email-marketing-generated-email resource
514
+ - `patchEmail-marketingGenerated-emailsByIdSchedule()` - /email-marketing/generated-emails/:id/schedule operation on email-marketing-generated-email resource
496
515
 
497
- ## Email-marketing-send-limit
516
+ ## Email-marketing-recipient
498
517
 
499
- - `getEmail-marketingSend-limitsById()` - Get send limits
500
- - `getEmail-marketingSend-limitsWorkspaceByWorkspaceId()` - Get workspace
518
+ - `getCampaignsRecipientsById()` - /campaigns/recipients/:id operation on email-marketing-recipient resource
519
+ - `getCampaignsRecipientsCampaignByCampaignId()` - /campaigns/recipients/campaign/:campaign_id operation on email-marketing-recipient resource
501
520
 
502
521
  ## Email-marketing-sender-profile
503
522
 
504
- - `getEmail-marketingSender-profilesById()` - Get sender profiles
505
- - `getEmail-marketingSender-profilesWorkspaceByWorkspaceId()` - Get workspace
506
- - `postEmail-marketingSender-profiles()` - Create sender profiles
507
- - `patchEmail-marketingSender-profilesById()` - Update sender profiles
508
- - `patchEmail-marketingSender-profilesByIdValidate-dns()` - Update validate dns
509
- - `deleteEmail-marketingSender-profilesById()` - Delete sender profiles
523
+ - `getEmail-marketingSender-profilesById()` - /email-marketing/sender-profiles/:id operation on email-marketing-sender-profile resource
524
+ - `getEmail-marketingSender-profilesWorkspaceByWorkspaceId()` - /email-marketing/sender-profiles/workspace/:workspace_id operation on email-marketing-sender-profile resource
525
+ - `postEmail-marketingSender-profiles()` - /email-marketing/sender-profiles operation on email-marketing-sender-profile resource
526
+ - `patchEmail-marketingSender-profilesById()` - /email-marketing/sender-profiles/:id operation on email-marketing-sender-profile resource
527
+ - `patchEmail-marketingSender-profilesByIdSet-default()` - /email-marketing/sender-profiles/:id/set-default operation on email-marketing-sender-profile resource
528
+ - `patchEmail-marketingSender-profilesByIdValidate-dns()` - /email-marketing/sender-profiles/:id/validate-dns operation on email-marketing-sender-profile resource
529
+ - `deleteEmail-marketingSender-profilesById()` - /email-marketing/sender-profiles/:id operation on email-marketing-sender-profile resource
510
530
 
511
531
  ## Email-marketing-sequence
512
532
 
513
- - `getEmail-marketingSequencesById()` - Get sequences
514
- - `getEmail-marketingSequencesWorkspaceByWorkspaceId()` - Get workspace
515
- - `postEmail-marketingSequences()` - Create sequences
516
- - `patchEmail-marketingSequencesById()` - Update sequences
517
- - `patchEmail-marketingSequencesByIdActivate()` - Update activate
518
- - `patchEmail-marketingSequencesByIdComplete()` - Update complete
519
- - `patchEmail-marketingSequencesByIdPause()` - Update pause
520
- - `patchEmail-marketingSequencesByIdResume()` - Update resume
521
- - `deleteEmail-marketingSequencesById()` - Delete sequences
533
+ - `getCampaignsSequencesById()` - /campaigns/sequences/:id operation on email-marketing-sequence resource
534
+ - `getCampaignsSequencesWorkspaceByWorkspaceId()` - /campaigns/sequences/workspace/:workspace_id operation on email-marketing-sequence resource
535
+ - `postCampaignsSequences()` - /campaigns/sequences operation on email-marketing-sequence resource
536
+ - `patchCampaignsSequencesById()` - /campaigns/sequences/:id operation on email-marketing-sequence resource
537
+ - `patchCampaignsSequencesByIdActivate()` - /campaigns/sequences/:id/activate operation on email-marketing-sequence resource
538
+ - `patchCampaignsSequencesByIdComplete()` - /campaigns/sequences/:id/complete operation on email-marketing-sequence resource
539
+ - `patchCampaignsSequencesByIdPause()` - /campaigns/sequences/:id/pause operation on email-marketing-sequence resource
540
+ - `patchCampaignsSequencesByIdResume()` - /campaigns/sequences/:id/resume operation on email-marketing-sequence resource
541
+ - `deleteCampaignsSequencesById()` - /campaigns/sequences/:id operation on email-marketing-sequence resource
522
542
 
523
543
  ## Email-marketing-sequence-step
524
544
 
525
- - `getEmail-marketingSequence-stepsById()` - Get sequence steps
526
- - `getEmail-marketingSequence-stepsSequenceBySequenceId()` - Get sequence
527
- - `postEmail-marketingSequence-steps()` - Create sequence steps
528
- - `patchEmail-marketingSequence-stepsById()` - Update sequence steps
529
- - `deleteEmail-marketingSequence-stepsById()` - Delete sequence steps
545
+ - `getCampaignsSequence-stepsById()` - /campaigns/sequence-steps/:id operation on email-marketing-sequence-step resource
546
+ - `getCampaignsSequence-stepsSequenceBySequenceId()` - /campaigns/sequence-steps/sequence/:sequence_id operation on email-marketing-sequence-step resource
547
+ - `postCampaignsSequence-steps()` - /campaigns/sequence-steps operation on email-marketing-sequence-step resource
548
+ - `patchCampaignsSequence-stepsById()` - /campaigns/sequence-steps/:id operation on email-marketing-sequence-step resource
549
+ - `deleteCampaignsSequence-stepsById()` - /campaigns/sequence-steps/:id operation on email-marketing-sequence-step resource
530
550
 
531
551
  ## Email-marketing-template
532
552
 
533
- - `getEmail-marketingTemplatesById()` - Get templates
534
- - `getEmail-marketingTemplatesWorkspaceByWorkspaceId()` - Get workspace
535
- - `postEmail-marketingTemplates()` - Create templates
536
- - `patchEmail-marketingTemplatesById()` - Update templates
537
- - `patchEmail-marketingTemplatesByIdArchive()` - Update archive
538
- - `patchEmail-marketingTemplatesByIdRestore()` - Update restore
539
- - `deleteEmail-marketingTemplatesById()` - Delete templates
540
-
541
- ## Email-marketing-tracking-event
542
-
543
- - `getEmail-marketingTracking-eventsById()` - Get tracking events
544
- - `getEmail-marketingTracking-eventsCampaignByCampaignId()` - Get campaign
553
+ - `getEmail-marketingTemplatesById()` - /email-marketing/templates/:id operation on email-marketing-template resource
554
+ - `getEmail-marketingTemplatesWorkspaceByWorkspaceId()` - /email-marketing/templates/workspace/:workspace_id operation on email-marketing-template resource
555
+ - `postEmail-marketingTemplates()` - /email-marketing/templates operation on email-marketing-template resource
556
+ - `postEmail-marketingTemplatesCompile()` - Stateless MJML → HTML compilation
557
+ - `patchEmail-marketingTemplatesById()` - /email-marketing/templates/:id operation on email-marketing-template resource
558
+ - `patchEmail-marketingTemplatesByIdArchive()` - /email-marketing/templates/:id/archive operation on email-marketing-template resource
559
+ - `patchEmail-marketingTemplatesByIdPreview()` - Renders published_body_html with variable substitutions for preview
560
+ - `patchEmail-marketingTemplatesByIdPublish()` - Compiles MJML, snapshots to published_body_html, creates TemplateVersion, bumps current_version.
561
+ - `patchEmail-marketingTemplatesByIdRestore()` - /email-marketing/templates/:id/restore operation on email-marketing-template resource
562
+ - `patchEmail-marketingTemplatesByIdRollback()` - Restores body_mjml from a previously published TemplateVersion snapshot.
563
+ - `patchEmail-marketingTemplatesByIdUnpublish()` - Clears published_at — template reverts to draft state.
564
+ - `deleteEmail-marketingTemplatesById()` - /email-marketing/templates/:id operation on email-marketing-template resource
565
+
566
+ ## Email-outbound-email
567
+
568
+ - `getEmailOutbound-emailsById()` - /email/outbound-emails/:id operation on email-outbound-email resource
569
+ - `getEmailOutbound-emailsWorkspaceByWorkspaceId()` - /email/outbound-emails/workspace/:workspace_id operation on email-outbound-email resource
570
+ - `getEmailOutbound-emailsWorkspaceByWorkspaceIdContactByContactRefId()` - /email/outbound-emails/workspace/:workspace_id/contact/:contact_ref_id operation on email-outbound-email resource
571
+ - `postEmailOutbound-emails()` - /email/outbound-emails operation on email-outbound-email resource
572
+ - `postEmailOutbound-emailsCompose-with-ai()` - AI-draft an email from a prompt and context map.
573
+ - `patchEmailOutbound-emailsById()` - /email/outbound-emails/:id operation on email-outbound-email resource
574
+ - `patchEmailOutbound-emailsByIdCancel-schedule()` - /email/outbound-emails/:id/cancel-schedule operation on email-outbound-email resource
575
+ - `patchEmailOutbound-emailsByIdSchedule()` - /email/outbound-emails/:id/schedule operation on email-outbound-email resource
576
+ - `patchEmailOutbound-emailsByIdSend()` - Deliver this email immediately via connected account.
577
+ - `deleteEmailOutbound-emailsById()` - /email/outbound-emails/:id operation on email-outbound-email resource
578
+
579
+ ## Email-recipient
580
+
581
+ - `getEmailRecipientsById()` - /email/recipients/:id operation on email-recipient resource
582
+ - `getEmailRecipientsEmailByOutboundEmailId()` - /email/recipients/email/:outbound_email_id operation on email-recipient resource
583
+ - `postEmailRecipients()` - /email/recipients operation on email-recipient resource
584
+ - `deleteEmailRecipientsById()` - /email/recipients/:id operation on email-recipient resource
585
+
586
+ ## Email-tracking-event
587
+
588
+ - `getEmailTracking-eventsById()` - /email/tracking-events/:id operation on email-tracking-event resource
589
+ - `getEmailTracking-eventsWorkspaceByWorkspaceId()` - /email/tracking-events/workspace/:workspace_id operation on email-tracking-event resource
590
+
591
+ ## Email-unsubscriber
592
+
593
+ - `getEmail-marketingUnsubscribersById()` - /email-marketing/unsubscribers/:id operation on email-unsubscriber resource
594
+ - `getEmail-marketingUnsubscribersWorkspaceByWorkspaceId()` - /email-marketing/unsubscribers/workspace/:workspace_id operation on email-unsubscriber resource
545
595
 
546
596
  ## Embedding
547
597
 
548
- - `postAiEmbed()` - Create embed
598
+ - `postAiEmbed()` - Generate a 1024-dim vector embedding for the given text via the LlmTriage sidecar; validates workspace membership, estimates token cost, charges credits, and returns the embedding with usage stats.
549
599
 
550
600
  ## Extraction Batches
551
601
 
552
- - `getExtractionBatchesById()` - Get batches
553
- - `getExtractionBatchesByIdUpload-urls()` - Get upload urls
554
- - `getExtractionBatchesWorkspaceByWorkspaceId()` - Get workspace
555
- - `postExtractionBatches()` - Create batches
556
- - `deleteExtractionBatchesById()` - Delete batches
602
+ - `getExtractionBatchesById()` - /extraction/batches/:id operation on extraction_batch resource
603
+ - `getExtractionBatchesByIdUpload-urls()` - Generate presigned URLs for batch document upload
604
+ - `getExtractionBatchesWorkspaceByWorkspaceId()` - List all batches for a workspace, unfiltered and unpaginated
605
+ - `postExtractionBatches()` - Create a new extraction batch to group related documents
606
+ - `deleteExtractionBatchesById()` - /extraction/batches/:id operation on extraction_batch resource
557
607
 
558
608
  ## Extraction export
559
609
 
560
- - `getWorkspacesByWorkspaceIdExtractionExports()` - Get exports
561
- - `getWorkspacesByWorkspaceIdExtractionExportsById()` - Get exports
562
- - `postWorkspacesByWorkspaceIdExtractionExports()` - Create exports
610
+ - `getWorkspacesByWorkspaceIdExtractionExports()` - List exports for a workspace, filtered by status
611
+ - `getWorkspacesByWorkspaceIdExtractionExportsById()` - /workspaces/:workspace_id/extraction/exports/:id operation on extraction_export resource
612
+ - `postWorkspacesByWorkspaceIdExtractionExports()` - /workspaces/:workspace_id/extraction/exports operation on extraction_export resource
563
613
 
564
614
  ## Extraction Results
565
615
 
566
- - `getExtractionResults()` - List results
567
- - `getExtractionResultsById()` - Get results
568
- - `getExtractionResultsDocumentByDocumentId()` - Get document
569
- - `getExtractionResultsDocumentByDocumentIdHistory()` - Get history
570
- - `getExtractionResultsDocumentByDocumentIdPartial()` - Get partial
571
- - `getExtractionResultsWorkspaceByWorkspaceId()` - Get workspace
572
- - `patchExtractionResultsById()` - Update results
573
- - `patchExtractionResultsByIdRegenerate()` - Update regenerate
574
- - `patchExtractionResultsByIdSave-corrections()` - Update save corrections
575
- - `deleteExtractionResultsById()` - Delete results
616
+ - `getExtractionResults()` - Primary read for extraction results
617
+ - `getExtractionResultsById()` - Fetch a single ExtractionResult by ID
618
+ - `getExtractionResultsDocumentByDocumentId()` - Fetch the latest ExtractionResult for a given document
619
+ - `getExtractionResultsDocumentByDocumentIdHistory()` - List all ExtractionResults for a document in reverse-chronological order (newest first)
620
+ - `getExtractionResultsDocumentByDocumentIdPartial()` - Get the latest extraction result for a document including partial (in-progress) results with per-field status
621
+ - `getExtractionResultsWorkspaceByWorkspaceId()` - List all ExtractionResults in a workspace, sorted newest first
622
+ - `patchExtractionResultsById()` - General-purpose update for an ExtractionResult
623
+ - `patchExtractionResultsByIdRegenerate()` - Re-run extraction on an existing result, optionally with user feedback or targeting specific
624
+ fields
625
+ - `patchExtractionResultsByIdSave-corrections()` - Apply human corrections to extracted field values
626
+ - `deleteExtractionResultsById()` - Delete an ExtractionResult record
576
627
 
577
628
  ## Field mapping confirmation
578
629
 
579
- - `postWorkspacesByWorkspaceIdExtractionByDocumentIdMapping()` - Create mapping
630
+ - `postWorkspacesByWorkspaceIdExtractionByDocumentIdMapping()` - /workspaces/:workspace_id/extraction/:document_id/mapping operation on field_mapping_confirmation resource
580
631
 
581
632
  ## Field mapping result
582
633
 
583
- - `getWorkspacesByWorkspaceIdExtractionByDocumentIdMapping()` - Get mapping
634
+ - `getWorkspacesByWorkspaceIdExtractionByDocumentIdMapping()` - /workspaces/:workspace_id/extraction/:document_id/mapping operation on field_mapping_result resource
584
635
 
585
636
  ## Field Templates
586
637
 
587
- - `getField-templates()` - List field templates
588
- - `getField-templatesById()` - Get field templates
589
- - `postField-templates()` - Create field templates
590
- - `deleteField-templatesById()` - Delete field templates
638
+ - `getField-templates()` - /field-templates operation on field_template resource
639
+ - `getField-templatesById()` - /field-templates/:id operation on field_template resource
640
+ - `postField-templates()` - /field-templates operation on field_template resource
641
+ - `deleteField-templatesById()` - /field-templates/:id operation on field_template resource
591
642
 
592
643
  ## Invitations
593
644
 
594
- - `getInvitations()` - List invitations
595
- - `getInvitationsConsumeByToken()` - Get consume
596
- - `getInvitationsMe()` - List me
597
- - `postInvitations()` - Create invitations
598
- - `postInvitationsAccept-by-token()` - Create accept by token
599
- - `patchInvitationsByIdAccept()` - Update accept
600
- - `patchInvitationsByIdAccept-by-user()` - Update accept by user
601
- - `patchInvitationsByIdDecline()` - Update decline
602
- - `patchInvitationsByIdResend()` - Update resend
603
- - `patchInvitationsByIdRevoke()` - Update revoke
645
+ - `getInvitations()` - List invitations visible to the actor
646
+ - `getInvitationsConsumeByToken()` - Look up a pending, non-expired invitation by its raw token
647
+ - `getInvitationsMe()` - List all pending invitations addressed to the authenticated actor's email
648
+ - `postInvitations()` - Send an invitation to a user to join a tenant or workspace
649
+ - `postInvitationsAccept-by-token()` - Accept an invitation using only the token
650
+ - `patchInvitationsByIdAccept()` - Accept a pending invitation using a token and the authenticated actor's identity
651
+ - `patchInvitationsByIdAccept-by-user()` - Accept an invitation on behalf of a specific user (by user_id)
652
+ - `patchInvitationsByIdDecline()` - Decline a pending invitation
653
+ - `patchInvitationsByIdResend()` - Resend an invitation email with a refreshed token and a new 7-day expiry
654
+ - `patchInvitationsByIdRevoke()` - Cancel a pending invitation by setting its status to :revoked
604
655
 
605
656
  ## Invoice
606
657
 
607
- - `getWalletInvoices()` - List invoices
658
+ - `getWalletInvoices()` - Read all invoices for the current tenant
608
659
 
609
660
  ## Knowledge Graph
610
661
 
611
- - `getAiGraphNodes()` - List nodes
612
- - `getAiGraphNodesLabelByLabel()` - Get label
613
- - `postAiGraphNodes()` - Create nodes
614
- - `deleteAiGraphNodesById()` - Delete nodes
662
+ - `getAiGraphNodes()` - Paginate Entity vertices for the caller's tenant; returns up to 50 nodes per page by default.
663
+ - `getAiGraphNodesLabelByLabel()` - Find all Entity vertices with an exact label match; use to look up a specific named entity in the knowledge graph.
664
+ - `postAiGraphNodes()` - Create an Entity vertex in the knowledge graph; tenant_id is always forced from the actor and cannot be supplied by the caller
665
+ - `deleteAiGraphNodesById()` - /ai/graph/nodes/:id operation on graph_node resource
615
666
 
616
667
  ## Legal acceptance
617
668
 
618
- - `getLegal-acceptances()` - List legal acceptances
619
- - `getLegal-acceptancesById()` - Get legal acceptances
620
- - `getLegal-acceptancesLatest()` - List latest
669
+ - `getLegal-acceptances()` - /legal-acceptances operation on legal_acceptance resource
670
+ - `getLegal-acceptancesById()` - /legal-acceptances/:id operation on legal_acceptance resource
671
+ - `getLegal-acceptancesLatest()` - Fetch the most recent acceptance record for a given user and document type
621
672
 
622
673
  ## Legal document
623
674
 
624
- - `getLegal-documents()` - List legal documents
625
- - `getLegal-documentsBy-locale()` - List by locale
626
- - `getLegal-documentsById()` - Get legal documents
627
- - `getLegal-documentsFor-application()` - List for application
628
- - `postLegal-documents()` - Create legal documents
629
- - `patchLegal-documentsById()` - Update legal documents
630
- - `patchLegal-documentsByIdPublish()` - Update publish
631
- - `patchLegal-documentsByIdUnpublish()` - Update unpublish
632
- - `deleteLegal-documentsById()` - Delete legal documents
675
+ - `getLegal-documents()` - /legal-documents operation on legal_document resource
676
+ - `getLegal-documentsBy-locale()` - Fetch active legal documents filtered by locale and optional region, used to display the appropriate ToS or Privacy Policy to a user based on their location.
677
+ - `getLegal-documentsById()` - /legal-documents/:id operation on legal_document resource
678
+ - `getLegal-documentsFor-application()` - List legal documents scoped to the current application context, including platform-level documents (null application_id) and application-specific overrides
679
+ - `postLegal-documents()` - Create a new versioned legal document (Terms of Service, Privacy Policy, BAA, DPA, or SCC)
680
+ - `patchLegal-documentsById()` - Edit draft document content, locale, region, or scheduling fields
681
+ - `patchLegal-documentsByIdPublish()` - Make a legal document live
682
+ - `patchLegal-documentsByIdUnpublish()` - Deactivate a legal document without deleting it
683
+ - `deleteLegal-documentsById()` - /legal-documents/:id operation on legal_document resource
633
684
 
634
685
  ## Messages
635
686
 
636
- - `getAiMessages()` - List messages
637
- - `getMessages()` - List messages
638
- - `getMessagesById()` - Get messages
639
- - `getMessagesSearch()` - List search
640
- - `getMessagesSemantic-search()` - List semantic search
641
- - `getThreadsByIdMessages()` - Get messages
642
- - `postAiMessages()` - Create messages
643
- - `postMessages()` - Create messages
644
- - `patchMessagesById()` - Update messages
645
- - `deleteAiMessagesById()` - Delete messages
646
- - `deleteMessagesById()` - Delete messages
687
+ - `getAiMessages()` - /ai/messages operation on message resource
688
+ - `getMessages()` - /messages operation on message resource
689
+ - `getMessagesById()` - /messages/:id operation on message resource
690
+ - `getMessagesSearch()` - Full-text search messages by substring match on content within the actor's accessible threads
691
+ - `getMessagesSemantic-search()` - Vector similarity search across messages using a generated embedding of the query string
692
+ - `getThreadsByIdMessages()` - /threads/:id/messages operation on message resource
693
+ - `postAiMessages()` - Append a new message turn (system, user, or assistant) to a Conversation
694
+ - `postMessages()` - Add a new message turn to a thread
695
+ - `patchMessagesById()` - Edit a message's content, role, or metadata
696
+ - `deleteAiMessagesById()` - /ai/messages/:id operation on message resource
697
+ - `deleteMessagesById()` - /messages/:id operation on message resource
647
698
 
648
699
  ## Notification log
649
700
 
650
- - `getNotification-logs()` - List notification logs
651
- - `getNotification-logsById()` - Get notification logs
652
- - `getNotification-logsStats()` - List stats
701
+ - `getNotification-logs()` - /notification-logs operation on notification_log resource
702
+ - `getNotification-logsById()` - /notification-logs/:id operation on notification_log resource
703
+ - `getNotification-logsStats()` - Get notification log statistics
653
704
 
654
705
  ## Notification method
655
706
 
656
- - `getNotification-methods()` - List notification methods
657
- - `getNotification-methodsById()` - Get notification methods
658
- - `postNotification-methods()` - Create notification methods
659
- - `patchNotification-methodsById()` - Update notification methods
660
- - `patchNotification-methodsByIdSend-verification()` - Update send verification
661
- - `patchNotification-methodsByIdSet-primary()` - Update set primary
662
- - `patchNotification-methodsByIdVerify()` - Update verify
663
- - `deleteNotification-methodsById()` - Delete notification methods
707
+ - `getNotification-methods()` - /notification-methods operation on notification_method resource
708
+ - `getNotification-methodsById()` - /notification-methods/:id operation on notification_method resource
709
+ - `postNotification-methods()` - Register a new notification delivery channel for a user (email address, phone number, Slack webhook, or generic webhook URL)
710
+ - `patchNotification-methodsById()` - Update the display name or connection config for an existing notification method
711
+ - `patchNotification-methodsByIdSend-verification()` - Generate a 6-digit verification code, store it as `verification_token`, and record `verification_sent_at`
712
+ - `patchNotification-methodsByIdSet-primary()` - Mark this notification method as the primary channel for its type, used when multiple methods of the same type exist.
713
+ - `patchNotification-methodsByIdVerify()` - Mark the notification method as verified by setting `verified_at` to the current timestamp
714
+ - `deleteNotification-methodsById()` - /notification-methods/:id operation on notification_method resource
664
715
 
665
716
  ## Notification preference
666
717
 
667
- - `getNotification-preferences()` - List notification preferences
668
- - `getNotification-preferencesById()` - Get notification preferences
669
- - `postNotification-preferences()` - Create notification preferences
670
- - `patchNotification-preferencesById()` - Update notification preferences
671
- - `deleteNotification-preferencesById()` - Delete notification preferences
718
+ - `getNotification-preferences()` - /notification-preferences operation on notification_preference resource
719
+ - `getNotification-preferencesById()` - /notification-preferences/:id operation on notification_preference resource
720
+ - `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
721
+ - `patchNotification-preferencesById()` - Update a user's notification channel list or per-category preferences
722
+ - `deleteNotification-preferencesById()` - /notification-preferences/:id operation on notification_preference resource
672
723
 
673
724
  ## Operation success
674
725
 
675
- - `postDocumentsBulk-delete()` - Create bulk delete
726
+ - `postDocumentsBulk-delete()` - /documents/bulk-delete operation on operation_success resource
676
727
 
677
728
  ## Payment method
678
729
 
679
- - `getPayment-methods()` - List payment methods
680
- - `getPayment-methodsById()` - Get payment methods
681
- - `postPayment-methods()` - Create payment methods
682
- - `postPayment-methodsTokenize()` - Create tokenize
683
- - `patchPayment-methodsById()` - Update payment methods
684
- - `patchPayment-methodsByIdDefault()` - Update default
685
- - `deletePayment-methodsById()` - Delete payment methods
730
+ - `getPayment-methods()` - /payment-methods operation on payment_method resource
731
+ - `getPayment-methodsById()` - /payment-methods/:id operation on payment_method resource
732
+ - `postPayment-methods()` - Save a pre-tokenized payment method for a customer
733
+ - `postPayment-methodsTokenize()` - Create a payment method via direct proxy tokenization (S2S)
734
+ - `patchPayment-methodsById()` - Update a saved payment method's nickname or default status
735
+ - `patchPayment-methodsByIdDefault()` - Set this payment method as default for the customer
736
+ - `deletePayment-methodsById()` - /payment-methods/:id operation on payment_method resource
686
737
 
687
738
  ## Permission
688
739
 
689
- - `getPermissions()` - List permissions
690
- - `getPermissionsById()` - Get permissions
691
- - `getPermissionsPresets()` - List presets
740
+ - `getPermissions()` - List all platform permissions for a given context (:tenant or :workspace); returns permission metadata from the PermissionRegistry for use in permission-picker UIs.
741
+ - `getPermissionsById()` - Fetch all permissions and apply any query filters supplied by the caller; use :by_id for single-record lookup by permission ID string.
742
+ - `getPermissionsPresets()` - List role presets (admin, member, viewer, etc.) for a given context (:tenant or :workspace); each preset includes its name, description, and the full permission list it grants.
692
743
 
693
744
  ## Permission meta
694
745
 
695
- - `getPermissionsMeta()` - List meta
746
+ - `getPermissionsMeta()` - Fetch a single metadata record describing the permission system — schema version, available apps, scopes, categories, and suggested client cache TTL
696
747
 
697
748
  ## Permission preset
698
749
 
699
- - `getPermissionsPresetsById()` - Get presets
750
+ - `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.
700
751
 
701
752
  ## Presigned url
702
753
 
703
- - `postDocumentsPresigned-upload()` - Create presigned upload
754
+ - `postDocumentsPresigned-upload()` - /documents/presigned-upload operation on presigned_url resource
704
755
 
705
756
  ## Processing activity
706
757
 
707
- - `getProcessing-activities()` - List processing activities
708
- - `getProcessing-activitiesById()` - Get processing activities
709
- - `postProcessing-activities()` - Create processing activities
710
- - `deleteProcessing-activitiesById()` - Delete processing activities
758
+ - `getProcessing-activities()` - /processing-activities operation on processing_activity resource
759
+ - `getProcessing-activitiesById()` - /processing-activities/:id operation on processing_activity resource
760
+ - `postProcessing-activities()` - Add a new GDPR Article 30 Record of Processing Activities (ROPA) entry, documenting a processing purpose, the categories of personal data processed, data subjects, recipients, and legal basis for the workspace.
761
+ - `deleteProcessing-activitiesById()` - /processing-activities/:id operation on processing_activity resource
711
762
 
712
763
  ## Retention policy
713
764
 
714
- - `getRetention-policies()` - List retention policies
715
- - `getRetention-policiesById()` - Get retention policies
716
- - `postRetention-policies()` - Create retention policies
717
- - `patchRetention-policiesById()` - Update retention policies
718
- - `deleteRetention-policiesById()` - Delete retention policies
765
+ - `getRetention-policies()` - /retention-policies operation on retention_policy resource
766
+ - `getRetention-policiesById()` - /retention-policies/:id operation on retention_policy resource
767
+ - `postRetention-policies()` - Define a data retention rule for a specific data category in a workspace
768
+ - `patchRetention-policiesById()` - Modify the retention period, expiry action, or enabled state of an existing policy
769
+ - `deleteRetention-policiesById()` - /retention-policies/:id operation on retention_policy resource
719
770
 
720
771
  ## Role
721
772
 
722
- - `getRoles()` - List roles
723
- - `postRoles()` - Create roles
724
- - `patchRolesById()` - Update roles
725
- - `deleteRolesById()` - Delete roles
773
+ - `getRoles()` - /roles operation on role resource
774
+ - `postRoles()` - Create a new role (permission bundle); creates a system default if application_id is nil, or an ISV application role if application_id is supplied
775
+ - `patchRolesById()` - Update a role's name, description, or permission list; does NOT retroactively update existing TenantMemberships — use bulk_refresh_memberships for that
776
+ - `deleteRolesById()` - Delete a role; emits a RoleDeleted audit event
726
777
 
727
778
  ## Scan result
728
779
 
729
- - `getScan-results()` - List scan results
730
- - `getScan-resultsById()` - Get scan results
780
+ - `getScan-results()` - /scan-results operation on scan_result resource
781
+ - `getScan-resultsById()` - /scan-results/:id operation on scan_result resource
731
782
 
732
783
  ## Scheduling booking
733
784
 
734
- - `getSchedulingBookings()` - List bookings
735
- - `getSchedulingBookingsById()` - Get bookings
736
- - `postSchedulingBookings()` - Create bookings
737
- - `patchSchedulingBookingsSchedulingBookingsByIdCancel()` - Update cancel
738
- - `patchSchedulingBookingsSchedulingBookingsByIdConfirm()` - Update confirm
739
- - `patchSchedulingBookingsSchedulingBookingsByIdReschedule()` - Update reschedule
785
+ - `getSchedulingBookings()` - List all bookings for a workspace
786
+ - `getSchedulingBookingsById()` - Fetch a single booking by ID
787
+ - `postSchedulingBookings()` - Create a booking for an external party claiming a time slot
788
+ - `patchSchedulingBookingsSchedulingBookingsByIdCancel()` - Cancel a booking, recording cancellation_reason and cancelled_by (:booker/:organizer/:system)
789
+ - `patchSchedulingBookingsSchedulingBookingsByIdConfirm()` - Approve a pending booking, setting status to :confirmed and confirmed_at timestamp
790
+ - `patchSchedulingBookingsSchedulingBookingsByIdReschedule()` - Reschedule a booking by moving its linked Event to new_start_time/new_end_time
740
791
 
741
792
  ## Scheduling calendar sync
742
793
 
743
- - `getSchedulingCalendar-syncs()` - List calendar syncs
744
- - `getSchedulingCalendar-syncsById()` - Get calendar syncs
745
- - `postSchedulingCalendar-syncs()` - Create calendar syncs
746
- - `patchSchedulingCalendar-syncsSchedulingCalendar-syncsById()` - Update calendar syncs
747
- - `patchSchedulingCalendar-syncsSchedulingCalendar-syncsByIdPause()` - Update pause
748
- - `patchSchedulingCalendar-syncsSchedulingCalendar-syncsByIdResume()` - Update resume
749
- - `deleteSchedulingCalendar-syncsSchedulingCalendar-syncsById()` - Delete calendar syncs
794
+ - `getSchedulingCalendar-syncs()` - List all calendar sync configurations for a specific user
795
+ - `getSchedulingCalendar-syncsById()` - Fetch a single calendar sync configuration by ID
796
+ - `postSchedulingCalendar-syncs()` - Link a user's external calendar for bi-directional sync
797
+ - `patchSchedulingCalendar-syncsSchedulingCalendar-syncsById()` - Update calendar sync settings: name, direction, poll interval, or custom metadata
798
+ - `patchSchedulingCalendar-syncsSchedulingCalendar-syncsByIdPause()` - Pause calendar sync by setting sync_status to :paused
799
+ - `patchSchedulingCalendar-syncsSchedulingCalendar-syncsByIdResume()` - Resume a paused or errored calendar sync
800
+ - `deleteSchedulingCalendar-syncsSchedulingCalendar-syncsById()` - Hard-delete a calendar sync configuration, stopping all future sync runs for this calendar
750
801
 
751
802
  ## Scheduling event
752
803
 
753
- - `getSchedulingEvents()` - List events
754
- - `getSchedulingEventsById()` - Get events
755
- - `postSchedulingEvents()` - Create events
756
- - `patchSchedulingEventsById()` - Update events
804
+ - `getSchedulingEvents()` - List all events in a workspace, newest first
805
+ - `getSchedulingEventsById()` - Fetch a single event by ID
806
+ - `postSchedulingEvents()` - Create a scheduled event occurrence
807
+ - `patchSchedulingEventsById()` - Update event metadata: title, description, timezone, location, notes, or custom metadata
757
808
 
758
809
  ## Scheduling event type
759
810
 
760
- - `getSchedulingEvent-types()` - List event types
761
- - `getSchedulingEvent-typesById()` - Get event types
762
- - `postSchedulingEvent-types()` - Create event types
763
- - `patchSchedulingEvent-typesById()` - Update event types
811
+ - `getSchedulingEvent-types()` - List all active event types for a workspace
812
+ - `getSchedulingEvent-typesById()` - Fetch a single event type by ID
813
+ - `postSchedulingEvent-types()` - Create an event type template for a workspace
814
+ - `patchSchedulingEvent-typesById()` - Update event type configuration including duration, buffers, location, capacity, and intake form
764
815
 
765
816
  ## Scheduling participant
766
817
 
767
- - `getSchedulingParticipants()` - List participants
768
- - `getSchedulingParticipantsById()` - Get participants
769
- - `postSchedulingParticipants()` - Create participants
770
- - `patchSchedulingParticipantsById()` - Update participants
818
+ - `getSchedulingParticipants()` - List all participants for a specific event, including organizer and attendees
819
+ - `getSchedulingParticipantsById()` - Fetch a single participant by ID
820
+ - `postSchedulingParticipants()` - Add a participant to an event
821
+ - `patchSchedulingParticipantsById()` - Update participant metadata: name, phone, role, or custom metadata
771
822
 
772
823
  ## Schema discovery
773
824
 
774
- - `getExtractionSchema-discoveriesById()` - Get schema discoveries
775
- - `postExtractionSchema-discoveries()` - Create schema discoveries
776
- - `postExtractionSchema-discoveriesBootstrap()` - Create bootstrap
825
+ - `getExtractionSchema-discoveriesById()` - /extraction/schema-discoveries/:id operation on schema_discovery resource
826
+ - `postExtractionSchema-discoveries()` - /extraction/schema-discoveries operation on schema_discovery resource
827
+ - `postExtractionSchema-discoveriesBootstrap()` - Bootstrap schema discovery without an agent
777
828
 
778
829
  ## Search
779
830
 
780
- - `getSearch()` - List search
781
- - `getSearchHealth()` - List health
782
- - `getSearchIndexes()` - List indexes
783
- - `getSearchSaved()` - List saved
784
- - `getSearchSemantic()` - List semantic
785
- - `getSearchStats()` - List stats
786
- - `getSearchStatus()` - List status
787
- - `getSearchSuggest()` - List suggest
788
- - `postAiSearch()` - Create search
789
- - `postAiSearchAdvanced()` - Create advanced
790
- - `postSearchBatch()` - Create batch
791
- - `postSearchReindex()` - Create reindex
792
- - `postSearchSaved()` - Create saved
793
- - `postSearchSavedByIdRun()` - Create run
794
- - `patchSearchSavedById()` - Update saved
795
- - `deleteSearchSavedById()` - Delete saved
831
+ - `getSearch()` - Full-text keyword search via Meilisearch across users, tenants, and documents
832
+ - `getSearchHealth()` - Check Meilisearch server health, returning status and latency
833
+ - `getSearchIndexes()` - Return the names of all configured Meilisearch indexes
834
+ - `getSearchSaved()` - List saved searches accessible to the current actor: the actor's own searches and any searches marked `is_shared` within the same tenant.
835
+ - `getSearchSemantic()` - Vector similarity search across document chunks using a generated embedding of the query
836
+ - `getSearchStats()` - Return Meilisearch database size and per-index document counts
837
+ - `getSearchStatus()` - Return the current status and tenant context for the search indexes
838
+ - `getSearchSuggest()` - Return typeahead suggestions for a query prefix
839
+ - `postAiSearch()` - Run a semantic similarity search against vectorized document chunks for the caller's tenant; embeds the query text and returns the top-k most relevant chunks ranked by cosine similarity.
840
+ - `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.
841
+ - `postSearchBatch()` - Execute multiple search queries in a single request and return the combined results
842
+ - `postSearchReindex()` - Trigger a Meilisearch reindex for all or a specific subset of indexes (users, tenants, documents)
843
+ - `postSearchSaved()` - Persist a named search query for reuse
844
+ - `postSearchSavedByIdRun()` - Re-execute a saved search by ID and return the saved search metadata enriched with an `executed_at` ISO-8601 timestamp
845
+ - `patchSearchSavedById()` - Modify the name, query string, search type, filters, or sharing status of an existing saved search
846
+ - `deleteSearchSavedById()` - /search/saved/:id operation on saved_search resource
796
847
 
797
848
  ## Search analytics
798
849
 
799
- - `getSearchAnalytics()` - List analytics
800
- - `getSearchAnalyticsSummary()` - List summary
850
+ - `getSearchAnalytics()` - List search analytics with tenant-based filtering
851
+ - `getSearchAnalyticsSummary()` - Aggregated search analytics summary (platform admin only)
801
852
 
802
853
  ## Storage
803
854
 
804
- - `getBuckets()` - List buckets
805
- - `getBucketsAll()` - List all
806
- - `getBucketsById()` - Get buckets
807
- - `getBucketsByIdStats()` - Get stats
808
- - `postBuckets()` - Create buckets
809
- - `patchBucketsById()` - Update buckets
810
- - `deleteBucketsById()` - Delete buckets
855
+ - `getBuckets()` - List or fetch buckets; excludes processing-type buckets by default
856
+ - `getBucketsAll()` - Read all buckets including system/processing buckets
857
+ - `getBucketsById()` - List or fetch buckets; excludes processing-type buckets by default
858
+ - `getBucketsByIdStats()` - Fetch a single bucket with the storage_used calculation (total bytes across all workspace files in this bucket).
859
+ - `postBuckets()` - Create a bucket record and provision it in object storage (GCS in prod, MinIO in dev); sets lifecycle rules and public policy if type is :public
860
+ - `patchBucketsById()` - Update the region of an existing bucket
861
+ - `deleteBucketsById()` - Delete a bucket from the database and attempt to remove it from object storage; fails if any StorageFile records still reference this bucket.
811
862
 
812
863
  ## Storage file
813
864
 
814
- - `getStorage-files()` - List storage files
815
- - `getStorage-filesById()` - Get storage files
816
- - `postStorage-files()` - Create storage files
817
- - `patchStorage-filesById()` - Update storage files
818
- - `patchStorage-filesByIdSoft-delete()` - Update soft delete
865
+ - `getStorage-files()` - /storage-files operation on storage_file resource
866
+ - `getStorage-filesById()` - /storage-files/:id operation on storage_file resource
867
+ - `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.
868
+ - `patchStorage-filesById()` - Update file metadata, tags, visibility, key, namespace, or status
869
+ - `patchStorage-filesByIdSoft-delete()` - Mark an active file as pending_deletion; the S3 object is deleted by PendingDeletionWorker after the grace period
819
870
 
820
871
  ## Support tag
821
872
 
822
- - `getSupportTagsWorkspaceByWorkspaceId()` - Get workspace
823
- - `postSupportTags()` - Create tags
824
- - `deleteSupportTagsById()` - Delete tags
873
+ - `getSupportTagsWorkspaceByWorkspaceId()` - List all tags defined for a workspace
874
+ - `postSupportTags()` - Create a workspace-scoped ticket tag
875
+ - `deleteSupportTagsById()` - Hard-delete a tag
825
876
 
826
877
  ## Support ticket
827
878
 
828
- - `getSupportTicketsById()` - Get tickets
829
- - `getSupportTicketsWorkspaceByWorkspaceId()` - Get workspace
830
- - `postSupportTickets()` - Create tickets
831
- - `patchSupportTicketsById()` - Update tickets
832
- - `deleteSupportTicketsById()` - Delete tickets
879
+ - `getSupportTicketsById()` - Fetch a single active ticket by ID
880
+ - `getSupportTicketsWorkspaceByWorkspaceId()` - List active tickets for a workspace, optionally filtered by status, priority, queue, or agent
881
+ - `postSupportTickets()` - Create a support ticket
882
+ - `patchSupportTicketsById()` - Update ticket fields including status (validated by ValidStatusTransition), queue assignment, SLA, and AI classification fields
883
+ - `deleteSupportTicketsById()` - Soft-delete a ticket by setting deleted_at
833
884
 
834
885
  ## Support ticket attachment
835
886
 
836
- - `getSupportTicket-attachmentsMessageByTicketMessageId()` - Get message
837
- - `postSupportTicket-attachments()` - Create ticket attachments
887
+ - `getSupportTicket-attachmentsMessageByTicketMessageId()` - List all attachments for a specific ticket message
888
+ - `postSupportTicket-attachments()` - Register a file attachment on a ticket message
838
889
 
839
890
  ## Support ticket message
840
891
 
841
- - `getSupportTicket-messagesTicketByTicketId()` - Get ticket
842
- - `postSupportTicket-messages()` - Create ticket messages
892
+ - `getSupportTicket-messagesTicketByTicketId()` - List all messages on a ticket in chronological order
893
+ - `postSupportTicket-messages()` - Add a message to a ticket thread
843
894
 
844
895
  ## Support ticket rating
845
896
 
846
- - `postSupportTicket-ratings()` - Create ticket ratings
897
+ - `postSupportTicket-ratings()` - Submit or update a CSAT rating (1-5) for a resolved ticket
847
898
 
848
899
  ## Tenant document stats
849
900
 
850
- - `getTenantsByTenantIdDocumentStats()` - Get document stats
901
+ - `getTenantsByTenantIdDocumentStats()` - /tenants/:tenant_id/document_stats operation on tenant_document_stats resource
851
902
 
852
903
  ## Tenant stats
853
904
 
854
- - `getTenantsByTenantIdStats()` - Get stats
905
+ - `getTenantsByTenantIdStats()` - /tenants/:tenant_id/stats operation on tenant_stats resource
855
906
 
856
907
  ## Tenant-membership
857
908
 
858
- - `getTenant-memberships()` - List tenant memberships
859
- - `postTenant-memberships()` - Create tenant memberships
860
- - `patchTenant-membershipsByTenantIdByUserId()` - Update tenant memberships
861
- - `deleteTenant-membershipsByTenantIdByUserId()` - Delete tenant memberships
909
+ - `getTenant-memberships()` - /tenant-memberships operation on tenant-membership resource
910
+ - `postTenant-memberships()` - /tenant-memberships operation on tenant-membership resource
911
+ - `patchTenant-membershipsByTenantIdByUserId()` - /tenant-memberships/:tenant_id/:user_id operation on tenant-membership resource
912
+ - `deleteTenant-membershipsByTenantIdByUserId()` - /tenant-memberships/:tenant_id/:user_id operation on tenant-membership resource
862
913
 
863
914
  ## Tenants
864
915
 
865
- - `getTenants()` - List tenants
866
- - `getTenantsById()` - Get tenants
867
- - `postTenants()` - Create tenants
868
- - `postTenantsByIdCredit()` - Create credit
869
- - `postTenantsByIdSchedule-purge()` - Create schedule purge
870
- - `postTenantsIsv()` - Create isv
871
- - `patchTenantsById()` - Update tenants
872
- - `deleteTenantsById()` - Delete tenants
916
+ - `getTenants()` - /tenants operation on tenant resource
917
+ - `getTenantsById()` - Fetch a single tenant by its UUID
918
+ - `postTenants()` - Create a new tenant organization
919
+ - `postTenantsByIdCredit()` - Allocate credits to the tenant's liability account
920
+ - `postTenantsByIdSchedule-purge()` - Schedule an Oban job to purge all storage objects for the given tenant
921
+ - `postTenantsIsv()` - Create an ISV tenant with initial credits
922
+ - `patchTenantsById()` - Update general tenant settings: name, slug, kind, branding URLs, training price,
923
+ plan tier, vanity slug, and storage spending cap
924
+ - `deleteTenantsById()` - Permanently delete a tenant and all associated data
873
925
 
874
926
  ## Thread stats
875
927
 
876
- - `getThreadsStats()` - List stats
928
+ - `getThreadsStats()` - Return platform-wide chat statistics including total threads, total messages, threads active in the last 24h and 7d, message distribution by role, and top 10 workspaces by thread count
877
929
 
878
930
  ## Thread workspace stats
879
931
 
880
- - `getThreadsWorkspace-stats()` - List workspace stats
932
+ - `getThreadsWorkspace-stats()` - Return aggregated chat statistics for the actor's current workspace: total threads, total messages, activity counts for 24h and 7d windows, and message distribution by role
881
933
 
882
934
  ## Threads
883
935
 
884
- - `getThreads()` - List threads
885
- - `getThreadsById()` - Get threads
886
- - `getThreadsSearch()` - List search
887
- - `postThreads()` - Create threads
888
- - `postThreadsActive()` - Create active
889
- - `postThreadsByIdExport()` - Create export
890
- - `postThreadsByIdFork()` - Create fork
891
- - `postThreadsByIdMessages()` - Create messages
892
- - `postThreadsByIdSummarize()` - Create summarize
893
- - `patchThreadsById()` - Update threads
894
- - `patchThreadsByIdArchive()` - Update archive
895
- - `patchThreadsByIdUnarchive()` - Update unarchive
896
- - `deleteThreadsById()` - Delete threads
936
+ - `getThreads()` - /threads operation on thread resource
937
+ - `getThreadsById()` - /threads/:id operation on thread resource
938
+ - `getThreadsSearch()` - Full-text search threads by title or context summary within the actor's accessible workspace
939
+ - `postThreads()` - Create a new conversation thread scoped to a tenant, workspace, and user
940
+ - `postThreadsActive()` - Return the current user's active thread for their workspace, creating a new one if none exists or the existing thread has expired (>24h inactive)
941
+ - `postThreadsByIdExport()` - Export thread with messages to JSON, Markdown, or plain text format
942
+ - `postThreadsByIdFork()` - Fork a thread by cloning it with all its messages
943
+ - `postThreadsByIdMessages()` - Submit a user message to a thread and receive the AI response synchronously
944
+ - `postThreadsByIdSummarize()` - Generate a 2-3 sentence LLM summary of the thread's message history and persist it as `context_summary`
945
+ - `patchThreadsById()` - Update the thread's title or context summary
946
+ - `patchThreadsByIdArchive()` - Archive a thread by setting `archived_at` to the current timestamp
947
+ - `patchThreadsByIdUnarchive()` - Restore an archived thread by clearing `archived_at`, making it visible in the default thread list again.
948
+ - `deleteThreadsById()` - /threads/:id operation on thread resource
897
949
 
898
950
  ## Token
899
951
 
900
- - `postTokens()` - Create tokens
952
+ - `postTokens()` - Create a payment token
901
953
 
902
954
  ## Training analytics
903
955
 
904
- - `getWorkspacesAnalytics-batch()` - List analytics batch
905
- - `getWorkspacesByWorkspaceIdTrainingAnalytics()` - Get analytics
956
+ - `getWorkspacesAnalytics-batch()` - Get training analytics for multiple workspaces in a single request (max 50)
957
+ - `getWorkspacesByWorkspaceIdTrainingAnalytics()` - Get training analytics for a specific workspace
906
958
 
907
959
  ## Transaction
908
960
 
909
- - `getTransactions()` - List transactions
910
- - `getTransactionsById()` - Get transactions
961
+ - `getTransactions()` - Read user's transactions
962
+ - `getTransactionsById()` - Read user's transactions
911
963
 
912
964
  ## Users
913
965
 
914
- - `getUser-profiles()` - List user profiles
915
- - `getUser-profilesById()` - Get user profiles
916
- - `getUser-profilesMe()` - List me
917
- - `getUsers()` - List users
918
- - `getUsersBy-email()` - List by email
919
- - `getUsersById()` - Get users
920
- - `getUsersMe()` - List me
921
- - `getUsersMeActivity()` - List activity
922
- - `getUsersMeDashboard()` - List dashboard
923
- - `getUsersMeStats()` - List stats
924
- - `getUsersMeTenants()` - List tenants
925
- - `postUser-profiles()` - Create user profiles
926
- - `postUsersAuthConfirm()` - Create confirm
927
- - `postUsersAuthLogin()` - Create login
928
- - `postUsersAuthMagic-linkLogin()` - Create login
929
- - `postUsersAuthMagic-linkRequest()` - Create request
930
- - `postUsersAuthRegister()` - Create register
931
- - `postUsersAuthRegister-with-oidc()` - Create register with oidc
932
- - `postUsersAuthResend-confirmation()` - Create resend confirmation
933
- - `postUsersAuthReset-passwordRequest()` - Create request
934
- - `postUsersRegister-isv()` - Create register isv
935
- - `patchUser-profilesById()` - Update user profiles
936
- - `patchUser-profilesByIdAccept-tos()` - Update accept tos
937
- - `patchUser-profilesByIdDismiss-announcement()` - Update dismiss announcement
938
- - `patchUser-profilesByIdDismiss-welcome()` - Update dismiss welcome
939
- - `patchUsersAuthPasswordChange()` - Update change
940
- - `patchUsersAuthReset-password()` - Update reset password
941
- - `patchUsersById()` - Update admin
942
- - `patchUsersByIdConfirm-email()` - Update confirm email
943
- - `patchUsersByIdEmail()` - Update email
944
- - `patchUsersByIdReset-password()` - Update reset password
945
- - `deleteUser-profilesById()` - Delete user profiles
946
- - `deleteUsersById()` - Delete users
966
+ - `getUser-profiles()` - /user-profiles operation on user_profile resource
967
+ - `getUser-profilesById()` - /user-profiles/:id operation on user_profile resource
968
+ - `getUser-profilesMe()` - Get the current user's profile
969
+ - `getUsers()` - /users operation on user resource
970
+ - `getUsersBy-email()` - Look up a single user by their email address (case-insensitive)
971
+ - `getUsersById()` - /users/:id operation on user resource
972
+ - `getUsersMe()` - Get the currently authenticated user
973
+ - `getUsersMeActivity()` - Get activity feed for the user's tenant context
974
+ - `getUsersMeDashboard()` - Get dashboard data for the user's tenant context
975
+ - `getUsersMeStats()` - Get stats for the user's tenant context
976
+ - `getUsersMeTenants()` - List all tenants the current user belongs to with their roles and permissions
977
+ - `postUser-profiles()` - Create a user profile record linked to an existing user
978
+ - `postUsersAuthConfirm()` - Confirm a user's email address using a confirmation token
979
+ - `postUsersAuthLogin()` - Attempt to sign in using a username and password.
980
+ - `postUsersAuthMagic-linkLogin()` - /users/auth/magic-link/login operation on user resource
981
+ - `postUsersAuthMagic-linkRequest()` - /users/auth/magic-link/request operation on user resource
982
+ - `postUsersAuthRegister()` - Register a new user account with email and password
983
+ - `postUsersAuthRegister-with-oidc()` - Register or sign in a user via an OAuth/OIDC provider (Google, GitHub, Salesforce,
984
+ Microsoft)
985
+ - `postUsersAuthResend-confirmation()` - Resend confirmation email to an unconfirmed user
986
+ - `postUsersAuthReset-passwordRequest()` - Public action for users to request a password reset email
987
+ - `postUsersRegister-isv()` - Platform Admin action to register a new ISV (User + Tenant + App)
988
+ - `patchUser-profilesById()` - Update the user's display profile fields: name, avatar, bio, social links, and
989
+ raw preferences map
990
+ - `patchUser-profilesByIdAccept-tos()` - Accept Terms of Service - merges with existing preferences
991
+ - `patchUser-profilesByIdDismiss-announcement()` - Dismiss announcement - merges with existing preferences
992
+ - `patchUser-profilesByIdDismiss-welcome()` - Dismiss welcome message - merges with existing preferences
993
+ - `patchUsersAuthPasswordChange()` - Change password for authenticated user with current password verification
994
+ - `patchUsersAuthReset-password()` - Reset password using admin-issued reset token
995
+ - `patchUsersById()` - Admin-only user management (platform admins) - promotes/demotes admin status
996
+ - `patchUsersByIdConfirm-email()` - Admin manually confirms user's email
997
+ - `patchUsersByIdEmail()` - Admin-only email update
998
+ - `patchUsersByIdReset-password()` - Admin triggers password reset email for user
999
+ - `deleteUser-profilesById()` - /user-profiles/:id operation on user_profile resource
1000
+ - `deleteUsersById()` - Permanently delete a user account
1001
+
1002
+ ## Voice recording
1003
+
1004
+ - `getVoiceRecordings()` - /voice/recordings operation on voice_recording resource
1005
+ - `getVoiceRecordingsById()` - /voice/recordings/:id operation on voice_recording resource
1006
+ - `getVoiceRecordingsSessionBySessionId()` - List recordings for a specific voice session
947
1007
 
948
1008
  ## Voice session
949
1009
 
950
- - `getVoiceSessions()` - List sessions
951
- - `getVoiceSessionsById()` - Get sessions
952
- - `getVoiceSessionsMine()` - List mine
953
- - `getVoiceSessionsWorkspaceByWorkspaceId()` - Get workspace
954
- - `postVoiceSessions()` - Create sessions
955
- - `patchVoiceSessionsByIdFinalize()` - Update finalize
956
- - `patchVoiceSessionsByIdStop()` - Update stop
1010
+ - `getVoiceSessions()` - /voice/sessions operation on voice_session resource
1011
+ - `getVoiceSessionsById()` - /voice/sessions/:id operation on voice_session resource
1012
+ - `getVoiceSessionsMine()` - List current user's voice sessions
1013
+ - `getVoiceSessionsWorkspaceByWorkspaceId()` - List all voice sessions in a workspace (ISV admin)
1014
+ - `postVoiceSessions()` - Start a new voice session with LiveKit room provisioning
1015
+ - `patchVoiceSessionsByIdFinalize()` - Dispatch accumulated transcript to the blueprint/chat pipeline
1016
+ - `patchVoiceSessionsByIdStop()` - End a voice session and release the LiveKit room
1017
+ - `deleteVoiceSessionsById()` - /voice/sessions/:id operation on voice_session resource
1018
+
1019
+ ## Voice transcription result
1020
+
1021
+ - `getVoiceTranscription-results()` - /voice/transcription-results operation on voice_transcription_result resource
1022
+ - `getVoiceTranscription-resultsById()` - /voice/transcription-results/:id operation on voice_transcription_result resource
1023
+ - `getVoiceTranscription-resultsSessionBySessionId()` - List transcription results for a voice session
957
1024
 
958
1025
  ## Watcher claim
959
1026
 
960
- - `getWatcherClaims()` - List claims
961
- - `getWatcherClaimsById()` - Get claims
962
- - `getWatcherClaimsHistory()` - List history
963
- - `getWatcherClaimsStatus()` - List status
964
- - `postWatcherClaims()` - Create claims
965
- - `patchWatcherClaimsById()` - Update claims
966
- - `patchWatcherClaimsByIdRelease()` - Update release
967
- - `patchWatcherClaimsByIdRetry()` - Update retry
1027
+ - `getWatcherClaims()` - List claims for a workspace, optionally filtering by one or more statuses (e.g., [:claimed, :processing])
1028
+ - `getWatcherClaimsById()` - Paginate all ingestion claims; use by_workspace to scope to a specific workspace and filter by status.
1029
+ - `getWatcherClaimsHistory()` - Check if a file hash was already processed in this workspace
1030
+ - `getWatcherClaimsStatus()` - Get ingestion status for a workspace
1031
+ - `postWatcherClaims()` - Atomically claim a detected file for processing; returns {claimed: true, claim: ...} on success or {claimed: false, existing: ...} if another machine already holds the claim.
1032
+ - `patchWatcherClaimsById()` - Advance a claim through the state machine (claimed → processing → completed/failed); stamps completed_at when transitioning to :completed
1033
+ - `patchWatcherClaimsByIdRelease()` - Release a claim by setting its status to :expired, allowing another machine to re-claim the file on the next poll cycle.
1034
+ - `patchWatcherClaimsByIdRetry()` - Re-open a terminal claim (completed/failed/expired/document_deleted) for re-processing; increments retry_count unless reset_retry_count is true
968
1035
 
969
1036
  ## Watcher event
970
1037
 
971
- - `getWatcherEvents()` - List events
972
- - `getWatcherEventsById()` - Get events
973
- - `postWatcherEvents()` - Create events
1038
+ - `getWatcherEvents()` - List ingestion events for a workspace, optionally filtered by event_type, machine_id, or a since timestamp
1039
+ - `getWatcherEventsById()` - Fetch a single ingestion event by ID; use the :list action to query events by workspace, type, machine, or time range.
1040
+ - `postWatcherEvents()` - Create multiple events in batch
974
1041
 
975
1042
  ## Webhooks
976
1043
 
977
- - `getWebhook-configs()` - List webhook configs
978
- - `getWebhook-configsById()` - Get webhook configs
979
- - `getWebhook-configsByIdEvents()` - Get events
980
- - `getWebhook-configsStats()` - List stats
981
- - `getWebhook-deliveries()` - List webhook deliveries
982
- - `getWebhook-deliveriesById()` - Get webhook deliveries
983
- - `getWebhook-deliveriesStats()` - List stats
984
- - `postWebhook-configs()` - Create webhook configs
985
- - `postWebhook-configsBulk-disable()` - Create bulk disable
986
- - `postWebhook-configsBulk-enable()` - Create bulk enable
987
- - `postWebhook-configsByIdReplay()` - Create replay
988
- - `postWebhook-configsByIdTest()` - Create test
989
- - `postWebhook-deliveriesBulk-retry()` - Create bulk retry
990
- - `postWebhook-deliveriesByIdRetry()` - Create retry
991
- - `patchWebhook-configsById()` - Update webhook configs
992
- - `patchWebhook-configsByIdRotate-secret()` - Update rotate secret
993
- - `deleteWebhook-configsById()` - Delete webhook configs
1044
+ - `getWebhook-configs()` - /webhook-configs operation on webhook_config resource
1045
+ - `getWebhook-configsById()` - /webhook-configs/:id operation on webhook_config resource
1046
+ - `getWebhook-configsByIdEvents()` - List available events that can be subscribed to
1047
+ - `getWebhook-configsStats()` - Get webhook configuration statistics
1048
+ - `getWebhook-deliveries()` - /webhook-deliveries operation on webhook_delivery resource
1049
+ - `getWebhook-deliveriesById()` - /webhook-deliveries/:id operation on webhook_delivery resource
1050
+ - `getWebhook-deliveriesStats()` - Return aggregate delivery counts by status (total, delivered, failed, retrying)
1051
+ - `postWebhook-configs()` - Register a new webhook endpoint to receive platform events
1052
+ - `postWebhook-configsBulk-disable()` - Disable multiple webhook configs by ID in a single call
1053
+ - `postWebhook-configsBulk-enable()` - Enable multiple webhook configs by ID in a single call
1054
+ - `postWebhook-configsByIdReplay()` - Replay historical events to this webhook
1055
+ - `postWebhook-configsByIdTest()` - Send a realistic sample payload to the webhook URL to verify connectivity and signature verification
1056
+ - `postWebhook-deliveriesBulk-retry()` - Set multiple delivery records to `:retrying` status in bulk
1057
+ - `postWebhook-deliveriesByIdRetry()` - Re-enqueue a failed or pending delivery for immediate re-dispatch
1058
+ - `patchWebhook-configsById()` - Update webhook endpoint settings such as URL, subscribed events, and enabled state
1059
+ - `patchWebhook-configsByIdRotate-secret()` - Generate a new `whsec_`-prefixed HMAC secret for this webhook, invalidating the previous secret immediately
1060
+ - `deleteWebhook-configsById()` - /webhook-configs/:id operation on webhook_config resource
994
1061
 
995
1062
  ## Workspace document stats
996
1063
 
997
- - `getTenantsByTenantIdWorkspaceStats()` - Get workspace stats
1064
+ - `getTenantsByTenantIdWorkspaceStats()` - /tenants/:tenant_id/workspace_stats operation on workspace_document_stats resource
998
1065
 
999
1066
  ## Workspace-membership
1000
1067
 
1001
- - `getWorkspace-memberships()` - List workspace memberships
1002
- - `getWorkspace-membershipsByWorkspaceIdByUserId()` - Get workspace memberships
1003
- - `getWorkspace-membershipsInherited()` - List inherited
1004
- - `getWorkspacesByIdMembers()` - Get members
1005
- - `postWorkspace-memberships()` - Create workspace memberships
1006
- - `patchWorkspace-membershipsByWorkspaceIdByUserId()` - Update workspace memberships
1007
- - `patchWorkspace-membershipsByWorkspaceIdByUserIdProfile()` - Update profile
1008
- - `deleteWorkspace-membershipsByWorkspaceIdByUserId()` - Delete workspace memberships
1068
+ - `getWorkspace-memberships()` - /workspace-memberships operation on workspace-membership resource
1069
+ - `getWorkspace-membershipsByWorkspaceIdByUserId()` - /workspace-memberships/:workspace_id/:user_id operation on workspace-membership resource
1070
+ - `getWorkspace-membershipsInherited()` - List workspace members including inherited org owners/admins
1071
+ - `getWorkspacesByIdMembers()` - /workspaces/:id/members operation on workspace-membership resource
1072
+ - `postWorkspace-memberships()` - /workspace-memberships operation on workspace-membership resource
1073
+ - `patchWorkspace-membershipsByWorkspaceIdByUserId()` - /workspace-memberships/:workspace_id/:user_id operation on workspace-membership resource
1074
+ - `patchWorkspace-membershipsByWorkspaceIdByUserIdProfile()` - Update the member's profile_attributes field
1075
+ - `deleteWorkspace-membershipsByWorkspaceIdByUserId()` - /workspace-memberships/:workspace_id/:user_id operation on workspace-membership resource
1009
1076
 
1010
1077
  ## Workspaces
1011
1078
 
1012
- - `getWorkspaces()` - List workspaces
1013
- - `getWorkspacesById()` - Get workspaces
1014
- - `getWorkspacesMine()` - List mine
1015
- - `getWorkspacesShared()` - List shared
1016
- - `postWorkspaces()` - Create workspaces
1017
- - `patchWorkspacesById()` - Update workspaces
1018
- - `patchWorkspacesByIdAllocate()` - Update allocate
1019
- - `patchWorkspacesByIdPopulate-hashes()` - Update populate hashes
1020
- - `patchWorkspacesByIdStorage-settings()` - Update storage settings
1021
- - `deleteWorkspacesById()` - Delete workspaces
1079
+ - `getWorkspaces()` - List workspaces visible to the actor
1080
+ - `getWorkspacesById()` - Fetch a single workspace by its primary key
1081
+ - `getWorkspacesMine()` - List all workspaces where the authenticated user has a direct workspace membership
1082
+ - `getWorkspacesShared()` - Workspaces where user has membership but NOT tenant membership (shared from external orgs)
1083
+ - `postWorkspaces()` - Create a new workspace under a tenant
1084
+ - `patchWorkspacesById()` - Update workspace metadata and settings
1085
+ - `patchWorkspacesByIdAllocate()` - Transfer credits from the tenant's liability account to this workspace's
1086
+ liability account
1087
+ - `patchWorkspacesByIdPopulate-hashes()` - Enqueue a background job to populate file hashes for documents missing them
1088
+ - `patchWorkspacesByIdStorage-settings()` - Update workspace storage settings - tenant admin/owner only
1089
+ - `deleteWorkspacesById()` - Soft-delete a workspace by setting archived_at to the current timestamp
1022
1090
 
1023
1091
  ## Error Handling
1024
1092