@gpt-platform/admin 0.3.3 → 0.4.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.d.mts +9040 -3783
- package/dist/index.d.ts +9040 -3783
- package/dist/index.js +3191 -122
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +3191 -122
- package/dist/index.mjs.map +1 -1
- package/llms.txt +844 -769
- package/package.json +1 -1
package/llms.txt
CHANGED
|
@@ -25,1220 +25,1295 @@ client.setConfig({
|
|
|
25
25
|
|
|
26
26
|
## Access log
|
|
27
27
|
|
|
28
|
-
- `getAccess-logs()` -
|
|
29
|
-
- `getAccess-logsById()` -
|
|
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()` -
|
|
34
|
-
- `getAccountsBy-tenantByTenantId()` -
|
|
35
|
-
- `getAccountsById()` -
|
|
36
|
-
- `patchAccountsByIdCredit()` -
|
|
37
|
-
- `patchAccountsByIdDebit()` -
|
|
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()` -
|
|
41
|
+
- `getAgentsByIdStats()` - /agents/:id/stats operation on agent_stats resource
|
|
42
42
|
|
|
43
43
|
## Agent test result
|
|
44
44
|
|
|
45
|
-
- `postAgent-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()` -
|
|
49
|
+
- `getAgentsByIdTraining-stats()` - /agents/:id/training-stats operation on agent_training_stats resource
|
|
50
50
|
|
|
51
51
|
## Agent usage
|
|
52
52
|
|
|
53
|
-
- `getAgentsByIdUsage()` -
|
|
54
|
-
- `getAgentsUsage()` -
|
|
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()` -
|
|
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()` -
|
|
63
|
-
- `getAgent-version-revisionsById()` -
|
|
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
|
|
68
|
-
- `getAgent-versionsById()` -
|
|
69
|
-
- `getAgent-versionsByIdMetrics()` - Get metrics
|
|
70
|
-
- `getAgent-versionsByIdRevisions()` -
|
|
71
|
-
- `getAgents()` -
|
|
72
|
-
- `getAgentsById()` -
|
|
73
|
-
- `getAgentsByIdSchema-versions()` -
|
|
74
|
-
- `getAgentsByIdTraining-examples()` -
|
|
75
|
-
- `postAgent-versions()` - Create
|
|
76
|
-
- `postAgent-versionsByIdAdd-system-field()` -
|
|
77
|
-
- `postAgent-versionsByIdRemove-system-field()` -
|
|
78
|
-
- `postAgent-versionsByIdSet-system-fields()` -
|
|
79
|
-
- `postAgentsByIdAnalyze-training()` -
|
|
80
|
-
- `postAgentsByIdClone()` -
|
|
81
|
-
- `postAgentsByIdExport()` -
|
|
82
|
-
- `postAgentsByIdPublish-version()` - Create
|
|
83
|
-
- `postAgentsByIdRestore-version()` -
|
|
84
|
-
- `postAgentsByIdSchema-versions()` - Create schema
|
|
85
|
-
- `postAgentsByIdSchema-versionsByVersionIdActivate()` -
|
|
86
|
-
- `postAgentsByIdTeach()` -
|
|
87
|
-
- `postAgentsByIdTest()` -
|
|
88
|
-
- `postAgentsByIdValidate()` -
|
|
89
|
-
- `postAgentsClone-for-workspace()` -
|
|
90
|
-
- `postAgentsImport()` -
|
|
91
|
-
- `postAgentsPredict()` -
|
|
92
|
-
- `patchAgentsByIdSchema-versionsByVersionId()` - Update schema
|
|
93
|
-
- `deleteAgent-versionsById()` - Delete
|
|
94
|
-
- `deleteAgentsByIdTraining-examplesByExampleId()` - Delete training
|
|
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()` -
|
|
99
|
-
- `getSysAi-configById()` -
|
|
100
|
-
- `postSysAi-config()` -
|
|
101
|
-
- `patchSysAi-configById()` - Update
|
|
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()` -
|
|
107
|
-
- `getTraining-sessionsAgentsByAgentIdSessions()` -
|
|
108
|
-
- `getTraining-sessionsById()` -
|
|
109
|
-
- `postTraining-examples()` - Create training
|
|
110
|
-
- `postTraining-examplesBulk()` - Create
|
|
111
|
-
- `postTraining-examplesBulk-delete()` -
|
|
112
|
-
- `postTraining-examplesSearch()` -
|
|
113
|
-
- `patchTraining-examplesById()` - Update training
|
|
114
|
-
|
|
115
|
-
- `deleteTraining-
|
|
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
|
|
120
|
-
- `getLlmAnalyticsById()` -
|
|
121
|
-
- `getLlmAnalyticsCosts()` -
|
|
122
|
-
- `getLlmAnalyticsPlatform()` -
|
|
123
|
-
- `getLlmAnalyticsSummary()` -
|
|
124
|
-
- `getLlmAnalyticsUsage()` -
|
|
125
|
-
- `getLlmAnalyticsWorkspace()` -
|
|
126
|
-
- `postLlmAnalytics()` -
|
|
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
|
|
131
|
-
- `getApi-keysActive()` - List active
|
|
132
|
-
- `getApi-keysById()` -
|
|
133
|
-
- `getApi-keysStats()` -
|
|
134
|
-
- `postApi-keys()` - Create
|
|
135
|
-
- `patchApi-keysById()` - Update
|
|
136
|
-
- `patchApi-
|
|
137
|
-
- `patchApi-
|
|
138
|
-
|
|
139
|
-
- `patchApi-keysByIdRotate()` -
|
|
140
|
-
|
|
141
|
-
- `
|
|
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()` -
|
|
146
|
-
- `getApplicationsBy-slugBySlug()` -
|
|
147
|
-
- `getApplicationsById()` -
|
|
148
|
-
- `getApplicationsCurrent()` -
|
|
149
|
-
- `postApplications()` -
|
|
150
|
-
- `patchApplicationsById()` - Update
|
|
151
|
-
|
|
152
|
-
- `
|
|
153
|
-
- `
|
|
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()` -
|
|
158
|
-
- `getAudit-chain-entriesById()` -
|
|
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
|
|
163
|
-
- `getAudit-logsActivity()` -
|
|
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()` -
|
|
168
|
-
- `getBalancesById()` -
|
|
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()` -
|
|
174
|
-
- `getCredit-packagesSlugBySlug()` -
|
|
175
|
-
-
|
|
176
|
-
- `
|
|
177
|
-
- `
|
|
178
|
-
- `
|
|
179
|
-
- `
|
|
180
|
-
- `
|
|
181
|
-
- `
|
|
182
|
-
- `
|
|
183
|
-
- `
|
|
184
|
-
- `getWalletUsage
|
|
185
|
-
- `
|
|
186
|
-
- `
|
|
187
|
-
- `
|
|
188
|
-
- `
|
|
189
|
-
- `
|
|
190
|
-
- `
|
|
191
|
-
- `
|
|
192
|
-
- `
|
|
193
|
-
- `
|
|
194
|
-
- `
|
|
195
|
-
- `
|
|
196
|
-
- `
|
|
197
|
-
- `
|
|
198
|
-
- `
|
|
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()` -
|
|
203
|
-
- `getBreach-incidentsById()` -
|
|
204
|
-
- `postBreach-incidents()` -
|
|
205
|
-
- `patchBreach-incidentsByIdStatus()` -
|
|
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()` -
|
|
210
|
-
- `getBreach-notificationsById()` -
|
|
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()` -
|
|
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()` -
|
|
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()` -
|
|
223
|
-
- `getCatalogClassification-suggestionsWorkspaceByWorkspaceIdPending()` -
|
|
224
|
-
- `patchCatalogClassification-suggestionsByIdAccept()` -
|
|
225
|
-
- `patchCatalogClassification-suggestionsByIdReject()` -
|
|
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()` -
|
|
230
|
-
- `getCatalogOption-typesById()` -
|
|
231
|
-
- `postCatalogOption-types()` - Create option
|
|
232
|
-
- `patchCatalogOption-typesById()` - Update option
|
|
233
|
-
- `deleteCatalogOption-typesById()` -
|
|
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()` -
|
|
238
|
-
- `getCatalogOption-valuesOption-typeByOptionTypeId()` -
|
|
239
|
-
- `postCatalogOption-values()` - Create option
|
|
240
|
-
- `patchCatalogOption-valuesById()` - Update option
|
|
241
|
-
- `deleteCatalogOption-valuesById()` -
|
|
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()` -
|
|
246
|
-
- `getCatalogPrice-listsById()` -
|
|
247
|
-
- `postCatalogPrice-lists()` - Create price
|
|
248
|
-
- `patchCatalogPrice-listsById()` - Update price
|
|
249
|
-
- `deleteCatalogPrice-listsById()` -
|
|
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()` -
|
|
254
|
-
- `postCatalogPrice-list-entries()` -
|
|
255
|
-
- `patchCatalogPrice-list-entriesById()` - Update price
|
|
256
|
-
- `deleteCatalogPrice-list-entriesById()` -
|
|
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()` -
|
|
261
|
-
- `getCatalogPrice-suggestionsWorkspaceByWorkspaceId()` -
|
|
262
|
-
- `patchCatalogPrice-suggestionsByIdAccept()` -
|
|
263
|
-
- `patchCatalogPrice-suggestionsByIdReject()` -
|
|
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()` -
|
|
268
|
-
- `getCatalogProductsWorkspaceByWorkspaceId()` -
|
|
269
|
-
- `postCatalogProducts()` - Create
|
|
270
|
-
- `patchCatalogProductsById()` - Update
|
|
271
|
-
- `deleteCatalogProductsById()` -
|
|
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()` -
|
|
276
|
-
- `deleteCatalogProduct-classificationsById()` -
|
|
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()` -
|
|
281
|
-
- `getCatalogProduct-variantsProductByProductId()` -
|
|
282
|
-
- `postCatalogProduct-variants()` - Create product
|
|
283
|
-
- `patchCatalogProduct-variantsById()` - Update
|
|
284
|
-
- `deleteCatalogProduct-variantsById()` -
|
|
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()` -
|
|
289
|
-
- `getCatalogStock-locationsWorkspaceByWorkspaceId()` -
|
|
290
|
-
- `postCatalogStock-locations()` - Create stock
|
|
291
|
-
- `patchCatalogStock-locationsById()` - Update
|
|
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()` -
|
|
296
|
-
- `getCatalogStock-movementsTransactionByTransactionId()` -
|
|
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()` -
|
|
301
|
-
- `getCatalogStock-recordsLocationByStockLocationId()` -
|
|
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()` -
|
|
306
|
-
- `getCatalogTaxonomiesById()` -
|
|
307
|
-
- `postCatalogTaxonomies()` - Create
|
|
308
|
-
- `patchCatalogTaxonomiesById()` - Update
|
|
309
|
-
- `deleteCatalogTaxonomiesById()` -
|
|
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()` -
|
|
314
|
-
- `getCatalogTaxonomy-nodesTaxonomyByTaxonomyId()` -
|
|
315
|
-
- `postCatalogTaxonomy-nodes()` - Create taxonomy
|
|
316
|
-
- `patchCatalogTaxonomy-nodesById()` - Update
|
|
317
|
-
- `deleteCatalogTaxonomy-nodesById()` -
|
|
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()` -
|
|
322
|
-
- `deleteCatalogVariant-option-valuesById()` -
|
|
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()` -
|
|
327
|
-
- `getCatalogViewsWorkspaceByWorkspaceId()` -
|
|
328
|
-
- `postCatalogViews()` - Create
|
|
329
|
-
- `patchCatalogViewsById()` - Update
|
|
330
|
-
- `deleteCatalogViewsById()` -
|
|
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()` -
|
|
335
|
-
- `patchCatalogView-overridesById()` - Update view
|
|
336
|
-
- `deleteCatalogView-overridesById()` -
|
|
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()` -
|
|
341
|
-
- `deleteCatalogView-rulesById()` -
|
|
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()` -
|
|
346
|
-
- `postConfigs()` - Create
|
|
347
|
-
- `patchConfigsByKey()` - Update
|
|
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()` -
|
|
352
|
-
- `getExtractionConfig-enumsById()` -
|
|
353
|
-
- `postExtractionConfig-enums()` -
|
|
354
|
-
- `patchExtractionConfig-enumsById()` -
|
|
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()` -
|
|
359
|
-
- `getConnectorsById()` -
|
|
360
|
-
- `postConnectors()` -
|
|
361
|
-
- `
|
|
362
|
-
- `
|
|
363
|
-
- `
|
|
364
|
-
- `
|
|
365
|
-
- `
|
|
366
|
-
- `
|
|
367
|
-
- `
|
|
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
|
|
368
392
|
|
|
369
393
|
## Consent record
|
|
370
394
|
|
|
371
|
-
- `getConsent-records()` -
|
|
372
|
-
- `getConsent-recordsActive()` - List
|
|
373
|
-
- `getConsent-recordsById()` -
|
|
374
|
-
- `postConsent-records()` -
|
|
375
|
-
- `patchConsent-recordsByIdWithdraw()` -
|
|
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
|
|
376
400
|
|
|
377
401
|
## Conversations
|
|
378
402
|
|
|
379
|
-
- `getAiConversations()` -
|
|
380
|
-
- `getAiConversationsById()` -
|
|
381
|
-
- `postAiConversations()` -
|
|
382
|
-
- `patchAiConversationsById()` - Update
|
|
383
|
-
- `deleteAiConversationsById()` -
|
|
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
|
|
384
408
|
|
|
385
409
|
## Crawler job
|
|
386
410
|
|
|
387
|
-
- `getCrawlerJobs()` -
|
|
388
|
-
- `getCrawlerJobsById()` -
|
|
389
|
-
- `postCrawlerJobs()` - Create
|
|
390
|
-
- `patchCrawlerJobsByIdCancel()` -
|
|
391
|
-
- `deleteCrawlerJobsById()` -
|
|
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
|
|
392
416
|
|
|
393
417
|
## Crawler result
|
|
394
418
|
|
|
395
|
-
- `getCrawlerResults()` -
|
|
396
|
-
- `getCrawlerResultsById()` -
|
|
419
|
+
- `getCrawlerResults()` - /crawler/results operation on crawler_result resource
|
|
420
|
+
- `getCrawlerResultsById()` - /crawler/results/:id operation on crawler_result resource
|
|
397
421
|
|
|
398
422
|
## Crawler schedule
|
|
399
423
|
|
|
400
|
-
- `getCrawlerSchedules()` -
|
|
401
|
-
- `getCrawlerSchedulesById()` -
|
|
402
|
-
- `postCrawlerSchedules()` - Create
|
|
403
|
-
- `patchCrawlerSchedulesById()` - Update
|
|
404
|
-
- `patchCrawlerSchedulesByIdDisable()` -
|
|
405
|
-
- `patchCrawlerSchedulesByIdEnable()` -
|
|
406
|
-
- `patchCrawlerSchedulesByIdTrigger()` -
|
|
407
|
-
- `deleteCrawlerSchedulesById()` -
|
|
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
|
|
408
432
|
|
|
409
433
|
## Crawler site config
|
|
410
434
|
|
|
411
|
-
- `getCrawlerSite-configs()` -
|
|
412
|
-
- `getCrawlerSite-configsById()` -
|
|
413
|
-
- `postCrawlerSite-configs()` - Create
|
|
414
|
-
- `patchCrawlerSite-configsById()` - Update site
|
|
415
|
-
- `deleteCrawlerSite-configsById()` -
|
|
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
|
|
416
440
|
|
|
417
441
|
## Credential
|
|
418
442
|
|
|
419
|
-
- `getConnectorsCredentials()` -
|
|
420
|
-
- `getConnectorsCredentialsById()` -
|
|
421
|
-
- `postConnectorsCredentialsByIdRefresh()` -
|
|
443
|
+
- `getConnectorsCredentials()` - /connectors/credentials operation on credential resource
|
|
444
|
+
- `getConnectorsCredentialsById()` - /connectors/credentials/:id operation on credential resource
|
|
445
|
+
- `postConnectorsCredentialsByIdRefresh()` - Refresh OAuth credential token.
|
|
422
446
|
|
|
423
447
|
## Crm activity
|
|
424
448
|
|
|
425
|
-
- `getCrmActivitiesById()` -
|
|
426
|
-
- `getCrmActivitiesWorkspaceByWorkspaceId()` -
|
|
427
|
-
- `postCrmActivities()` -
|
|
428
|
-
- `deleteCrmActivitiesById()` -
|
|
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
|
|
429
453
|
|
|
430
454
|
## Crm channel capture config
|
|
431
455
|
|
|
432
|
-
- `getIsvCrmChannel-capture-configById()` -
|
|
433
|
-
- `postIsvCrmChannel-capture-config()` - Create channel capture
|
|
434
|
-
- `patchIsvCrmChannel-capture-configById()` - Update channel capture
|
|
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
|
|
435
459
|
|
|
436
460
|
## Crm company
|
|
437
461
|
|
|
438
|
-
- `getCrmCompaniesById()` -
|
|
439
|
-
- `getCrmCompaniesWorkspaceByWorkspaceId()` -
|
|
440
|
-
- `postCrmCompanies()` - Create
|
|
441
|
-
- `patchCrmCompaniesById()` - Update
|
|
442
|
-
- `deleteCrmCompaniesById()` -
|
|
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
|
|
443
467
|
|
|
444
468
|
## Crm contact
|
|
445
469
|
|
|
446
|
-
- `getCrmContactsById()` -
|
|
447
|
-
- `getCrmContactsWorkspaceByWorkspaceId()` -
|
|
448
|
-
|
|
449
|
-
- `
|
|
450
|
-
- `
|
|
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
|
|
451
479
|
|
|
452
480
|
## Crm custom entity
|
|
453
481
|
|
|
454
|
-
- `getCrmCustom-entitiesById()` -
|
|
455
|
-
- `getCrmCustom-entitiesWorkspaceByWorkspaceId()` -
|
|
456
|
-
-
|
|
457
|
-
- `
|
|
458
|
-
- `
|
|
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
|
|
459
488
|
|
|
460
489
|
## Crm custom entity type
|
|
461
490
|
|
|
462
|
-
- `getIsvCrmEntity-typesApplicationByApplicationId()` -
|
|
463
|
-
- `getIsvCrmEntity-typesById()` -
|
|
464
|
-
- `postIsvCrmEntity-types()` -
|
|
465
|
-
- `patchIsvCrmEntity-typesById()` - Update entity
|
|
466
|
-
- `deleteIsvCrmEntity-typesById()` -
|
|
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
|
|
467
496
|
|
|
468
497
|
## Crm custom entity version
|
|
469
498
|
|
|
470
|
-
- `getCrmCustom-entitiesByEntityIdVersions()` -
|
|
471
|
-
- `getCrmCustom-entitiesByEntityIdVersionsById()` -
|
|
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)
|
|
472
501
|
|
|
473
502
|
## Crm custom field definition
|
|
474
503
|
|
|
475
|
-
- `getIsvCrmField-definitionsEntity-typeByEntityType()` -
|
|
476
|
-
- `postIsvCrmField-definitions()` -
|
|
477
|
-
- `patchIsvCrmField-definitionsById()` - Update field
|
|
478
|
-
- `deleteIsvCrmField-definitionsById()` -
|
|
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
|
|
479
508
|
|
|
480
509
|
## Crm data export job
|
|
481
510
|
|
|
482
|
-
- `getCrmExportsById()` -
|
|
483
|
-
- `getCrmExportsWorkspaceByWorkspaceId()` -
|
|
484
|
-
- `postCrmExports()` -
|
|
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
|
|
485
514
|
|
|
486
515
|
## Crm deal
|
|
487
516
|
|
|
488
|
-
- `getCrmDealsById()` -
|
|
489
|
-
- `getCrmDealsWorkspaceByWorkspaceId()` -
|
|
490
|
-
- `postCrmDeals()` - Create
|
|
491
|
-
- `patchCrmDealsById()` - Update
|
|
492
|
-
- `deleteCrmDealsById()` -
|
|
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
|
|
493
522
|
|
|
494
523
|
## Crm deal product
|
|
495
524
|
|
|
496
|
-
- `getCrmDeal-products()` -
|
|
497
|
-
- `postCrmDeal-products()` -
|
|
498
|
-
- `deleteCrmDeal-productsById()` -
|
|
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
|
|
499
528
|
|
|
500
529
|
## Crm pipeline
|
|
501
530
|
|
|
502
|
-
- `getCrmPipelinesById()` -
|
|
503
|
-
- `getCrmPipelinesWorkspaceByWorkspaceId()` -
|
|
504
|
-
- `postCrmPipelines()` - Create
|
|
505
|
-
- `patchCrmPipelinesById()` - Update
|
|
506
|
-
- `deleteCrmPipelinesById()` -
|
|
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
|
|
507
536
|
|
|
508
537
|
## Crm pipeline stage
|
|
509
538
|
|
|
510
|
-
- `getCrmPipeline-stagesById()` -
|
|
511
|
-
- `postCrmPipeline-stages()` -
|
|
512
|
-
- `patchCrmPipeline-stagesById()` - Update pipeline
|
|
513
|
-
- `deleteCrmPipeline-stagesById()` -
|
|
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
|
|
514
543
|
|
|
515
544
|
## Crm relationship
|
|
516
545
|
|
|
517
|
-
- `getCrmRelationshipsById()` -
|
|
518
|
-
- `getCrmRelationshipsWorkspaceByWorkspaceId()` -
|
|
519
|
-
- `postCrmRelationships()` - Create
|
|
520
|
-
- `deleteCrmRelationshipsById()` -
|
|
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)
|
|
521
550
|
|
|
522
551
|
## Crm relationship type
|
|
523
552
|
|
|
524
|
-
- `getCrmRelationship-types()` -
|
|
525
|
-
- `getCrmRelationship-typesById()` -
|
|
526
|
-
- `postCrmRelationship-types()` -
|
|
527
|
-
- `patchCrmRelationship-typesById()` - Update relationship types
|
|
528
|
-
- `deleteCrmRelationship-typesById()` -
|
|
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
|
|
529
558
|
|
|
530
559
|
## Crm sync config
|
|
531
560
|
|
|
532
|
-
- `getIsvCrmSync-configsWorkspaceByWorkspaceId()` -
|
|
533
|
-
- `postIsvCrmSync-configs()` - Create sync
|
|
534
|
-
- `patchIsvCrmSync-configsById()` - Update sync
|
|
535
|
-
- `deleteIsvCrmSync-configsById()` -
|
|
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
|
|
536
565
|
|
|
537
566
|
## Customer
|
|
538
567
|
|
|
539
|
-
- `getCustomersById()` -
|
|
540
|
-
- `postCustomers()` -
|
|
541
|
-
- `patchCustomersById()` -
|
|
542
|
-
- `deleteCustomersById()` -
|
|
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
|
|
543
572
|
|
|
544
573
|
## Data protection impact assessment
|
|
545
574
|
|
|
546
|
-
- `getImpact-assessments()` -
|
|
547
|
-
- `getImpact-assessmentsById()` -
|
|
548
|
-
- `postImpact-assessments()` -
|
|
549
|
-
- `patchImpact-assessmentsById()` - Update
|
|
550
|
-
- `patchImpact-assessmentsByIdApprove()` -
|
|
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
|
|
551
580
|
|
|
552
581
|
## Data subject request
|
|
553
582
|
|
|
554
|
-
- `getData-subject-requests()` -
|
|
555
|
-
- `getData-subject-requestsById()` -
|
|
556
|
-
- `postData-subject-requests()` -
|
|
557
|
-
- `patchData-subject-requestsByIdStatus()` -
|
|
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.
|
|
558
587
|
|
|
559
588
|
## Document chunk
|
|
560
589
|
|
|
561
|
-
- `getAiChunksDocumentByDocumentId()` -
|
|
562
|
-
- `postAiChunksSearch()` -
|
|
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.
|
|
563
592
|
|
|
564
593
|
## Document Extraction
|
|
565
594
|
|
|
566
|
-
- `getExtractionDocuments()` -
|
|
567
|
-
- `getExtractionDocumentsById()` -
|
|
568
|
-
- `getExtractionDocumentsByIdStatus()` -
|
|
569
|
-
|
|
570
|
-
- `
|
|
571
|
-
- `
|
|
572
|
-
- `
|
|
573
|
-
- `
|
|
574
|
-
- `
|
|
575
|
-
- `
|
|
576
|
-
- `
|
|
577
|
-
- `
|
|
578
|
-
- `
|
|
579
|
-
- `
|
|
580
|
-
- `
|
|
581
|
-
- `patchExtractionDocumentsByIdDismiss
|
|
582
|
-
- `
|
|
583
|
-
|
|
584
|
-
- `
|
|
585
|
-
- `
|
|
586
|
-
- `
|
|
587
|
-
|
|
588
|
-
- `
|
|
589
|
-
- `
|
|
590
|
-
- `
|
|
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
|
|
591
624
|
|
|
592
625
|
## Document stats
|
|
593
626
|
|
|
594
|
-
- `getDocumentsStats()` -
|
|
627
|
+
- `getDocumentsStats()` - /documents/stats operation on document_stats resource
|
|
595
628
|
|
|
596
629
|
## Email template
|
|
597
630
|
|
|
598
|
-
- `getApplicationsByApplicationIdEmail-templates()` -
|
|
599
|
-
- `getApplicationsByApplicationIdEmail-templatesBySlug()` -
|
|
600
|
-
- `postApplicationsByApplicationIdEmail-templates()` - Create email
|
|
601
|
-
- `postApplicationsByApplicationIdEmail-templatesBySlugPreview()` -
|
|
602
|
-
- `postApplicationsByApplicationIdEmail-templatesBySlugTest()` -
|
|
603
|
-
- `patchApplicationsByApplicationIdEmail-templatesBySlug()` - Update
|
|
604
|
-
- `deleteApplicationsByApplicationIdEmail-templatesBySlug()` -
|
|
605
|
-
|
|
606
|
-
## Email-marketing-campaign
|
|
607
|
-
|
|
608
|
-
- `getEmail-marketingCampaignsById()` - Get campaigns
|
|
609
|
-
- `getEmail-marketingCampaignsWorkspaceByWorkspaceId()` - Get workspace
|
|
610
|
-
- `postEmail-marketingCampaigns()` - Create campaigns
|
|
611
|
-
- `postEmail-marketingCampaignsByIdAnalyze()` - Create analyze
|
|
612
|
-
- `postEmail-marketingCampaignsByIdCreate-followup()` - Create create followup
|
|
613
|
-
- `postEmail-marketingCampaignsByIdExport()` - Create export
|
|
614
|
-
- `postEmail-marketingCampaignsByIdGenerate-emails()` - Create generate emails
|
|
615
|
-
- `postEmail-marketingCampaignsByIdImport-recipients()` - Create import recipients
|
|
616
|
-
- `postEmail-marketingCampaignsByIdOptimize-send-times()` - Create optimize send times
|
|
617
|
-
- `postEmail-marketingCampaignsByIdOptimize-subjects()` - Create optimize subjects
|
|
618
|
-
- `postEmail-marketingCampaignsByIdSend()` - Create send
|
|
619
|
-
- `patchEmail-marketingCampaignsById()` - Update campaigns
|
|
620
|
-
- `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
|
|
621
638
|
|
|
622
|
-
## Email-
|
|
639
|
+
## Email-inclusion
|
|
623
640
|
|
|
624
|
-
- `
|
|
625
|
-
- `
|
|
626
|
-
- `
|
|
627
|
-
- `
|
|
628
|
-
- `
|
|
629
|
-
- `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
|
|
630
646
|
|
|
631
|
-
## Email-marketing-
|
|
647
|
+
## Email-marketing-generated-email
|
|
632
648
|
|
|
633
|
-
- `getEmail-
|
|
634
|
-
- `getEmail-
|
|
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
|
|
635
655
|
|
|
636
|
-
## Email-marketing-
|
|
656
|
+
## Email-marketing-recipient
|
|
637
657
|
|
|
638
|
-
- `
|
|
639
|
-
- `
|
|
658
|
+
- `getCampaignsRecipientsById()` - /campaigns/recipients/:id operation on email-marketing-recipient resource
|
|
659
|
+
- `getCampaignsRecipientsCampaignByCampaignId()` - /campaigns/recipients/campaign/:campaign_id operation on email-marketing-recipient resource
|
|
640
660
|
|
|
641
661
|
## Email-marketing-sender-profile
|
|
642
662
|
|
|
643
|
-
- `getEmail-marketingSender-profilesById()` -
|
|
644
|
-
- `getEmail-marketingSender-profilesWorkspaceByWorkspaceId()` -
|
|
645
|
-
- `postEmail-marketingSender-profiles()` -
|
|
646
|
-
- `patchEmail-marketingSender-profilesById()` -
|
|
647
|
-
- `patchEmail-marketingSender-
|
|
648
|
-
- `
|
|
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
|
|
649
670
|
|
|
650
671
|
## Email-marketing-sequence
|
|
651
672
|
|
|
652
|
-
- `
|
|
653
|
-
- `
|
|
654
|
-
- `
|
|
655
|
-
- `
|
|
656
|
-
- `
|
|
657
|
-
- `
|
|
658
|
-
- `
|
|
659
|
-
- `
|
|
660
|
-
- `
|
|
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
|
|
661
682
|
|
|
662
683
|
## Email-marketing-sequence-step
|
|
663
684
|
|
|
664
|
-
- `
|
|
665
|
-
- `
|
|
666
|
-
- `
|
|
667
|
-
- `
|
|
668
|
-
- `
|
|
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
|
|
669
690
|
|
|
670
691
|
## Email-marketing-template
|
|
671
692
|
|
|
672
|
-
- `getEmail-marketingTemplatesById()` -
|
|
673
|
-
- `getEmail-marketingTemplatesWorkspaceByWorkspaceId()` -
|
|
674
|
-
- `postEmail-marketingTemplates()` -
|
|
675
|
-
- `
|
|
676
|
-
- `patchEmail-
|
|
677
|
-
- `patchEmail-
|
|
678
|
-
- `
|
|
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
|
|
679
718
|
|
|
680
|
-
## Email-
|
|
719
|
+
## Email-recipient
|
|
681
720
|
|
|
682
|
-
- `
|
|
683
|
-
- `
|
|
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
|
|
684
725
|
|
|
685
|
-
## Email-
|
|
726
|
+
## Email-send-limit
|
|
686
727
|
|
|
687
|
-
- `
|
|
688
|
-
- `
|
|
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
|
|
689
745
|
|
|
690
746
|
## Embedding
|
|
691
747
|
|
|
692
|
-
- `postAiEmbed()` -
|
|
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.
|
|
693
749
|
|
|
694
750
|
## Extraction Batches
|
|
695
751
|
|
|
696
|
-
- `getExtractionBatchesById()` -
|
|
697
|
-
- `getExtractionBatchesByIdUpload-urls()` -
|
|
698
|
-
- `getExtractionBatchesWorkspaceByWorkspaceId()` -
|
|
699
|
-
- `postExtractionBatches()` - Create
|
|
700
|
-
- `deleteExtractionBatchesById()` -
|
|
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
|
|
701
757
|
|
|
702
758
|
## Extraction export
|
|
703
759
|
|
|
704
|
-
- `getWorkspacesByWorkspaceIdExtractionExports()` -
|
|
705
|
-
- `getWorkspacesByWorkspaceIdExtractionExportsById()` -
|
|
706
|
-
- `postWorkspacesByWorkspaceIdExtractionExports()` -
|
|
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
|
|
707
763
|
|
|
708
764
|
## Extraction Results
|
|
709
765
|
|
|
710
|
-
- `getExtractionResults()` -
|
|
711
|
-
- `getExtractionResultsById()` -
|
|
712
|
-
- `getExtractionResultsDocumentByDocumentId()` -
|
|
713
|
-
- `getExtractionResultsDocumentByDocumentIdHistory()` -
|
|
714
|
-
- `getExtractionResultsDocumentByDocumentIdPartial()` - Get partial
|
|
715
|
-
- `getExtractionResultsWorkspaceByWorkspaceId()` -
|
|
716
|
-
- `patchExtractionResultsById()` -
|
|
717
|
-
- `patchExtractionResultsByIdRegenerate()` -
|
|
718
|
-
|
|
719
|
-
- `
|
|
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
|
|
720
777
|
|
|
721
778
|
## Extraction workflow
|
|
722
779
|
|
|
723
|
-
- `getExtraction-workflows()` -
|
|
724
|
-
- `getExtraction-workflowsById()` -
|
|
725
|
-
- `postExtraction-workflows()` -
|
|
726
|
-
- `patchExtraction-workflowsById()` -
|
|
727
|
-
- `deleteExtraction-workflowsById()` -
|
|
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
|
|
728
785
|
|
|
729
786
|
## Field mapping confirmation
|
|
730
787
|
|
|
731
|
-
- `postWorkspacesByWorkspaceIdExtractionByDocumentIdMapping()` -
|
|
788
|
+
- `postWorkspacesByWorkspaceIdExtractionByDocumentIdMapping()` - /workspaces/:workspace_id/extraction/:document_id/mapping operation on field_mapping_confirmation resource
|
|
732
789
|
|
|
733
790
|
## Field mapping result
|
|
734
791
|
|
|
735
|
-
- `getWorkspacesByWorkspaceIdExtractionByDocumentIdMapping()` -
|
|
792
|
+
- `getWorkspacesByWorkspaceIdExtractionByDocumentIdMapping()` - /workspaces/:workspace_id/extraction/:document_id/mapping operation on field_mapping_result resource
|
|
736
793
|
|
|
737
794
|
## Field Templates
|
|
738
795
|
|
|
739
|
-
- `getField-templates()` -
|
|
740
|
-
- `getField-templatesById()` -
|
|
741
|
-
- `postField-templates()` -
|
|
742
|
-
- `deleteField-templatesById()` -
|
|
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
|
|
743
800
|
|
|
744
801
|
## Invitations
|
|
745
802
|
|
|
746
|
-
- `getInvitations()` - List invitations
|
|
747
|
-
- `getInvitationsConsumeByToken()` -
|
|
748
|
-
- `getInvitationsMe()` - List
|
|
749
|
-
- `postInvitations()` -
|
|
750
|
-
- `postInvitationsAccept-by-token()` -
|
|
751
|
-
- `patchInvitationsByIdAccept()` -
|
|
752
|
-
- `patchInvitationsByIdAccept-by-user()` -
|
|
753
|
-
- `patchInvitationsByIdDecline()` -
|
|
754
|
-
- `patchInvitationsByIdResend()` -
|
|
755
|
-
- `patchInvitationsByIdRevoke()` -
|
|
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
|
|
756
813
|
|
|
757
814
|
## Isv revenue
|
|
758
815
|
|
|
759
|
-
- `getIsv-revenue()` -
|
|
760
|
-
- `getIsv-revenueById()` -
|
|
761
|
-
- `postIsv-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
|
|
762
819
|
|
|
763
820
|
## Isv settlement
|
|
764
821
|
|
|
765
|
-
- `getIsv-settlements()` -
|
|
766
|
-
- `getIsv-settlementsById()` -
|
|
767
|
-
- `postIsv-settlements()` -
|
|
768
|
-
- `patchIsv-settlementsById()` -
|
|
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
|
|
769
826
|
|
|
770
827
|
## Knowledge Graph
|
|
771
828
|
|
|
772
|
-
- `getAiGraphNodes()` -
|
|
773
|
-
- `getAiGraphNodesLabelByLabel()` -
|
|
774
|
-
- `postAiGraphNodes()` - Create
|
|
775
|
-
- `deleteAiGraphNodesById()` -
|
|
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
|
|
776
833
|
|
|
777
834
|
## Ledger
|
|
778
835
|
|
|
779
|
-
- `getLedger()` -
|
|
780
|
-
- `getLedgerBy-accountByAccountId()` -
|
|
781
|
-
- `getLedgerById()` -
|
|
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
|
|
782
839
|
|
|
783
840
|
## Legal acceptance
|
|
784
841
|
|
|
785
|
-
- `getLegal-acceptances()` -
|
|
786
|
-
- `getLegal-acceptancesById()` -
|
|
787
|
-
- `getLegal-acceptancesLatest()` -
|
|
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
|
|
788
845
|
|
|
789
846
|
## Legal document
|
|
790
847
|
|
|
791
|
-
- `getLegal-documents()` -
|
|
792
|
-
- `getLegal-documentsBy-locale()` -
|
|
793
|
-
- `getLegal-documentsById()` -
|
|
794
|
-
- `getLegal-documentsFor-application()` - List
|
|
795
|
-
- `postLegal-documents()` - Create legal
|
|
796
|
-
- `patchLegal-documentsById()` -
|
|
797
|
-
- `patchLegal-documentsByIdPublish()` -
|
|
798
|
-
- `patchLegal-documentsByIdUnpublish()` -
|
|
799
|
-
- `deleteLegal-documentsById()` -
|
|
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
|
|
800
857
|
|
|
801
858
|
## Messages
|
|
802
859
|
|
|
803
|
-
- `getAiMessages()` -
|
|
804
|
-
- `getMessages()` -
|
|
805
|
-
- `getMessagesById()` -
|
|
806
|
-
- `getMessagesSearch()` -
|
|
807
|
-
- `getMessagesSemantic-search()` -
|
|
808
|
-
- `getThreadsByIdMessages()` -
|
|
809
|
-
- `postAiMessages()` -
|
|
810
|
-
- `postMessages()` -
|
|
811
|
-
- `patchMessagesById()` -
|
|
812
|
-
- `deleteAiMessagesById()` -
|
|
813
|
-
- `deleteMessagesById()` -
|
|
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
|
|
814
871
|
|
|
815
872
|
## Notification log
|
|
816
873
|
|
|
817
|
-
- `getNotification-logs()` -
|
|
818
|
-
- `getNotification-logsById()` -
|
|
819
|
-
- `getNotification-logsStats()` -
|
|
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
|
|
820
877
|
|
|
821
878
|
## Notification method
|
|
822
879
|
|
|
823
|
-
- `getNotification-methods()` -
|
|
824
|
-
- `getNotification-methodsById()` -
|
|
825
|
-
- `postNotification-methods()` -
|
|
826
|
-
- `patchNotification-methodsById()` - Update notification
|
|
827
|
-
- `patchNotification-methodsByIdSend-verification()` -
|
|
828
|
-
- `patchNotification-methodsByIdSet-primary()` -
|
|
829
|
-
- `patchNotification-methodsByIdVerify()` -
|
|
830
|
-
- `deleteNotification-methodsById()` -
|
|
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
|
|
831
888
|
|
|
832
889
|
## Notification preference
|
|
833
890
|
|
|
834
|
-
- `getNotification-preferences()` -
|
|
835
|
-
- `getNotification-preferencesById()` -
|
|
836
|
-
- `postNotification-preferences()` - Create notification preferences
|
|
837
|
-
- `patchNotification-preferencesById()` - Update notification preferences
|
|
838
|
-
- `deleteNotification-preferencesById()` -
|
|
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
|
|
839
896
|
|
|
840
897
|
## Operation success
|
|
841
898
|
|
|
842
|
-
- `postDocumentsBulk-delete()` -
|
|
899
|
+
- `postDocumentsBulk-delete()` - /documents/bulk-delete operation on operation_success resource
|
|
843
900
|
|
|
844
901
|
## Payment method
|
|
845
902
|
|
|
846
|
-
- `getPayment-methods()` -
|
|
847
|
-
- `getPayment-methodsById()` -
|
|
848
|
-
- `postPayment-methods()` -
|
|
849
|
-
- `postPayment-methodsTokenize()` - Create
|
|
850
|
-
- `patchPayment-methodsById()` - Update payment
|
|
851
|
-
- `patchPayment-methodsByIdDefault()` -
|
|
852
|
-
- `deletePayment-methodsById()` -
|
|
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
|
|
853
910
|
|
|
854
911
|
## Permission
|
|
855
912
|
|
|
856
|
-
- `getPermissions()` - List permissions
|
|
857
|
-
- `getPermissionsById()` -
|
|
858
|
-
- `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.
|
|
859
916
|
|
|
860
917
|
## Permission meta
|
|
861
918
|
|
|
862
|
-
- `getPermissionsMeta()` -
|
|
919
|
+
- `getPermissionsMeta()` - Fetch a single metadata record describing the permission system — schema version, available apps, scopes, categories, and suggested client cache TTL
|
|
863
920
|
|
|
864
921
|
## Permission preset
|
|
865
922
|
|
|
866
|
-
- `getPermissionsPresetsById()` -
|
|
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.
|
|
867
924
|
|
|
868
925
|
## Platform-pricing-config
|
|
869
926
|
|
|
870
|
-
- `getPlatform-pricing-configs()` -
|
|
871
|
-
- `getPlatform-pricing-configsById()` -
|
|
872
|
-
- `postPlatform-pricing-configs()` -
|
|
873
|
-
- `patchPlatform-pricing-configsById()` -
|
|
874
|
-
- `deletePlatform-pricing-configsById()` -
|
|
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
|
|
875
932
|
|
|
876
933
|
## Post processing hook
|
|
877
934
|
|
|
878
|
-
- `getPost-processing-hooks()` -
|
|
879
|
-
- `getPost-processing-hooksById()` -
|
|
880
|
-
- `postPost-processing-hooks()` -
|
|
881
|
-
- `patchPost-processing-hooksById()` -
|
|
882
|
-
- `deletePost-processing-hooksById()` -
|
|
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
|
|
883
940
|
|
|
884
941
|
## Presigned url
|
|
885
942
|
|
|
886
|
-
- `postDocumentsPresigned-upload()` -
|
|
943
|
+
- `postDocumentsPresigned-upload()` - /documents/presigned-upload operation on presigned_url resource
|
|
887
944
|
|
|
888
945
|
## Pricing rule
|
|
889
946
|
|
|
890
|
-
- `getPricing-rules()` -
|
|
891
|
-
- `getPricing-rulesById()` -
|
|
892
|
-
- `getPricing-rulesResolve()` -
|
|
893
|
-
- `postPricing-rules()` -
|
|
894
|
-
- `patchPricing-rulesById()` -
|
|
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
|
|
895
952
|
|
|
896
953
|
## Pricing strategy
|
|
897
954
|
|
|
898
|
-
- `getPricing-strategies()` -
|
|
899
|
-
- `getPricing-strategiesById()` -
|
|
900
|
-
- `postPricing-strategies()` -
|
|
901
|
-
- `patchPricing-strategiesById()` -
|
|
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
|
|
902
959
|
|
|
903
960
|
## Processing activity
|
|
904
961
|
|
|
905
|
-
- `getProcessing-activities()` -
|
|
906
|
-
- `getProcessing-activitiesById()` -
|
|
907
|
-
- `postProcessing-activities()` -
|
|
908
|
-
- `deleteProcessing-activitiesById()` -
|
|
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
|
|
909
966
|
|
|
910
967
|
## Retention policy
|
|
911
968
|
|
|
912
|
-
- `getRetention-policies()` -
|
|
913
|
-
- `getRetention-policiesById()` -
|
|
914
|
-
- `postRetention-policies()` -
|
|
915
|
-
- `patchRetention-policiesById()` -
|
|
916
|
-
- `deleteRetention-policiesById()` -
|
|
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
|
|
917
974
|
|
|
918
975
|
## Role
|
|
919
976
|
|
|
920
|
-
- `getRoles()` -
|
|
921
|
-
- `postRoles()` - Create
|
|
922
|
-
- `patchRolesById()` - Update
|
|
923
|
-
- `deleteRolesById()` - Delete
|
|
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
|
|
924
981
|
|
|
925
982
|
## Scan result
|
|
926
983
|
|
|
927
|
-
- `getScan-results()` -
|
|
928
|
-
- `getScan-resultsById()` -
|
|
984
|
+
- `getScan-results()` - /scan-results operation on scan_result resource
|
|
985
|
+
- `getScan-resultsById()` - /scan-results/:id operation on scan_result resource
|
|
929
986
|
|
|
930
987
|
## Scheduling availability rule
|
|
931
988
|
|
|
932
|
-
- `getSchedulingAvailability-rules()` - List availability rules
|
|
933
|
-
- `getSchedulingAvailability-rulesById()` -
|
|
934
|
-
- `postSchedulingAvailability-rules()` - Create availability
|
|
935
|
-
- `patchSchedulingAvailability-rulesById()` - Update availability
|
|
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
|
|
936
993
|
|
|
937
994
|
## Scheduling booking
|
|
938
995
|
|
|
939
|
-
- `getSchedulingBookings()` - List bookings
|
|
940
|
-
- `getSchedulingBookingsById()` -
|
|
941
|
-
- `postSchedulingBookings()` - Create
|
|
942
|
-
- `patchSchedulingBookingsSchedulingBookingsByIdCancel()` -
|
|
943
|
-
- `patchSchedulingBookingsSchedulingBookingsByIdConfirm()` -
|
|
944
|
-
- `patchSchedulingBookingsSchedulingBookingsByIdReschedule()` -
|
|
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
|
|
945
1002
|
|
|
946
1003
|
## Scheduling calendar sync
|
|
947
1004
|
|
|
948
|
-
- `getSchedulingCalendar-syncs()` - List calendar
|
|
949
|
-
- `getSchedulingCalendar-syncsById()` -
|
|
950
|
-
- `postSchedulingCalendar-syncs()` -
|
|
951
|
-
- `patchSchedulingCalendar-syncsSchedulingCalendar-syncsById()` - Update calendar
|
|
952
|
-
- `patchSchedulingCalendar-syncsSchedulingCalendar-syncsByIdPause()` -
|
|
953
|
-
- `patchSchedulingCalendar-syncsSchedulingCalendar-syncsByIdResume()` -
|
|
954
|
-
- `deleteSchedulingCalendar-syncsSchedulingCalendar-syncsById()` -
|
|
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
|
|
955
1012
|
|
|
956
1013
|
## Scheduling event
|
|
957
1014
|
|
|
958
|
-
- `getSchedulingEvents()` - List events
|
|
959
|
-
- `getSchedulingEventsById()` -
|
|
960
|
-
- `postSchedulingEvents()` - Create
|
|
961
|
-
- `patchSchedulingEventsById()` - Update
|
|
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
|
|
962
1019
|
|
|
963
1020
|
## Scheduling event type
|
|
964
1021
|
|
|
965
|
-
- `getSchedulingEvent-types()` - List event types
|
|
966
|
-
- `getSchedulingEvent-typesById()` -
|
|
967
|
-
- `postSchedulingEvent-types()` - Create event
|
|
968
|
-
- `patchSchedulingEvent-typesById()` - Update event
|
|
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
|
|
969
1026
|
|
|
970
1027
|
## Scheduling location
|
|
971
1028
|
|
|
972
|
-
- `getSchedulingLocations()` - List locations
|
|
973
|
-
- `getSchedulingLocationsById()` -
|
|
974
|
-
- `postSchedulingLocations()` - Create
|
|
975
|
-
- `patchSchedulingLocationsById()` - Update
|
|
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
|
|
976
1033
|
|
|
977
1034
|
## Scheduling participant
|
|
978
1035
|
|
|
979
|
-
- `getSchedulingParticipants()` - List participants
|
|
980
|
-
- `getSchedulingParticipantsById()` -
|
|
981
|
-
- `postSchedulingParticipants()` -
|
|
982
|
-
- `patchSchedulingParticipantsById()` - Update
|
|
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
|
|
983
1040
|
|
|
984
1041
|
## Scheduling reminder
|
|
985
1042
|
|
|
986
|
-
- `getSchedulingReminders()` - List reminders
|
|
987
|
-
- `getSchedulingRemindersById()` -
|
|
988
|
-
- `postSchedulingReminders()` - Create
|
|
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
|
|
989
1046
|
|
|
990
1047
|
## Schema discovery
|
|
991
1048
|
|
|
992
|
-
- `getExtractionSchema-discoveriesById()` -
|
|
993
|
-
- `postExtractionSchema-discoveries()` -
|
|
994
|
-
- `postExtractionSchema-discoveriesBootstrap()` -
|
|
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
|
|
995
1052
|
|
|
996
1053
|
## Search
|
|
997
1054
|
|
|
998
|
-
- `getSearch()` -
|
|
999
|
-
- `getSearchHealth()` -
|
|
1000
|
-
- `getSearchIndexes()` -
|
|
1001
|
-
- `getSearchSaved()` - List saved
|
|
1002
|
-
- `getSearchSemantic()` -
|
|
1003
|
-
- `getSearchStats()` -
|
|
1004
|
-
- `getSearchStatus()` -
|
|
1005
|
-
- `getSearchSuggest()` -
|
|
1006
|
-
- `postAiSearch()` -
|
|
1007
|
-
- `postAiSearchAdvanced()` -
|
|
1008
|
-
- `postSearchBatch()` -
|
|
1009
|
-
- `postSearchReindex()` -
|
|
1010
|
-
- `postSearchSaved()` -
|
|
1011
|
-
- `postSearchSavedByIdRun()` -
|
|
1012
|
-
- `patchSearchSavedById()` -
|
|
1013
|
-
- `deleteSearchSavedById()` -
|
|
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
|
|
1014
1071
|
|
|
1015
1072
|
## Search analytics
|
|
1016
1073
|
|
|
1017
|
-
- `getSearchAnalytics()` - List analytics
|
|
1018
|
-
- `getSearchAnalyticsSummary()` -
|
|
1074
|
+
- `getSearchAnalytics()` - List search analytics with tenant-based filtering
|
|
1075
|
+
- `getSearchAnalyticsSummary()` - Aggregated search analytics summary (platform admin only)
|
|
1019
1076
|
|
|
1020
1077
|
## Semantic cache entry
|
|
1021
1078
|
|
|
1022
|
-
- `getSysSemantic-cacheById()` -
|
|
1023
|
-
- `postSysSemantic-cacheClear()` -
|
|
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
|
|
1024
1081
|
|
|
1025
1082
|
## Settlement
|
|
1026
1083
|
|
|
1027
|
-
- `getSettlements()` -
|
|
1028
|
-
- `getSettlementsById()` -
|
|
1029
|
-
- `postSettlements()` -
|
|
1084
|
+
- `getSettlements()` - /settlements operation on settlement resource
|
|
1085
|
+
- `getSettlementsById()` - /settlements/:id operation on settlement resource
|
|
1086
|
+
- `postSettlements()` - /settlements operation on settlement resource
|
|
1030
1087
|
|
|
1031
1088
|
## Storage
|
|
1032
1089
|
|
|
1033
|
-
- `getBuckets()` - List buckets
|
|
1034
|
-
- `getBucketsAll()` -
|
|
1035
|
-
- `getBucketsById()` -
|
|
1036
|
-
- `getBucketsByIdStats()` -
|
|
1037
|
-
- `postBuckets()` - Create
|
|
1038
|
-
- `patchBucketsById()` - Update
|
|
1039
|
-
- `deleteBucketsById()` - Delete
|
|
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.
|
|
1040
1097
|
|
|
1041
1098
|
## Storage file
|
|
1042
1099
|
|
|
1043
|
-
- `getStorage-files()` -
|
|
1044
|
-
- `getStorage-filesById()` -
|
|
1045
|
-
- `postStorage-files()` - Create
|
|
1046
|
-
- `patchStorage-filesById()` - Update
|
|
1047
|
-
- `patchStorage-filesByIdSoft-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
|
|
1048
1105
|
|
|
1049
1106
|
## Storage stats
|
|
1050
1107
|
|
|
1051
|
-
- `getStorageStats()` -
|
|
1052
|
-
- `getStorageStatsTenantByTenantId()` - Get tenant
|
|
1108
|
+
- `getStorageStats()` - Get platform-wide storage statistics
|
|
1109
|
+
- `getStorageStatsTenantByTenantId()` - Get storage stats for a specific tenant
|
|
1053
1110
|
|
|
1054
1111
|
## System message
|
|
1055
1112
|
|
|
1056
|
-
- `getSystem-messages()` -
|
|
1057
|
-
- `getSystem-messagesById()` -
|
|
1058
|
-
- `postSystem-messages()` - Create system
|
|
1059
|
-
- `patchSystem-messagesById()` -
|
|
1060
|
-
- `patchSystem-messagesByIdPublish()` -
|
|
1061
|
-
- `patchSystem-messagesByIdUnpublish()` -
|
|
1062
|
-
- `deleteSystem-messagesById()` -
|
|
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
|
|
1063
1120
|
|
|
1064
1121
|
## Tenant document stats
|
|
1065
1122
|
|
|
1066
|
-
- `getTenantsByTenantIdDocumentStats()` -
|
|
1123
|
+
- `getTenantsByTenantIdDocumentStats()` - /tenants/:tenant_id/document_stats operation on tenant_document_stats resource
|
|
1067
1124
|
|
|
1068
1125
|
## Tenant pricing override
|
|
1069
1126
|
|
|
1070
|
-
- `getTenant-pricing-overrides()` -
|
|
1071
|
-
- `getTenant-pricing-overridesById()` -
|
|
1072
|
-
- `postTenant-pricing-overrides()` -
|
|
1073
|
-
- `patchTenant-pricing-overridesById()` -
|
|
1074
|
-
- `deleteTenant-pricing-overridesById()` -
|
|
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
|
|
1075
1132
|
|
|
1076
1133
|
## Tenant stats
|
|
1077
1134
|
|
|
1078
|
-
- `getTenantsByTenantIdStats()` -
|
|
1135
|
+
- `getTenantsByTenantIdStats()` - /tenants/:tenant_id/stats operation on tenant_stats resource
|
|
1079
1136
|
|
|
1080
1137
|
## Tenant-membership
|
|
1081
1138
|
|
|
1082
|
-
- `getTenant-memberships()` -
|
|
1083
|
-
- `postTenant-memberships()` -
|
|
1084
|
-
- `patchTenant-membershipsByTenantIdByUserId()` -
|
|
1085
|
-
- `deleteTenant-membershipsByTenantIdByUserId()` -
|
|
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
|
|
1086
1143
|
|
|
1087
1144
|
## Tenants
|
|
1088
1145
|
|
|
1089
|
-
- `getTenants()` -
|
|
1090
|
-
- `getTenantsById()` -
|
|
1091
|
-
- `postTenants()` - Create
|
|
1092
|
-
- `postTenantsByIdCredit()` -
|
|
1093
|
-
- `postTenantsByIdSchedule-purge()` -
|
|
1094
|
-
- `postTenantsIsv()` - Create
|
|
1095
|
-
- `patchTenantsById()` - Update
|
|
1096
|
-
|
|
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
|
|
1097
1155
|
|
|
1098
1156
|
## Thread stats
|
|
1099
1157
|
|
|
1100
|
-
- `getThreadsStats()` -
|
|
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
|
|
1101
1159
|
|
|
1102
1160
|
## Thread workspace stats
|
|
1103
1161
|
|
|
1104
|
-
- `getThreadsWorkspace-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
|
|
1105
1163
|
|
|
1106
1164
|
## Threads
|
|
1107
1165
|
|
|
1108
|
-
- `getThreads()` -
|
|
1109
|
-
- `getThreadsById()` -
|
|
1110
|
-
- `getThreadsSearch()` -
|
|
1111
|
-
- `postThreads()` - Create
|
|
1112
|
-
- `postThreadsActive()` -
|
|
1113
|
-
- `postThreadsByIdExport()` -
|
|
1114
|
-
- `postThreadsByIdFork()` -
|
|
1115
|
-
- `postThreadsByIdMessages()` -
|
|
1116
|
-
- `postThreadsByIdSummarize()` -
|
|
1117
|
-
- `patchThreadsById()` - Update
|
|
1118
|
-
- `patchThreadsByIdArchive()` -
|
|
1119
|
-
- `patchThreadsByIdUnarchive()` -
|
|
1120
|
-
- `deleteThreadsById()` -
|
|
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
|
|
1121
1179
|
|
|
1122
1180
|
## Token
|
|
1123
1181
|
|
|
1124
|
-
- `postTokens()` - Create
|
|
1182
|
+
- `postTokens()` - Create a payment token
|
|
1125
1183
|
|
|
1126
1184
|
## Training analytics
|
|
1127
1185
|
|
|
1128
|
-
- `getWorkspacesAnalytics-batch()` -
|
|
1129
|
-
- `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
|
|
1130
1188
|
|
|
1131
1189
|
## Transaction
|
|
1132
1190
|
|
|
1133
|
-
- `getTransactions()` - List transactions
|
|
1134
|
-
|
|
1135
|
-
- `
|
|
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)
|
|
1136
1195
|
|
|
1137
1196
|
## Transfer
|
|
1138
1197
|
|
|
1139
|
-
- `getTransfers()` -
|
|
1140
|
-
- `getTransfersById()` -
|
|
1198
|
+
- `getTransfers()` - /transfers operation on transfer resource
|
|
1199
|
+
- `getTransfersById()` - /transfers/:id operation on transfer resource
|
|
1141
1200
|
|
|
1142
1201
|
## Users
|
|
1143
1202
|
|
|
1144
|
-
- `getUser-profiles()` -
|
|
1145
|
-
- `getUser-profilesById()` -
|
|
1146
|
-
- `getUser-profilesMe()` -
|
|
1147
|
-
- `getUsers()` -
|
|
1148
|
-
- `getUsersBy-email()` -
|
|
1149
|
-
- `getUsersById()` -
|
|
1150
|
-
- `getUsersMe()` -
|
|
1151
|
-
- `getUsersMeActivity()` -
|
|
1152
|
-
- `getUsersMeDashboard()` -
|
|
1153
|
-
- `getUsersMeStats()` -
|
|
1154
|
-
- `getUsersMeTenants()` - List tenants
|
|
1155
|
-
- `postUser-profiles()` - Create user
|
|
1156
|
-
- `postUsersAuthConfirm()` -
|
|
1157
|
-
- `postUsersAuthLogin()` -
|
|
1158
|
-
- `postUsersAuthMagic-linkLogin()` -
|
|
1159
|
-
- `postUsersAuthMagic-linkRequest()` -
|
|
1160
|
-
- `postUsersAuthRegister()` -
|
|
1161
|
-
- `postUsersAuthRegister-with-oidc()` -
|
|
1162
|
-
|
|
1163
|
-
- `
|
|
1164
|
-
- `
|
|
1165
|
-
- `
|
|
1166
|
-
- `patchUser-
|
|
1167
|
-
|
|
1168
|
-
- `patchUser-
|
|
1169
|
-
- `
|
|
1170
|
-
- `
|
|
1171
|
-
- `
|
|
1172
|
-
- `
|
|
1173
|
-
- `
|
|
1174
|
-
- `
|
|
1175
|
-
- `
|
|
1176
|
-
- `
|
|
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
|
|
1177
1244
|
|
|
1178
1245
|
## Voice session
|
|
1179
1246
|
|
|
1180
|
-
- `getVoiceSessions()` -
|
|
1181
|
-
- `getVoiceSessionsById()` -
|
|
1182
|
-
- `getVoiceSessionsMine()` - List
|
|
1183
|
-
- `getVoiceSessionsWorkspaceByWorkspaceId()` -
|
|
1184
|
-
- `postVoiceSessions()` -
|
|
1185
|
-
- `patchVoiceSessionsByIdFinalize()` -
|
|
1186
|
-
- `patchVoiceSessionsByIdStop()` -
|
|
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
|
|
1187
1261
|
|
|
1188
1262
|
## Webhooks
|
|
1189
1263
|
|
|
1190
|
-
- `getWebhook-configs()` -
|
|
1191
|
-
- `getWebhook-configsById()` -
|
|
1192
|
-
- `getWebhook-configsByIdEvents()` -
|
|
1193
|
-
- `getWebhook-configsStats()` -
|
|
1194
|
-
- `getWebhook-deliveries()` -
|
|
1195
|
-
- `getWebhook-deliveriesById()` -
|
|
1196
|
-
- `getWebhook-deliveriesStats()` -
|
|
1197
|
-
- `postWebhook-configs()` -
|
|
1198
|
-
- `postWebhook-configsBulk-disable()` -
|
|
1199
|
-
- `postWebhook-configsBulk-enable()` -
|
|
1200
|
-
- `postWebhook-configsByIdReplay()` -
|
|
1201
|
-
- `postWebhook-configsByIdTest()` -
|
|
1202
|
-
- `postWebhook-deliveriesBulk-retry()` -
|
|
1203
|
-
- `postWebhook-deliveriesByIdRetry()` -
|
|
1204
|
-
- `patchWebhook-configsById()` - Update webhook
|
|
1205
|
-
- `patchWebhook-configsByIdRotate-secret()` -
|
|
1206
|
-
- `deleteWebhook-configsById()` -
|
|
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
|
|
1207
1281
|
|
|
1208
1282
|
## Wholesale-agreement
|
|
1209
1283
|
|
|
1210
|
-
- `getWholesale-agreements()` -
|
|
1211
|
-
- `getWholesale-agreementsById()` -
|
|
1212
|
-
- `postWholesale-agreements()` -
|
|
1213
|
-
- `patchWholesale-agreementsById()` -
|
|
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
|
|
1214
1288
|
|
|
1215
1289
|
## Workspace document stats
|
|
1216
1290
|
|
|
1217
|
-
- `getTenantsByTenantIdWorkspaceStats()` -
|
|
1291
|
+
- `getTenantsByTenantIdWorkspaceStats()` - /tenants/:tenant_id/workspace_stats operation on workspace_document_stats resource
|
|
1218
1292
|
|
|
1219
1293
|
## Workspace-membership
|
|
1220
1294
|
|
|
1221
|
-
- `getWorkspace-memberships()` -
|
|
1222
|
-
- `getWorkspace-membershipsByWorkspaceIdByUserId()` -
|
|
1223
|
-
- `getWorkspace-membershipsInherited()` - List inherited
|
|
1224
|
-
- `getWorkspacesByIdMembers()` -
|
|
1225
|
-
- `postWorkspace-memberships()` -
|
|
1226
|
-
- `patchWorkspace-membershipsByWorkspaceIdByUserId()` -
|
|
1227
|
-
- `patchWorkspace-membershipsByWorkspaceIdByUserIdProfile()` - Update
|
|
1228
|
-
- `deleteWorkspace-membershipsByWorkspaceIdByUserId()` -
|
|
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
|
|
1229
1303
|
|
|
1230
1304
|
## Workspaces
|
|
1231
1305
|
|
|
1232
|
-
- `getWorkspaces()` - List workspaces
|
|
1233
|
-
- `getWorkspacesById()` -
|
|
1234
|
-
- `getWorkspacesMine()` - List
|
|
1235
|
-
- `getWorkspacesShared()` -
|
|
1236
|
-
- `postWorkspaces()` - Create
|
|
1237
|
-
- `patchWorkspacesById()` - Update
|
|
1238
|
-
- `patchWorkspacesByIdAllocate()` -
|
|
1239
|
-
|
|
1240
|
-
- `
|
|
1241
|
-
- `
|
|
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
|
|
1242
1317
|
|
|
1243
1318
|
## Error Handling
|
|
1244
1319
|
|