@mindstudio-ai/agent 0.1.176 → 0.1.177

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.
Files changed (49) hide show
  1. package/CHANGELOG.md +7 -0
  2. package/dist/analytics/index.d.ts +384 -0
  3. package/dist/auth/index.d.ts +113 -0
  4. package/dist/browser/index.d.ts +332 -0
  5. package/dist/cli.js +27 -27
  6. package/dist/client.d.ts +767 -0
  7. package/dist/config.d.ts +13 -0
  8. package/dist/context.d.ts +125 -0
  9. package/dist/datasources/index.d.ts +52 -0
  10. package/dist/datasources/source.d.ts +1074 -0
  11. package/dist/db/aggregate.d.ts +101 -0
  12. package/dist/db/index.d.ts +280 -0
  13. package/dist/db/mutation.d.ts +65 -0
  14. package/dist/db/predicate.d.ts +85 -0
  15. package/dist/db/query.d.ts +233 -0
  16. package/dist/db/raw.d.ts +36 -0
  17. package/dist/db/readBatching.d.ts +36 -0
  18. package/dist/db/scanHints.d.ts +8 -0
  19. package/dist/db/sql.d.ts +136 -0
  20. package/dist/db/table.d.ts +146 -0
  21. package/dist/db/time.d.ts +17 -0
  22. package/dist/db/types.d.ts +237 -0
  23. package/dist/db-ws.d.ts +35 -0
  24. package/dist/email/index.d.ts +396 -0
  25. package/dist/errors.d.ts +34 -0
  26. package/dist/events/index.d.ts +127 -0
  27. package/dist/files/index.d.ts +62 -0
  28. package/dist/files/store.d.ts +244 -0
  29. package/dist/generated/metadata.d.ts +8 -0
  30. package/dist/generated/snippets.d.ts +8 -0
  31. package/dist/generated/steps.d.ts +2745 -0
  32. package/dist/generated/types.d.ts +4234 -0
  33. package/dist/http.d.ts +22 -0
  34. package/dist/index.d.ts +59 -13329
  35. package/dist/index.js +15 -15
  36. package/dist/index.js.map +7 -1
  37. package/dist/jewel/index.d.ts +325 -0
  38. package/dist/mapper/index.d.ts +229 -0
  39. package/dist/rate-limit.d.ts +25 -0
  40. package/dist/reader/index.d.ts +170 -0
  41. package/dist/respond.d.ts +68 -0
  42. package/dist/task/index.d.ts +18 -0
  43. package/dist/task/local.d.ts +48 -0
  44. package/dist/task/schema.d.ts +120 -0
  45. package/dist/task/types.d.ts +203 -0
  46. package/dist/types.d.ts +591 -0
  47. package/dist/voice/index.d.ts +87 -0
  48. package/package.json +6 -12
  49. package/dist/postinstall.js +0 -12115
@@ -0,0 +1,2745 @@
1
+ import type { ActiveCampaignAddNoteStepInput, ActiveCampaignCreateContactStepInput, AddSubtitlesToVideoStepInput, AddThumbnailToVideoStepInput, AirtableCreateUpdateRecordStepInput, AirtableDeleteRecordStepInput, AirtableGetRecordStepInput, AirtableGetTableRecordsStepInput, AnalyzeImageStepInput, AnalyzeVideoStepInput, CaptureThumbnailStepInput, CheckAppRoleStepInput, CodaCreateUpdatePageStepInput, CodaCreateUpdateRowStepInput, CodaFindRowStepInput, CodaGetPageStepInput, CodaGetTableRowsStepInput, ConvertPdfToImagesStepInput, CreateDataSourceStepInput, CreateGmailDraftStepInput, CreateGoogleCalendarEventStepInput, CreateGoogleDocStepInput, CreateGoogleSheetStepInput, DecomposeImageStepInput, DeleteDataSourceStepInput, DeleteDataSourceDocumentStepInput, DeleteGmailEmailStepInput, DeleteGoogleCalendarEventStepInput, DeleteGoogleSheetRowsStepInput, DetectChangesStepInput, DetectPIIStepInput, DownloadVideoStepInput, EnhanceImageGenerationPromptStepInput, EnhanceVideoGenerationPromptStepInput, EnrichPersonStepInput, EvaluateDecisionStepInput, ExtractAudioFromVideoStepInput, ExtractTextStepInput, FetchDataSourceDocumentStepInput, FetchGoogleDocStepInput, FetchGoogleSheetStepInput, FetchSlackChannelHistoryStepInput, FetchYoutubeCaptionsStepInput, FetchYoutubeChannelStepInput, FetchYoutubeCommentsStepInput, FetchYoutubeVideoStepInput, Generate3dModelStepInput, GenerateImageStepInput, GenerateLipsyncStepInput, GenerateMusicStepInput, GeneratePdfStepInput, GenerateSoundStepInput, GenerateStaticVideoFromImageStepInput, GenerateVideoStepInput, GetGmailAttachmentsStepInput, GetGmailDraftStepInput, GetGmailEmailStepInput, GetGmailUnreadCountStepInput, GetGoogleCalendarEventStepInput, GetGoogleDriveFileStepInput, GetGoogleSheetInfoStepInput, GetMediaMetadataStepInput, HubspotCreateCompanyStepInput, HubspotCreateContactStepInput, HubspotGetCompanyStepInput, HubspotGetContactStepInput, HunterApiCompanyEnrichmentStepInput, HunterApiDomainSearchStepInput, HunterApiEmailFinderStepInput, HunterApiEmailVerificationStepInput, HunterApiPersonEnrichmentStepInput, ImageFaceSwapStepInput, ImageRemoveWatermarkStepInput, ImportFromUrlStepInput, InsertVideoClipsStepInput, ListDataSourcesStepInput, ListGmailDraftsStepInput, ListGmailLabelsStepInput, ListGoogleCalendarEventsStepInput, ListGoogleDriveFilesStepInput, ListRecentGmailEmailsStepInput, LogicStepInput, MakeDotComRunScenarioStepInput, MergeAudioStepInput, MergeVideosStepInput, MeshyAnimateStepInput, MeshyImageTo3dStepInput, MeshyRemeshStepInput, MeshyRigStepInput, MeshyTextTo3dStepInput, MeshyTextureStepInput, MixAudioIntoVideoStepInput, MuteVideoStepInput, N8nRunNodeStepInput, NotionCreatePageStepInput, NotionUpdatePageStepInput, PeopleSearchStepInput, PostToLinkedInStepInput, PostToSlackChannelStepInput, PostToXStepInput, PostToZapierStepInput, QueryDataSourceStepInput, QueryExternalDatabaseStepInput, QuickbooksApiRequestStepInput, RedactPIIStepInput, RemoveBackgroundFromImageStepInput, RenderVideoFromHtmlCompositionStepInput, ReplyToGmailEmailStepInput, ResizeVideoStepInput, RunFfmpegStepInput, RunFromConnectorRegistryStepInput, ScrapeLinkedInCompanyStepInput, ScrapeLinkedInProfileStepInput, ScrapeUrlStepInput, ScrapeXPostStepInput, ScrapeXProfileStepInput, ScreenshotUrlStepInput, SearchGmailEmailsStepInput, SearchGoogleStepInput, SearchGoogleCalendarEventsStepInput, SearchGoogleDriveStepInput, SearchGoogleImagesStepInput, SearchGoogleNewsStepInput, SearchGoogleTrendsStepInput, SearchPerplexityStepInput, SearchXPostsStepInput, SearchYoutubeStepInput, SearchYoutubeTrendsStepInput, SendEmailStepInput, SendGmailDraftStepInput, SendGmailMessageStepInput, SendSlackDirectMessageStepInput, SendSMSStepInput, SetGmailReadStatusStepInput, SetRunTitleStepInput, SetVariableStepInput, TextToSpeechStepInput, TranscribeAudioStepInput, TrimMediaStepInput, TypesafeEvaluateStepInput, UpdateGmailLabelsStepInput, UpdateGoogleCalendarEventStepInput, UpdateGoogleDocStepInput, UpdateGoogleSheetStepInput, UploadDataSourceDocumentStepInput, UpscaleImageStepInput, UpscaleVideoStepInput, UserMessageStepInput, VideoFaceSwapStepInput, VideoRemoveBackgroundStepInput, VideoRemoveWatermarkStepInput, WatermarkImageStepInput, WatermarkVideoStepInput, YouDotComFinanceResearchStepInput, YouDotComGetPageContentStepInput, YouDotComLiveNewsStepInput, YouDotComWebResearchStepInput, YouDotComWebSearchStepInput, ActiveCampaignAddNoteStepOutput, ActiveCampaignCreateContactStepOutput, AddSubtitlesToVideoStepOutput, AddThumbnailToVideoStepOutput, AirtableCreateUpdateRecordStepOutput, AirtableDeleteRecordStepOutput, AirtableGetRecordStepOutput, AirtableGetTableRecordsStepOutput, AnalyzeImageStepOutput, AnalyzeVideoStepOutput, CaptureThumbnailStepOutput, CheckAppRoleStepOutput, CodaCreateUpdatePageStepOutput, CodaCreateUpdateRowStepOutput, CodaFindRowStepOutput, CodaGetPageStepOutput, CodaGetTableRowsStepOutput, ConvertPdfToImagesStepOutput, CreateDataSourceStepOutput, CreateGmailDraftStepOutput, CreateGoogleCalendarEventStepOutput, CreateGoogleDocStepOutput, CreateGoogleSheetStepOutput, DecomposeImageStepOutput, DeleteDataSourceStepOutput, DeleteDataSourceDocumentStepOutput, DeleteGmailEmailStepOutput, DeleteGoogleCalendarEventStepOutput, DeleteGoogleSheetRowsStepOutput, DetectChangesStepOutput, DetectPIIStepOutput, DownloadVideoStepOutput, EnhanceImageGenerationPromptStepOutput, EnhanceVideoGenerationPromptStepOutput, EnrichPersonStepOutput, EvaluateDecisionStepOutput, ExtractAudioFromVideoStepOutput, ExtractTextStepOutput, FetchDataSourceDocumentStepOutput, FetchGoogleDocStepOutput, FetchGoogleSheetStepOutput, FetchSlackChannelHistoryStepOutput, FetchYoutubeCaptionsStepOutput, FetchYoutubeChannelStepOutput, FetchYoutubeCommentsStepOutput, FetchYoutubeVideoStepOutput, Generate3dModelStepOutput, GenerateImageStepOutput, GenerateLipsyncStepOutput, GenerateMusicStepOutput, GeneratePdfStepOutput, GenerateSoundStepOutput, GenerateStaticVideoFromImageStepOutput, GenerateVideoStepOutput, GetGmailAttachmentsStepOutput, GetGmailDraftStepOutput, GetGmailEmailStepOutput, GetGmailUnreadCountStepOutput, GetGoogleCalendarEventStepOutput, GetGoogleDriveFileStepOutput, GetGoogleSheetInfoStepOutput, GetMediaMetadataStepOutput, HubspotCreateCompanyStepOutput, HubspotCreateContactStepOutput, HubspotGetCompanyStepOutput, HubspotGetContactStepOutput, HunterApiCompanyEnrichmentStepOutput, HunterApiDomainSearchStepOutput, HunterApiEmailFinderStepOutput, HunterApiEmailVerificationStepOutput, HunterApiPersonEnrichmentStepOutput, ImageFaceSwapStepOutput, ImageRemoveWatermarkStepOutput, ImportFromUrlStepOutput, InsertVideoClipsStepOutput, ListDataSourcesStepOutput, ListGmailDraftsStepOutput, ListGmailLabelsStepOutput, ListGoogleCalendarEventsStepOutput, ListGoogleDriveFilesStepOutput, ListRecentGmailEmailsStepOutput, LogicStepOutput, MakeDotComRunScenarioStepOutput, MergeAudioStepOutput, MergeVideosStepOutput, MeshyAnimateStepOutput, MeshyImageTo3dStepOutput, MeshyRemeshStepOutput, MeshyRigStepOutput, MeshyTextTo3dStepOutput, MeshyTextureStepOutput, MixAudioIntoVideoStepOutput, MuteVideoStepOutput, N8nRunNodeStepOutput, NotionCreatePageStepOutput, NotionUpdatePageStepOutput, PeopleSearchStepOutput, PostToLinkedInStepOutput, PostToSlackChannelStepOutput, PostToXStepOutput, PostToZapierStepOutput, QueryDataSourceStepOutput, QueryExternalDatabaseStepOutput, QuickbooksApiRequestStepOutput, RedactPIIStepOutput, RemoveBackgroundFromImageStepOutput, RenderVideoFromHtmlCompositionStepOutput, ReplyToGmailEmailStepOutput, ResizeVideoStepOutput, RunFfmpegStepOutput, RunFromConnectorRegistryStepOutput, ScrapeLinkedInCompanyStepOutput, ScrapeLinkedInProfileStepOutput, ScrapeUrlStepOutput, ScrapeXPostStepOutput, ScrapeXProfileStepOutput, ScreenshotUrlStepOutput, SearchGmailEmailsStepOutput, SearchGoogleStepOutput, SearchGoogleCalendarEventsStepOutput, SearchGoogleDriveStepOutput, SearchGoogleImagesStepOutput, SearchGoogleNewsStepOutput, SearchGoogleTrendsStepOutput, SearchPerplexityStepOutput, SearchXPostsStepOutput, SearchYoutubeStepOutput, SearchYoutubeTrendsStepOutput, SendEmailStepOutput, SendGmailDraftStepOutput, SendGmailMessageStepOutput, SendSlackDirectMessageStepOutput, SendSMSStepOutput, SetGmailReadStatusStepOutput, SetRunTitleStepOutput, SetVariableStepOutput, TextToSpeechStepOutput, TranscribeAudioStepOutput, TrimMediaStepOutput, TypesafeEvaluateStepOutput, UpdateGmailLabelsStepOutput, UpdateGoogleCalendarEventStepOutput, UpdateGoogleDocStepOutput, UpdateGoogleSheetStepOutput, UploadDataSourceDocumentStepOutput, UpscaleImageStepOutput, UpscaleVideoStepOutput, UserMessageStepOutput, VideoFaceSwapStepOutput, VideoRemoveBackgroundStepOutput, VideoRemoveWatermarkStepOutput, WatermarkImageStepOutput, WatermarkVideoStepOutput, YouDotComFinanceResearchStepOutput, YouDotComGetPageContentStepOutput, YouDotComLiveNewsStepOutput, YouDotComWebResearchStepOutput, YouDotComWebSearchStepOutput } from "./types.js";
2
+ import type { StepExecutionOptions, StepExecutionResult } from "../types.js";
3
+ export interface StepMethods {
4
+ /**
5
+ * Add a note to an existing contact in ActiveCampaign.
6
+ *
7
+ * @remarks
8
+ * - Requires an ActiveCampaign OAuth connection (connectionId).
9
+ * - The contact must already exist — use the contact ID from a previous create or search step.
10
+ *
11
+ * @example
12
+ * ```typescript
13
+ * const result = await agent.activeCampaignAddNote({
14
+ * contactId: ``,
15
+ * note: ``,
16
+ * });
17
+ * ```
18
+ */
19
+ activeCampaignAddNote(step: ActiveCampaignAddNoteStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<ActiveCampaignAddNoteStepOutput>>;
20
+ /**
21
+ * Create or sync a contact in ActiveCampaign.
22
+ *
23
+ * @remarks
24
+ * - Requires an ActiveCampaign OAuth connection (connectionId).
25
+ * - If a contact with the email already exists, it may be updated depending on ActiveCampaign settings.
26
+ * - Custom fields are passed as a key-value map where keys are field IDs.
27
+ *
28
+ * @example
29
+ * ```typescript
30
+ * const result = await agent.activeCampaignCreateContact({
31
+ * email: ``,
32
+ * firstName: ``,
33
+ * lastName: ``,
34
+ * phone: ``,
35
+ * accountId: ``,
36
+ * customFields: {},
37
+ * });
38
+ * ```
39
+ */
40
+ activeCampaignCreateContact(step: ActiveCampaignCreateContactStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<ActiveCampaignCreateContactStepOutput>>;
41
+ /**
42
+ * Automatically add subtitles to a video
43
+ *
44
+ * @remarks
45
+ * - Can control style of text and animation
46
+ *
47
+ * @example
48
+ * ```typescript
49
+ * const result = await agent.addSubtitlesToVideo({
50
+ * videoUrl: ``,
51
+ * language: ``,
52
+ * fontName: ``,
53
+ * fontSize: 0,
54
+ * fontWeight: "normal",
55
+ * fontColor: "white",
56
+ * highlightColor: "white",
57
+ * strokeWidth: 0,
58
+ * strokeColor: "black",
59
+ * backgroundColor: "black",
60
+ * backgroundOpacity: 0,
61
+ * position: "top",
62
+ * yOffset: 0,
63
+ * wordsPerSubtitle: 0,
64
+ * enableAnimation: false,
65
+ * });
66
+ * ```
67
+ */
68
+ addSubtitlesToVideo(step: AddSubtitlesToVideoStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<AddSubtitlesToVideoStepOutput>>;
69
+ /**
70
+ * Set a video's thumbnail: embedded as its cover art, and optionally as its opening frames
71
+ *
72
+ * @remarks
73
+ * - Almost everything that shows a video without a poster shows its first frame (a web page's video, link previews, the platform's own), so a video that fades in from black has a black thumbnail
74
+ * - Pass the thumbnail as `imageUrl` (a designed cover) or as `at`, a moment of the video in seconds
75
+ * - The thumbnail is always embedded as the video's cover art, its streams copied as they are; desktop players and file browsers show it, browsers and social platforms don't
76
+ * - `asFirstFrame` also shows it for the video's first 0.2 seconds, fitted to the frame over black, so first-frame thumbnails are it too; that re-encodes the video, keeping its length and audio
77
+ * - Returns the video as an mp4, and the thumbnail as `thumbnailUrl` (a png) for a web page's poster or a platform that takes a cover image
78
+ *
79
+ * @example
80
+ * ```typescript
81
+ * const result = await agent.addThumbnailToVideo({
82
+ * videoUrl: ``,
83
+ * });
84
+ * ```
85
+ */
86
+ addThumbnailToVideo(step: AddThumbnailToVideoStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<AddThumbnailToVideoStepOutput>>;
87
+ /**
88
+ * Create a new record or update an existing record in an Airtable table.
89
+ *
90
+ * @remarks
91
+ * - If recordId is provided, updates that record. Otherwise, creates a new one.
92
+ * - When updating with updateMode "onlySpecified", unspecified fields are left as-is. With "all", unspecified fields are cleared.
93
+ * - Array fields (e.g. multipleAttachments) accept arrays of values.
94
+ *
95
+ * @example
96
+ * ```typescript
97
+ * const result = await agent.airtableCreateUpdateRecord({
98
+ * baseId: ``,
99
+ * tableId: ``,
100
+ * fields: ``,
101
+ * recordData: {},
102
+ * });
103
+ * ```
104
+ */
105
+ airtableCreateUpdateRecord(step: AirtableCreateUpdateRecordStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<AirtableCreateUpdateRecordStepOutput>>;
106
+ /**
107
+ * Delete a record from an Airtable table by its record ID.
108
+ *
109
+ * @remarks
110
+ * - Requires an active Airtable OAuth connection (connectionId).
111
+ * - Silently succeeds if the record does not exist.
112
+ *
113
+ * @example
114
+ * ```typescript
115
+ * const result = await agent.airtableDeleteRecord({
116
+ * baseId: ``,
117
+ * tableId: ``,
118
+ * recordId: ``,
119
+ * });
120
+ * ```
121
+ */
122
+ airtableDeleteRecord(step: AirtableDeleteRecordStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<AirtableDeleteRecordStepOutput>>;
123
+ /**
124
+ * Fetch a single record from an Airtable table by its record ID.
125
+ *
126
+ * @remarks
127
+ * - Requires an active Airtable OAuth connection (connectionId).
128
+ * - If the record is not found, returns a string message instead of a record object.
129
+ *
130
+ * @example
131
+ * ```typescript
132
+ * const result = await agent.airtableGetRecord({
133
+ * baseId: ``,
134
+ * tableId: ``,
135
+ * recordId: ``,
136
+ * });
137
+ * ```
138
+ */
139
+ airtableGetRecord(step: AirtableGetRecordStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<AirtableGetRecordStepOutput>>;
140
+ /**
141
+ * Fetch multiple records from an Airtable table with optional pagination.
142
+ *
143
+ * @remarks
144
+ * - Requires an active Airtable OAuth connection (connectionId).
145
+ * - Default limit is 100 records. Maximum is 1000.
146
+ * - When outputFormat is 'csv', the variable receives CSV text. The direct execution output always returns parsed records.
147
+ *
148
+ * @example
149
+ * ```typescript
150
+ * const result = await agent.airtableGetTableRecords({
151
+ * baseId: ``,
152
+ * tableId: ``,
153
+ * });
154
+ * ```
155
+ */
156
+ airtableGetTableRecords(step: AirtableGetTableRecordsStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<AirtableGetTableRecordsStepOutput>>;
157
+ /**
158
+ * Analyze one or more images with a chat model that reads images, based on a text prompt.
159
+ *
160
+ * @remarks
161
+ * - Runs on any chat model that reads images; the default is gemini-3.8-flash. `visionModelOverride` takes the same settings as a chat model's override (`model`, `temperature`, `maxResponseTokens`).
162
+ * - The prompt should describe what to look for or extract from the image.
163
+ * - Pass imageUrls for one or more images analyzed together in one request (imageUrl, a single image, still works).
164
+ *
165
+ * @example
166
+ * ```typescript
167
+ * const result = await agent.analyzeImage({
168
+ * prompt: ``,
169
+ * });
170
+ * ```
171
+ */
172
+ analyzeImage(step: AnalyzeImageStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<AnalyzeImageStepOutput>>;
173
+ /**
174
+ * Analyze a video using a video analysis model based on a text prompt.
175
+ *
176
+ * @remarks
177
+ * - The prompt describes what to look for or extract from the video.
178
+ * - The default model is gemini-3.8-flash. Any Gemini chat model reads video (the 3.x Flash and Flash Lite models, gemini-3.1-pro, and the 2.5 family), as does TwelveLabs' pegasus-1.6; set one with `videoAnalysisModelOverride`, with `temperature` and `maxResponseTokens` beside `model`.
179
+ * - `videoUrl` is a video file's URL (an app file, a Google Drive share link, or any public URL). Gemini also reads a public YouTube link; Pegasus doesn't.
180
+ * - Length: Pegasus takes 1 second to 1 hour. Gemini takes about 3 hours at its default resolution; the 3.x models read a second of video as about 66 tokens and the 2.5 models as about 258, which is what a long video costs.
181
+ *
182
+ * @example
183
+ * ```typescript
184
+ * const result = await agent.analyzeVideo({
185
+ * prompt: ``,
186
+ * videoUrl: ``,
187
+ * });
188
+ * ```
189
+ */
190
+ analyzeVideo(step: AnalyzeVideoStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<AnalyzeVideoStepOutput>>;
191
+ /**
192
+ * Capture a thumbnail from a video at a specified timestamp
193
+ *
194
+ * @example
195
+ * ```typescript
196
+ * const result = await agent.captureThumbnail({
197
+ * videoUrl: ``,
198
+ * at: ``,
199
+ * });
200
+ * ```
201
+ */
202
+ captureThumbnail(step: CaptureThumbnailStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<CaptureThumbnailStepOutput>>;
203
+ /**
204
+ * Check whether the current user has a specific app role and branch accordingly.
205
+ *
206
+ * @remarks
207
+ * - Checks if the current user has been assigned a specific role in this app.
208
+ * - If the user has the role, transitions to the "has role" path.
209
+ * - If the user does not have the role, transitions to the "no role" path, or errors if no path is configured.
210
+ * - Role names are defined by the app creator and assigned to users via the app roles system.
211
+ * - The roleName field supports {{variables}} for dynamic role checks.
212
+ *
213
+ * @example
214
+ * ```typescript
215
+ * const result = await agent.checkAppRole({
216
+ * roleName: ``,
217
+ * });
218
+ * ```
219
+ */
220
+ checkAppRole(step: CheckAppRoleStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<CheckAppRoleStepOutput>>;
221
+ /**
222
+ * Create a new page or update an existing page in a Coda document.
223
+ *
224
+ * @remarks
225
+ * - Requires a Coda OAuth connection (connectionId).
226
+ * - If pageData.pageId is provided, updates that page. Otherwise, creates a new one.
227
+ * - Page content is provided as markdown and converted to Coda's canvas format.
228
+ * - When updating, insertionMode controls how content is applied (default: 'append').
229
+ *
230
+ * @example
231
+ * ```typescript
232
+ * const result = await agent.codaCreateUpdatePage({
233
+ * pageData: {},
234
+ * });
235
+ * ```
236
+ */
237
+ codaCreateUpdatePage(step: CodaCreateUpdatePageStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<CodaCreateUpdatePageStepOutput>>;
238
+ /**
239
+ * Create a new row or update an existing row in a Coda table.
240
+ *
241
+ * @remarks
242
+ * - Requires a Coda OAuth connection (connectionId).
243
+ * - If rowId is provided, updates that row. Otherwise, creates a new one.
244
+ * - Row data keys are column IDs. Empty values are excluded.
245
+ *
246
+ * @example
247
+ * ```typescript
248
+ * const result = await agent.codaCreateUpdateRow({
249
+ * docId: ``,
250
+ * tableId: ``,
251
+ * rowData: {},
252
+ * });
253
+ * ```
254
+ */
255
+ codaCreateUpdateRow(step: CodaCreateUpdateRowStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<CodaCreateUpdateRowStepOutput>>;
256
+ /**
257
+ * Search for a row in a Coda table by matching column values.
258
+ *
259
+ * @remarks
260
+ * - Requires a Coda OAuth connection (connectionId).
261
+ * - Returns the first row matching all specified column values, or null if no match.
262
+ * - Search criteria in rowData are ANDed together.
263
+ *
264
+ * @example
265
+ * ```typescript
266
+ * const result = await agent.codaFindRow({
267
+ * docId: ``,
268
+ * tableId: ``,
269
+ * rowData: {},
270
+ * });
271
+ * ```
272
+ */
273
+ codaFindRow(step: CodaFindRowStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<CodaFindRowStepOutput>>;
274
+ /**
275
+ * Export and read the contents of a page from a Coda document.
276
+ *
277
+ * @remarks
278
+ * - Requires a Coda OAuth connection (connectionId).
279
+ * - Page export is asynchronous on Coda's side — there may be a brief delay while it processes.
280
+ * - If a page was just created in a prior step, there is an automatic 20-second retry if the first export attempt fails.
281
+ *
282
+ * @example
283
+ * ```typescript
284
+ * const result = await agent.codaGetPage({
285
+ * docId: ``,
286
+ * pageId: ``,
287
+ * });
288
+ * ```
289
+ */
290
+ codaGetPage(step: CodaGetPageStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<CodaGetPageStepOutput>>;
291
+ /**
292
+ * Fetch rows from a Coda table with optional pagination.
293
+ *
294
+ * @remarks
295
+ * - Requires a Coda OAuth connection (connectionId).
296
+ * - Default limit is 10000 rows. Rows are fetched in pages of 500.
297
+ * - When outputFormat is 'csv', the variable receives CSV text. The direct execution output always returns parsed rows.
298
+ *
299
+ * @example
300
+ * ```typescript
301
+ * const result = await agent.codaGetTableRows({
302
+ * docId: ``,
303
+ * tableId: ``,
304
+ * });
305
+ * ```
306
+ */
307
+ codaGetTableRows(step: CodaGetTableRowsStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<CodaGetTableRowsStepOutput>>;
308
+ /**
309
+ * Convert each page of a PDF document into a PNG image.
310
+ *
311
+ * @remarks
312
+ * - Each page is converted to a separate PNG.
313
+ * - The page images go to the public CDN by default, or into one of the app's own file stores when the call passes `store` — a private store keeps them private.
314
+ * - The source PDF is never published: one of the app's own files is read where it sits, and any other URL is staged privately for the renderer and discarded afterwards.
315
+ * - Returns an array of image URLs, one per page.
316
+ *
317
+ * @example
318
+ * ```typescript
319
+ * const result = await agent.convertPdfToImages({
320
+ * pdfUrl: ``,
321
+ * });
322
+ * ```
323
+ */
324
+ convertPdfToImages(step: ConvertPdfToImagesStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<ConvertPdfToImagesStepOutput>>;
325
+ /**
326
+ * @deprecated Legacy v1 data sources. v2 apps should use `dataSources.defineDataSource()` from @mindstudio-ai/agent instead, which owns parsing, chunking, embedding and citations. Create a new empty vector data source for the current app.
327
+ *
328
+ * @remarks
329
+ * - Creates a new data source (vector database) associated with the current app version.
330
+ * - The data source is created empty — use the "Upload Data Source Document" block to add documents.
331
+ * - Returns the new data source ID which can be used in subsequent blocks.
332
+ *
333
+ * @example
334
+ * ```typescript
335
+ * const result = await agent.createDataSource({
336
+ * name: ``,
337
+ * });
338
+ * ```
339
+ */
340
+ createDataSource(step: CreateDataSourceStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<CreateDataSourceStepOutput>>;
341
+ /**
342
+ * Create a draft email in the connected Gmail account.
343
+ *
344
+ * @remarks
345
+ * - Requires a Google OAuth connection with Gmail compose scope.
346
+ * - The draft appears in the user's Gmail Drafts folder but is not sent.
347
+ * - messageType controls the body format: "plain" for plain text, "html" for raw HTML, "markdown" for auto-converted markdown.
348
+ *
349
+ * @example
350
+ * ```typescript
351
+ * const result = await agent.createGmailDraft({
352
+ * to: ``,
353
+ * subject: ``,
354
+ * message: ``,
355
+ * messageType: "plain",
356
+ * });
357
+ * ```
358
+ */
359
+ createGmailDraft(step: CreateGmailDraftStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<CreateGmailDraftStepOutput>>;
360
+ /**
361
+ * Create a new event on a Google Calendar.
362
+ *
363
+ * @remarks
364
+ * - Requires a Google OAuth connection with Calendar events scope.
365
+ * - Date/time values must be ISO 8601 format (e.g. "2025-07-02T10:00:00-07:00").
366
+ * - Attendees are specified as one email address per line in a single string.
367
+ * - Set addMeetLink to true to automatically attach a Google Meet video call.
368
+ *
369
+ * @example
370
+ * ```typescript
371
+ * const result = await agent.createGoogleCalendarEvent({
372
+ * summary: ``,
373
+ * startDateTime: ``,
374
+ * endDateTime: ``,
375
+ * });
376
+ * ```
377
+ */
378
+ createGoogleCalendarEvent(step: CreateGoogleCalendarEventStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<CreateGoogleCalendarEventStepOutput>>;
379
+ /**
380
+ * Create a new Google Document and optionally populate it with content.
381
+ *
382
+ * @remarks
383
+ * - textType determines how the text field is interpreted: "plain" for plain text, "html" for HTML markup, "markdown" for Markdown.
384
+ *
385
+ * @example
386
+ * ```typescript
387
+ * const result = await agent.createGoogleDoc({
388
+ * title: ``,
389
+ * text: ``,
390
+ * textType: "plain",
391
+ * });
392
+ * ```
393
+ */
394
+ createGoogleDoc(step: CreateGoogleDocStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<CreateGoogleDocStepOutput>>;
395
+ /**
396
+ * Create a new Google Spreadsheet and populate it with CSV data.
397
+ *
398
+ * @example
399
+ * ```typescript
400
+ * const result = await agent.createGoogleSheet({
401
+ * title: ``,
402
+ * text: ``,
403
+ * });
404
+ * ```
405
+ */
406
+ createGoogleSheet(step: CreateGoogleSheetStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<CreateGoogleSheetStepOutput>>;
407
+ /**
408
+ * Split an image into a base image and transparent layers.
409
+ *
410
+ * @remarks
411
+ * - Uses Seedream 5.0 Flash layer decomposition by default, and Seedream 5.0 Pro when type is "advanced", which separates more cleanly and costs more (and twice as much at 2K).
412
+ * - `resolution` is "1k", "1.5k" or "2k" (the default).
413
+ * - An optional prompt names the objects or groupings to separate. Left out, the model separates the main elements itself: text, subjects, decorations and background.
414
+ * - The output is an array of hosted PNG image URLs: first the base image at full size, then each separated element as a transparent layer cropped to the element. The layers come with no position, so placing one back over the base means finding where it sat. Flash returned 13 layers for one photo and Pro 16.
415
+ *
416
+ * @example
417
+ * ```typescript
418
+ * const result = await agent.decomposeImage({
419
+ * image: ``,
420
+ * });
421
+ * ```
422
+ */
423
+ decomposeImage(step: DecomposeImageStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<DecomposeImageStepOutput>>;
424
+ /**
425
+ * @deprecated Legacy v1 data sources. v2 apps should use `dataSources.defineDataSource()` from @mindstudio-ai/agent instead, which owns parsing, chunking, embedding and citations. Delete a vector data source from the current app.
426
+ *
427
+ * @remarks
428
+ * - Soft-deletes a data source (vector database) by marking it as deleted.
429
+ * - The Milvus partition is cleaned up asynchronously by a background cron job.
430
+ * - The data source must belong to the current app version.
431
+ *
432
+ * @example
433
+ * ```typescript
434
+ * const result = await agent.deleteDataSource({
435
+ * dataSourceId: ``,
436
+ * });
437
+ * ```
438
+ */
439
+ deleteDataSource(step: DeleteDataSourceStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<DeleteDataSourceStepOutput>>;
440
+ /**
441
+ * @deprecated Legacy v1 data sources. v2 apps should use `dataSources.defineDataSource()` from @mindstudio-ai/agent instead, which owns parsing, chunking, embedding and citations. Delete a single document from a data source.
442
+ *
443
+ * @remarks
444
+ * - Soft-deletes a document by marking it as deleted.
445
+ * - Requires both the data source ID and document ID.
446
+ * - After deletion, reloads vectors into Milvus so the data source reflects the change immediately.
447
+ *
448
+ * @example
449
+ * ```typescript
450
+ * const result = await agent.deleteDataSourceDocument({
451
+ * dataSourceId: ``,
452
+ * documentId: ``,
453
+ * });
454
+ * ```
455
+ */
456
+ deleteDataSourceDocument(step: DeleteDataSourceDocumentStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<DeleteDataSourceDocumentStepOutput>>;
457
+ /**
458
+ * Move an email to trash in the connected Gmail account (recoverable delete).
459
+ *
460
+ * @remarks
461
+ * - Requires a Google OAuth connection with Gmail modify scope.
462
+ * - Uses trash (recoverable) rather than permanent delete.
463
+ *
464
+ * @example
465
+ * ```typescript
466
+ * const result = await agent.deleteGmailEmail({
467
+ * messageId: ``,
468
+ * });
469
+ * ```
470
+ */
471
+ deleteGmailEmail(step: DeleteGmailEmailStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<DeleteGmailEmailStepOutput>>;
472
+ /**
473
+ * Delete an event from a Google Calendar by event ID.
474
+ *
475
+ * @remarks
476
+ * - Requires a Google OAuth connection with Calendar events scope.
477
+ * - Throws an error if the event does not exist.
478
+ *
479
+ * @example
480
+ * ```typescript
481
+ * const result = await agent.deleteGoogleCalendarEvent({
482
+ * eventId: ``,
483
+ * });
484
+ * ```
485
+ */
486
+ deleteGoogleCalendarEvent(step: DeleteGoogleCalendarEventStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<DeleteGoogleCalendarEventStepOutput>>;
487
+ /**
488
+ * Delete a range of rows from a Google Spreadsheet.
489
+ *
490
+ * @remarks
491
+ * - Requires a Google OAuth connection with Drive scope.
492
+ * - startRow and endRow are 1-based row numbers (inclusive).
493
+ * - If sheetName is omitted, operates on the first sheet.
494
+ *
495
+ * @example
496
+ * ```typescript
497
+ * const result = await agent.deleteGoogleSheetRows({
498
+ * documentId: ``,
499
+ * startRow: ``,
500
+ * endRow: ``,
501
+ * });
502
+ * ```
503
+ */
504
+ deleteGoogleSheetRows(step: DeleteGoogleSheetRowsStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<DeleteGoogleSheetRowsStepOutput>>;
505
+ /**
506
+ * Detect changes between runs by comparing current input against previously stored state. Routes execution based on whether a change occurred.
507
+ *
508
+ * @remarks
509
+ * - Persists state across runs using a global variable keyed to the step ID.
510
+ * - Two modes: "comparison" (default) uses strict string inequality; "ai" uses an LLM to determine if a meaningful change occurred.
511
+ * - First run always treats the value as "changed" since there is no previous state.
512
+ * - Each mode supports transitions to different steps/workflows for the "changed" and "unchanged" paths.
513
+ * - AI mode bills normally for the LLM call.
514
+ *
515
+ * @example
516
+ * ```typescript
517
+ * const result = await agent.detectChanges({
518
+ * mode: "ai",
519
+ * input: ``,
520
+ * });
521
+ * ```
522
+ */
523
+ detectChanges(step: DetectChangesStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<DetectChangesStepOutput>>;
524
+ /**
525
+ * Scan text for personally identifiable information using Microsoft Presidio.
526
+ *
527
+ * @remarks
528
+ * - In workflow mode, transitions to detectedStepId if PII is found, notDetectedStepId otherwise.
529
+ * - In direct execution, returns the detection results without transitioning.
530
+ * - If entities is empty, returns immediately with no detections.
531
+ *
532
+ * @example
533
+ * ```typescript
534
+ * const result = await agent.detectPII({
535
+ * input: ``,
536
+ * language: ``,
537
+ * entities: [],
538
+ * });
539
+ * ```
540
+ */
541
+ detectPII(step: DetectPIIStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<DetectPIIStepOutput>>;
542
+ /**
543
+ * Download a video file
544
+ *
545
+ * @remarks
546
+ * - Works with YouTube, TikTok, etc., by using ytdlp behind the scenes
547
+ * - Can save as mp4 or mp3
548
+ * - `item` picks one item of a URL that holds several: a carousel, a playlist, a post with several videos. A link to one slide of a carousel downloads that slide. `itemCount` in the output says how many there are, so download item 1 and loop for the rest
549
+ * - `start` and `duration` (seconds) download a clip. An mp4 clip is cut without re-encoding, so it can start a moment before `start` (for an exact cut, trim the result with `trimMedia`); an mp3 clip is exact
550
+ * - Videos and audio only: a photo (a photo post, a photo in a carousel) fails as `video_unavailable`, and so does an item the URL doesn't have
551
+ *
552
+ * @example
553
+ * ```typescript
554
+ * const result = await agent.downloadVideo({
555
+ * videoUrl: ``,
556
+ * format: "mp4",
557
+ * });
558
+ * ```
559
+ */
560
+ downloadVideo(step: DownloadVideoStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<DownloadVideoStepOutput>>;
561
+ /**
562
+ * Generate or enhance an image generation prompt using a language model. Optionally generates a negative prompt.
563
+ *
564
+ * @remarks
565
+ * - Rewrites the user's prompt with added detail about style, lighting, colors, and composition.
566
+ * - Also useful for initial generation, it doesn't always need to be enhancing an existing prompt
567
+ * - When includeNegativePrompt is true, a second model call generates a negative prompt.
568
+ *
569
+ * @example
570
+ * ```typescript
571
+ * const result = await agent.enhanceImageGenerationPrompt({
572
+ * initialPrompt: ``,
573
+ * includeNegativePrompt: false,
574
+ * systemPrompt: ``,
575
+ * });
576
+ * ```
577
+ */
578
+ enhanceImageGenerationPrompt(step: EnhanceImageGenerationPromptStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<EnhanceImageGenerationPromptStepOutput>>;
579
+ /**
580
+ * Generate or enhance a video generation prompt using a language model. Optionally generates a negative prompt.
581
+ *
582
+ * @remarks
583
+ * - Rewrites the user's prompt with added detail about style, camera movement, lighting, and composition.
584
+ * - Also useful for initial generation, it doesn't always need to be enhancing an existing prompt
585
+ * - When includeNegativePrompt is true, a second model call generates a negative prompt.
586
+ *
587
+ * @example
588
+ * ```typescript
589
+ * const result = await agent.enhanceVideoGenerationPrompt({
590
+ * initialPrompt: ``,
591
+ * includeNegativePrompt: false,
592
+ * systemPrompt: ``,
593
+ * });
594
+ * ```
595
+ */
596
+ enhanceVideoGenerationPrompt(step: EnhanceVideoGenerationPromptStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<EnhanceVideoGenerationPromptStepOutput>>;
597
+ /**
598
+ * Look up professional information about a person using Apollo.io. Search by ID, name, LinkedIn URL, email, or domain.
599
+ *
600
+ * @remarks
601
+ * - At least one search parameter must be provided.
602
+ * - Returns enriched data from Apollo including contact details, employment info, and social profiles.
603
+ *
604
+ * @example
605
+ * ```typescript
606
+ * const result = await agent.enrichPerson({
607
+ * params: {},
608
+ * });
609
+ * ```
610
+ */
611
+ enrichPerson(step: EnrichPersonStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<EnrichPersonStepOutput>>;
612
+ /**
613
+ * Ask structured questions about text, JSON, or images and get calibrated answers from a decision model. The model returns a probability, a selected option, or a score. It does not write a reply. Each question is a noul (yes or no, as a probability from 0 to 1), a choice (one option from a set you define, with a probability for each), or a score (a rating against ordered levels). Put every question in the same call. The question id is yours: answers come back under the same ids. The model defaults to Jev (jev-latest).
614
+ *
615
+ * @remarks
616
+ * - state is the content to judge: a string, or a JSON object or array (a record, a chat log, application state).
617
+ * - questions is a map. The key is an id you choose. It is not shown to the model. The answer comes back under the same id.
618
+ * - A noul asks a yes/no question and returns noul, a probability from 0 (no) to 1 (yes). Optional criteria.true and criteria.false say what a yes and a no mean.
619
+ * - A choice picks one option. criteria is a map of option id to a short description (or null). At most 255 options. The answer includes the winning choice, a probability for every option, and confidence.
620
+ * - A score rates the state on an ordered rubric. criteria is 2 to 10 level descriptions, low to high. The answer's score can land between levels, and includes a probability per level plus confidence.
621
+ * - An answer of type refusal means the model declined that question (GPT-6 Luna Decisions can).
622
+ * - instructions may be a string, or an object that keeps the question in one field and reference data in the others. Refer to those fields by name in backticks.
623
+ * - Send every question you need in one call. The model reads the state once and answers them together.
624
+ * - Probabilities from different models are not comparable: tune a threshold against the model, and the version, it will run on.
625
+ * - decisionModelOverride.model picks the model:
626
+ * - jev-latest (the default) is TypeSafe's current stable release, text only, up to 64k tokens. jev-preview tracks TypeSafe's newest release. Pin a version such as jev-1.13.0 when a threshold was tuned against that version.
627
+ * - clef and clef-flash run Cloudflare Clef, which also reads up to 4 PNG, JPEG, or WebP images, each at most 4 MiB and 8 MiB together, and takes at most 64 questions, each id using only letters, digits, underscore, dot, and hyphen, up to 100 characters. clef is the larger model, clef-flash the faster one. @cf/cloudflare/clef and @cf/cloudflare/clef-flash name the same two.
628
+ * - mercury-decide runs Inception's Mercury Decide, which reads up to 64k tokens and up to 16 PNG, JPEG, WebP, or GIF images, each at most 10 MiB and 14 MiB together.
629
+ * - drex-max, drex-v2.0 and drex-v1.5 run Nace.AI's Drex, served by DeepInfra, and take at most 16 questions. drex-max reads up to 262k tokens and up to 4 PNG, JPEG, WebP, or GIF images, 9 MiB together. drex-v2.0 and drex-v1.5 read text only, up to 128k tokens. nace-ai/drex-max, nace-ai/drex-v2.0 and nace-ai/drex-v1.5 name the same three.
630
+ * - gpt-6-luna-decisions runs OpenAI's Decisions API (in beta), which reads up to 922k tokens and PNG, JPEG, WebP, or GIF images of up to 20 MB each. It takes up to 200 questions, and a choice needs at least 2 options. gpt-6-luna names it too.
631
+ * - images is for a model that reads them. Pass URLs or data URLs. A model that reads none refuses the call.
632
+ * - The response model field is the version that answered.
633
+ * - Billed per input token. Output tokens are free. Each model has its own rate, and GPT-6 Luna Decisions bills a prompt over 272k tokens at twice its rate.
634
+ *
635
+ * @example
636
+ * ```typescript
637
+ * const result = await agent.evaluateDecision({
638
+ * state: ``,
639
+ * questions: {},
640
+ * });
641
+ * ```
642
+ */
643
+ evaluateDecision(step: EvaluateDecisionStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<EvaluateDecisionStepOutput>>;
644
+ /**
645
+ * Extract audio MP3 from a video file
646
+ *
647
+ * @example
648
+ * ```typescript
649
+ * const result = await agent.extractAudioFromVideo({
650
+ * videoUrl: ``,
651
+ * });
652
+ * ```
653
+ */
654
+ extractAudioFromVideo(step: ExtractAudioFromVideoStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<ExtractAudioFromVideoStepOutput>>;
655
+ /**
656
+ * Download a file from a URL and extract its text content. Supports PDFs (including scanned/image-based PDFs via OCR), plain text files, and other document formats.
657
+ *
658
+ * @remarks
659
+ * - Best suited for PDFs and raw text/document files. For web pages, use the scrapeUrl step instead.
660
+ * - Handles both text-layer PDFs and image-based/scanned PDFs (e.g. Figma/Canva exports, scanned documents). Image-based PDFs are processed with OCR automatically — there is no need to convert PDF pages to images first.
661
+ * - Plain text, code, HTML, spreadsheets and Office documents (docx, pptx, odt, rtf, epub) are read without a model and cost nothing. PDFs and images go to the extraction model, billed per page.
662
+ * - Accepts a single URL, a comma-separated list of URLs, or a JSON array of URLs.
663
+ * - Nothing is published. One of the app's own files — including a private one, or a share link — is read where it sits; any other URL is downloaded and staged privately for the extraction model, then discarded when extraction finishes.
664
+ * - `text` is each document's text: a string for one URL, an array for several. `documents` has each document page by page, with its page numbers and the pages billed. Set `includeBlocks` to add each page's typed blocks (title, text, table, image, header, footer…) with their bounding boxes, and the page's size.
665
+ * - A file that can't be read (unreachable, an unsupported type, past the model's limits, or refused by the model) fails the step with the reason.
666
+ * - `extractionModelOverride.model` picks the model; omit it to use the workspace's default:
667
+ * - `mistral-ocr-4.1` (the default): PDFs and images up to 50 MB and 1,000 pages, with typed blocks.
668
+ * - `mistral-document-ai-2512`: Mistral Document AI on Microsoft Foundry, up to 30 MB and 30 pages, with typed blocks.
669
+ * - `llamaparse`: LlamaParse's agentic mode, up to 100 MB and 1,000 pages, markdown without blocks.
670
+ * - `google-document-ai`: Google Document AI OCR, up to 500 pages, where the deployment has set it up.
671
+ * - Maximum file size is 50MB per URL.
672
+ *
673
+ * @example
674
+ * ```typescript
675
+ * const result = await agent.extractText({
676
+ * url: ``,
677
+ * });
678
+ * ```
679
+ */
680
+ extractText(step: ExtractTextStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<ExtractTextStepOutput>>;
681
+ /**
682
+ * @deprecated Legacy v1 data sources. v2 apps should use `dataSources.defineDataSource()` from @mindstudio-ai/agent instead, which owns parsing, chunking, embedding and citations. Fetch the full extracted text contents of a document in a data source.
683
+ *
684
+ * @remarks
685
+ * - Loads a document by ID and returns its full extracted text content.
686
+ * - The document must have been successfully processed (status "done").
687
+ * - Also returns document metadata (name, summary, word count).
688
+ *
689
+ * @example
690
+ * ```typescript
691
+ * const result = await agent.fetchDataSourceDocument({
692
+ * dataSourceId: ``,
693
+ * documentId: ``,
694
+ * });
695
+ * ```
696
+ */
697
+ fetchDataSourceDocument(step: FetchDataSourceDocumentStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<FetchDataSourceDocumentStepOutput>>;
698
+ /**
699
+ * Fetch the contents of an existing Google Document.
700
+ *
701
+ * @remarks
702
+ * - exportType controls the output format: "html" for HTML markup, "markdown" for Markdown, "json" for structured JSON, "plain" for plain text.
703
+ *
704
+ * @example
705
+ * ```typescript
706
+ * const result = await agent.fetchGoogleDoc({
707
+ * documentId: ``,
708
+ * exportType: "html",
709
+ * });
710
+ * ```
711
+ */
712
+ fetchGoogleDoc(step: FetchGoogleDocStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<FetchGoogleDocStepOutput>>;
713
+ /**
714
+ * Fetch contents of a Google Spreadsheet range.
715
+ *
716
+ * @remarks
717
+ * - range uses A1 notation (e.g. "Sheet1!A1:C10"). Omit to fetch the entire first sheet.
718
+ * - exportType controls the output format: "csv" for comma-separated values, "json" for structured JSON.
719
+ *
720
+ * @example
721
+ * ```typescript
722
+ * const result = await agent.fetchGoogleSheet({
723
+ * spreadsheetId: ``,
724
+ * range: ``,
725
+ * exportType: "csv",
726
+ * });
727
+ * ```
728
+ */
729
+ fetchGoogleSheet(step: FetchGoogleSheetStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<FetchGoogleSheetStepOutput>>;
730
+ /**
731
+ * Fetch recent message history from a Slack channel.
732
+ *
733
+ * @remarks
734
+ * - The user is responsible for connecting their Slack workspace and selecting the channel
735
+ *
736
+ * @example
737
+ * ```typescript
738
+ * const result = await agent.fetchSlackChannelHistory({
739
+ * channelId: ``,
740
+ * });
741
+ * ```
742
+ */
743
+ fetchSlackChannelHistory(step: FetchSlackChannelHistoryStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<FetchSlackChannelHistoryStepOutput>>;
744
+ /**
745
+ * Retrieve the captions/transcript for a YouTube video.
746
+ *
747
+ * @remarks
748
+ * - Supports multiple languages via the language parameter.
749
+ * - "text" export produces timestamped plain text; "json" export produces structured transcript data.
750
+ *
751
+ * @example
752
+ * ```typescript
753
+ * const result = await agent.fetchYoutubeCaptions({
754
+ * videoUrl: ``,
755
+ * exportType: "text",
756
+ * language: ``,
757
+ * });
758
+ * ```
759
+ */
760
+ fetchYoutubeCaptions(step: FetchYoutubeCaptionsStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<FetchYoutubeCaptionsStepOutput>>;
761
+ /**
762
+ * Retrieve metadata and recent videos for a YouTube channel.
763
+ *
764
+ * @remarks
765
+ * - Accepts a YouTube channel URL (e.g. https://www.youtube.com/@ChannelName or /channel/ID).
766
+ * - Returns channel info and video listings as a JSON object.
767
+ *
768
+ * @example
769
+ * ```typescript
770
+ * const result = await agent.fetchYoutubeChannel({
771
+ * channelUrl: ``,
772
+ * });
773
+ * ```
774
+ */
775
+ fetchYoutubeChannel(step: FetchYoutubeChannelStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<FetchYoutubeChannelStepOutput>>;
776
+ /**
777
+ * Retrieve comments for a YouTube video.
778
+ *
779
+ * @remarks
780
+ * - Paginates through comments (up to 5 pages).
781
+ * - "text" export produces markdown-formatted text; "json" export produces structured comment data.
782
+ *
783
+ * @example
784
+ * ```typescript
785
+ * const result = await agent.fetchYoutubeComments({
786
+ * videoUrl: ``,
787
+ * exportType: "text",
788
+ * limitPages: ``,
789
+ * });
790
+ * ```
791
+ */
792
+ fetchYoutubeComments(step: FetchYoutubeCommentsStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<FetchYoutubeCommentsStepOutput>>;
793
+ /**
794
+ * Retrieve metadata for a YouTube video (title, description, stats, channel info).
795
+ *
796
+ * @remarks
797
+ * - Returns video metadata, channel info, and engagement stats.
798
+ * - Video format data is excluded from the response.
799
+ *
800
+ * @example
801
+ * ```typescript
802
+ * const result = await agent.fetchYoutubeVideo({
803
+ * videoUrl: ``,
804
+ * });
805
+ * ```
806
+ */
807
+ fetchYoutubeVideo(step: FetchYoutubeVideoStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<FetchYoutubeVideoStepOutput>>;
808
+ /**
809
+ * Generate a 3D model using a 3D generation model.
810
+ *
811
+ * @remarks
812
+ * - The default model is wavespeed-tripo3d-h3.1 (Tripo v3.1), which makes a model from the prompt, from one `image`, or from `images`: 2–4 views of the same object, in order front, left, back, right.
813
+ * - Models and what they take, set in `threeDModelOverride.config`:
814
+ * - From text or an image: wavespeed-tripo3d-h3.1, wavespeed-meshy7.1 (also `images`, 1–4 views), wavespeed-hunyuan3d-v3 (an `image`, plus optional `back_image_url`, `left_image_url`, `right_image_url`), wavespeed-hunyuan-3d-v3.1-rapid, wavespeed-tripo3d-p2, wavespeed-rodin-v2.5 (`images`, 1–5).
815
+ * - From an image only: trellis-2, wavespeed-meshy7 (or `images`, 1–4 views), wavespeed-tripo3d-v2.5, seed3d-2.0, wavespeed-sam-3d-objects (with optional `mask_images`).
816
+ * - From views: wavespeed-hi3d-v3.0 (`front_image`, and optional `back_image`, `left_image`, `right_image`).
817
+ * - `$mode` in the config picks a model's mode (`text-to-3d`, `image-to-3d`, or its multi-view mode). Left out, `images` picks the multi-view mode and `image` picks image-to-3d; with neither, the model's default mode. A text mode needs the prompt; in the others the prompt is optional guidance.
818
+ * - The output is standardized as a GLB URL plus optional FBX/OBJ/USDZ, thumbnail, texture maps, and provider task ID.
819
+ *
820
+ * @example
821
+ * ```typescript
822
+ * const result = await agent.generate3dModel({});
823
+ * ```
824
+ */
825
+ generate3dModel(step: Generate3dModelStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<Generate3dModelStepOutput>>;
826
+ /**
827
+ * Generate an image from a text prompt, or edit one, using an AI model.
828
+ *
829
+ * @remarks
830
+ * - Prompts should be descriptive but concise (roughly 3–6 sentences).
831
+ * - The default model is seedream-4.5. Options go in `imageModelOverride.config` under the model's own names, and differ by model, so look the model up before writing the call. Images to edit or draw from go there too, as URLs: `images` on most models, `source_images` on the Gemini and GPT Image models, one `image` on qwen-image, z-image-turbo, krea-v2-turbo, ideogram-v4 and the MAI models, `source_image` on Grok Imagine, `image_url` on the Ideogram remix and FLUX Kontext models, and `reference` on krea-v2-large.
832
+ * - A model that makes and edits images by separate means takes `$mode` in its config (`text-to-image`, and `edit`, `image-edit` or `image-to-image`, as it lists). Left out, images in the config pick the edit mode, and otherwise the model makes the image from the prompt.
833
+ * - Images are hosted on the public CDN by default, or in one of the app's own file stores when the call passes `store` — a private store keeps the image private.
834
+ * - In foreground mode, the image is displayed to the user. In background mode, the URL is saved to a variable.
835
+ * - When generateVariants is true with numVariants > 1 (up to 10), the images are generated in parallel. One that fails is left out of the URLs returned, and the step fails only when every one does.
836
+ * - In direct execution, foreground mode behaves as background, and userSelect variant behavior behaves as saveAll.
837
+ *
838
+ * @example
839
+ * ```typescript
840
+ * const result = await agent.generateImage({
841
+ * prompt: ``,
842
+ * });
843
+ * ```
844
+ */
845
+ generateImage(step: GenerateImageStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<GenerateImageStepOutput>>;
846
+ /**
847
+ * Generate a lip sync video from audio and an image or video.
848
+ *
849
+ * @remarks
850
+ * - In foreground mode, the video is displayed to the user. In background mode, the URL is saved to a variable.
851
+ *
852
+ * @example
853
+ * ```typescript
854
+ * const result = await agent.generateLipsync({});
855
+ * ```
856
+ */
857
+ generateLipsync(step: GenerateLipsyncStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<GenerateLipsyncStepOutput>>;
858
+ /**
859
+ * Generate an audio file from provided instructions (text) using a music model.
860
+ *
861
+ * @remarks
862
+ * - `text` describes the song: genre, mood, instruments, tempo, vocals, and for Lyria its structure (`[Verse]`, `[Chorus]`, timestamps such as `[0:00-0:20] Intro`).
863
+ * - The default model is elevenlabs-music_v2.5. Options go in `musicModelOverride.config`, and differ by model:
864
+ * - elevenlabs-music_v2.5, elevenlabs-music_v2: `musicLengthMs`, the song's length from 3,000 to 600,000 (the model chooses one from the text otherwise, and holds a length it's given), and `forceInstrumental: true` for no vocals.
865
+ * - lyria-3.5: songs of up to about three minutes, their length steered from the text; `image`, the URL of an image for the song to take its mood and subject from. lyria-3 makes 30-second clips, lyria-3-pro songs of up to about three minutes.
866
+ * - minimax-music-3.0: `lyrics` (written from the text when left out), `is_instrumental: true`, `bitrate`, `sample_rate`. minimax-music-2.5 requires `lyrics`.
867
+ * - In foreground mode, the audio is displayed to the user. In background mode, the URL is saved to a variable.
868
+ *
869
+ * @example
870
+ * ```typescript
871
+ * const result = await agent.generateMusic({
872
+ * text: ``,
873
+ * });
874
+ * ```
875
+ */
876
+ generateMusic(step: GenerateMusicStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<GenerateMusicStepOutput>>;
877
+ /**
878
+ * Generate an HTML asset and export it as a webpage, PDF, or image
879
+ *
880
+ * @remarks
881
+ * - Agents can generate HTML documents and export as webpage, PDFs, images, or videos. They do this by using the "generatePdf" block, which defines an HTML page with variables, and then the generation process renders the page to create the output and save its URL at the specified variable.
882
+ * - The template for the HTML page is generated by a separate process, and it can only use variables that have already been defined in the workflow at the time of its execution. It has full access to handlebars to render the HTML template, including a handlebars helper to render a markdown variable string as HTML (which can be useful for creating templates that render long strings). The template can also create its own simple JavaScript to do things like format dates and strings.
883
+ * - If PDF or composited image generation are part of the workflow, assistant adds the block and leaves the "source" empty. In a separate step, assistant generates a detailed request for the developer who will write the HTML.
884
+ * - Can also auto-generate HTML from a prompt (like a generate text block to generate HTML). In these cases, create a prompt with variables in the dynamicPrompt variable describing, in detail, the document to generate
885
+ * - Can either display output directly to user (foreground mode) or save the URL of the asset to a variable (background mode)
886
+ *
887
+ * @example
888
+ * ```typescript
889
+ * const result = await agent.generateAsset({
890
+ * source: ``,
891
+ * sourceType: "html",
892
+ * outputFormat: "pdf",
893
+ * pageSize: "full",
894
+ * testData: {},
895
+ * });
896
+ * ```
897
+ */
898
+ generateAsset(step: GeneratePdfStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<GeneratePdfStepOutput>>;
899
+ /**
900
+ * Generate a sound effect from a text description using a sound model.
901
+ *
902
+ * @remarks
903
+ * - `text` describes the sound effect to generate.
904
+ * - The default model is elevenlabs-sound_v2. Options go in `soundModelOverride.config`:
905
+ * - `durationSeconds` — the length, from 0.5 to 30. Left out, the model picks one from the text, and the effect is billed as 5 seconds whatever its length.
906
+ * - `loop: true` — a sound that repeats with no audible start or end, for ambience and backgrounds.
907
+ * - `promptInfluence` — how literally the text is followed, from 0 to 1 (default 0.3).
908
+ * - `outputFormat` — MP3 (`mp3_44100_128` by default, up to `mp3_44100_192`) or Opus (`opus_48000_32` to `opus_48000_192`).
909
+ * - In foreground mode, the audio is displayed to the user. In background mode, the URL is saved to a variable.
910
+ *
911
+ * @example
912
+ * ```typescript
913
+ * const result = await agent.generateSound({
914
+ * text: ``,
915
+ * });
916
+ * ```
917
+ */
918
+ generateSound(step: GenerateSoundStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<GenerateSoundStepOutput>>;
919
+ /**
920
+ * Convert a static image to an MP4
921
+ *
922
+ * @remarks
923
+ * - Can use to create slides/intertitles/slates for video composition
924
+ *
925
+ * @example
926
+ * ```typescript
927
+ * const result = await agent.generateStaticVideoFromImage({
928
+ * imageUrl: ``,
929
+ * duration: ``,
930
+ * });
931
+ * ```
932
+ */
933
+ generateStaticVideoFromImage(step: GenerateStaticVideoFromImageStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<GenerateStaticVideoFromImageStepOutput>>;
934
+ /**
935
+ * Generate a video from a text prompt, an image or references, using an AI model.
936
+ *
937
+ * @remarks
938
+ * - Prompts should be descriptive but concise (roughly 3–6 sentences): the subject, the motion, the camera and the sound.
939
+ * - The default model is wan3.0-video. Options go in `videoModelOverride.config` under the model's own names, and differ by model, so look the model up before writing the call. Images, videos and audio go there too, as URLs: a first frame is `image` on most models, `image_url` on Veo, gemini-omni-flash, Runway's and minimax-h3-max, `source_image` on Grok Imagine, `start_frame` on ray-2 and `first_frame_image` on skyreels-v4.
940
+ * - A model that makes video more than one way takes `$mode` in its config (`text-to-video`, `image-to-video`, `reference-to-video`, `video-edit` and others it lists). Left out, a first frame or reference images in the config pick their mode, and otherwise the model's default runs.
941
+ * - Videos are hosted on the public CDN by default, or in one of the app's own file stores when the call passes `store` — a private store keeps the video private, with no public copy left behind.
942
+ * - In foreground mode, the video is displayed to the user. In background mode, the URL is saved to a variable.
943
+ * - When generateVariants is true with numVariants > 1, multiple videos are generated in parallel.
944
+ * - In direct execution, foreground mode behaves as background, and userSelect variant behavior behaves as saveAll.
945
+ *
946
+ * @example
947
+ * ```typescript
948
+ * const result = await agent.generateVideo({
949
+ * prompt: ``,
950
+ * });
951
+ * ```
952
+ */
953
+ generateVideo(step: GenerateVideoStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<GenerateVideoStepOutput>>;
954
+ /**
955
+ * Download attachments from a Gmail email and store them on the app's own storage.
956
+ *
957
+ * @remarks
958
+ * - Requires a Google OAuth connection with Gmail readonly scope.
959
+ * - Attachments are stored and returned as URLs — on the public CDN by default, or in one of the app's own file stores when the call passes `store`. Use a private store for anything confidential; a public CDN URL is readable by anyone who has it.
960
+ * - Attachments larger than 25MB are skipped.
961
+ * - Use the message ID from Search Gmail Emails, List Recent Gmail Emails, or Get Gmail Email steps.
962
+ *
963
+ * @example
964
+ * ```typescript
965
+ * const result = await agent.getGmailAttachments({
966
+ * messageId: ``,
967
+ * });
968
+ * ```
969
+ */
970
+ getGmailAttachments(step: GetGmailAttachmentsStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<GetGmailAttachmentsStepOutput>>;
971
+ /**
972
+ * Retrieve a specific draft from Gmail by draft ID.
973
+ *
974
+ * @remarks
975
+ * - Requires a Google OAuth connection with Gmail readonly scope.
976
+ * - Returns the draft content including subject, recipients, sender, and body.
977
+ *
978
+ * @example
979
+ * ```typescript
980
+ * const result = await agent.getGmailDraft({
981
+ * draftId: ``,
982
+ * });
983
+ * ```
984
+ */
985
+ getGmailDraft(step: GetGmailDraftStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<GetGmailDraftStepOutput>>;
986
+ /**
987
+ * Retrieve a specific email from Gmail by message ID.
988
+ *
989
+ * @remarks
990
+ * - Requires a Google OAuth connection with Gmail readonly scope.
991
+ * - Returns the email subject, sender, recipient, date, body (plain text preferred, falls back to HTML), and labels.
992
+ *
993
+ * @example
994
+ * ```typescript
995
+ * const result = await agent.getGmailEmail({
996
+ * messageId: ``,
997
+ * });
998
+ * ```
999
+ */
1000
+ getGmailEmail(step: GetGmailEmailStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<GetGmailEmailStepOutput>>;
1001
+ /**
1002
+ * Get the number of unread emails in the connected Gmail inbox.
1003
+ *
1004
+ * @remarks
1005
+ * - Requires a Google OAuth connection with Gmail readonly scope.
1006
+ * - Returns the unread message count for the inbox label.
1007
+ * - This is a lightweight call that does not fetch any email content.
1008
+ *
1009
+ * @example
1010
+ * ```typescript
1011
+ * const result = await agent.getGmailUnreadCount({});
1012
+ * ```
1013
+ */
1014
+ getGmailUnreadCount(step: GetGmailUnreadCountStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<GetGmailUnreadCountStepOutput>>;
1015
+ /**
1016
+ * Retrieve a specific event from a Google Calendar by event ID.
1017
+ *
1018
+ * @remarks
1019
+ * - Requires a Google OAuth connection with Calendar events scope.
1020
+ * - The variable receives JSON or XML-like text depending on exportType. The direct execution output always returns the structured event.
1021
+ *
1022
+ * @example
1023
+ * ```typescript
1024
+ * const result = await agent.getGoogleCalendarEvent({
1025
+ * eventId: ``,
1026
+ * exportType: "json",
1027
+ * });
1028
+ * ```
1029
+ */
1030
+ getGoogleCalendarEvent(step: GetGoogleCalendarEventStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<GetGoogleCalendarEventStepOutput>>;
1031
+ /**
1032
+ * Download a file from Google Drive and rehost it on the CDN. Returns a public CDN URL.
1033
+ *
1034
+ * @remarks
1035
+ * - Requires a Google OAuth connection with Drive scope.
1036
+ * - Google-native files (Docs, Sheets, Slides) cannot be downloaded — use dedicated steps instead.
1037
+ * - Maximum file size: 200MB.
1038
+ * - The file is downloaded and stored on the public CDN, where the returned URL is publicly accessible — pass `store` to put it in one of the app's own file stores instead, which for a private store means the URL only loads for an authorized session.
1039
+ *
1040
+ * @example
1041
+ * ```typescript
1042
+ * const result = await agent.getGoogleDriveFile({
1043
+ * fileId: ``,
1044
+ * });
1045
+ * ```
1046
+ */
1047
+ getGoogleDriveFile(step: GetGoogleDriveFileStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<GetGoogleDriveFileStepOutput>>;
1048
+ /**
1049
+ * Get metadata about a Google Spreadsheet including sheet names, row counts, and column counts.
1050
+ *
1051
+ * @remarks
1052
+ * - Requires a Google OAuth connection with Drive scope.
1053
+ * - Returns the spreadsheet title and a list of all sheets with their dimensions.
1054
+ *
1055
+ * @example
1056
+ * ```typescript
1057
+ * const result = await agent.getGoogleSheetInfo({
1058
+ * documentId: ``,
1059
+ * });
1060
+ * ```
1061
+ */
1062
+ getGoogleSheetInfo(step: GetGoogleSheetInfoStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<GetGoogleSheetInfoStepOutput>>;
1063
+ /**
1064
+ * Get info about a media file
1065
+ *
1066
+ * @example
1067
+ * ```typescript
1068
+ * const result = await agent.getMediaMetadata({
1069
+ * mediaUrl: ``,
1070
+ * });
1071
+ * ```
1072
+ */
1073
+ getMediaMetadata(step: GetMediaMetadataStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<GetMediaMetadataStepOutput>>;
1074
+ /**
1075
+ * Create a new company or update an existing one in HubSpot. Matches by domain.
1076
+ *
1077
+ * @remarks
1078
+ * - Requires a HubSpot OAuth connection (connectionId).
1079
+ * - If a company with the given domain already exists, it is updated. Otherwise, a new one is created.
1080
+ * - Property values are type-checked against enabledProperties before being sent to HubSpot.
1081
+ *
1082
+ * @example
1083
+ * ```typescript
1084
+ * const result = await agent.hubspotCreateCompany({
1085
+ * company: {},
1086
+ * enabledProperties: [],
1087
+ * });
1088
+ * ```
1089
+ */
1090
+ hubspotCreateCompany(step: HubspotCreateCompanyStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<HubspotCreateCompanyStepOutput>>;
1091
+ /**
1092
+ * Create a new contact or update an existing one in HubSpot. Matches by email address.
1093
+ *
1094
+ * @remarks
1095
+ * - Requires a HubSpot OAuth connection (connectionId).
1096
+ * - If a contact with the given email already exists, it is updated. Otherwise, a new one is created.
1097
+ * - If companyDomain is provided, the contact is associated with that company (creating the company if needed).
1098
+ * - Property values are type-checked against enabledProperties before being sent to HubSpot.
1099
+ *
1100
+ * @example
1101
+ * ```typescript
1102
+ * const result = await agent.hubspotCreateContact({
1103
+ * contact: {},
1104
+ * enabledProperties: [],
1105
+ * companyDomain: ``,
1106
+ * });
1107
+ * ```
1108
+ */
1109
+ hubspotCreateContact(step: HubspotCreateContactStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<HubspotCreateContactStepOutput>>;
1110
+ /**
1111
+ * Look up a HubSpot company by domain name or company ID.
1112
+ *
1113
+ * @remarks
1114
+ * - Requires a HubSpot OAuth connection (connectionId).
1115
+ * - Returns null if the company is not found.
1116
+ * - When searching by domain, performs a search query then fetches the full company record.
1117
+ * - Use additionalProperties to request specific HubSpot properties beyond the defaults.
1118
+ *
1119
+ * @example
1120
+ * ```typescript
1121
+ * const result = await agent.hubspotGetCompany({
1122
+ * searchBy: "domain",
1123
+ * companyDomain: ``,
1124
+ * companyId: ``,
1125
+ * additionalProperties: [],
1126
+ * });
1127
+ * ```
1128
+ */
1129
+ hubspotGetCompany(step: HubspotGetCompanyStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<HubspotGetCompanyStepOutput>>;
1130
+ /**
1131
+ * Look up a HubSpot contact by email address or contact ID.
1132
+ *
1133
+ * @remarks
1134
+ * - Requires a HubSpot OAuth connection (connectionId).
1135
+ * - Returns null if the contact is not found.
1136
+ * - Use additionalProperties to request specific HubSpot properties beyond the defaults.
1137
+ *
1138
+ * @example
1139
+ * ```typescript
1140
+ * const result = await agent.hubspotGetContact({
1141
+ * searchBy: "email",
1142
+ * contactEmail: ``,
1143
+ * contactId: ``,
1144
+ * additionalProperties: [],
1145
+ * });
1146
+ * ```
1147
+ */
1148
+ hubspotGetContact(step: HubspotGetContactStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<HubspotGetContactStepOutput>>;
1149
+ /**
1150
+ * Look up company information by domain using Hunter.io.
1151
+ *
1152
+ * @remarks
1153
+ * - Returns company name, description, location, industry, size, technologies, and more.
1154
+ * - If the domain input is a full URL, the hostname is automatically extracted.
1155
+ * - Returns null if the company is not found.
1156
+ *
1157
+ * @example
1158
+ * ```typescript
1159
+ * const result = await agent.hunterApiCompanyEnrichment({
1160
+ * domain: ``,
1161
+ * });
1162
+ * ```
1163
+ */
1164
+ hunterApiCompanyEnrichment(step: HunterApiCompanyEnrichmentStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<HunterApiCompanyEnrichmentStepOutput>>;
1165
+ /**
1166
+ * Search for email addresses associated with a domain using Hunter.io.
1167
+ *
1168
+ * @remarks
1169
+ * - If the domain input is a full URL, the hostname is automatically extracted.
1170
+ * - Returns a list of email addresses found for the domain along with organization info.
1171
+ *
1172
+ * @example
1173
+ * ```typescript
1174
+ * const result = await agent.hunterApiDomainSearch({
1175
+ * domain: ``,
1176
+ * });
1177
+ * ```
1178
+ */
1179
+ hunterApiDomainSearch(step: HunterApiDomainSearchStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<HunterApiDomainSearchStepOutput>>;
1180
+ /**
1181
+ * Find an email address for a specific person at a domain using Hunter.io.
1182
+ *
1183
+ * @remarks
1184
+ * - Requires a first name, last name, and domain.
1185
+ * - If the domain input is a full URL, the hostname is automatically extracted.
1186
+ * - Returns the most likely email address with a confidence score.
1187
+ *
1188
+ * @example
1189
+ * ```typescript
1190
+ * const result = await agent.hunterApiEmailFinder({
1191
+ * domain: ``,
1192
+ * firstName: ``,
1193
+ * lastName: ``,
1194
+ * });
1195
+ * ```
1196
+ */
1197
+ hunterApiEmailFinder(step: HunterApiEmailFinderStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<HunterApiEmailFinderStepOutput>>;
1198
+ /**
1199
+ * Verify whether an email address is valid and deliverable using Hunter.io.
1200
+ *
1201
+ * @remarks
1202
+ * - Checks email format, MX records, SMTP server, and mailbox deliverability.
1203
+ * - Returns a status ("valid", "invalid", "accept_all", "webmail", "disposable", "unknown") and a score.
1204
+ *
1205
+ * @example
1206
+ * ```typescript
1207
+ * const result = await agent.hunterApiEmailVerification({
1208
+ * email: ``,
1209
+ * });
1210
+ * ```
1211
+ */
1212
+ hunterApiEmailVerification(step: HunterApiEmailVerificationStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<HunterApiEmailVerificationStepOutput>>;
1213
+ /**
1214
+ * Look up professional information about a person by their email address using Hunter.io.
1215
+ *
1216
+ * @remarks
1217
+ * - Returns name, job title, social profiles, and company information.
1218
+ * - If the person is not found, returns an object with an error message instead of throwing.
1219
+ *
1220
+ * @example
1221
+ * ```typescript
1222
+ * const result = await agent.hunterApiPersonEnrichment({
1223
+ * email: ``,
1224
+ * });
1225
+ * ```
1226
+ */
1227
+ hunterApiPersonEnrichment(step: HunterApiPersonEnrichmentStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<HunterApiPersonEnrichmentStepOutput>>;
1228
+ /**
1229
+ * Replace a face in an image with a face from another image using AI.
1230
+ *
1231
+ * @remarks
1232
+ * - Requires both a target image and a face source image.
1233
+ * - Output is a PNG on the public CDN, or in one of the app's own file stores when the call passes `store` — a private store keeps it private.
1234
+ *
1235
+ * @example
1236
+ * ```typescript
1237
+ * const result = await agent.imageFaceSwap({
1238
+ * imageUrl: ``,
1239
+ * faceImageUrl: ``,
1240
+ * engine: ``,
1241
+ * });
1242
+ * ```
1243
+ */
1244
+ imageFaceSwap(step: ImageFaceSwapStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<ImageFaceSwapStepOutput>>;
1245
+ /**
1246
+ * Remove watermarks from an image using AI.
1247
+ *
1248
+ * @remarks
1249
+ * - Output is a PNG on the public CDN, or in one of the app's own file stores when the call passes `store` — a private store keeps it private.
1250
+ *
1251
+ * @example
1252
+ * ```typescript
1253
+ * const result = await agent.imageRemoveWatermark({
1254
+ * imageUrl: ``,
1255
+ * engine: ``,
1256
+ * });
1257
+ * ```
1258
+ */
1259
+ imageRemoveWatermark(step: ImageRemoveWatermarkStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<ImageRemoveWatermarkStepOutput>>;
1260
+ /**
1261
+ * Copy a file at a URL into one of the app's file stores, without the bytes passing through the method
1262
+ *
1263
+ * @remarks
1264
+ * - For a direct link to a file (a recording, an export, a podcast episode's mp3), up to 5 GiB. The file is fetched and stored as it is.
1265
+ * - Requires a store: pass the store handle as `store` in the options. `Store.importFromUrl(url)` is the same call, returning a StoredFile.
1266
+ * - A share page (a Google Drive or Dropbox page, YouTube) is not the file: pass the file's own download link, or use downloadVideo for a hosted video.
1267
+ *
1268
+ * @example
1269
+ * ```typescript
1270
+ * const result = await agent.importFromUrl({
1271
+ * url: ``,
1272
+ * });
1273
+ * ```
1274
+ */
1275
+ importFromUrl(step: ImportFromUrlStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<ImportFromUrlStepOutput>>;
1276
+ /**
1277
+ * Insert b-roll clips into a base video at a timecode, optionally with an xfade transition.
1278
+ *
1279
+ * @example
1280
+ * ```typescript
1281
+ * const result = await agent.insertVideoClips({
1282
+ * baseVideoUrl: ``,
1283
+ * overlayVideos: [],
1284
+ * });
1285
+ * ```
1286
+ */
1287
+ insertVideoClips(step: InsertVideoClipsStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<InsertVideoClipsStepOutput>>;
1288
+ /**
1289
+ * @deprecated Legacy v1 data sources. v2 apps should use `dataSources.defineDataSource()` from @mindstudio-ai/agent instead, which owns parsing, chunking, embedding and citations. List all data sources for the current app.
1290
+ *
1291
+ * @remarks
1292
+ * - Returns metadata for every data source associated with the current app version.
1293
+ * - Each entry includes the data source ID, name, description, status, and document list.
1294
+ *
1295
+ * @example
1296
+ * ```typescript
1297
+ * const result = await agent.listDataSources({});
1298
+ * ```
1299
+ */
1300
+ listDataSources(step: ListDataSourcesStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<ListDataSourcesStepOutput>>;
1301
+ /**
1302
+ * List drafts in the connected Gmail account.
1303
+ *
1304
+ * @remarks
1305
+ * - Requires a Google OAuth connection with Gmail readonly scope.
1306
+ * - Returns up to 50 drafts (default 10).
1307
+ * - The variable receives text or JSON depending on exportType.
1308
+ *
1309
+ * @example
1310
+ * ```typescript
1311
+ * const result = await agent.listGmailDrafts({
1312
+ * exportType: "json",
1313
+ * });
1314
+ * ```
1315
+ */
1316
+ listGmailDrafts(step: ListGmailDraftsStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<ListGmailDraftsStepOutput>>;
1317
+ /**
1318
+ * List all labels in the connected Gmail account. Use these label IDs or names with the Update Gmail Labels step.
1319
+ *
1320
+ * @remarks
1321
+ * - Requires a Google OAuth connection with Gmail readonly scope.
1322
+ * - Returns both system labels (INBOX, SENT, TRASH, etc.) and user-created labels.
1323
+ * - Label type is "system" for built-in labels or "user" for custom labels.
1324
+ *
1325
+ * @example
1326
+ * ```typescript
1327
+ * const result = await agent.listGmailLabels({});
1328
+ * ```
1329
+ */
1330
+ listGmailLabels(step: ListGmailLabelsStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<ListGmailLabelsStepOutput>>;
1331
+ /**
1332
+ * List upcoming events from a Google Calendar, ordered by start time.
1333
+ *
1334
+ * @remarks
1335
+ * - Requires a Google OAuth connection with Calendar events scope.
1336
+ * - Only returns future events (timeMin = now).
1337
+ * - The variable receives JSON or XML-like text depending on exportType. The direct execution output always returns structured events.
1338
+ *
1339
+ * @example
1340
+ * ```typescript
1341
+ * const result = await agent.listGoogleCalendarEvents({
1342
+ * limit: 0,
1343
+ * exportType: "json",
1344
+ * });
1345
+ * ```
1346
+ */
1347
+ listGoogleCalendarEvents(step: ListGoogleCalendarEventsStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<ListGoogleCalendarEventsStepOutput>>;
1348
+ /**
1349
+ * List files in a Google Drive folder.
1350
+ *
1351
+ * @remarks
1352
+ * - Requires a Google OAuth connection with Drive scope.
1353
+ * - If folderId is omitted, lists files in the root folder.
1354
+ * - Returns file metadata including name, type, size, and links.
1355
+ *
1356
+ * @example
1357
+ * ```typescript
1358
+ * const result = await agent.listGoogleDriveFiles({
1359
+ * exportType: "json",
1360
+ * });
1361
+ * ```
1362
+ */
1363
+ listGoogleDriveFiles(step: ListGoogleDriveFilesStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<ListGoogleDriveFilesStepOutput>>;
1364
+ /**
1365
+ * List recent emails from the connected Gmail inbox.
1366
+ *
1367
+ * @remarks
1368
+ * - Requires a Google OAuth connection with Gmail readonly scope.
1369
+ * - Returns up to 100 emails (default 5), ordered by most recent first.
1370
+ * - Functionally equivalent to Search Gmail Emails with an "in:inbox" query.
1371
+ *
1372
+ * @example
1373
+ * ```typescript
1374
+ * const result = await agent.listRecentGmailEmails({
1375
+ * exportType: "json",
1376
+ * limit: ``,
1377
+ * });
1378
+ * ```
1379
+ */
1380
+ listRecentGmailEmails(step: ListRecentGmailEmailsStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<ListRecentGmailEmailsStepOutput>>;
1381
+ /**
1382
+ * Route execution to different branches based on AI evaluation, comparison operators, or workflow jumps.
1383
+ *
1384
+ * @remarks
1385
+ * - Supports two modes: "ai" (default) uses an AI model to pick the most accurate statement; "comparison" uses operator-based checks.
1386
+ * - In AI mode, the model picks the most accurate statement from the list. All possible cases must be specified.
1387
+ * - In comparison mode, the context is the left operand and each case's condition is the right operand. First matching case wins. Use operator "default" as a fallback.
1388
+ * - Requires at least two cases.
1389
+ * - Each case can transition to a step in the current workflow (destinationStepId) or jump to another workflow (destinationWorkflowId).
1390
+ *
1391
+ * @example
1392
+ * ```typescript
1393
+ * const result = await agent.logic({
1394
+ * context: ``,
1395
+ * cases: [],
1396
+ * });
1397
+ * ```
1398
+ */
1399
+ logic(step: LogicStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<LogicStepOutput>>;
1400
+ /**
1401
+ * Trigger a Make.com (formerly Integromat) scenario via webhook and return the response.
1402
+ *
1403
+ * @remarks
1404
+ * - The webhook URL must be configured in your Make.com scenario.
1405
+ * - Input key-value pairs are sent as JSON in the POST body.
1406
+ * - Response format depends on the Make.com scenario configuration.
1407
+ *
1408
+ * @example
1409
+ * ```typescript
1410
+ * const result = await agent.makeDotComRunScenario({
1411
+ * webhookUrl: ``,
1412
+ * input: {},
1413
+ * });
1414
+ * ```
1415
+ */
1416
+ makeDotComRunScenario(step: MakeDotComRunScenarioStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<MakeDotComRunScenarioStepOutput>>;
1417
+ /**
1418
+ * Merge one or more clips into a single audio file.
1419
+ *
1420
+ * @example
1421
+ * ```typescript
1422
+ * const result = await agent.mergeAudio({
1423
+ * mp3Urls: [],
1424
+ * });
1425
+ * ```
1426
+ */
1427
+ mergeAudio(step: MergeAudioStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<MergeAudioStepOutput>>;
1428
+ /**
1429
+ * Merge one or more clips into a single video.
1430
+ *
1431
+ * @example
1432
+ * ```typescript
1433
+ * const result = await agent.mergeVideos({
1434
+ * videoUrls: [],
1435
+ * });
1436
+ * ```
1437
+ */
1438
+ mergeVideos(step: MergeVideosStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<MergeVideosStepOutput>>;
1439
+ /**
1440
+ * Apply a preset animation to a rigged 3D character model using Meshy.
1441
+ *
1442
+ * @remarks
1443
+ * - Requires a rig_task_id from a previously completed Meshy rigging step.
1444
+ * - Select an animation from Meshy's library of 600+ preset animations.
1445
+ * - Only works with humanoid (bipedal) rigged characters.
1446
+ * - Supports post-processing: FPS change (24/25/30/60), FBX-to-USDZ conversion, or armature extraction.
1447
+ * - Animation categories: DailyActions, WalkAndRun, Fighting, Dancing, BodyMovements.
1448
+ *
1449
+ * @example
1450
+ * ```typescript
1451
+ * const result = await agent.meshyAnimate({
1452
+ * rigTaskId: ``,
1453
+ * actionId: 0,
1454
+ * });
1455
+ * ```
1456
+ */
1457
+ meshyAnimate(step: MeshyAnimateStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<MeshyAnimateStepOutput>>;
1458
+ /**
1459
+ * Generate a 3D model from one or more images using Meshy. Uses the multi-image-to-3D endpoint.
1460
+ *
1461
+ * @remarks
1462
+ * - Accepts 1-4 image URLs. All images should depict the same object from different angles for best results.
1463
+ * - By default generates with textures. Set shouldTexture to false for mesh-only output.
1464
+ * - Uses should_remesh: false to preserve UV mapping integrity.
1465
+ *
1466
+ * @example
1467
+ * ```typescript
1468
+ * const result = await agent.meshyImageTo3d({
1469
+ * imageUrls: [],
1470
+ * });
1471
+ * ```
1472
+ */
1473
+ meshyImageTo3d(step: MeshyImageTo3dStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<MeshyImageTo3dStepOutput>>;
1474
+ /**
1475
+ * Remesh an existing 3D model to adjust topology, polygon count, or convert formats using Meshy.
1476
+ *
1477
+ * @remarks
1478
+ * - Provide either an input task ID (from a previous Meshy step) or a model URL.
1479
+ * - Defaults to triangle topology with 30,000 target polys.
1480
+ * - Useful for reducing face count before rigging (max 300k faces for rigging).
1481
+ *
1482
+ * @example
1483
+ * ```typescript
1484
+ * const result = await agent.meshyRemesh({});
1485
+ * ```
1486
+ */
1487
+ meshyRemesh(step: MeshyRemeshStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<MeshyRemeshStepOutput>>;
1488
+ /**
1489
+ * Auto-rig a humanoid 3D model and generate basic walking/running animations using Meshy.
1490
+ *
1491
+ * @remarks
1492
+ * - Only works well with standard humanoid (bipedal) models with clearly defined limbs.
1493
+ * - Prefers model_url over input_task_id for cleaner rigging input.
1494
+ * - Models with more than 300,000 faces should be remeshed first.
1495
+ * - Returns rigged model files and optional basic animations.
1496
+ *
1497
+ * @example
1498
+ * ```typescript
1499
+ * const result = await agent.meshyRig({});
1500
+ * ```
1501
+ */
1502
+ meshyRig(step: MeshyRigStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<MeshyRigStepOutput>>;
1503
+ /**
1504
+ * Generate a 3D model preview from a text prompt using Meshy. Produces an untextured mesh (preview stage).
1505
+ *
1506
+ * @remarks
1507
+ * - Creates a text-to-3D preview task (mesh generation only, no texture).
1508
+ * - Use the Meshy Texture step to apply textures to the preview.
1509
+ * - Maximum prompt length is 600 characters.
1510
+ *
1511
+ * @example
1512
+ * ```typescript
1513
+ * const result = await agent.meshyTextTo3d({
1514
+ * prompt: ``,
1515
+ * });
1516
+ * ```
1517
+ */
1518
+ meshyTextTo3d(step: MeshyTextTo3dStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<MeshyTextTo3dStepOutput>>;
1519
+ /**
1520
+ * Apply or replace textures on a 3D model using a text prompt or reference image via Meshy.
1521
+ *
1522
+ * @remarks
1523
+ * - Provide either an input task ID (from a previous Meshy step) or a model URL.
1524
+ * - Provide either a text style prompt or an image style URL to guide texturing.
1525
+ * - Supports .glb, .gltf, .obj, .fbx, .stl model formats when using modelUrl.
1526
+ * - By default preserves original UVs (enableOriginalUv = true).
1527
+ * - Works with any model source: text-to-3D previews, image-to-3D, remeshed models, or external files.
1528
+ *
1529
+ * @example
1530
+ * ```typescript
1531
+ * const result = await agent.meshyTexture({});
1532
+ * ```
1533
+ */
1534
+ meshyTexture(step: MeshyTextureStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<MeshyTextureStepOutput>>;
1535
+ /**
1536
+ * Mix an audio track into a video
1537
+ *
1538
+ * @example
1539
+ * ```typescript
1540
+ * const result = await agent.mixAudioIntoVideo({
1541
+ * videoUrl: ``,
1542
+ * audioUrl: ``,
1543
+ * options: {},
1544
+ * });
1545
+ * ```
1546
+ */
1547
+ mixAudioIntoVideo(step: MixAudioIntoVideoStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<MixAudioIntoVideoStepOutput>>;
1548
+ /**
1549
+ * Mute a video file
1550
+ *
1551
+ * @example
1552
+ * ```typescript
1553
+ * const result = await agent.muteVideo({
1554
+ * videoUrl: ``,
1555
+ * });
1556
+ * ```
1557
+ */
1558
+ muteVideo(step: MuteVideoStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<MuteVideoStepOutput>>;
1559
+ /**
1560
+ * Trigger an n8n workflow node via webhook and return the response.
1561
+ *
1562
+ * @remarks
1563
+ * - The webhook URL must be configured in your n8n workflow.
1564
+ * - Supports GET and POST methods with optional Basic authentication.
1565
+ * - For GET requests, input values are sent as query parameters. For POST, they are sent as JSON body.
1566
+ *
1567
+ * @example
1568
+ * ```typescript
1569
+ * const result = await agent.n8nRunNode({
1570
+ * method: ``,
1571
+ * authentication: "none",
1572
+ * user: ``,
1573
+ * password: ``,
1574
+ * webhookUrl: ``,
1575
+ * input: {},
1576
+ * });
1577
+ * ```
1578
+ */
1579
+ n8nRunNode(step: N8nRunNodeStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<N8nRunNodeStepOutput>>;
1580
+ /**
1581
+ * Create a new page in Notion as a child of an existing page.
1582
+ *
1583
+ * @remarks
1584
+ * - Requires a Notion OAuth connection (connectionId).
1585
+ * - Content is provided as markdown and converted to Notion blocks (headings, paragraphs, lists, code, quotes).
1586
+ * - The page is created as a child of the specified parent page (pageId).
1587
+ *
1588
+ * @example
1589
+ * ```typescript
1590
+ * const result = await agent.notionCreatePage({
1591
+ * pageId: ``,
1592
+ * content: ``,
1593
+ * title: ``,
1594
+ * });
1595
+ * ```
1596
+ */
1597
+ notionCreatePage(step: NotionCreatePageStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<NotionCreatePageStepOutput>>;
1598
+ /**
1599
+ * Update the content of an existing Notion page.
1600
+ *
1601
+ * @remarks
1602
+ * - Requires a Notion OAuth connection (connectionId).
1603
+ * - Content is provided as markdown and converted to Notion blocks.
1604
+ * - "append" mode adds content to the end of the page. "overwrite" mode deletes all existing blocks first.
1605
+ *
1606
+ * @example
1607
+ * ```typescript
1608
+ * const result = await agent.notionUpdatePage({
1609
+ * pageId: ``,
1610
+ * content: ``,
1611
+ * mode: "append",
1612
+ * });
1613
+ * ```
1614
+ */
1615
+ notionUpdatePage(step: NotionUpdatePageStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<NotionUpdatePageStepOutput>>;
1616
+ /**
1617
+ * Search for people matching specific criteria using Apollo.io. Supports natural language queries and advanced filters.
1618
+ *
1619
+ * @remarks
1620
+ * - Can use a natural language "smartQuery" which is converted to Apollo search parameters by an AI model.
1621
+ * - Advanced params can override or supplement the smart query results.
1622
+ * - Optionally enriches returned people and/or their organizations for additional detail.
1623
+ * - Results are paginated. Use limit and page to control the result window.
1624
+ *
1625
+ * @example
1626
+ * ```typescript
1627
+ * const result = await agent.peopleSearch({
1628
+ * smartQuery: ``,
1629
+ * enrichPeople: false,
1630
+ * enrichOrganizations: false,
1631
+ * limit: ``,
1632
+ * page: ``,
1633
+ * params: {},
1634
+ * });
1635
+ * ```
1636
+ */
1637
+ peopleSearch(step: PeopleSearchStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<PeopleSearchStepOutput>>;
1638
+ /**
1639
+ * Create a post on LinkedIn from the connected account.
1640
+ *
1641
+ * @remarks
1642
+ * - Requires a LinkedIn OAuth connection (connectionId).
1643
+ * - Supports text posts, image posts, video posts, document posts, and article posts.
1644
+ * - Attach one media type per post: image, video, document, or article.
1645
+ * - Documents support PDF, PPT, PPTX, DOC, DOCX (max 100MB, 300 pages). Displays as a slideshow carousel.
1646
+ * - Articles create a link preview with optional custom title, description, and thumbnail.
1647
+ * - Visibility controls who can see the post.
1648
+ *
1649
+ * @example
1650
+ * ```typescript
1651
+ * const result = await agent.postToLinkedIn({
1652
+ * message: ``,
1653
+ * visibility: "PUBLIC",
1654
+ * });
1655
+ * ```
1656
+ */
1657
+ postToLinkedIn(step: PostToLinkedInStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<PostToLinkedInStepOutput>>;
1658
+ /**
1659
+ * Send a message to a Slack channel via a connected bot.
1660
+ *
1661
+ * @remarks
1662
+ * - The user is responsible for connecting their Slack workspace and selecting the channel
1663
+ * - Supports both simple text messages and slack blocks messages
1664
+ * - Text messages can use limited markdown (slack-only fomatting—e.g., headers are just rendered as bold)
1665
+ *
1666
+ * @example
1667
+ * ```typescript
1668
+ * const result = await agent.postToSlackChannel({
1669
+ * channelId: ``,
1670
+ * messageType: "string",
1671
+ * message: ``,
1672
+ * });
1673
+ * ```
1674
+ */
1675
+ postToSlackChannel(step: PostToSlackChannelStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<PostToSlackChannelStepOutput>>;
1676
+ /**
1677
+ * Create a post on X (Twitter) from the connected account.
1678
+ *
1679
+ * @remarks
1680
+ * - Requires an X OAuth connection (connectionId).
1681
+ * - Maximum 280 characters of text.
1682
+ * - Optionally attach up to 4 media items (images, GIFs, or videos) via mediaUrls.
1683
+ * - Media URLs must be publicly accessible. The service fetches and uploads them to X.
1684
+ * - Supported formats: JPEG, PNG, GIF, WEBP, MP4. Images up to 5MB, videos up to 512MB.
1685
+ *
1686
+ * @example
1687
+ * ```typescript
1688
+ * const result = await agent.postToX({
1689
+ * text: ``,
1690
+ * });
1691
+ * ```
1692
+ */
1693
+ postToX(step: PostToXStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<PostToXStepOutput>>;
1694
+ /**
1695
+ * Send data to a Zapier Zap via webhook and return the response.
1696
+ *
1697
+ * @remarks
1698
+ * - The webhook URL must be configured in the Zapier Zap settings
1699
+ * - Input keys and values are sent as the JSON body of the POST request
1700
+ * - The webhook response (JSON or plain text) is returned as the output
1701
+ *
1702
+ * @example
1703
+ * ```typescript
1704
+ * const result = await agent.postToZapier({
1705
+ * webhookUrl: ``,
1706
+ * input: {},
1707
+ * });
1708
+ * ```
1709
+ */
1710
+ postToZapier(step: PostToZapierStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<PostToZapierStepOutput>>;
1711
+ /**
1712
+ * @deprecated Legacy v1 data sources. v2 apps should use `dataSources.defineDataSource()` from @mindstudio-ai/agent instead, which owns parsing, chunking, embedding and citations. Search a vector data source (RAG) and return relevant document chunks.
1713
+ *
1714
+ * @remarks
1715
+ * - Queries a vectorized data source and returns the most relevant chunks.
1716
+ * - Useful for retrieval-augmented generation (RAG) workflows.
1717
+ *
1718
+ * @example
1719
+ * ```typescript
1720
+ * const result = await agent.queryDataSource({
1721
+ * dataSourceId: ``,
1722
+ * query: ``,
1723
+ * maxResults: 0,
1724
+ * });
1725
+ * ```
1726
+ */
1727
+ queryDataSource(step: QueryDataSourceStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<QueryDataSourceStepOutput>>;
1728
+ /**
1729
+ * Execute a SQL query against an external database connected to the workspace.
1730
+ *
1731
+ * @remarks
1732
+ * - Requires a database connection configured in the workspace.
1733
+ * - Supports PostgreSQL (including Supabase), MySQL, and MSSQL.
1734
+ * - Results can be returned as JSON or CSV.
1735
+ *
1736
+ * @example
1737
+ * ```typescript
1738
+ * const result = await agent.queryExternalDatabase({
1739
+ * query: ``,
1740
+ * outputFormat: "json",
1741
+ * });
1742
+ * ```
1743
+ */
1744
+ queryExternalDatabase(step: QueryExternalDatabaseStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<QueryExternalDatabaseStepOutput>>;
1745
+ /**
1746
+ * Call any QuickBooks Online Accounting API route using a connected company.
1747
+ *
1748
+ * @remarks
1749
+ * - Requires a QuickBooks OAuth connection (connectionId).
1750
+ * - Route is relative to /v3/company/{realmId}/, e.g. "account", "account/93", "query", "invoice".
1751
+ * - Use queryParams for query-string values such as query=select * from Account.
1752
+ * - Body is JSON for POST, PUT, and PATCH.
1753
+ *
1754
+ * @example
1755
+ * ```typescript
1756
+ * const result = await agent.quickbooksApiRequest({
1757
+ * method: ``,
1758
+ * route: ``,
1759
+ * queryParams: {},
1760
+ * body: ``,
1761
+ * });
1762
+ * ```
1763
+ */
1764
+ quickbooksApiRequest(step: QuickbooksApiRequestStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<QuickbooksApiRequestStepOutput>>;
1765
+ /**
1766
+ * Replace personally identifiable information in text with placeholders using Microsoft Presidio.
1767
+ *
1768
+ * @remarks
1769
+ * - PII is replaced with entity type placeholders (e.g. "Call me at <PHONE_NUMBER>").
1770
+ * - If entities is empty, returns empty text immediately without processing.
1771
+ *
1772
+ * @example
1773
+ * ```typescript
1774
+ * const result = await agent.redactPII({
1775
+ * input: ``,
1776
+ * language: ``,
1777
+ * entities: [],
1778
+ * });
1779
+ * ```
1780
+ */
1781
+ redactPII(step: RedactPIIStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<RedactPIIStepOutput>>;
1782
+ /**
1783
+ * Remove the background from an image using AI, producing a transparent PNG.
1784
+ *
1785
+ * @remarks
1786
+ * - Uses the Bria background removal model via fal.ai by default.
1787
+ * - Uses WaveSpeed's Ideogram background removal model when type is "advanced".
1788
+ * - Output is a PNG with transparency on the public CDN, or in one of the app's own file stores when the call passes `store` — a private store keeps it private, `autoCrop` included.
1789
+ *
1790
+ * @example
1791
+ * ```typescript
1792
+ * const result = await agent.removeBackgroundFromImage({
1793
+ * imageUrl: ``,
1794
+ * });
1795
+ * ```
1796
+ */
1797
+ removeBackgroundFromImage(step: RemoveBackgroundFromImageStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<RemoveBackgroundFromImageStepOutput>>;
1798
+ /**
1799
+ * Render an HTML composition (HTML, CSS, media and seekable animation on a timeline) to a video file
1800
+ *
1801
+ * @remarks
1802
+ * - Renders an HTML composition in HyperFrames' format (https://hyperframes.heygen.com) with HyperFrames 0.8.186, in Chrome off the app's own sandbox; author for that version
1803
+ * - Pass the composition as `html`, the page itself (up to 10 MB), or as `project`, the URL of a zip of a project's folder (`index.html` at its root, or the file `entryFile` names) or of one HTML file, up to 2 GiB: an app file or any public URL
1804
+ * - `variables` overrides the composition's `data-composition-variables` defaults, which it reads with `window.__hyperframes.getVariables()`
1805
+ * - Whatever the composition loads itself (fonts, scripts, images, video) is fetched as it renders, so each is in the project or at a public URL; a private app file needs a signed URL
1806
+ * - fps 24, 30 or 60 (default 30); quality draft, standard or high (default standard); format mp4 (default), webm or mov (both keep transparency), or gif
1807
+ * - An mp4, webm or mov renders in chunks of about 10 seconds side by side, so a long video takes little longer than a short one; a call finishes within about 30 minutes, and reports its progress as it goes. A gif renders whole, within 15 minutes
1808
+ * - A composition HyperFrames can't render fails with HyperFrames' own reason
1809
+ *
1810
+ * @example
1811
+ * ```typescript
1812
+ * const result = await agent.renderVideoFromHtmlComposition({});
1813
+ * ```
1814
+ */
1815
+ renderVideoFromHtmlComposition(step: RenderVideoFromHtmlCompositionStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<RenderVideoFromHtmlCompositionStepOutput>>;
1816
+ /**
1817
+ * Reply to an existing email in Gmail. The reply is threaded under the original message.
1818
+ *
1819
+ * @remarks
1820
+ * - Requires a Google OAuth connection with Gmail compose and readonly scopes.
1821
+ * - The reply is sent to the original sender and threaded under the original message.
1822
+ * - messageType controls the body format: "plain", "html", or "markdown".
1823
+ *
1824
+ * @example
1825
+ * ```typescript
1826
+ * const result = await agent.replyToGmailEmail({
1827
+ * messageId: ``,
1828
+ * message: ``,
1829
+ * messageType: "plain",
1830
+ * });
1831
+ * ```
1832
+ */
1833
+ replyToGmailEmail(step: ReplyToGmailEmailStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<ReplyToGmailEmailStepOutput>>;
1834
+ /**
1835
+ * Resize a video file
1836
+ *
1837
+ * @remarks
1838
+ * - `mode` is required: `fit` scales the video down to fit within `maxWidth` x `maxHeight`, keeping its shape (a video already inside them is left that size); `exact` makes it `width` x `height`, padding (`strategy: 'pad'`, the default) or cropping (`'crop'`) where the shapes differ
1839
+ *
1840
+ * @example
1841
+ * ```typescript
1842
+ * const result = await agent.resizeVideo({
1843
+ * videoUrl: ``,
1844
+ * mode: "fit",
1845
+ * });
1846
+ * ```
1847
+ */
1848
+ resizeVideo(step: ResizeVideoStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<ResizeVideoStepOutput>>;
1849
+ /**
1850
+ * Run an ffmpeg command on media files
1851
+ *
1852
+ * @remarks
1853
+ * - Runs one ffmpeg command, its arguments exactly as given, off the app's own sandbox (ffmpeg 9, a static build with the common codecs and filters)
1854
+ * - `inputs` names each input file by URL; `{in:<name>}` anywhere in an argument, a filter graph included, is that file's local path
1855
+ * - `{out:<file.ext>}` anywhere in an argument is an output's path; every output the arguments name comes back in `outputs` by its file name, its type from its extension
1856
+ * - One command per call, finishing within 15 minutes; up to 10 GB of inputs and outputs together, 5 GB per output
1857
+ * - The system fonts are Noto Sans (`drawtext`'s default), DejaVu Sans, Liberation Sans and Noto Color Emoji: pass a font file as an input for any other
1858
+ * - A command ffmpeg refuses fails with ffmpeg's own error lines
1859
+ *
1860
+ * @example
1861
+ * ```typescript
1862
+ * const result = await agent.runFfmpeg({
1863
+ * inputs: {},
1864
+ * args: [],
1865
+ * });
1866
+ * ```
1867
+ */
1868
+ runFfmpeg(step: RunFfmpegStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<RunFfmpegStepOutput>>;
1869
+ /**
1870
+ * Run a raw API connector to a third-party service
1871
+ *
1872
+ * @remarks
1873
+ * - Use the /developer/v2/helpers/connectors endpoint to list available services and actions.
1874
+ * - Use /developer/v2/helpers/connectors/{serviceId}/{actionId} to get the full input configuration for an action.
1875
+ * - Use /developer/v2/helpers/connections to list your available OAuth connections.
1876
+ * - The actionId format is "serviceId/actionId" (e.g., "slack/send-message").
1877
+ * - Pass a __connectionId to authenticate the request with a specific OAuth connection, otherwise the default will be used (if configured).
1878
+ *
1879
+ * @example
1880
+ * ```typescript
1881
+ * const result = await agent.runFromConnectorRegistry({
1882
+ * actionId: ``,
1883
+ * displayName: ``,
1884
+ * icon: ``,
1885
+ * configurationValues: {},
1886
+ * });
1887
+ * ```
1888
+ */
1889
+ runFromConnectorRegistry(step: RunFromConnectorRegistryStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<RunFromConnectorRegistryStepOutput>>;
1890
+ /**
1891
+ * Scrape public company data from a LinkedIn company page.
1892
+ *
1893
+ * @remarks
1894
+ * - Requires a LinkedIn company URL (e.g. https://www.linkedin.com/company/mindstudioai).
1895
+ * - Returns structured company data including description, employees, updates, and similar companies.
1896
+ *
1897
+ * @example
1898
+ * ```typescript
1899
+ * const result = await agent.scrapeLinkedInCompany({
1900
+ * url: ``,
1901
+ * });
1902
+ * ```
1903
+ */
1904
+ scrapeLinkedInCompany(step: ScrapeLinkedInCompanyStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<ScrapeLinkedInCompanyStepOutput>>;
1905
+ /**
1906
+ * Scrape public profile data from a LinkedIn profile page.
1907
+ *
1908
+ * @remarks
1909
+ * - Requires a LinkedIn profile URL (e.g. https://www.linkedin.com/in/username).
1910
+ * - Returns structured profile data including experience, education, articles, and activities.
1911
+ *
1912
+ * @example
1913
+ * ```typescript
1914
+ * const result = await agent.scrapeLinkedInProfile({
1915
+ * url: ``,
1916
+ * });
1917
+ * ```
1918
+ */
1919
+ scrapeLinkedInProfile(step: ScrapeLinkedInProfileStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<ScrapeLinkedInProfileStepOutput>>;
1920
+ /**
1921
+ * Extract text, HTML, or structured content from one or more web pages.
1922
+ *
1923
+ * @remarks
1924
+ * - Accepts a single URL or multiple URLs (as a JSON array, comma-separated, or newline-separated).
1925
+ * - Output format controls the result shape: "text" returns markdown, "html" returns raw HTML, "json" returns structured scraper data, "summary" returns a model-written summary and requires the "firecrawl" service.
1926
+ * - Can optionally capture a screenshot of each page. Screenshots go to the public CDN by default, or into one of the app's own file stores when the call passes `store`.
1927
+ * - Handles bot protection automatically; no proxy or rendering configuration is needed.
1928
+ *
1929
+ * @example
1930
+ * ```typescript
1931
+ * const result = await agent.scrapeUrl({
1932
+ * url: ``,
1933
+ * });
1934
+ * ```
1935
+ */
1936
+ scrapeUrl(step: ScrapeUrlStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<ScrapeUrlStepOutput>>;
1937
+ /**
1938
+ * Scrape data from a single X (Twitter) post by URL.
1939
+ *
1940
+ * @remarks
1941
+ * - Returns structured post data (text, html, optional json/screenshot/metadata).
1942
+ * - Optionally saves the text content to a variable.
1943
+ *
1944
+ * @example
1945
+ * ```typescript
1946
+ * const result = await agent.scrapeXPost({
1947
+ * url: ``,
1948
+ * });
1949
+ * ```
1950
+ */
1951
+ scrapeXPost(step: ScrapeXPostStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<ScrapeXPostStepOutput>>;
1952
+ /**
1953
+ * Scrape public profile data from an X (Twitter) account by URL.
1954
+ *
1955
+ * @remarks
1956
+ * - Returns structured profile data.
1957
+ * - Optionally saves the result to a variable.
1958
+ *
1959
+ * @example
1960
+ * ```typescript
1961
+ * const result = await agent.scrapeXProfile({
1962
+ * url: ``,
1963
+ * });
1964
+ * ```
1965
+ */
1966
+ scrapeXProfile(step: ScrapeXProfileStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<ScrapeXProfileStepOutput>>;
1967
+ /**
1968
+ * Capture a screenshot of a web page as a PNG image.
1969
+ *
1970
+ * @remarks
1971
+ * - Takes a viewport or full-page screenshot of the given URL.
1972
+ * - Returns a PNG image URL: on the public CDN by default, or in one of the app's own file stores when the call passes `store` — a private store keeps the screenshot private.
1973
+ * - Viewport mode captures only the visible area; fullPage captures the entire scrollable page, scrolling it first so lazy-loaded content is included.
1974
+ * - Works on sites behind bot protection (Cloudflare and similar).
1975
+ * - Cookie-consent banners and similar overlays are suppressed automatically.
1976
+ * - `width` and `height` are the exact output pixel dimensions.
1977
+ * - You can add a delay or wait for a CSS selector before capturing. A selector that never appears fails the step rather than capturing early.
1978
+ *
1979
+ * @example
1980
+ * ```typescript
1981
+ * const result = await agent.screenshotUrl({
1982
+ * url: ``,
1983
+ * });
1984
+ * ```
1985
+ */
1986
+ screenshotUrl(step: ScreenshotUrlStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<ScreenshotUrlStepOutput>>;
1987
+ /**
1988
+ * Search for emails in the connected Gmail account using a Gmail search query. To list recent inbox emails, pass an empty query string.
1989
+ *
1990
+ * @remarks
1991
+ * - Requires a Google OAuth connection with Gmail readonly scope.
1992
+ * - Uses Gmail search syntax (e.g. "from:user@example.com", "subject:invoice", "is:unread").
1993
+ * - To list recent inbox emails, use an empty query string or "in:inbox".
1994
+ * - Returns up to 100 emails (default 5). The variable receives text or JSON depending on exportType.
1995
+ * - The direct execution output always returns structured email objects.
1996
+ *
1997
+ * @example
1998
+ * ```typescript
1999
+ * const result = await agent.searchGmailEmails({
2000
+ * query: ``,
2001
+ * exportType: "json",
2002
+ * limit: ``,
2003
+ * });
2004
+ * ```
2005
+ */
2006
+ searchGmailEmails(step: SearchGmailEmailsStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<SearchGmailEmailsStepOutput>>;
2007
+ /**
2008
+ * Search the web using Google and return structured results.
2009
+ *
2010
+ * @remarks
2011
+ * - Defaults to us/english, but can optionally specify country and/or language.
2012
+ * - Defaults to any time, but can optionally specify last hour, last day, week, month, or year.
2013
+ * - Defaults to top 30 results, but can specify 1 to 100 results to return.
2014
+ * - Set fetchTopN to also read the page content of the first N results in the same step, instead of following up with a separate Scrape URL step per result. Costs meaningfully more (each page is a full scrape), so ask for the fewest you need.
2015
+ * - Also returns Google's "people also ask" and related searches when available, which are useful for choosing a follow-up query.
2016
+ *
2017
+ * @example
2018
+ * ```typescript
2019
+ * const result = await agent.searchGoogle({
2020
+ * query: ``,
2021
+ * exportType: "text",
2022
+ * });
2023
+ * ```
2024
+ */
2025
+ searchGoogle(step: SearchGoogleStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<SearchGoogleStepOutput>>;
2026
+ /**
2027
+ * Search for events in a Google Calendar by keyword, date range, or both.
2028
+ *
2029
+ * @remarks
2030
+ * - Requires a Google OAuth connection with Calendar events scope.
2031
+ * - Supports keyword search via "query" and date filtering via "timeMin"/"timeMax" (ISO 8601 format).
2032
+ * - Unlike "List Events" which only shows future events, this allows searching past events too.
2033
+ *
2034
+ * @example
2035
+ * ```typescript
2036
+ * const result = await agent.searchGoogleCalendarEvents({
2037
+ * exportType: "json",
2038
+ * });
2039
+ * ```
2040
+ */
2041
+ searchGoogleCalendarEvents(step: SearchGoogleCalendarEventsStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<SearchGoogleCalendarEventsStepOutput>>;
2042
+ /**
2043
+ * Search for files in Google Drive by keyword.
2044
+ *
2045
+ * @remarks
2046
+ * - Requires a Google OAuth connection with Drive scope.
2047
+ * - Searches file content and names using Google Drive's fullText search.
2048
+ *
2049
+ * @example
2050
+ * ```typescript
2051
+ * const result = await agent.searchGoogleDrive({
2052
+ * query: ``,
2053
+ * exportType: "json",
2054
+ * });
2055
+ * ```
2056
+ */
2057
+ searchGoogleDrive(step: SearchGoogleDriveStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<SearchGoogleDriveStepOutput>>;
2058
+ /**
2059
+ * Search Google Images and return image results with URLs and metadata.
2060
+ *
2061
+ * @remarks
2062
+ * - Defaults to us/english, but can optionally specify country and/or language.
2063
+ * - Defaults to any time, but can optionally specify last hour, last day, week, month, or year.
2064
+ * - Defaults to top 30 results, but can specify 1 to 100 results to return.
2065
+ *
2066
+ * @example
2067
+ * ```typescript
2068
+ * const result = await agent.searchGoogleImages({
2069
+ * query: ``,
2070
+ * exportType: "text",
2071
+ * });
2072
+ * ```
2073
+ */
2074
+ searchGoogleImages(step: SearchGoogleImagesStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<SearchGoogleImagesStepOutput>>;
2075
+ /**
2076
+ * Search Google News for recent news articles matching a query.
2077
+ *
2078
+ * @remarks
2079
+ * - Defaults to top 30 results, but can specify 1 to 100 results to return.
2080
+ *
2081
+ * @example
2082
+ * ```typescript
2083
+ * const result = await agent.searchGoogleNews({
2084
+ * text: ``,
2085
+ * exportType: "text",
2086
+ * });
2087
+ * ```
2088
+ */
2089
+ searchGoogleNews(step: SearchGoogleNewsStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<SearchGoogleNewsStepOutput>>;
2090
+ /**
2091
+ * Fetch Google Trends data for a search term.
2092
+ *
2093
+ * @remarks
2094
+ * - date accepts shorthand ("now 1-H", "today 1-m", "today 5-y", etc.) or custom "yyyy-mm-dd yyyy-mm-dd" ranges.
2095
+ * - data_type controls the shape of returned data: TIMESERIES, GEO_MAP, GEO_MAP_0, RELATED_TOPICS, or RELATED_QUERIES.
2096
+ *
2097
+ * @example
2098
+ * ```typescript
2099
+ * const result = await agent.searchGoogleTrends({
2100
+ * text: ``,
2101
+ * hl: ``,
2102
+ * geo: ``,
2103
+ * data_type: "TIMESERIES",
2104
+ * cat: ``,
2105
+ * date: ``,
2106
+ * ts: ``,
2107
+ * });
2108
+ * ```
2109
+ */
2110
+ searchGoogleTrends(step: SearchGoogleTrendsStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<SearchGoogleTrendsStepOutput>>;
2111
+ /**
2112
+ * Search the web using the Perplexity API and return structured results.
2113
+ *
2114
+ * @remarks
2115
+ * - Defaults to US results. Use countryCode (ISO code) to filter by country.
2116
+ * - Returns 10 results by default, configurable from 1 to 20.
2117
+ * - The variable receives text or JSON depending on exportType. The direct execution output always returns structured results.
2118
+ *
2119
+ * @example
2120
+ * ```typescript
2121
+ * const result = await agent.searchPerplexity({
2122
+ * query: ``,
2123
+ * exportType: "text",
2124
+ * });
2125
+ * ```
2126
+ */
2127
+ searchPerplexity(step: SearchPerplexityStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<SearchPerplexityStepOutput>>;
2128
+ /**
2129
+ * Search recent X (Twitter) posts matching a query.
2130
+ *
2131
+ * @remarks
2132
+ * - Searches only the past 7 days of posts.
2133
+ * - Query supports X API v2 search operators (up to 512 characters).
2134
+ * Available search operators in query:
2135
+ * | Operator | Description |
2136
+ * | -----------------| -------------------------------------------------|
2137
+ * | from: | Posts from a specific user (e.g., from:elonmusk) |
2138
+ * | to: | Posts sent to a specific user (e.g., to:NASA) |
2139
+ * | @ | Mentions a user (e.g., @openai) |
2140
+ * | # | Hashtag search (e.g., #AI) |
2141
+ * | is:retweet | Filters retweets |
2142
+ * | is:reply | Filters replies |
2143
+ * | has:media | Posts containing media (images, videos, or GIFs) |
2144
+ * | has:links | Posts containing URLs |
2145
+ * | lang: | Filters by language (e.g., lang:en) |
2146
+ * | - | Excludes specific terms (e.g., -spam) |
2147
+ * | () | Groups terms or operators (e.g., (AI OR ML)) |
2148
+ * | AND, OR, NOT | Boolean logic for combining or excluding terms |
2149
+ * Conjunction-Required Operators (must be combined with a standalone operator):
2150
+ * | Operator | Description |
2151
+ * | ------------ | -----------------------------------------------|
2152
+ * | has:media | Posts containing media (images, videos, or GIFs) |
2153
+ * | has:links | Posts containing URLs |
2154
+ * | is:retweet | Filters retweets |
2155
+ * | is:reply | Filters replies |
2156
+ * For example, has:media alone is invalid, but #AI has:media is valid.
2157
+ *
2158
+ * @example
2159
+ * ```typescript
2160
+ * const result = await agent.searchXPosts({
2161
+ * query: ``,
2162
+ * scope: "recent",
2163
+ * options: {},
2164
+ * });
2165
+ * ```
2166
+ */
2167
+ searchXPosts(step: SearchXPostsStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<SearchXPostsStepOutput>>;
2168
+ /**
2169
+ * Search for YouTube videos by keyword.
2170
+ *
2171
+ * @remarks
2172
+ * - Supports pagination (up to 5 pages) and country/language filters.
2173
+ * - Use the filter/filterType fields for YouTube search parameter (sp) filters.
2174
+ *
2175
+ * @example
2176
+ * ```typescript
2177
+ * const result = await agent.searchYoutube({
2178
+ * query: ``,
2179
+ * limitPages: ``,
2180
+ * filter: ``,
2181
+ * filterType: ``,
2182
+ * });
2183
+ * ```
2184
+ */
2185
+ searchYoutube(step: SearchYoutubeStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<SearchYoutubeStepOutput>>;
2186
+ /**
2187
+ * Retrieve trending videos on YouTube by category and region.
2188
+ *
2189
+ * @remarks
2190
+ * - Categories: "now" (trending now), "music", "gaming", "films".
2191
+ * - Supports country and language filtering.
2192
+ *
2193
+ * @example
2194
+ * ```typescript
2195
+ * const result = await agent.searchYoutubeTrends({
2196
+ * bp: "now",
2197
+ * hl: ``,
2198
+ * gl: ``,
2199
+ * });
2200
+ * ```
2201
+ */
2202
+ searchYoutubeTrends(step: SearchYoutubeTrendsStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<SearchYoutubeTrendsStepOutput>>;
2203
+ /**
2204
+ * Send an email to one or more recipient addresses.
2205
+ *
2206
+ * @remarks
2207
+ * - If you are writing a backend method for a v2 app, prefer mindstudio.email.send({...}) — it takes the same fields, returns the batchId you read stats back with, and sits alongside email.messages / email.batch / email.suppress. This action remains fully supported and runs the same code; it is also the only way to use connectionId or generateHtml.
2208
+ * - Use the "to" field to send to one or more specific recipient email addresses directly. Allowed recipients depend on the sender: when the app sends from a domain it owns (a verified custom domain or its <slug>.madewithremy.com subdomain) any recipient is allowed; when it falls back to the shared Remy address, recipients must be verified app users or members of the app's organization. (v1 apps cannot use a direct "to" — they must resolve recipients via a connection.)
2209
+ * - Alternatively, recipient email addresses can be resolved from OAuth connections configured by the app creator via connectionId. The user running the workflow does not specify the recipient directly.
2210
+ * - Use "cc" and "bcc" to add visible / hidden recipients (a string or an array). They are subject to the same recipient rules as "to".
2211
+ * - "to" is optional only in the sense that recipients can come from elsewhere — omit it and supply "cc"/"bcc" for a hidden-list send, or omit all three and recipients are resolved from an OAuth connection. Naming nobody at all is an error.
2212
+ * - Bcc-only sends are supported: with no "to" or "cc", the To: header is addressed to the app's own sender address (the standard "undisclosed recipients" pattern) so recipients can't see each other. The returned "recipients" reflects that auto-filled address.
2213
+ * - Every recipient counts toward the app's daily outbound cap, including cc and bcc.
2214
+ * - The sender defaults automatically: v2 apps send from the app's own identity — its verified custom domain if set, else its platform subdomain (noreply@<slug>.madewithremy.com), else the default Remy address.
2215
+ * - Optionally set "from" to a custom handle, but ONLY if the app has a custom domain or subdomain: a bare handle ("support" → support@<app-domain>), a full "support@your-domain.com", or "Name <support@your-domain.com>". The domain must be one the app owns, or the step fails.
2216
+ * - If the body is a URL to a hosted HTML file on the CDN, the HTML is fetched and used as the email body.
2217
+ * - The body is interpreted automatically: if it already looks like HTML it is sent as HTML, otherwise it is rendered from Markdown. Every email is sent as multipart with a plain-text alternative auto-derived from the body (better deliverability).
2218
+ * - Set bodyType to override interpretation: "html" (send as-is), "markdown" (render to HTML), or "text" (plain text only, no HTML part). Default is "auto".
2219
+ * - Optionally set "text" to supply your own plain-text alternative instead of the auto-derived one.
2220
+ * - Use "attachments" to attach files by URL. Each entry is a URL string, or an object { url, filename?, contentType? } to control the attachment's displayed filename and MIME type.
2221
+ * - When generateHtml is enabled, the body text is converted to a styled HTML email using an AI model (implies an HTML body).
2222
+ * - Set replyTo to control the Reply-To address for replies.
2223
+ * - For threaded replies in a shared inbox, set inReplyTo (the Message-ID being replied to) and references (prior Message-IDs in the thread).
2224
+ * - connectionId can be a comma-separated list to send to multiple recipients.
2225
+ * - The special connectionId "trigger_email" uses the email address that triggered the workflow.
2226
+ * - Sends default to category "marketing": every message carries a one-click unsubscribe header pointing at the app's own domain, and recipients who previously unsubscribed from this app are skipped and returned in "suppressed". Because the unsubscribe link is per-recipient, a marketing send delivers one separate message per recipient and cc/bcc are folded into that list.
2227
+ * - Set category to "transactional" for receipts, alerts, password resets and anything a recipient must not be able to opt out of. Transactional sends carry no unsubscribe header, ignore the unsubscribe list, and keep cc/bcc on a single message — use it whenever cc/bcc semantics matter.
2228
+ * - The subject is stored verbatim in the app's delivery log, which every workspace member can read for 90 days. Never put a secret in the subject — no one-time codes, no magic-link tokens, no password-reset tokens. Put those in the body of a "transactional" send: a small transactional send is delivered immediately and its body is never stored. A "marketing" send, or any large send, is queued for delivery, which means its body is held in internal storage until the send finishes — so do not put a secret in the body of one of those either.
2229
+ *
2230
+ * @example
2231
+ * ```typescript
2232
+ * const result = await agent.sendEmail({
2233
+ * subject: ``,
2234
+ * body: ``,
2235
+ * });
2236
+ * ```
2237
+ */
2238
+ sendEmail(step: SendEmailStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<SendEmailStepOutput>>;
2239
+ /**
2240
+ * Send an existing draft from the connected Gmail account.
2241
+ *
2242
+ * @remarks
2243
+ * - Requires a Google OAuth connection with Gmail compose scope.
2244
+ * - The draft is sent and removed from the Drafts folder.
2245
+ * - Use the draft ID returned by the Create Gmail Draft or List Gmail Drafts steps.
2246
+ *
2247
+ * @example
2248
+ * ```typescript
2249
+ * const result = await agent.sendGmailDraft({
2250
+ * draftId: ``,
2251
+ * });
2252
+ * ```
2253
+ */
2254
+ sendGmailDraft(step: SendGmailDraftStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<SendGmailDraftStepOutput>>;
2255
+ /**
2256
+ * Send an email from the connected Gmail account.
2257
+ *
2258
+ * @remarks
2259
+ * - Requires a Google OAuth connection with Gmail compose scope.
2260
+ * - messageType controls the body format: "plain" for plain text, "html" for raw HTML, "markdown" for auto-converted markdown.
2261
+ *
2262
+ * @example
2263
+ * ```typescript
2264
+ * const result = await agent.sendGmailMessage({
2265
+ * to: ``,
2266
+ * subject: ``,
2267
+ * message: ``,
2268
+ * messageType: "plain",
2269
+ * });
2270
+ * ```
2271
+ */
2272
+ sendGmailMessage(step: SendGmailMessageStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<SendGmailMessageStepOutput>>;
2273
+ /**
2274
+ * Send a direct message to a Slack user via a connected bot.
2275
+ *
2276
+ * @remarks
2277
+ * - The user is responsible for connecting their Slack workspace
2278
+ * - The recipient is identified by their Slack user ID
2279
+ * - Supports both simple text messages and Slack blocks messages
2280
+ * - Text messages can use limited markdown (slack-only formatting—e.g., headers are just rendered as bold)
2281
+ *
2282
+ * @example
2283
+ * ```typescript
2284
+ * const result = await agent.sendSlackDirectMessage({
2285
+ * slackUserId: ``,
2286
+ * messageType: "string",
2287
+ * message: ``,
2288
+ * });
2289
+ * ```
2290
+ */
2291
+ sendSlackDirectMessage(step: SendSlackDirectMessageStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<SendSlackDirectMessageStepOutput>>;
2292
+ /**
2293
+ * Send an SMS or MMS message to a phone number configured via OAuth connection.
2294
+ *
2295
+ * @remarks
2296
+ * - User is responsible for configuring the connection to the number (MindStudio requires double opt-in to prevent spam)
2297
+ * - If mediaUrls are provided, the message is sent as MMS instead of SMS
2298
+ * - MMS supports up to 10 media URLs (images, video, audio, PDF) with a 5MB limit per file
2299
+ * - MMS is only supported on US and Canadian carriers; international numbers will receive SMS only (media silently dropped)
2300
+ *
2301
+ * @example
2302
+ * ```typescript
2303
+ * const result = await agent.sendSMS({
2304
+ * body: ``,
2305
+ * });
2306
+ * ```
2307
+ */
2308
+ sendSMS(step: SendSMSStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<SendSMSStepOutput>>;
2309
+ /**
2310
+ * Mark one or more Gmail emails as read or unread.
2311
+ *
2312
+ * @remarks
2313
+ * - Requires a Google OAuth connection with Gmail modify scope.
2314
+ * - Accepts one or more message IDs as a comma-separated string or array.
2315
+ * - Set markAsRead to true to mark as read, false to mark as unread.
2316
+ *
2317
+ * @example
2318
+ * ```typescript
2319
+ * const result = await agent.setGmailReadStatus({
2320
+ * messageIds: ``,
2321
+ * markAsRead: false,
2322
+ * });
2323
+ * ```
2324
+ */
2325
+ setGmailReadStatus(step: SetGmailReadStatusStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<SetGmailReadStatusStepOutput>>;
2326
+ /**
2327
+ * Set the title of the agent run for the user's history
2328
+ *
2329
+ * @example
2330
+ * ```typescript
2331
+ * const result = await agent.setRunTitle({
2332
+ * title: ``,
2333
+ * });
2334
+ * ```
2335
+ */
2336
+ setRunTitle(step: SetRunTitleStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<SetRunTitleStepOutput>>;
2337
+ /**
2338
+ * Explicitly set a variable to a given value.
2339
+ *
2340
+ * @remarks
2341
+ * - Useful for bootstrapping global variables or setting constants.
2342
+ * - The variable name and value both support variable interpolation.
2343
+ * - The type field is a UI hint only (controls input widget in the editor).
2344
+ *
2345
+ * @example
2346
+ * ```typescript
2347
+ * const result = await agent.setVariable({
2348
+ * value: ``,
2349
+ * });
2350
+ * ```
2351
+ */
2352
+ setVariable(step: SetVariableStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<SetVariableStepOutput>>;
2353
+ /**
2354
+ * Generate an audio file from provided text using a speech model.
2355
+ *
2356
+ * @remarks
2357
+ * - The text field contains the exact words to be spoken (not instructions).
2358
+ * - Voice, delivery and format are set through `speechModelOverride.config`, whose keys are the model's own (look a model up with its id). Delivery direction, where a model takes one, is never spoken: `styleInstruction` on gemini-3.8-flash-tts and gemini-3.8-flash-lite-tts, `instructions` on gpt-realtime-2.1-mini-tts, `voice_instruction` on seed-speech-tts-2.0, `emotion` on cartesia-sonic-3.6 and the MiniMax models.
2359
+ * - Tags in the text act at that point, in each vendor's own syntax: `[laughs]` or `[whispers]` on elevenlabs-tts with Eleven v4 or v3; `<laugh>`, `<sigh>` or `<whispers>` on the Gemini 3.8 models; `[laugh]`, `[pause]` or `<whisper>…</whisper>` on grok-voice-tts; `[laughter]` or `<emotion value="excited"/>` on cartesia-sonic-3.6; `[be happy and upbeat]` on inworld-tts-2; `[emotion=happy]` or `[pace=slow]` on voxtral-tts-3, until the next tag.
2360
+ * - A dialogue between voices: set `$mode: 'dialogue'` and name each speaker (`speaker1_name`, `speaker1_voice`, `speaker2_name`, …), then write the text as a script, one `Name: line` per turn. Supported by elevenlabs-tts (Eleven v4 or v3, up to 4 speakers) and the Gemini 3.8 models (exactly 2).
2361
+ * - A text longer than a model takes in one request is spoken in pieces and joined, and then comes back as MP3 whatever format was asked for.
2362
+ * - In foreground mode, the audio is displayed to the user. In background mode, the URL is saved to a variable.
2363
+ *
2364
+ * @example
2365
+ * ```typescript
2366
+ * const result = await agent.textToSpeech({
2367
+ * text: ``,
2368
+ * });
2369
+ * ```
2370
+ */
2371
+ textToSpeech(step: TextToSpeechStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<TextToSpeechStepOutput>>;
2372
+ /**
2373
+ * Convert an audio file to text using a transcription model.
2374
+ *
2375
+ * @remarks
2376
+ * - The default model is elevenlabs-scribe-v2: speakers, word timings, key terms and redaction, at any length.
2377
+ * - The prompt field gives context (speaker names, domain) to OpenAI's and DeepInfra's models. Other models ignore it; give them `keyterms` instead.
2378
+ * - Options go in `transcriptionModelOverride.config`, and support varies by model:
2379
+ * - `language` — the spoken language as a code such as `en` or `es`; left out, the model detects it. Every model takes it. deepgram-nova-3 assumes `en` unless told, and also takes `multi` for speech that switches language (billed at its multilingual rate).
2380
+ * - `detectLanguage: 'yes'` — detect the language instead of assuming English (deepgram-nova-3 only).
2381
+ * - `includeSpeakers: 'yes'` — label each passage with a speaker. Supported by elevenlabs-scribe-v2, elevenlabs-scribe-v2-medical, deepgram-nova-3, grok-stt, voxtral-mini-transcribe-2, voxtral-mini-transcribe-3, voxtral-small-transcribe-3 and gemini-3.5-transcribe; gpt-4o-transcribe-diarize always does. Scribe and Voxtral also switch `text` to a timestamped, speaker-labelled block format; Deepgram, Gemini and gpt-4o-transcribe-diarize to `Speaker N:` lines.
2382
+ * - `numSpeakers` — the most people talking, to help tell them apart (Scribe).
2383
+ * - `keyterms` — a list of names, products and terms the audio contains, so they're spelled right. Supported by gpt-transcribe, Scribe, deepgram-nova-3, grok-stt, voxtral-mini-transcribe-2, voxtral-mini-transcribe-3, voxtral-small-transcribe-3 and gemini-3.5-transcribe. Billed as an add-on on Scribe and Deepgram.
2384
+ * - `redactPii: 'yes'` — replace names, phone numbers, addresses and other personal information with a label of what was there (Scribe, deepgram-nova-3). Billed as an add-on.
2385
+ * - `includeWordTimings: 'yes'` — add per-word timings and confidence inside each segment. Supported by Scribe, deepgram-nova-3, whisper-1, grok-stt, voxtral-mini-transcribe-2 and gemini-3.5-transcribe. Off by default because an hour of speech is roughly ten thousand words.
2386
+ * - `subtitles: 'srt' | 'vtt'` — also return the transcript as a subtitle file, in the `subtitles` output, timed by the segments. Any model that returns segments.
2387
+ * - gemini-3.5-transcribe can't take `keyterms` together with speakers, word timings or subtitles; asked for both, it's refused.
2388
+ * - The `segments` output carries timings, confidence and speakers as structured data, so there is no need to slice the audio up to recover them. It is populated by Scribe, deepgram-nova-3, grok-stt, whisper-1, gpt-4o-transcribe-diarize, voxtral-mini-transcribe-2, voxtral-mini-transcribe-3, voxtral-small-transcribe-3, gemini-3.5-transcribe (with word timings or subtitles) and the DeepInfra-served whisper and qwen models, and absent for models that return nothing but text (gpt-transcribe, gpt-4o-transcribe, gpt-4o-mini-transcribe, the DeepInfra-served voxtral models).
2389
+ * - In a workflow, `destinationVar` receives the transcript text. Name `segmentsVar` to also keep the `segments` array. A model that returns no segments leaves that variable unset.
2390
+ * - A recording of any length can be transcribed. One longer than a model takes at once (OpenAI's and DeepInfra's models, Gemini, Voxtral 3) is transcribed in pieces and joined, its timings running from the start of the recording. Speakers can't be followed from one piece to the next, so with speakers on, such a recording is refused; Scribe and Deepgram label speakers at any length.
2391
+ * - `confidence` is always 0..1 with higher meaning more confident, whichever model produced it.
2392
+ *
2393
+ * @example
2394
+ * ```typescript
2395
+ * const result = await agent.transcribeAudio({
2396
+ * audioUrl: ``,
2397
+ * prompt: ``,
2398
+ * });
2399
+ * ```
2400
+ */
2401
+ transcribeAudio(step: TranscribeAudioStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<TranscribeAudioStepOutput>>;
2402
+ /**
2403
+ * Trim an audio or video clip
2404
+ *
2405
+ * @example
2406
+ * ```typescript
2407
+ * const result = await agent.trimMedia({
2408
+ * inputUrl: ``,
2409
+ * });
2410
+ * ```
2411
+ */
2412
+ trimMedia(step: TrimMediaStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<TrimMediaStepOutput>>;
2413
+ /**
2414
+ * @deprecated Use evaluateDecision: the same questions, answers and models, with decisionModelOverride in place of model. evaluateDecision's earlier name, which still runs: ask structured questions about text, JSON, or images and get calibrated answers from a decision model.
2415
+ *
2416
+ * @remarks
2417
+ * - Runs exactly as evaluateDecision does, with the same questions, answers, models and limits (see its notes), and model in place of decisionModelOverride.model.
2418
+ *
2419
+ * @example
2420
+ * ```typescript
2421
+ * const result = await agent.typesafeEvaluate({
2422
+ * state: ``,
2423
+ * questions: {},
2424
+ * });
2425
+ * ```
2426
+ */
2427
+ typesafeEvaluate(step: TypesafeEvaluateStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<TypesafeEvaluateStepOutput>>;
2428
+ /**
2429
+ * Add or remove labels on Gmail messages, identified by message IDs or a search query.
2430
+ *
2431
+ * @remarks
2432
+ * - Requires a Google OAuth connection with Gmail modify scope.
2433
+ * - Provide either a query (Gmail search syntax) or explicit messageIds to target messages.
2434
+ * - Label IDs can be label names or Gmail label IDs — names are resolved automatically.
2435
+ *
2436
+ * @example
2437
+ * ```typescript
2438
+ * const result = await agent.updateGmailLabels({
2439
+ * query: ``,
2440
+ * messageIds: ``,
2441
+ * addLabelIds: ``,
2442
+ * removeLabelIds: ``,
2443
+ * });
2444
+ * ```
2445
+ */
2446
+ updateGmailLabels(step: UpdateGmailLabelsStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<UpdateGmailLabelsStepOutput>>;
2447
+ /**
2448
+ * Update an existing event on a Google Calendar. Only specified fields are changed.
2449
+ *
2450
+ * @remarks
2451
+ * - Requires a Google OAuth connection with Calendar events scope.
2452
+ * - Fetches the existing event first, then applies only the provided updates. Omitted fields are left unchanged.
2453
+ * - Attendees are specified as one email address per line, and replace the entire attendee list.
2454
+ *
2455
+ * @example
2456
+ * ```typescript
2457
+ * const result = await agent.updateGoogleCalendarEvent({
2458
+ * eventId: ``,
2459
+ * });
2460
+ * ```
2461
+ */
2462
+ updateGoogleCalendarEvent(step: UpdateGoogleCalendarEventStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<UpdateGoogleCalendarEventStepOutput>>;
2463
+ /**
2464
+ * Update the contents of an existing Google Document.
2465
+ *
2466
+ * @remarks
2467
+ * - operationType controls how content is applied: "addToTop" prepends, "addToBottom" appends, "overwrite" replaces all content.
2468
+ * - textType determines how the text field is interpreted: "plain" for plain text, "html" for HTML markup, "markdown" for Markdown.
2469
+ *
2470
+ * @example
2471
+ * ```typescript
2472
+ * const result = await agent.updateGoogleDoc({
2473
+ * documentId: ``,
2474
+ * text: ``,
2475
+ * textType: "plain",
2476
+ * operationType: "addToTop",
2477
+ * });
2478
+ * ```
2479
+ */
2480
+ updateGoogleDoc(step: UpdateGoogleDocStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<UpdateGoogleDocStepOutput>>;
2481
+ /**
2482
+ * Update a Google Spreadsheet with new data.
2483
+ *
2484
+ * @remarks
2485
+ * - operationType controls how data is written: "addToBottom" appends rows, "overwrite" replaces all data, "range" writes to a specific cell range.
2486
+ * - Data should be provided as CSV in the text field.
2487
+ *
2488
+ * @example
2489
+ * ```typescript
2490
+ * const result = await agent.updateGoogleSheet({
2491
+ * text: ``,
2492
+ * spreadsheetId: ``,
2493
+ * range: ``,
2494
+ * operationType: "addToBottom",
2495
+ * });
2496
+ * ```
2497
+ */
2498
+ updateGoogleSheet(step: UpdateGoogleSheetStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<UpdateGoogleSheetStepOutput>>;
2499
+ /**
2500
+ * @deprecated Legacy v1 data sources. v2 apps should use `dataSources.defineDataSource()` from @mindstudio-ai/agent instead, which owns parsing, chunking, embedding and citations. Upload a file into an existing data source from a URL or raw text content.
2501
+ *
2502
+ * @remarks
2503
+ * - If "file" is a single URL, the file is downloaded from that URL and uploaded.
2504
+ * - If "file" is any other string, a .txt document is created from that content and uploaded.
2505
+ * - The block waits (polls) for processing to complete before transitioning, up to 5 minutes.
2506
+ * - Once processing finishes, vectors are loaded into Milvus so the data source is immediately queryable.
2507
+ * - Supported file types (when using a URL) are the same as the data source upload UI (PDF, DOCX, TXT, etc.).
2508
+ *
2509
+ * @example
2510
+ * ```typescript
2511
+ * const result = await agent.uploadDataSourceDocument({
2512
+ * dataSourceId: ``,
2513
+ * file: ``,
2514
+ * fileName: ``,
2515
+ * });
2516
+ * ```
2517
+ */
2518
+ uploadDataSourceDocument(step: UploadDataSourceDocumentStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<UploadDataSourceDocumentStepOutput>>;
2519
+ /**
2520
+ * Increase the resolution of an image using AI upscaling.
2521
+ *
2522
+ * @remarks
2523
+ * - Output is a PNG on the public CDN, or in one of the app's own file stores when the call passes `store` — a private store keeps it private.
2524
+ *
2525
+ * @example
2526
+ * ```typescript
2527
+ * const result = await agent.upscaleImage({
2528
+ * imageUrl: ``,
2529
+ * targetResolution: "2k",
2530
+ * engine: "standard",
2531
+ * });
2532
+ * ```
2533
+ */
2534
+ upscaleImage(step: UpscaleImageStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<UpscaleImageStepOutput>>;
2535
+ /**
2536
+ * Upscale a video file
2537
+ *
2538
+ * @example
2539
+ * ```typescript
2540
+ * const result = await agent.upscaleVideo({
2541
+ * videoUrl: ``,
2542
+ * targetResolution: "720p",
2543
+ * engine: "standard",
2544
+ * });
2545
+ * ```
2546
+ */
2547
+ upscaleVideo(step: UpscaleVideoStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<UpscaleVideoStepOutput>>;
2548
+ /**
2549
+ * Send a message to an AI model and return the response, or echo a system message.
2550
+ *
2551
+ * @remarks
2552
+ * - Source "user" sends the message to an LLM and returns the model's response.
2553
+ * - Source "system" echoes the message content directly (no AI call).
2554
+ * - Mode "background" saves the result to a variable. Mode "foreground" streams it to the user (not available in direct execution).
2555
+ * - Structured output (JSON/CSV) can be enforced via structuredOutputType and structuredOutputExample.
2556
+ * - When executed inside a v2 app method (managed sandbox or local dev tunnel),
2557
+ * LLM token output can be streamed to the frontend in real time via an SSE
2558
+ * side-channel. The frontend opts in by passing { stream: true } to the method
2559
+ * invocation via @mindstudio-ai/interface. Tokens are published to Redis
2560
+ * pub/sub as they arrive and forwarded as SSE events on the invoke response.
2561
+ * The method code itself is unchanged — streaming is transparent to the
2562
+ * developer. See Sandboxes/execute.ts and the invoke handler in V2Apps for
2563
+ * the server-side plumbing.
2564
+ *
2565
+ * @example
2566
+ * ```typescript
2567
+ * const result = await agent.generateText({
2568
+ * message: ``,
2569
+ * });
2570
+ * ```
2571
+ */
2572
+ generateText(step: UserMessageStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<UserMessageStepOutput>>;
2573
+ /**
2574
+ * Swap faces in a video file
2575
+ *
2576
+ * @example
2577
+ * ```typescript
2578
+ * const result = await agent.videoFaceSwap({
2579
+ * videoUrl: ``,
2580
+ * faceImageUrl: ``,
2581
+ * targetIndex: 0,
2582
+ * engine: ``,
2583
+ * });
2584
+ * ```
2585
+ */
2586
+ videoFaceSwap(step: VideoFaceSwapStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<VideoFaceSwapStepOutput>>;
2587
+ /**
2588
+ * Remove or replace background from a video
2589
+ *
2590
+ * @example
2591
+ * ```typescript
2592
+ * const result = await agent.videoRemoveBackground({
2593
+ * videoUrl: ``,
2594
+ * newBackground: "transparent",
2595
+ * engine: ``,
2596
+ * });
2597
+ * ```
2598
+ */
2599
+ videoRemoveBackground(step: VideoRemoveBackgroundStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<VideoRemoveBackgroundStepOutput>>;
2600
+ /**
2601
+ * Remove a watermark from a video
2602
+ *
2603
+ * @example
2604
+ * ```typescript
2605
+ * const result = await agent.videoRemoveWatermark({
2606
+ * videoUrl: ``,
2607
+ * engine: ``,
2608
+ * });
2609
+ * ```
2610
+ */
2611
+ videoRemoveWatermark(step: VideoRemoveWatermarkStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<VideoRemoveWatermarkStepOutput>>;
2612
+ /**
2613
+ * Overlay a watermark image onto another image.
2614
+ *
2615
+ * @remarks
2616
+ * - The watermark is placed at the specified corner with configurable padding and width.
2617
+ *
2618
+ * @example
2619
+ * ```typescript
2620
+ * const result = await agent.watermarkImage({
2621
+ * imageUrl: ``,
2622
+ * watermarkImageUrl: ``,
2623
+ * corner: "top-left",
2624
+ * paddingPx: 0,
2625
+ * widthPx: 0,
2626
+ * });
2627
+ * ```
2628
+ */
2629
+ watermarkImage(step: WatermarkImageStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<WatermarkImageStepOutput>>;
2630
+ /**
2631
+ * Add an image watermark to a video
2632
+ *
2633
+ * @example
2634
+ * ```typescript
2635
+ * const result = await agent.watermarkVideo({
2636
+ * videoUrl: ``,
2637
+ * imageUrl: ``,
2638
+ * corner: "top-left",
2639
+ * paddingPx: 0,
2640
+ * widthPx: 0,
2641
+ * });
2642
+ * ```
2643
+ */
2644
+ watermarkVideo(step: WatermarkVideoStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<WatermarkVideoStepOutput>>;
2645
+ /**
2646
+ * Ask a financial research question using You.com Finance Research and return the sourced response.
2647
+ *
2648
+ * @remarks
2649
+ * - Use this for financial questions such as company analysis, earnings, market research, filings, macroeconomics, and due diligence.
2650
+ * - researchEffort supports deep (default) or exhaustive.
2651
+ * - Finance Research returns the same response shape as Web Research, but searches a finance-optimized index.
2652
+ * - Use it for cited synthesis, not raw price feeds or structured time-series exports.
2653
+ *
2654
+ * @example
2655
+ * ```typescript
2656
+ * const result = await agent.youDotComFinanceResearch({
2657
+ * input: ``,
2658
+ * });
2659
+ * ```
2660
+ */
2661
+ youDotComFinanceResearch(step: YouDotComFinanceResearchStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<YouDotComFinanceResearchStepOutput>>;
2662
+ /**
2663
+ * Fetch clean Markdown, HTML, or metadata for known URLs using the You.com Contents API.
2664
+ *
2665
+ * @remarks
2666
+ * - Use this step when you already know the URLs. Use Web Search with livecrawl when You.com should discover pages from a query.
2667
+ * - A single request supports up to 10 URLs.
2668
+ * - Request only the formats you need. Markdown is recommended for LLM consumption.
2669
+ * - Increase crawlTimeout for JavaScript-heavy pages, up to 60 seconds.
2670
+ * - Individual pages can partially fail; check each returned item before processing.
2671
+ *
2672
+ * @example
2673
+ * ```typescript
2674
+ * const result = await agent.youDotComGetPageContent({
2675
+ * urls: [],
2676
+ * });
2677
+ * ```
2678
+ */
2679
+ youDotComGetPageContent(step: YouDotComGetPageContentStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<YouDotComGetPageContentStepOutput>>;
2680
+ /**
2681
+ * Fetch live news articles through the You.com Search API and return the full structured response.
2682
+ *
2683
+ * @remarks
2684
+ * - Defaults freshness to day for breaking or recent news.
2685
+ * - Use country and language together to monitor regional or non-English news.
2686
+ * - Use livecrawl: 'news' with livecrawlFormats: ['markdown'] when you need full article text.
2687
+ * - Use a custom freshness range like YYYY-MM-DDtoYYYY-MM-DD for historical news windows.
2688
+ *
2689
+ * @example
2690
+ * ```typescript
2691
+ * const result = await agent.youDotComLiveNews({
2692
+ * query: ``,
2693
+ * });
2694
+ * ```
2695
+ */
2696
+ youDotComLiveNews(step: YouDotComLiveNewsStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<YouDotComLiveNewsStepOutput>>;
2697
+ /**
2698
+ * Ask a research question and return a grounded You.com Research API answer with sources.
2699
+ *
2700
+ * @remarks
2701
+ * - Use Web Search when you need raw URLs and snippets. Use Web Research when you want a synthesized answer with citations.
2702
+ * - researchEffort controls depth and latency: lite, standard, deep, or exhaustive. standard is a good default.
2703
+ * - sourceControl can restrict, exclude, or boost domains, and can apply freshness or country filters.
2704
+ * - includeDomains cannot be combined with excludeDomains or boostDomains.
2705
+ * - outputSchema returns structured output.content and is supported by standard, deep, and exhaustive, not lite.
2706
+ *
2707
+ * @example
2708
+ * ```typescript
2709
+ * const result = await agent.youDotComWebResearch({
2710
+ * input: ``,
2711
+ * });
2712
+ * ```
2713
+ */
2714
+ youDotComWebResearch(step: YouDotComWebResearchStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<YouDotComWebResearchStepOutput>>;
2715
+ /**
2716
+ * Search the web and news using the You.com Search API and return the full structured response.
2717
+ *
2718
+ * @remarks
2719
+ * - Query supports You.com search operators:
2720
+ * | Operator | Description | Example |
2721
+ * | -------- | ----------- | ------- |
2722
+ * | site: | Search within a domain and its subdomains | site:uscourts.gov |
2723
+ * | filetype: | Search for a specific file type | filetype:pdf |
2724
+ * | + | Require the exact term after the operator | +GAAP |
2725
+ * | - | Exclude the exact term after the operator | -prs |
2726
+ * | AND | Require both expressions | guitar AND Fender |
2727
+ * | OR | Match either expression | guitar OR drum |
2728
+ * | NOT | Negate an expression | NOT site:uscourts.gov |
2729
+ * - Use livecrawl with livecrawlFormats: ['markdown'] when you need full page content instead of snippets.
2730
+ * - Use the Get Page Content step when you already know the URLs to fetch.
2731
+ * - Use freshness for recency: day, week, month, year, or YYYY-MM-DDtoYYYY-MM-DD.
2732
+ * - Use country (ISO 3166-1 alpha-2) and language (BCP 47) to focus results geographically or linguistically.
2733
+ * - includeDomains cannot be combined with excludeDomains or boostDomains.
2734
+ *
2735
+ * @example
2736
+ * ```typescript
2737
+ * const result = await agent.youDotComWebSearch({
2738
+ * query: ``,
2739
+ * });
2740
+ * ```
2741
+ */
2742
+ youDotComWebSearch(step: YouDotComWebSearchStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<YouDotComWebSearchStepOutput>>;
2743
+ }
2744
+ /** @internal Attaches typed step methods to the MindStudioAgent prototype. */
2745
+ export declare function applyStepMethods(AgentClass: new (...args: any[]) => any): void;