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