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