@mindstudio-ai/agent 0.0.10 → 0.0.11
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.d.ts +1198 -393
- package/dist/index.js.map +1 -1
- package/llms.txt +508 -152
- package/package.json +4 -3
package/dist/index.d.ts
CHANGED
|
@@ -3235,1016 +3235,1647 @@ interface StepOutputMap {
|
|
|
3235
3235
|
|
|
3236
3236
|
interface StepMethods {
|
|
3237
3237
|
/**
|
|
3238
|
-
* [ActiveCampaign] Add Note
|
|
3239
|
-
*
|
|
3240
3238
|
* Add a note to an existing contact in ActiveCampaign.
|
|
3241
3239
|
*
|
|
3242
|
-
*
|
|
3240
|
+
* @remarks
|
|
3243
3241
|
* - Requires an ActiveCampaign OAuth connection (connectionId).
|
|
3244
3242
|
* - The contact must already exist — use the contact ID from a previous create or search step.
|
|
3243
|
+
*
|
|
3244
|
+
* @example
|
|
3245
|
+
* ```typescript
|
|
3246
|
+
* const result = await agent.activeCampaignAddNote({
|
|
3247
|
+
* contactId: ``,
|
|
3248
|
+
* note: ``,
|
|
3249
|
+
* connectionId: ``,
|
|
3250
|
+
* });
|
|
3251
|
+
* ```
|
|
3245
3252
|
*/
|
|
3246
3253
|
activeCampaignAddNote(step: ActiveCampaignAddNoteStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<ActiveCampaignAddNoteStepOutput>>;
|
|
3247
3254
|
/**
|
|
3248
|
-
* [ActiveCampaign] Create Contact
|
|
3249
|
-
*
|
|
3250
3255
|
* Create or sync a contact in ActiveCampaign.
|
|
3251
3256
|
*
|
|
3252
|
-
*
|
|
3257
|
+
* @remarks
|
|
3253
3258
|
* - Requires an ActiveCampaign OAuth connection (connectionId).
|
|
3254
3259
|
* - If a contact with the email already exists, it may be updated depending on ActiveCampaign settings.
|
|
3255
3260
|
* - Custom fields are passed as a key-value map where keys are field IDs.
|
|
3261
|
+
*
|
|
3262
|
+
* @example
|
|
3263
|
+
* ```typescript
|
|
3264
|
+
* const result = await agent.activeCampaignCreateContact({
|
|
3265
|
+
* email: ``,
|
|
3266
|
+
* firstName: ``,
|
|
3267
|
+
* lastName: ``,
|
|
3268
|
+
* phone: ``,
|
|
3269
|
+
* accountId: ``,
|
|
3270
|
+
* customFields: {},
|
|
3271
|
+
* connectionId: ``,
|
|
3272
|
+
* });
|
|
3273
|
+
* ```
|
|
3256
3274
|
*/
|
|
3257
3275
|
activeCampaignCreateContact(step: ActiveCampaignCreateContactStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<ActiveCampaignCreateContactStepOutput>>;
|
|
3258
3276
|
/**
|
|
3259
|
-
* Add Subtitles To Video
|
|
3260
|
-
*
|
|
3261
3277
|
* Automatically add subtitles to a video
|
|
3262
3278
|
*
|
|
3263
|
-
*
|
|
3279
|
+
* @remarks
|
|
3264
3280
|
* - Can control style of text and animation
|
|
3281
|
+
*
|
|
3282
|
+
* @example
|
|
3283
|
+
* ```typescript
|
|
3284
|
+
* const result = await agent.addSubtitlesToVideo({
|
|
3285
|
+
* videoUrl: ``,
|
|
3286
|
+
* language: ``,
|
|
3287
|
+
* fontName: ``,
|
|
3288
|
+
* fontSize: 0,
|
|
3289
|
+
* fontWeight: "normal",
|
|
3290
|
+
* fontColor: "white",
|
|
3291
|
+
* highlightColor: "white",
|
|
3292
|
+
* strokeWidth: 0,
|
|
3293
|
+
* strokeColor: "black",
|
|
3294
|
+
* backgroundColor: "black",
|
|
3295
|
+
* backgroundOpacity: 0,
|
|
3296
|
+
* position: "top",
|
|
3297
|
+
* yOffset: 0,
|
|
3298
|
+
* wordsPerSubtitle: 0,
|
|
3299
|
+
* enableAnimation: false,
|
|
3300
|
+
* });
|
|
3301
|
+
* ```
|
|
3265
3302
|
*/
|
|
3266
3303
|
addSubtitlesToVideo(step: AddSubtitlesToVideoStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<AddSubtitlesToVideoStepOutput>>;
|
|
3267
3304
|
/**
|
|
3268
|
-
* [Airtable] Create/Update record
|
|
3269
|
-
*
|
|
3270
3305
|
* Create a new record or update an existing record in an Airtable table.
|
|
3271
3306
|
*
|
|
3272
|
-
*
|
|
3307
|
+
* @remarks
|
|
3273
3308
|
* - If recordId is provided, updates that record. Otherwise, creates a new one.
|
|
3274
3309
|
* - When updating with updateMode "onlySpecified", unspecified fields are left as-is. With "all", unspecified fields are cleared.
|
|
3275
3310
|
* - Array fields (e.g. multipleAttachments) accept arrays of values.
|
|
3311
|
+
*
|
|
3312
|
+
* @example
|
|
3313
|
+
* ```typescript
|
|
3314
|
+
* const result = await agent.airtableCreateUpdateRecord({
|
|
3315
|
+
* connectionId: ``,
|
|
3316
|
+
* baseId: ``,
|
|
3317
|
+
* tableId: ``,
|
|
3318
|
+
* fields: ``,
|
|
3319
|
+
* recordData: {},
|
|
3320
|
+
* });
|
|
3321
|
+
* ```
|
|
3276
3322
|
*/
|
|
3277
3323
|
airtableCreateUpdateRecord(step: AirtableCreateUpdateRecordStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<AirtableCreateUpdateRecordStepOutput>>;
|
|
3278
3324
|
/**
|
|
3279
|
-
* [Airtable] Delete record
|
|
3280
|
-
*
|
|
3281
3325
|
* Delete a record from an Airtable table by its record ID.
|
|
3282
3326
|
*
|
|
3283
|
-
*
|
|
3327
|
+
* @remarks
|
|
3284
3328
|
* - Requires an active Airtable OAuth connection (connectionId).
|
|
3285
3329
|
* - Silently succeeds if the record does not exist.
|
|
3330
|
+
*
|
|
3331
|
+
* @example
|
|
3332
|
+
* ```typescript
|
|
3333
|
+
* const result = await agent.airtableDeleteRecord({
|
|
3334
|
+
* connectionId: ``,
|
|
3335
|
+
* baseId: ``,
|
|
3336
|
+
* tableId: ``,
|
|
3337
|
+
* recordId: ``,
|
|
3338
|
+
* });
|
|
3339
|
+
* ```
|
|
3286
3340
|
*/
|
|
3287
3341
|
airtableDeleteRecord(step: AirtableDeleteRecordStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<AirtableDeleteRecordStepOutput>>;
|
|
3288
3342
|
/**
|
|
3289
|
-
* [Airtable] Get record
|
|
3290
|
-
*
|
|
3291
3343
|
* Fetch a single record from an Airtable table by its record ID.
|
|
3292
3344
|
*
|
|
3293
|
-
*
|
|
3345
|
+
* @remarks
|
|
3294
3346
|
* - Requires an active Airtable OAuth connection (connectionId).
|
|
3295
3347
|
* - If the record is not found, returns a string message instead of a record object.
|
|
3348
|
+
*
|
|
3349
|
+
* @example
|
|
3350
|
+
* ```typescript
|
|
3351
|
+
* const result = await agent.airtableGetRecord({
|
|
3352
|
+
* connectionId: ``,
|
|
3353
|
+
* baseId: ``,
|
|
3354
|
+
* tableId: ``,
|
|
3355
|
+
* recordId: ``,
|
|
3356
|
+
* });
|
|
3357
|
+
* ```
|
|
3296
3358
|
*/
|
|
3297
3359
|
airtableGetRecord(step: AirtableGetRecordStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<AirtableGetRecordStepOutput>>;
|
|
3298
3360
|
/**
|
|
3299
|
-
* [Airtable] Get table records
|
|
3300
|
-
*
|
|
3301
3361
|
* Fetch multiple records from an Airtable table with optional pagination.
|
|
3302
3362
|
*
|
|
3303
|
-
*
|
|
3363
|
+
* @remarks
|
|
3304
3364
|
* - Requires an active Airtable OAuth connection (connectionId).
|
|
3305
3365
|
* - Default limit is 100 records. Maximum is 1000.
|
|
3306
3366
|
* - When outputFormat is 'csv', the variable receives CSV text. The direct execution output always returns parsed records.
|
|
3367
|
+
*
|
|
3368
|
+
* @example
|
|
3369
|
+
* ```typescript
|
|
3370
|
+
* const result = await agent.airtableGetTableRecords({
|
|
3371
|
+
* connectionId: ``,
|
|
3372
|
+
* baseId: ``,
|
|
3373
|
+
* tableId: ``,
|
|
3374
|
+
* });
|
|
3375
|
+
* ```
|
|
3307
3376
|
*/
|
|
3308
3377
|
airtableGetTableRecords(step: AirtableGetTableRecordsStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<AirtableGetTableRecordsStepOutput>>;
|
|
3309
3378
|
/**
|
|
3310
|
-
* Analyze Image
|
|
3311
|
-
*
|
|
3312
3379
|
* Analyze an image using a vision model based on a text prompt.
|
|
3313
3380
|
*
|
|
3314
|
-
*
|
|
3381
|
+
* @remarks
|
|
3315
3382
|
* - Uses the configured vision model to generate a text analysis of the image.
|
|
3316
3383
|
* - The prompt should describe what to look for or extract from the image.
|
|
3384
|
+
*
|
|
3385
|
+
* @example
|
|
3386
|
+
* ```typescript
|
|
3387
|
+
* const result = await agent.analyzeImage({
|
|
3388
|
+
* prompt: ``,
|
|
3389
|
+
* imageUrl: ``,
|
|
3390
|
+
* });
|
|
3391
|
+
* ```
|
|
3317
3392
|
*/
|
|
3318
3393
|
analyzeImage(step: AnalyzeImageStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<AnalyzeImageStepOutput>>;
|
|
3319
3394
|
/**
|
|
3320
|
-
* Analyze Video
|
|
3321
|
-
*
|
|
3322
3395
|
* Analyze a video using a video analysis model based on a text prompt.
|
|
3323
3396
|
*
|
|
3324
|
-
*
|
|
3397
|
+
* @remarks
|
|
3325
3398
|
* - Uses the configured video analysis model to generate a text analysis of the video.
|
|
3326
3399
|
* - The prompt should describe what to look for or extract from the video.
|
|
3400
|
+
*
|
|
3401
|
+
* @example
|
|
3402
|
+
* ```typescript
|
|
3403
|
+
* const result = await agent.analyzeVideo({
|
|
3404
|
+
* prompt: ``,
|
|
3405
|
+
* videoUrl: ``,
|
|
3406
|
+
* });
|
|
3407
|
+
* ```
|
|
3327
3408
|
*/
|
|
3328
3409
|
analyzeVideo(step: AnalyzeVideoStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<AnalyzeVideoStepOutput>>;
|
|
3329
3410
|
/**
|
|
3330
|
-
* Get Image from Video Frame
|
|
3331
|
-
*
|
|
3332
3411
|
* Capture a thumbnail from a video at a specified timestamp
|
|
3333
3412
|
*
|
|
3334
|
-
*
|
|
3335
|
-
*
|
|
3413
|
+
* @example
|
|
3414
|
+
* ```typescript
|
|
3415
|
+
* const result = await agent.captureThumbnail({
|
|
3416
|
+
* videoUrl: ``,
|
|
3417
|
+
* at: ``,
|
|
3418
|
+
* });
|
|
3419
|
+
* ```
|
|
3336
3420
|
*/
|
|
3337
3421
|
captureThumbnail(step: CaptureThumbnailStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<CaptureThumbnailStepOutput>>;
|
|
3338
3422
|
/**
|
|
3339
|
-
* [Coda] Create/Update page
|
|
3340
|
-
*
|
|
3341
3423
|
* Create a new page or update an existing page in a Coda document.
|
|
3342
3424
|
*
|
|
3343
|
-
*
|
|
3425
|
+
* @remarks
|
|
3344
3426
|
* - Requires a Coda OAuth connection (connectionId).
|
|
3345
3427
|
* - If pageData.pageId is provided, updates that page. Otherwise, creates a new one.
|
|
3346
3428
|
* - Page content is provided as markdown and converted to Coda's canvas format.
|
|
3347
3429
|
* - When updating, insertionMode controls how content is applied (default: 'append').
|
|
3430
|
+
*
|
|
3431
|
+
* @example
|
|
3432
|
+
* ```typescript
|
|
3433
|
+
* const result = await agent.codaCreateUpdatePage({
|
|
3434
|
+
* connectionId: ``,
|
|
3435
|
+
* pageData: {},
|
|
3436
|
+
* });
|
|
3437
|
+
* ```
|
|
3348
3438
|
*/
|
|
3349
3439
|
codaCreateUpdatePage(step: CodaCreateUpdatePageStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<CodaCreateUpdatePageStepOutput>>;
|
|
3350
3440
|
/**
|
|
3351
|
-
* [Coda] Create/Update row
|
|
3352
|
-
*
|
|
3353
3441
|
* Create a new row or update an existing row in a Coda table.
|
|
3354
3442
|
*
|
|
3355
|
-
*
|
|
3443
|
+
* @remarks
|
|
3356
3444
|
* - Requires a Coda OAuth connection (connectionId).
|
|
3357
3445
|
* - If rowId is provided, updates that row. Otherwise, creates a new one.
|
|
3358
3446
|
* - Row data keys are column IDs. Empty values are excluded.
|
|
3447
|
+
*
|
|
3448
|
+
* @example
|
|
3449
|
+
* ```typescript
|
|
3450
|
+
* const result = await agent.codaCreateUpdateRow({
|
|
3451
|
+
* connectionId: ``,
|
|
3452
|
+
* docId: ``,
|
|
3453
|
+
* tableId: ``,
|
|
3454
|
+
* rowData: {},
|
|
3455
|
+
* });
|
|
3456
|
+
* ```
|
|
3359
3457
|
*/
|
|
3360
3458
|
codaCreateUpdateRow(step: CodaCreateUpdateRowStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<CodaCreateUpdateRowStepOutput>>;
|
|
3361
3459
|
/**
|
|
3362
|
-
* [Coda] Find row
|
|
3363
|
-
*
|
|
3364
3460
|
* Search for a row in a Coda table by matching column values.
|
|
3365
3461
|
*
|
|
3366
|
-
*
|
|
3462
|
+
* @remarks
|
|
3367
3463
|
* - Requires a Coda OAuth connection (connectionId).
|
|
3368
3464
|
* - Returns the first row matching all specified column values, or null if no match.
|
|
3369
3465
|
* - Search criteria in rowData are ANDed together.
|
|
3466
|
+
*
|
|
3467
|
+
* @example
|
|
3468
|
+
* ```typescript
|
|
3469
|
+
* const result = await agent.codaFindRow({
|
|
3470
|
+
* connectionId: ``,
|
|
3471
|
+
* docId: ``,
|
|
3472
|
+
* tableId: ``,
|
|
3473
|
+
* rowData: {},
|
|
3474
|
+
* });
|
|
3475
|
+
* ```
|
|
3370
3476
|
*/
|
|
3371
3477
|
codaFindRow(step: CodaFindRowStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<CodaFindRowStepOutput>>;
|
|
3372
3478
|
/**
|
|
3373
|
-
* [Coda] Get page
|
|
3374
|
-
*
|
|
3375
3479
|
* Export and read the contents of a page from a Coda document.
|
|
3376
3480
|
*
|
|
3377
|
-
*
|
|
3481
|
+
* @remarks
|
|
3378
3482
|
* - Requires a Coda OAuth connection (connectionId).
|
|
3379
3483
|
* - Page export is asynchronous on Coda's side — there may be a brief delay while it processes.
|
|
3380
3484
|
* - If a page was just created in a prior step, there is an automatic 20-second retry if the first export attempt fails.
|
|
3485
|
+
*
|
|
3486
|
+
* @example
|
|
3487
|
+
* ```typescript
|
|
3488
|
+
* const result = await agent.codaGetPage({
|
|
3489
|
+
* connectionId: ``,
|
|
3490
|
+
* docId: ``,
|
|
3491
|
+
* pageId: ``,
|
|
3492
|
+
* });
|
|
3493
|
+
* ```
|
|
3381
3494
|
*/
|
|
3382
3495
|
codaGetPage(step: CodaGetPageStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<CodaGetPageStepOutput>>;
|
|
3383
3496
|
/**
|
|
3384
|
-
* [Coda] Get table rows
|
|
3385
|
-
*
|
|
3386
3497
|
* Fetch rows from a Coda table with optional pagination.
|
|
3387
3498
|
*
|
|
3388
|
-
*
|
|
3499
|
+
* @remarks
|
|
3389
3500
|
* - Requires a Coda OAuth connection (connectionId).
|
|
3390
3501
|
* - Default limit is 10000 rows. Rows are fetched in pages of 500.
|
|
3391
3502
|
* - When outputFormat is 'csv', the variable receives CSV text. The direct execution output always returns parsed rows.
|
|
3503
|
+
*
|
|
3504
|
+
* @example
|
|
3505
|
+
* ```typescript
|
|
3506
|
+
* const result = await agent.codaGetTableRows({
|
|
3507
|
+
* connectionId: ``,
|
|
3508
|
+
* docId: ``,
|
|
3509
|
+
* tableId: ``,
|
|
3510
|
+
* });
|
|
3511
|
+
* ```
|
|
3392
3512
|
*/
|
|
3393
3513
|
codaGetTableRows(step: CodaGetTableRowsStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<CodaGetTableRowsStepOutput>>;
|
|
3394
3514
|
/**
|
|
3395
|
-
* Convert PDF to Images
|
|
3396
|
-
*
|
|
3397
3515
|
* Convert each page of a PDF document into a PNG image.
|
|
3398
3516
|
*
|
|
3399
|
-
*
|
|
3517
|
+
* @remarks
|
|
3400
3518
|
* - Each page is converted to a separate PNG and re-hosted on the CDN.
|
|
3401
3519
|
* - Returns an array of image URLs, one per page.
|
|
3520
|
+
*
|
|
3521
|
+
* @example
|
|
3522
|
+
* ```typescript
|
|
3523
|
+
* const result = await agent.convertPdfToImages({
|
|
3524
|
+
* pdfUrl: ``,
|
|
3525
|
+
* });
|
|
3526
|
+
* ```
|
|
3402
3527
|
*/
|
|
3403
3528
|
convertPdfToImages(step: ConvertPdfToImagesStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<ConvertPdfToImagesStepOutput>>;
|
|
3404
3529
|
/**
|
|
3405
|
-
* Create Data Source
|
|
3406
|
-
*
|
|
3407
3530
|
* Create a new empty vector data source for the current app.
|
|
3408
3531
|
*
|
|
3409
|
-
*
|
|
3532
|
+
* @remarks
|
|
3410
3533
|
* - Creates a new data source (vector database) associated with the current app version.
|
|
3411
3534
|
* - The data source is created empty — use the "Upload Data Source Document" block to add documents.
|
|
3412
3535
|
* - Returns the new data source ID which can be used in subsequent blocks.
|
|
3536
|
+
*
|
|
3537
|
+
* @example
|
|
3538
|
+
* ```typescript
|
|
3539
|
+
* const result = await agent.createDataSource({
|
|
3540
|
+
* name: ``,
|
|
3541
|
+
* });
|
|
3542
|
+
* ```
|
|
3413
3543
|
*/
|
|
3414
3544
|
createDataSource(step: CreateDataSourceStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<CreateDataSourceStepOutput>>;
|
|
3415
3545
|
/**
|
|
3416
|
-
* [Google Calendar] Create Event
|
|
3417
|
-
*
|
|
3418
3546
|
* Create a new event on a Google Calendar.
|
|
3419
3547
|
*
|
|
3420
|
-
*
|
|
3548
|
+
* @remarks
|
|
3421
3549
|
* - Requires a Google OAuth connection with Calendar events scope.
|
|
3422
3550
|
* - Date/time values must be ISO 8601 format (e.g. "2025-07-02T10:00:00-07:00").
|
|
3423
3551
|
* - Attendees are specified as one email address per line in a single string.
|
|
3424
3552
|
* - Set addMeetLink to true to automatically attach a Google Meet video call.
|
|
3553
|
+
*
|
|
3554
|
+
* @example
|
|
3555
|
+
* ```typescript
|
|
3556
|
+
* const result = await agent.createGoogleCalendarEvent({
|
|
3557
|
+
* connectionId: ``,
|
|
3558
|
+
* summary: ``,
|
|
3559
|
+
* startDateTime: ``,
|
|
3560
|
+
* endDateTime: ``,
|
|
3561
|
+
* });
|
|
3562
|
+
* ```
|
|
3425
3563
|
*/
|
|
3426
3564
|
createGoogleCalendarEvent(step: CreateGoogleCalendarEventStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<CreateGoogleCalendarEventStepOutput>>;
|
|
3427
3565
|
/**
|
|
3428
|
-
* [Google] Create Google Doc
|
|
3429
|
-
*
|
|
3430
3566
|
* Create a new Google Document and optionally populate it with content.
|
|
3431
3567
|
*
|
|
3432
|
-
*
|
|
3568
|
+
* @remarks
|
|
3433
3569
|
* - textType determines how the text field is interpreted: "plain" for plain text, "html" for HTML markup, "markdown" for Markdown.
|
|
3570
|
+
*
|
|
3571
|
+
* @example
|
|
3572
|
+
* ```typescript
|
|
3573
|
+
* const result = await agent.createGoogleDoc({
|
|
3574
|
+
* title: ``,
|
|
3575
|
+
* text: ``,
|
|
3576
|
+
* connectionId: ``,
|
|
3577
|
+
* textType: "plain",
|
|
3578
|
+
* });
|
|
3579
|
+
* ```
|
|
3434
3580
|
*/
|
|
3435
3581
|
createGoogleDoc(step: CreateGoogleDocStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<CreateGoogleDocStepOutput>>;
|
|
3436
3582
|
/**
|
|
3437
|
-
* [Google] Create Google Sheet
|
|
3438
|
-
*
|
|
3439
3583
|
* Create a new Google Spreadsheet and populate it with CSV data.
|
|
3584
|
+
*
|
|
3585
|
+
* @example
|
|
3586
|
+
* ```typescript
|
|
3587
|
+
* const result = await agent.createGoogleSheet({
|
|
3588
|
+
* title: ``,
|
|
3589
|
+
* text: ``,
|
|
3590
|
+
* connectionId: ``,
|
|
3591
|
+
* });
|
|
3592
|
+
* ```
|
|
3440
3593
|
*/
|
|
3441
3594
|
createGoogleSheet(step: CreateGoogleSheetStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<CreateGoogleSheetStepOutput>>;
|
|
3442
3595
|
/**
|
|
3443
|
-
* Delete Data Source
|
|
3444
|
-
*
|
|
3445
3596
|
* Delete a vector data source from the current app.
|
|
3446
3597
|
*
|
|
3447
|
-
*
|
|
3598
|
+
* @remarks
|
|
3448
3599
|
* - Soft-deletes a data source (vector database) by marking it as deleted.
|
|
3449
3600
|
* - The Milvus partition is cleaned up asynchronously by a background cron job.
|
|
3450
3601
|
* - The data source must belong to the current app version.
|
|
3602
|
+
*
|
|
3603
|
+
* @example
|
|
3604
|
+
* ```typescript
|
|
3605
|
+
* const result = await agent.deleteDataSource({
|
|
3606
|
+
* dataSourceId: ``,
|
|
3607
|
+
* });
|
|
3608
|
+
* ```
|
|
3451
3609
|
*/
|
|
3452
3610
|
deleteDataSource(step: DeleteDataSourceStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<DeleteDataSourceStepOutput>>;
|
|
3453
3611
|
/**
|
|
3454
|
-
* Delete Data Source Document
|
|
3455
|
-
*
|
|
3456
3612
|
* Delete a single document from a data source.
|
|
3457
3613
|
*
|
|
3458
|
-
*
|
|
3614
|
+
* @remarks
|
|
3459
3615
|
* - Soft-deletes a document by marking it as deleted.
|
|
3460
3616
|
* - Requires both the data source ID and document ID.
|
|
3461
3617
|
* - After deletion, reloads vectors into Milvus so the data source reflects the change immediately.
|
|
3618
|
+
*
|
|
3619
|
+
* @example
|
|
3620
|
+
* ```typescript
|
|
3621
|
+
* const result = await agent.deleteDataSourceDocument({
|
|
3622
|
+
* dataSourceId: ``,
|
|
3623
|
+
* documentId: ``,
|
|
3624
|
+
* });
|
|
3625
|
+
* ```
|
|
3462
3626
|
*/
|
|
3463
3627
|
deleteDataSourceDocument(step: DeleteDataSourceDocumentStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<DeleteDataSourceDocumentStepOutput>>;
|
|
3464
3628
|
/**
|
|
3465
|
-
* [Google Calendar] Get Event
|
|
3466
|
-
*
|
|
3467
3629
|
* Retrieve a specific event from a Google Calendar by event ID.
|
|
3468
3630
|
*
|
|
3469
|
-
*
|
|
3631
|
+
* @remarks
|
|
3470
3632
|
* - Requires a Google OAuth connection with Calendar events scope.
|
|
3471
3633
|
* - The variable receives JSON or XML-like text depending on exportType. The direct execution output always returns the structured event.
|
|
3634
|
+
*
|
|
3635
|
+
* @example
|
|
3636
|
+
* ```typescript
|
|
3637
|
+
* const result = await agent.deleteGoogleCalendarEvent({
|
|
3638
|
+
* connectionId: ``,
|
|
3639
|
+
* eventId: ``,
|
|
3640
|
+
* });
|
|
3641
|
+
* ```
|
|
3472
3642
|
*/
|
|
3473
3643
|
deleteGoogleCalendarEvent(step: DeleteGoogleCalendarEventStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<DeleteGoogleCalendarEventStepOutput>>;
|
|
3474
3644
|
/**
|
|
3475
|
-
* Detect PII
|
|
3476
|
-
*
|
|
3477
3645
|
* Scan text for personally identifiable information using Microsoft Presidio.
|
|
3478
3646
|
*
|
|
3479
|
-
*
|
|
3647
|
+
* @remarks
|
|
3480
3648
|
* - In workflow mode, transitions to detectedStepId if PII is found, notDetectedStepId otherwise.
|
|
3481
3649
|
* - In direct execution, returns the detection results without transitioning.
|
|
3482
3650
|
* - If entities is empty, returns immediately with no detections.
|
|
3651
|
+
*
|
|
3652
|
+
* @example
|
|
3653
|
+
* ```typescript
|
|
3654
|
+
* const result = await agent.detectPII({
|
|
3655
|
+
* input: ``,
|
|
3656
|
+
* language: ``,
|
|
3657
|
+
* entities: [],
|
|
3658
|
+
* });
|
|
3659
|
+
* ```
|
|
3483
3660
|
*/
|
|
3484
3661
|
detectPII(step: DetectPIIStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<DetectPIIStepOutput>>;
|
|
3485
3662
|
/**
|
|
3486
|
-
* Download Video
|
|
3487
|
-
*
|
|
3488
3663
|
* Download a video file
|
|
3489
3664
|
*
|
|
3490
|
-
*
|
|
3665
|
+
* @remarks
|
|
3491
3666
|
* - Works with YouTube, TikTok, etc., by using ytdlp behind the scenes
|
|
3492
3667
|
* - Can save as mp4 or mp3
|
|
3668
|
+
*
|
|
3669
|
+
* @example
|
|
3670
|
+
* ```typescript
|
|
3671
|
+
* const result = await agent.downloadVideo({
|
|
3672
|
+
* videoUrl: ``,
|
|
3673
|
+
* format: "mp4",
|
|
3674
|
+
* });
|
|
3675
|
+
* ```
|
|
3493
3676
|
*/
|
|
3494
3677
|
downloadVideo(step: DownloadVideoStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<DownloadVideoStepOutput>>;
|
|
3495
3678
|
/**
|
|
3496
|
-
*
|
|
3497
|
-
*
|
|
3498
|
-
* Auto-enhance an image generation prompt using a language model. Optionally generates a negative prompt.
|
|
3679
|
+
* Generate or enhance an image generation prompt using a language model. Optionally generates a negative prompt.
|
|
3499
3680
|
*
|
|
3500
|
-
*
|
|
3681
|
+
* @remarks
|
|
3501
3682
|
* - Rewrites the user's prompt with added detail about style, lighting, colors, and composition.
|
|
3683
|
+
* - Also useful for initial generation, it doesn't always need to be enhancing an existing prompt
|
|
3502
3684
|
* - When includeNegativePrompt is true, a second model call generates a negative prompt.
|
|
3685
|
+
*
|
|
3686
|
+
* @example
|
|
3687
|
+
* ```typescript
|
|
3688
|
+
* const result = await agent.enhanceImageGenerationPrompt({
|
|
3689
|
+
* initialPrompt: ``,
|
|
3690
|
+
* includeNegativePrompt: false,
|
|
3691
|
+
* systemPrompt: ``,
|
|
3692
|
+
* });
|
|
3693
|
+
* ```
|
|
3503
3694
|
*/
|
|
3504
3695
|
enhanceImageGenerationPrompt(step: EnhanceImageGenerationPromptStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<EnhanceImageGenerationPromptStepOutput>>;
|
|
3505
3696
|
/**
|
|
3506
|
-
*
|
|
3507
|
-
*
|
|
3508
|
-
* Auto-enhance a video generation prompt using a language model. Optionally generates a negative prompt.
|
|
3697
|
+
* Generate or enhance a video generation prompt using a language model. Optionally generates a negative prompt.
|
|
3509
3698
|
*
|
|
3510
|
-
*
|
|
3699
|
+
* @remarks
|
|
3511
3700
|
* - Rewrites the user's prompt with added detail about style, camera movement, lighting, and composition.
|
|
3701
|
+
* - Also useful for initial generation, it doesn't always need to be enhancing an existing prompt
|
|
3512
3702
|
* - When includeNegativePrompt is true, a second model call generates a negative prompt.
|
|
3703
|
+
*
|
|
3704
|
+
* @example
|
|
3705
|
+
* ```typescript
|
|
3706
|
+
* const result = await agent.enhanceVideoGenerationPrompt({
|
|
3707
|
+
* initialPrompt: ``,
|
|
3708
|
+
* includeNegativePrompt: false,
|
|
3709
|
+
* systemPrompt: ``,
|
|
3710
|
+
* });
|
|
3711
|
+
* ```
|
|
3513
3712
|
*/
|
|
3514
3713
|
enhanceVideoGenerationPrompt(step: EnhanceVideoGenerationPromptStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<EnhanceVideoGenerationPromptStepOutput>>;
|
|
3515
3714
|
/**
|
|
3516
|
-
* [Apollo] Enrich Person
|
|
3517
|
-
*
|
|
3518
3715
|
* Look up professional information about a person using Apollo.io. Search by ID, name, LinkedIn URL, email, or domain.
|
|
3519
3716
|
*
|
|
3520
|
-
*
|
|
3717
|
+
* @remarks
|
|
3521
3718
|
* - At least one search parameter must be provided.
|
|
3522
3719
|
* - Returns enriched data from Apollo including contact details, employment info, and social profiles.
|
|
3720
|
+
*
|
|
3721
|
+
* @example
|
|
3722
|
+
* ```typescript
|
|
3723
|
+
* const result = await agent.enrichPerson({
|
|
3724
|
+
* params: {},
|
|
3725
|
+
* });
|
|
3726
|
+
* ```
|
|
3523
3727
|
*/
|
|
3524
3728
|
enrichPerson(step: EnrichPersonStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<EnrichPersonStepOutput>>;
|
|
3525
3729
|
/**
|
|
3526
|
-
* Extract Audio from Video
|
|
3527
|
-
*
|
|
3528
3730
|
* Extract audio MP3 from a video file
|
|
3529
3731
|
*
|
|
3530
|
-
*
|
|
3531
|
-
*
|
|
3732
|
+
* @example
|
|
3733
|
+
* ```typescript
|
|
3734
|
+
* const result = await agent.extractAudioFromVideo({
|
|
3735
|
+
* videoUrl: ``,
|
|
3736
|
+
* });
|
|
3737
|
+
* ```
|
|
3532
3738
|
*/
|
|
3533
3739
|
extractAudioFromVideo(step: ExtractAudioFromVideoStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<ExtractAudioFromVideoStepOutput>>;
|
|
3534
3740
|
/**
|
|
3535
|
-
* Extract Text from URL
|
|
3536
|
-
*
|
|
3537
3741
|
* Download a file from a URL and extract its text content. Supports PDFs, plain text files, and other document formats.
|
|
3538
3742
|
*
|
|
3539
|
-
*
|
|
3743
|
+
* @remarks
|
|
3540
3744
|
* - Best suited for PDFs and raw text/document files. For web pages, use the scrapeUrl step instead.
|
|
3541
3745
|
* - Accepts a single URL, a comma-separated list of URLs, or a JSON array of URLs.
|
|
3542
3746
|
* - Files are rehosted on the MindStudio CDN before extraction.
|
|
3543
3747
|
* - Maximum file size is 50MB per URL.
|
|
3748
|
+
*
|
|
3749
|
+
* @example
|
|
3750
|
+
* ```typescript
|
|
3751
|
+
* const result = await agent.extractText({
|
|
3752
|
+
* url: ``,
|
|
3753
|
+
* });
|
|
3754
|
+
* ```
|
|
3544
3755
|
*/
|
|
3545
3756
|
extractText(step: ExtractTextStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<ExtractTextStepOutput>>;
|
|
3546
3757
|
/**
|
|
3547
|
-
* Fetch Data Source Document
|
|
3548
|
-
*
|
|
3549
3758
|
* Fetch the full extracted text contents of a document in a data source.
|
|
3550
3759
|
*
|
|
3551
|
-
*
|
|
3760
|
+
* @remarks
|
|
3552
3761
|
* - Loads a document by ID and returns its full extracted text content.
|
|
3553
3762
|
* - The document must have been successfully processed (status "done").
|
|
3554
3763
|
* - Also returns document metadata (name, summary, word count).
|
|
3764
|
+
*
|
|
3765
|
+
* @example
|
|
3766
|
+
* ```typescript
|
|
3767
|
+
* const result = await agent.fetchDataSourceDocument({
|
|
3768
|
+
* dataSourceId: ``,
|
|
3769
|
+
* documentId: ``,
|
|
3770
|
+
* });
|
|
3771
|
+
* ```
|
|
3555
3772
|
*/
|
|
3556
3773
|
fetchDataSourceDocument(step: FetchDataSourceDocumentStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<FetchDataSourceDocumentStepOutput>>;
|
|
3557
3774
|
/**
|
|
3558
|
-
* [Google] Fetch Google Doc
|
|
3559
|
-
*
|
|
3560
3775
|
* Fetch the contents of an existing Google Document.
|
|
3561
3776
|
*
|
|
3562
|
-
*
|
|
3777
|
+
* @remarks
|
|
3563
3778
|
* - exportType controls the output format: "html" for HTML markup, "markdown" for Markdown, "json" for structured JSON, "plain" for plain text.
|
|
3779
|
+
*
|
|
3780
|
+
* @example
|
|
3781
|
+
* ```typescript
|
|
3782
|
+
* const result = await agent.fetchGoogleDoc({
|
|
3783
|
+
* documentId: ``,
|
|
3784
|
+
* connectionId: ``,
|
|
3785
|
+
* exportType: "html",
|
|
3786
|
+
* });
|
|
3787
|
+
* ```
|
|
3564
3788
|
*/
|
|
3565
3789
|
fetchGoogleDoc(step: FetchGoogleDocStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<FetchGoogleDocStepOutput>>;
|
|
3566
3790
|
/**
|
|
3567
|
-
* [Google] Fetch Google Sheet
|
|
3568
|
-
*
|
|
3569
3791
|
* Fetch contents of a Google Spreadsheet range.
|
|
3570
3792
|
*
|
|
3571
|
-
*
|
|
3793
|
+
* @remarks
|
|
3572
3794
|
* - range uses A1 notation (e.g. "Sheet1!A1:C10"). Omit to fetch the entire first sheet.
|
|
3573
3795
|
* - exportType controls the output format: "csv" for comma-separated values, "json" for structured JSON.
|
|
3796
|
+
*
|
|
3797
|
+
* @example
|
|
3798
|
+
* ```typescript
|
|
3799
|
+
* const result = await agent.fetchGoogleSheet({
|
|
3800
|
+
* spreadsheetId: ``,
|
|
3801
|
+
* range: ``,
|
|
3802
|
+
* connectionId: ``,
|
|
3803
|
+
* exportType: "csv",
|
|
3804
|
+
* });
|
|
3805
|
+
* ```
|
|
3574
3806
|
*/
|
|
3575
3807
|
fetchGoogleSheet(step: FetchGoogleSheetStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<FetchGoogleSheetStepOutput>>;
|
|
3576
3808
|
/**
|
|
3577
|
-
* Fetch Slack Channel History
|
|
3578
|
-
*
|
|
3579
3809
|
* Fetch recent message history from a Slack channel.
|
|
3580
3810
|
*
|
|
3581
|
-
*
|
|
3811
|
+
* @remarks
|
|
3582
3812
|
* - The user is responsible for connecting their Slack workspace and selecting the channel
|
|
3813
|
+
*
|
|
3814
|
+
* @example
|
|
3815
|
+
* ```typescript
|
|
3816
|
+
* const result = await agent.fetchSlackChannelHistory({
|
|
3817
|
+
* connectionId: ``,
|
|
3818
|
+
* channelId: ``,
|
|
3819
|
+
* });
|
|
3820
|
+
* ```
|
|
3583
3821
|
*/
|
|
3584
3822
|
fetchSlackChannelHistory(step: FetchSlackChannelHistoryStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<FetchSlackChannelHistoryStepOutput>>;
|
|
3585
3823
|
/**
|
|
3586
|
-
* [YouTube] Fetch Captions
|
|
3587
|
-
*
|
|
3588
3824
|
* Retrieve the captions/transcript for a YouTube video.
|
|
3589
3825
|
*
|
|
3590
|
-
*
|
|
3826
|
+
* @remarks
|
|
3591
3827
|
* - Supports multiple languages via the language parameter.
|
|
3592
3828
|
* - "text" export produces timestamped plain text; "json" export produces structured transcript data.
|
|
3829
|
+
*
|
|
3830
|
+
* @example
|
|
3831
|
+
* ```typescript
|
|
3832
|
+
* const result = await agent.fetchYoutubeCaptions({
|
|
3833
|
+
* videoUrl: ``,
|
|
3834
|
+
* exportType: "text",
|
|
3835
|
+
* language: ``,
|
|
3836
|
+
* });
|
|
3837
|
+
* ```
|
|
3593
3838
|
*/
|
|
3594
3839
|
fetchYoutubeCaptions(step: FetchYoutubeCaptionsStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<FetchYoutubeCaptionsStepOutput>>;
|
|
3595
3840
|
/**
|
|
3596
|
-
* [YouTube] Fetch Channel
|
|
3597
|
-
*
|
|
3598
3841
|
* Retrieve metadata and recent videos for a YouTube channel.
|
|
3599
3842
|
*
|
|
3600
|
-
*
|
|
3843
|
+
* @remarks
|
|
3601
3844
|
* - Accepts a YouTube channel URL (e.g. https://www.youtube.com/@ChannelName or /channel/ID).
|
|
3602
3845
|
* - Returns channel info and video listings as a JSON object.
|
|
3846
|
+
*
|
|
3847
|
+
* @example
|
|
3848
|
+
* ```typescript
|
|
3849
|
+
* const result = await agent.fetchYoutubeChannel({
|
|
3850
|
+
* channelUrl: ``,
|
|
3851
|
+
* });
|
|
3852
|
+
* ```
|
|
3603
3853
|
*/
|
|
3604
3854
|
fetchYoutubeChannel(step: FetchYoutubeChannelStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<FetchYoutubeChannelStepOutput>>;
|
|
3605
3855
|
/**
|
|
3606
|
-
* [YouTube] Fetch Comments
|
|
3607
|
-
*
|
|
3608
3856
|
* Retrieve comments for a YouTube video.
|
|
3609
3857
|
*
|
|
3610
|
-
*
|
|
3858
|
+
* @remarks
|
|
3611
3859
|
* - Paginates through comments (up to 5 pages).
|
|
3612
3860
|
* - "text" export produces markdown-formatted text; "json" export produces structured comment data.
|
|
3861
|
+
*
|
|
3862
|
+
* @example
|
|
3863
|
+
* ```typescript
|
|
3864
|
+
* const result = await agent.fetchYoutubeComments({
|
|
3865
|
+
* videoUrl: ``,
|
|
3866
|
+
* exportType: "text",
|
|
3867
|
+
* limitPages: ``,
|
|
3868
|
+
* });
|
|
3869
|
+
* ```
|
|
3613
3870
|
*/
|
|
3614
3871
|
fetchYoutubeComments(step: FetchYoutubeCommentsStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<FetchYoutubeCommentsStepOutput>>;
|
|
3615
3872
|
/**
|
|
3616
|
-
* [YouTube] Fetch Video
|
|
3617
|
-
*
|
|
3618
3873
|
* Retrieve metadata for a YouTube video (title, description, stats, channel info).
|
|
3619
3874
|
*
|
|
3620
|
-
*
|
|
3875
|
+
* @remarks
|
|
3621
3876
|
* - Returns video metadata, channel info, and engagement stats.
|
|
3622
3877
|
* - Video format data is excluded from the response.
|
|
3878
|
+
*
|
|
3879
|
+
* @example
|
|
3880
|
+
* ```typescript
|
|
3881
|
+
* const result = await agent.fetchYoutubeVideo({
|
|
3882
|
+
* videoUrl: ``,
|
|
3883
|
+
* });
|
|
3884
|
+
* ```
|
|
3623
3885
|
*/
|
|
3624
3886
|
fetchYoutubeVideo(step: FetchYoutubeVideoStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<FetchYoutubeVideoStepOutput>>;
|
|
3625
3887
|
/**
|
|
3626
|
-
* Generate Chart
|
|
3627
|
-
*
|
|
3628
3888
|
* Create a chart image using QuickChart (Chart.js) and return the URL.
|
|
3629
3889
|
*
|
|
3630
|
-
*
|
|
3890
|
+
* @remarks
|
|
3631
3891
|
* - The data field must be a Chart.js-compatible JSON object serialized as a string.
|
|
3632
3892
|
* - Supported chart types: bar, line, pie.
|
|
3893
|
+
*
|
|
3894
|
+
* @example
|
|
3895
|
+
* ```typescript
|
|
3896
|
+
* const result = await agent.generateChart({
|
|
3897
|
+
* chart: {},
|
|
3898
|
+
* });
|
|
3899
|
+
* ```
|
|
3633
3900
|
*/
|
|
3634
3901
|
generateChart(step: GenerateChartStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<GenerateChartStepOutput>>;
|
|
3635
3902
|
/**
|
|
3636
|
-
* Generate Image
|
|
3637
|
-
*
|
|
3638
3903
|
* Generate an image from a text prompt using an AI model.
|
|
3639
3904
|
*
|
|
3640
|
-
*
|
|
3905
|
+
* @remarks
|
|
3641
3906
|
* - Prompts should be descriptive but concise (roughly 3–6 sentences).
|
|
3642
3907
|
* - Images are automatically hosted on a CDN.
|
|
3643
3908
|
* - In foreground mode, the image is displayed to the user. In background mode, the URL is saved to a variable.
|
|
3644
3909
|
* - When generateVariants is true with numVariants > 1, multiple images are generated in parallel.
|
|
3645
3910
|
* - In direct execution, foreground mode behaves as background, and userSelect variant behavior behaves as saveAll.
|
|
3911
|
+
*
|
|
3912
|
+
* @example
|
|
3913
|
+
* ```typescript
|
|
3914
|
+
* const result = await agent.generateImage({
|
|
3915
|
+
* prompt: ``,
|
|
3916
|
+
* });
|
|
3917
|
+
* ```
|
|
3646
3918
|
*/
|
|
3647
3919
|
generateImage(step: GenerateImageStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<GenerateImageStepOutput>>;
|
|
3648
3920
|
/**
|
|
3649
|
-
* Generate Lipsync
|
|
3650
|
-
*
|
|
3651
3921
|
* Generate a lip sync video from provided audio and image.
|
|
3652
3922
|
*
|
|
3653
|
-
*
|
|
3923
|
+
* @remarks
|
|
3654
3924
|
* - In foreground mode, the video is displayed to the user. In background mode, the URL is saved to a variable.
|
|
3925
|
+
*
|
|
3926
|
+
* @example
|
|
3927
|
+
* ```typescript
|
|
3928
|
+
* const result = await agent.generateLipsync({});
|
|
3929
|
+
* ```
|
|
3655
3930
|
*/
|
|
3656
3931
|
generateLipsync(step: GenerateLipsyncStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<GenerateLipsyncStepOutput>>;
|
|
3657
3932
|
/**
|
|
3658
|
-
* Generate Music
|
|
3659
|
-
*
|
|
3660
3933
|
* Generate an audio file from provided instructions (text) using a music model.
|
|
3661
3934
|
*
|
|
3662
|
-
*
|
|
3935
|
+
* @remarks
|
|
3663
3936
|
* - The text field contains the instructions (prompt) for the music generation.
|
|
3664
3937
|
* - In foreground mode, the audio is displayed to the user. In background mode, the URL is saved to a variable.
|
|
3938
|
+
*
|
|
3939
|
+
* @example
|
|
3940
|
+
* ```typescript
|
|
3941
|
+
* const result = await agent.generateMusic({
|
|
3942
|
+
* text: ``,
|
|
3943
|
+
* });
|
|
3944
|
+
* ```
|
|
3665
3945
|
*/
|
|
3666
3946
|
generateMusic(step: GenerateMusicStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<GenerateMusicStepOutput>>;
|
|
3667
3947
|
/**
|
|
3668
|
-
* Generate HTML Asset
|
|
3669
|
-
*
|
|
3670
3948
|
* Generate an HTML asset and export it as a webpage, PDF, or image
|
|
3671
3949
|
*
|
|
3672
|
-
*
|
|
3950
|
+
* @remarks
|
|
3673
3951
|
* - 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.
|
|
3674
3952
|
* - 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.
|
|
3675
3953
|
* - 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.
|
|
3676
3954
|
* - 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
|
|
3677
3955
|
* - Can either display output directly to user (foreground mode) or save the URL of the asset to a variable (background mode)
|
|
3956
|
+
*
|
|
3957
|
+
* @example
|
|
3958
|
+
* ```typescript
|
|
3959
|
+
* const result = await agent.generateAsset({
|
|
3960
|
+
* source: ``,
|
|
3961
|
+
* sourceType: "html",
|
|
3962
|
+
* outputFormat: "pdf",
|
|
3963
|
+
* pageSize: "full",
|
|
3964
|
+
* testData: {},
|
|
3965
|
+
* });
|
|
3966
|
+
* ```
|
|
3678
3967
|
*/
|
|
3679
3968
|
generateAsset(step: GeneratePdfStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<GeneratePdfStepOutput>>;
|
|
3680
3969
|
/**
|
|
3681
|
-
* Generate Static Video from Image
|
|
3682
|
-
*
|
|
3683
3970
|
* Convert a static image to an MP4
|
|
3684
3971
|
*
|
|
3685
|
-
*
|
|
3972
|
+
* @remarks
|
|
3686
3973
|
* - Can use to create slides/intertitles/slates for video composition
|
|
3974
|
+
*
|
|
3975
|
+
* @example
|
|
3976
|
+
* ```typescript
|
|
3977
|
+
* const result = await agent.generateStaticVideoFromImage({
|
|
3978
|
+
* imageUrl: ``,
|
|
3979
|
+
* duration: ``,
|
|
3980
|
+
* });
|
|
3981
|
+
* ```
|
|
3687
3982
|
*/
|
|
3688
3983
|
generateStaticVideoFromImage(step: GenerateStaticVideoFromImageStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<GenerateStaticVideoFromImageStepOutput>>;
|
|
3689
3984
|
/**
|
|
3690
|
-
* Generate Video
|
|
3691
|
-
*
|
|
3692
3985
|
* Generate a video from a text prompt using an AI model.
|
|
3693
3986
|
*
|
|
3694
|
-
*
|
|
3987
|
+
* @remarks
|
|
3695
3988
|
* - Prompts should be descriptive but concise (roughly 3–6 sentences).
|
|
3696
3989
|
* - Videos are automatically hosted on a CDN.
|
|
3697
3990
|
* - In foreground mode, the video is displayed to the user. In background mode, the URL is saved to a variable.
|
|
3698
3991
|
* - When generateVariants is true with numVariants > 1, multiple videos are generated in parallel.
|
|
3699
3992
|
* - In direct execution, foreground mode behaves as background, and userSelect variant behavior behaves as saveAll.
|
|
3993
|
+
*
|
|
3994
|
+
* @example
|
|
3995
|
+
* ```typescript
|
|
3996
|
+
* const result = await agent.generateVideo({
|
|
3997
|
+
* prompt: ``,
|
|
3998
|
+
* });
|
|
3999
|
+
* ```
|
|
3700
4000
|
*/
|
|
3701
4001
|
generateVideo(step: GenerateVideoStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<GenerateVideoStepOutput>>;
|
|
3702
4002
|
/**
|
|
3703
|
-
* [Google Calendar] Get Event
|
|
3704
|
-
*
|
|
3705
4003
|
* Retrieve a specific event from a Google Calendar by event ID.
|
|
3706
4004
|
*
|
|
3707
|
-
*
|
|
4005
|
+
* @remarks
|
|
3708
4006
|
* - Requires a Google OAuth connection with Calendar events scope.
|
|
3709
4007
|
* - The variable receives JSON or XML-like text depending on exportType. The direct execution output always returns the structured event.
|
|
4008
|
+
*
|
|
4009
|
+
* @example
|
|
4010
|
+
* ```typescript
|
|
4011
|
+
* const result = await agent.getGoogleCalendarEvent({
|
|
4012
|
+
* connectionId: ``,
|
|
4013
|
+
* eventId: ``,
|
|
4014
|
+
* exportType: "json",
|
|
4015
|
+
* });
|
|
4016
|
+
* ```
|
|
3710
4017
|
*/
|
|
3711
4018
|
getGoogleCalendarEvent(step: GetGoogleCalendarEventStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<GetGoogleCalendarEventStepOutput>>;
|
|
3712
4019
|
/**
|
|
3713
|
-
* Get Media Metadata
|
|
3714
|
-
*
|
|
3715
4020
|
* Get info about a media file
|
|
3716
4021
|
*
|
|
3717
|
-
*
|
|
3718
|
-
*
|
|
4022
|
+
* @example
|
|
4023
|
+
* ```typescript
|
|
4024
|
+
* const result = await agent.getMediaMetadata({
|
|
4025
|
+
* mediaUrl: ``,
|
|
4026
|
+
* });
|
|
4027
|
+
* ```
|
|
3719
4028
|
*/
|
|
3720
4029
|
getMediaMetadata(step: GetMediaMetadataStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<GetMediaMetadataStepOutput>>;
|
|
3721
4030
|
/**
|
|
3722
|
-
* HTTP Request
|
|
3723
|
-
*
|
|
3724
4031
|
* Make an HTTP request to an external endpoint and return the response.
|
|
3725
4032
|
*
|
|
3726
|
-
*
|
|
4033
|
+
* @remarks
|
|
3727
4034
|
* - Supports GET, POST, PATCH, DELETE, and PUT methods.
|
|
3728
4035
|
* - Body can be raw JSON/text, URL-encoded form data, or multipart form data.
|
|
4036
|
+
*
|
|
4037
|
+
* @example
|
|
4038
|
+
* ```typescript
|
|
4039
|
+
* const result = await agent.httpRequest({
|
|
4040
|
+
* url: ``,
|
|
4041
|
+
* method: ``,
|
|
4042
|
+
* headers: {},
|
|
4043
|
+
* queryParams: {},
|
|
4044
|
+
* body: ``,
|
|
4045
|
+
* bodyItems: {},
|
|
4046
|
+
* contentType: "none",
|
|
4047
|
+
* customContentType: ``,
|
|
4048
|
+
* });
|
|
4049
|
+
* ```
|
|
3729
4050
|
*/
|
|
3730
4051
|
httpRequest(step: HttpRequestStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<HttpRequestStepOutput>>;
|
|
3731
4052
|
/**
|
|
3732
|
-
* [HubSpot] Create/Update Company
|
|
3733
|
-
*
|
|
3734
4053
|
* Create a new company or update an existing one in HubSpot. Matches by domain.
|
|
3735
4054
|
*
|
|
3736
|
-
*
|
|
4055
|
+
* @remarks
|
|
3737
4056
|
* - Requires a HubSpot OAuth connection (connectionId).
|
|
3738
4057
|
* - If a company with the given domain already exists, it is updated. Otherwise, a new one is created.
|
|
3739
4058
|
* - Property values are type-checked against enabledProperties before being sent to HubSpot.
|
|
4059
|
+
*
|
|
4060
|
+
* @example
|
|
4061
|
+
* ```typescript
|
|
4062
|
+
* const result = await agent.hubspotCreateCompany({
|
|
4063
|
+
* connectionId: ``,
|
|
4064
|
+
* company: {},
|
|
4065
|
+
* enabledProperties: [],
|
|
4066
|
+
* });
|
|
4067
|
+
* ```
|
|
3740
4068
|
*/
|
|
3741
4069
|
hubspotCreateCompany(step: HubspotCreateCompanyStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<HubspotCreateCompanyStepOutput>>;
|
|
3742
4070
|
/**
|
|
3743
|
-
* [HubSpot] Create/Update Contact
|
|
3744
|
-
*
|
|
3745
4071
|
* Create a new contact or update an existing one in HubSpot. Matches by email address.
|
|
3746
4072
|
*
|
|
3747
|
-
*
|
|
4073
|
+
* @remarks
|
|
3748
4074
|
* - Requires a HubSpot OAuth connection (connectionId).
|
|
3749
4075
|
* - If a contact with the given email already exists, it is updated. Otherwise, a new one is created.
|
|
3750
4076
|
* - If companyDomain is provided, the contact is associated with that company (creating the company if needed).
|
|
3751
4077
|
* - Property values are type-checked against enabledProperties before being sent to HubSpot.
|
|
4078
|
+
*
|
|
4079
|
+
* @example
|
|
4080
|
+
* ```typescript
|
|
4081
|
+
* const result = await agent.hubspotCreateContact({
|
|
4082
|
+
* connectionId: ``,
|
|
4083
|
+
* contact: {},
|
|
4084
|
+
* enabledProperties: [],
|
|
4085
|
+
* companyDomain: ``,
|
|
4086
|
+
* });
|
|
4087
|
+
* ```
|
|
3752
4088
|
*/
|
|
3753
4089
|
hubspotCreateContact(step: HubspotCreateContactStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<HubspotCreateContactStepOutput>>;
|
|
3754
4090
|
/**
|
|
3755
|
-
* [HubSpot] Get Company
|
|
3756
|
-
*
|
|
3757
4091
|
* Look up a HubSpot company by domain name or company ID.
|
|
3758
4092
|
*
|
|
3759
|
-
*
|
|
4093
|
+
* @remarks
|
|
3760
4094
|
* - Requires a HubSpot OAuth connection (connectionId).
|
|
3761
4095
|
* - Returns null if the company is not found.
|
|
3762
4096
|
* - When searching by domain, performs a search query then fetches the full company record.
|
|
3763
4097
|
* - Use additionalProperties to request specific HubSpot properties beyond the defaults.
|
|
4098
|
+
*
|
|
4099
|
+
* @example
|
|
4100
|
+
* ```typescript
|
|
4101
|
+
* const result = await agent.hubspotGetCompany({
|
|
4102
|
+
* connectionId: ``,
|
|
4103
|
+
* searchBy: "domain",
|
|
4104
|
+
* companyDomain: ``,
|
|
4105
|
+
* companyId: ``,
|
|
4106
|
+
* additionalProperties: [],
|
|
4107
|
+
* });
|
|
4108
|
+
* ```
|
|
3764
4109
|
*/
|
|
3765
4110
|
hubspotGetCompany(step: HubspotGetCompanyStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<HubspotGetCompanyStepOutput>>;
|
|
3766
4111
|
/**
|
|
3767
|
-
* [HubSpot] Get Contact
|
|
3768
|
-
*
|
|
3769
4112
|
* Look up a HubSpot contact by email address or contact ID.
|
|
3770
4113
|
*
|
|
3771
|
-
*
|
|
4114
|
+
* @remarks
|
|
3772
4115
|
* - Requires a HubSpot OAuth connection (connectionId).
|
|
3773
4116
|
* - Returns null if the contact is not found.
|
|
3774
4117
|
* - Use additionalProperties to request specific HubSpot properties beyond the defaults.
|
|
4118
|
+
*
|
|
4119
|
+
* @example
|
|
4120
|
+
* ```typescript
|
|
4121
|
+
* const result = await agent.hubspotGetContact({
|
|
4122
|
+
* connectionId: ``,
|
|
4123
|
+
* searchBy: "email",
|
|
4124
|
+
* contactEmail: ``,
|
|
4125
|
+
* contactId: ``,
|
|
4126
|
+
* additionalProperties: [],
|
|
4127
|
+
* });
|
|
4128
|
+
* ```
|
|
3775
4129
|
*/
|
|
3776
4130
|
hubspotGetContact(step: HubspotGetContactStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<HubspotGetContactStepOutput>>;
|
|
3777
4131
|
/**
|
|
3778
|
-
* [Hunter.io] Enrich Company
|
|
3779
|
-
*
|
|
3780
4132
|
* Look up company information by domain using Hunter.io.
|
|
3781
4133
|
*
|
|
3782
|
-
*
|
|
4134
|
+
* @remarks
|
|
3783
4135
|
* - Returns company name, description, location, industry, size, technologies, and more.
|
|
3784
4136
|
* - If the domain input is a full URL, the hostname is automatically extracted.
|
|
3785
4137
|
* - Returns null if the company is not found.
|
|
4138
|
+
*
|
|
4139
|
+
* @example
|
|
4140
|
+
* ```typescript
|
|
4141
|
+
* const result = await agent.hunterApiCompanyEnrichment({
|
|
4142
|
+
* domain: ``,
|
|
4143
|
+
* });
|
|
4144
|
+
* ```
|
|
3786
4145
|
*/
|
|
3787
4146
|
hunterApiCompanyEnrichment(step: HunterApiCompanyEnrichmentStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<HunterApiCompanyEnrichmentStepOutput>>;
|
|
3788
4147
|
/**
|
|
3789
|
-
* [Hunter.io] Domain Search
|
|
3790
|
-
*
|
|
3791
4148
|
* Search for email addresses associated with a domain using Hunter.io.
|
|
3792
4149
|
*
|
|
3793
|
-
*
|
|
4150
|
+
* @remarks
|
|
3794
4151
|
* - If the domain input is a full URL, the hostname is automatically extracted.
|
|
3795
4152
|
* - Returns a list of email addresses found for the domain along with organization info.
|
|
4153
|
+
*
|
|
4154
|
+
* @example
|
|
4155
|
+
* ```typescript
|
|
4156
|
+
* const result = await agent.hunterApiDomainSearch({
|
|
4157
|
+
* domain: ``,
|
|
4158
|
+
* });
|
|
4159
|
+
* ```
|
|
3796
4160
|
*/
|
|
3797
4161
|
hunterApiDomainSearch(step: HunterApiDomainSearchStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<HunterApiDomainSearchStepOutput>>;
|
|
3798
4162
|
/**
|
|
3799
|
-
* [Hunter.io] Find Email
|
|
3800
|
-
*
|
|
3801
4163
|
* Find an email address for a specific person at a domain using Hunter.io.
|
|
3802
4164
|
*
|
|
3803
|
-
*
|
|
4165
|
+
* @remarks
|
|
3804
4166
|
* - Requires a first name, last name, and domain.
|
|
3805
4167
|
* - If the domain input is a full URL, the hostname is automatically extracted.
|
|
3806
4168
|
* - Returns the most likely email address with a confidence score.
|
|
4169
|
+
*
|
|
4170
|
+
* @example
|
|
4171
|
+
* ```typescript
|
|
4172
|
+
* const result = await agent.hunterApiEmailFinder({
|
|
4173
|
+
* domain: ``,
|
|
4174
|
+
* firstName: ``,
|
|
4175
|
+
* lastName: ``,
|
|
4176
|
+
* });
|
|
4177
|
+
* ```
|
|
3807
4178
|
*/
|
|
3808
4179
|
hunterApiEmailFinder(step: HunterApiEmailFinderStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<HunterApiEmailFinderStepOutput>>;
|
|
3809
4180
|
/**
|
|
3810
|
-
* [Hunter.io] Verify Email
|
|
3811
|
-
*
|
|
3812
4181
|
* Verify whether an email address is valid and deliverable using Hunter.io.
|
|
3813
4182
|
*
|
|
3814
|
-
*
|
|
4183
|
+
* @remarks
|
|
3815
4184
|
* - Checks email format, MX records, SMTP server, and mailbox deliverability.
|
|
3816
4185
|
* - Returns a status ("valid", "invalid", "accept_all", "webmail", "disposable", "unknown") and a score.
|
|
4186
|
+
*
|
|
4187
|
+
* @example
|
|
4188
|
+
* ```typescript
|
|
4189
|
+
* const result = await agent.hunterApiEmailVerification({
|
|
4190
|
+
* email: ``,
|
|
4191
|
+
* });
|
|
4192
|
+
* ```
|
|
3817
4193
|
*/
|
|
3818
4194
|
hunterApiEmailVerification(step: HunterApiEmailVerificationStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<HunterApiEmailVerificationStepOutput>>;
|
|
3819
4195
|
/**
|
|
3820
|
-
* [Hunter.io] Enrich Person
|
|
3821
|
-
*
|
|
3822
4196
|
* Look up professional information about a person by their email address using Hunter.io.
|
|
3823
4197
|
*
|
|
3824
|
-
*
|
|
4198
|
+
* @remarks
|
|
3825
4199
|
* - Returns name, job title, social profiles, and company information.
|
|
3826
4200
|
* - If the person is not found, returns an object with an error message instead of throwing.
|
|
4201
|
+
*
|
|
4202
|
+
* @example
|
|
4203
|
+
* ```typescript
|
|
4204
|
+
* const result = await agent.hunterApiPersonEnrichment({
|
|
4205
|
+
* email: ``,
|
|
4206
|
+
* });
|
|
4207
|
+
* ```
|
|
3827
4208
|
*/
|
|
3828
4209
|
hunterApiPersonEnrichment(step: HunterApiPersonEnrichmentStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<HunterApiPersonEnrichmentStepOutput>>;
|
|
3829
4210
|
/**
|
|
3830
|
-
* Image Face Swap
|
|
3831
|
-
*
|
|
3832
4211
|
* Replace a face in an image with a face from another image using AI.
|
|
3833
4212
|
*
|
|
3834
|
-
*
|
|
4213
|
+
* @remarks
|
|
3835
4214
|
* - Requires both a target image and a face source image.
|
|
3836
4215
|
* - Output is re-hosted on the CDN as a PNG.
|
|
4216
|
+
*
|
|
4217
|
+
* @example
|
|
4218
|
+
* ```typescript
|
|
4219
|
+
* const result = await agent.imageFaceSwap({
|
|
4220
|
+
* imageUrl: ``,
|
|
4221
|
+
* faceImageUrl: ``,
|
|
4222
|
+
* engine: ``,
|
|
4223
|
+
* });
|
|
4224
|
+
* ```
|
|
3837
4225
|
*/
|
|
3838
4226
|
imageFaceSwap(step: ImageFaceSwapStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<ImageFaceSwapStepOutput>>;
|
|
3839
4227
|
/**
|
|
3840
|
-
* Remove Image Watermark
|
|
3841
|
-
*
|
|
3842
4228
|
* Remove watermarks from an image using AI.
|
|
3843
4229
|
*
|
|
3844
|
-
*
|
|
4230
|
+
* @remarks
|
|
3845
4231
|
* - Output is re-hosted on the CDN as a PNG.
|
|
4232
|
+
*
|
|
4233
|
+
* @example
|
|
4234
|
+
* ```typescript
|
|
4235
|
+
* const result = await agent.imageRemoveWatermark({
|
|
4236
|
+
* imageUrl: ``,
|
|
4237
|
+
* engine: ``,
|
|
4238
|
+
* });
|
|
4239
|
+
* ```
|
|
3846
4240
|
*/
|
|
3847
4241
|
imageRemoveWatermark(step: ImageRemoveWatermarkStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<ImageRemoveWatermarkStepOutput>>;
|
|
3848
4242
|
/**
|
|
3849
|
-
* Insert Video Clips
|
|
3850
|
-
*
|
|
3851
4243
|
* Insert b-roll clips into a base video at a timecode, optionally with an xfade transition.
|
|
3852
4244
|
*
|
|
3853
|
-
*
|
|
3854
|
-
*
|
|
4245
|
+
* @example
|
|
4246
|
+
* ```typescript
|
|
4247
|
+
* const result = await agent.insertVideoClips({
|
|
4248
|
+
* baseVideoUrl: ``,
|
|
4249
|
+
* overlayVideos: [],
|
|
4250
|
+
* });
|
|
4251
|
+
* ```
|
|
3855
4252
|
*/
|
|
3856
4253
|
insertVideoClips(step: InsertVideoClipsStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<InsertVideoClipsStepOutput>>;
|
|
3857
4254
|
/**
|
|
3858
|
-
* List Data Sources
|
|
3859
|
-
*
|
|
3860
4255
|
* List all data sources for the current app.
|
|
3861
4256
|
*
|
|
3862
|
-
*
|
|
4257
|
+
* @remarks
|
|
3863
4258
|
* - Returns metadata for every data source associated with the current app version.
|
|
3864
4259
|
* - Each entry includes the data source ID, name, description, status, and document list.
|
|
4260
|
+
*
|
|
4261
|
+
* @example
|
|
4262
|
+
* ```typescript
|
|
4263
|
+
* const result = await agent.listDataSources({});
|
|
4264
|
+
* ```
|
|
3865
4265
|
*/
|
|
3866
4266
|
listDataSources(step: ListDataSourcesStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<ListDataSourcesStepOutput>>;
|
|
3867
4267
|
/**
|
|
3868
|
-
* [Google Calendar] List Events
|
|
3869
|
-
*
|
|
3870
4268
|
* List upcoming events from a Google Calendar, ordered by start time.
|
|
3871
4269
|
*
|
|
3872
|
-
*
|
|
4270
|
+
* @remarks
|
|
3873
4271
|
* - Requires a Google OAuth connection with Calendar events scope.
|
|
3874
4272
|
* - Only returns future events (timeMin = now).
|
|
3875
4273
|
* - The variable receives JSON or XML-like text depending on exportType. The direct execution output always returns structured events.
|
|
4274
|
+
*
|
|
4275
|
+
* @example
|
|
4276
|
+
* ```typescript
|
|
4277
|
+
* const result = await agent.listGoogleCalendarEvents({
|
|
4278
|
+
* connectionId: ``,
|
|
4279
|
+
* limit: 0,
|
|
4280
|
+
* exportType: "json",
|
|
4281
|
+
* });
|
|
4282
|
+
* ```
|
|
3876
4283
|
*/
|
|
3877
4284
|
listGoogleCalendarEvents(step: ListGoogleCalendarEventsStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<ListGoogleCalendarEventsStepOutput>>;
|
|
3878
4285
|
/**
|
|
3879
|
-
* Evaluate Logic
|
|
3880
|
-
*
|
|
3881
4286
|
* Use an AI model to evaluate which condition from a list is most true, given a context prompt.
|
|
3882
4287
|
*
|
|
3883
|
-
*
|
|
4288
|
+
* @remarks
|
|
3884
4289
|
* - This is "fuzzy" logic evaluated by an AI model, not computational logic. The model picks the most accurate statement.
|
|
3885
4290
|
* - All possible cases must be specified — there is no default/fallback case.
|
|
3886
4291
|
* - Requires at least two cases.
|
|
3887
4292
|
* - In workflow mode, transitions to the destinationStepId of the winning case. In direct execution, returns the winning case ID and condition.
|
|
4293
|
+
*
|
|
4294
|
+
* @example
|
|
4295
|
+
* ```typescript
|
|
4296
|
+
* const result = await agent.logic({
|
|
4297
|
+
* context: ``,
|
|
4298
|
+
* cases: [],
|
|
4299
|
+
* });
|
|
4300
|
+
* ```
|
|
3888
4301
|
*/
|
|
3889
4302
|
logic(step: LogicStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<LogicStepOutput>>;
|
|
3890
4303
|
/**
|
|
3891
|
-
* Make.com Run Scenario
|
|
3892
|
-
*
|
|
3893
4304
|
* Trigger a Make.com (formerly Integromat) scenario via webhook and return the response.
|
|
3894
4305
|
*
|
|
3895
|
-
*
|
|
4306
|
+
* @remarks
|
|
3896
4307
|
* - The webhook URL must be configured in your Make.com scenario.
|
|
3897
4308
|
* - Input key-value pairs are sent as JSON in the POST body.
|
|
3898
4309
|
* - Response format depends on the Make.com scenario configuration.
|
|
4310
|
+
*
|
|
4311
|
+
* @example
|
|
4312
|
+
* ```typescript
|
|
4313
|
+
* const result = await agent.makeDotComRunScenario({
|
|
4314
|
+
* webhookUrl: ``,
|
|
4315
|
+
* input: {},
|
|
4316
|
+
* });
|
|
4317
|
+
* ```
|
|
3899
4318
|
*/
|
|
3900
4319
|
makeDotComRunScenario(step: MakeDotComRunScenarioStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<MakeDotComRunScenarioStepOutput>>;
|
|
3901
4320
|
/**
|
|
3902
|
-
* Merge Audio
|
|
3903
|
-
*
|
|
3904
4321
|
* Merge one or more clips into a single audio file.
|
|
3905
4322
|
*
|
|
3906
|
-
*
|
|
3907
|
-
*
|
|
4323
|
+
* @example
|
|
4324
|
+
* ```typescript
|
|
4325
|
+
* const result = await agent.mergeAudio({
|
|
4326
|
+
* mp3Urls: [],
|
|
4327
|
+
* });
|
|
4328
|
+
* ```
|
|
3908
4329
|
*/
|
|
3909
4330
|
mergeAudio(step: MergeAudioStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<MergeAudioStepOutput>>;
|
|
3910
4331
|
/**
|
|
3911
|
-
* Merge Videos
|
|
3912
|
-
*
|
|
3913
4332
|
* Merge one or more clips into a single video.
|
|
3914
4333
|
*
|
|
3915
|
-
*
|
|
3916
|
-
*
|
|
4334
|
+
* @example
|
|
4335
|
+
* ```typescript
|
|
4336
|
+
* const result = await agent.mergeVideos({
|
|
4337
|
+
* videoUrls: [],
|
|
4338
|
+
* });
|
|
4339
|
+
* ```
|
|
3917
4340
|
*/
|
|
3918
4341
|
mergeVideos(step: MergeVideosStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<MergeVideosStepOutput>>;
|
|
3919
4342
|
/**
|
|
3920
|
-
* Mix Audio into Video
|
|
3921
|
-
*
|
|
3922
4343
|
* Mix an audio track into a video
|
|
3923
4344
|
*
|
|
3924
|
-
*
|
|
3925
|
-
*
|
|
4345
|
+
* @example
|
|
4346
|
+
* ```typescript
|
|
4347
|
+
* const result = await agent.mixAudioIntoVideo({
|
|
4348
|
+
* videoUrl: ``,
|
|
4349
|
+
* audioUrl: ``,
|
|
4350
|
+
* options: {},
|
|
4351
|
+
* });
|
|
4352
|
+
* ```
|
|
3926
4353
|
*/
|
|
3927
4354
|
mixAudioIntoVideo(step: MixAudioIntoVideoStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<MixAudioIntoVideoStepOutput>>;
|
|
3928
4355
|
/**
|
|
3929
|
-
* Mute Video
|
|
3930
|
-
*
|
|
3931
4356
|
* Mute a video file
|
|
3932
4357
|
*
|
|
3933
|
-
*
|
|
3934
|
-
*
|
|
4358
|
+
* @example
|
|
4359
|
+
* ```typescript
|
|
4360
|
+
* const result = await agent.muteVideo({
|
|
4361
|
+
* videoUrl: ``,
|
|
4362
|
+
* });
|
|
4363
|
+
* ```
|
|
3935
4364
|
*/
|
|
3936
4365
|
muteVideo(step: MuteVideoStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<MuteVideoStepOutput>>;
|
|
3937
4366
|
/**
|
|
3938
|
-
* N8N Run Node
|
|
3939
|
-
*
|
|
3940
4367
|
* Trigger an n8n workflow node via webhook and return the response.
|
|
3941
4368
|
*
|
|
3942
|
-
*
|
|
4369
|
+
* @remarks
|
|
3943
4370
|
* - The webhook URL must be configured in your n8n workflow.
|
|
3944
4371
|
* - Supports GET and POST methods with optional Basic authentication.
|
|
3945
4372
|
* - For GET requests, input values are sent as query parameters. For POST, they are sent as JSON body.
|
|
4373
|
+
*
|
|
4374
|
+
* @example
|
|
4375
|
+
* ```typescript
|
|
4376
|
+
* const result = await agent.n8nRunNode({
|
|
4377
|
+
* method: ``,
|
|
4378
|
+
* authentication: "none",
|
|
4379
|
+
* user: ``,
|
|
4380
|
+
* password: ``,
|
|
4381
|
+
* webhookUrl: ``,
|
|
4382
|
+
* input: {},
|
|
4383
|
+
* });
|
|
4384
|
+
* ```
|
|
3946
4385
|
*/
|
|
3947
4386
|
n8nRunNode(step: N8nRunNodeStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<N8nRunNodeStepOutput>>;
|
|
3948
4387
|
/**
|
|
3949
|
-
* [Notion] Create Page
|
|
3950
|
-
*
|
|
3951
4388
|
* Create a new page in Notion as a child of an existing page.
|
|
3952
4389
|
*
|
|
3953
|
-
*
|
|
4390
|
+
* @remarks
|
|
3954
4391
|
* - Requires a Notion OAuth connection (connectionId).
|
|
3955
4392
|
* - Content is provided as markdown and converted to Notion blocks (headings, paragraphs, lists, code, quotes).
|
|
3956
4393
|
* - The page is created as a child of the specified parent page (pageId).
|
|
4394
|
+
*
|
|
4395
|
+
* @example
|
|
4396
|
+
* ```typescript
|
|
4397
|
+
* const result = await agent.notionCreatePage({
|
|
4398
|
+
* pageId: ``,
|
|
4399
|
+
* content: ``,
|
|
4400
|
+
* title: ``,
|
|
4401
|
+
* connectionId: ``,
|
|
4402
|
+
* });
|
|
4403
|
+
* ```
|
|
3957
4404
|
*/
|
|
3958
4405
|
notionCreatePage(step: NotionCreatePageStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<NotionCreatePageStepOutput>>;
|
|
3959
4406
|
/**
|
|
3960
|
-
* [Notion] Update Page
|
|
3961
|
-
*
|
|
3962
4407
|
* Update the content of an existing Notion page.
|
|
3963
4408
|
*
|
|
3964
|
-
*
|
|
4409
|
+
* @remarks
|
|
3965
4410
|
* - Requires a Notion OAuth connection (connectionId).
|
|
3966
4411
|
* - Content is provided as markdown and converted to Notion blocks.
|
|
3967
4412
|
* - "append" mode adds content to the end of the page. "overwrite" mode deletes all existing blocks first.
|
|
4413
|
+
*
|
|
4414
|
+
* @example
|
|
4415
|
+
* ```typescript
|
|
4416
|
+
* const result = await agent.notionUpdatePage({
|
|
4417
|
+
* pageId: ``,
|
|
4418
|
+
* content: ``,
|
|
4419
|
+
* mode: "append",
|
|
4420
|
+
* connectionId: ``,
|
|
4421
|
+
* });
|
|
4422
|
+
* ```
|
|
3968
4423
|
*/
|
|
3969
4424
|
notionUpdatePage(step: NotionUpdatePageStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<NotionUpdatePageStepOutput>>;
|
|
3970
4425
|
/**
|
|
3971
|
-
* [Apollo] People Search
|
|
3972
|
-
*
|
|
3973
4426
|
* Search for people matching specific criteria using Apollo.io. Supports natural language queries and advanced filters.
|
|
3974
4427
|
*
|
|
3975
|
-
*
|
|
4428
|
+
* @remarks
|
|
3976
4429
|
* - Can use a natural language "smartQuery" which is converted to Apollo search parameters by an AI model.
|
|
3977
4430
|
* - Advanced params can override or supplement the smart query results.
|
|
3978
4431
|
* - Optionally enriches returned people and/or their organizations for additional detail.
|
|
3979
4432
|
* - Results are paginated. Use limit and page to control the result window.
|
|
4433
|
+
*
|
|
4434
|
+
* @example
|
|
4435
|
+
* ```typescript
|
|
4436
|
+
* const result = await agent.peopleSearch({
|
|
4437
|
+
* smartQuery: ``,
|
|
4438
|
+
* enrichPeople: false,
|
|
4439
|
+
* enrichOrganizations: false,
|
|
4440
|
+
* limit: ``,
|
|
4441
|
+
* page: ``,
|
|
4442
|
+
* params: {},
|
|
4443
|
+
* });
|
|
4444
|
+
* ```
|
|
3980
4445
|
*/
|
|
3981
4446
|
peopleSearch(step: PeopleSearchStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<PeopleSearchStepOutput>>;
|
|
3982
4447
|
/**
|
|
3983
|
-
* [LinkedIn] Create post
|
|
3984
|
-
*
|
|
3985
4448
|
* Create a post on LinkedIn from the connected account.
|
|
3986
4449
|
*
|
|
3987
|
-
*
|
|
4450
|
+
* @remarks
|
|
3988
4451
|
* - Requires a LinkedIn OAuth connection (connectionId).
|
|
3989
4452
|
* - Supports text posts, image posts, and video posts.
|
|
3990
4453
|
* - Visibility controls who can see the post.
|
|
4454
|
+
*
|
|
4455
|
+
* @example
|
|
4456
|
+
* ```typescript
|
|
4457
|
+
* const result = await agent.postToLinkedIn({
|
|
4458
|
+
* message: ``,
|
|
4459
|
+
* visibility: "PUBLIC",
|
|
4460
|
+
* connectionId: ``,
|
|
4461
|
+
* });
|
|
4462
|
+
* ```
|
|
3991
4463
|
*/
|
|
3992
4464
|
postToLinkedIn(step: PostToLinkedInStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<PostToLinkedInStepOutput>>;
|
|
3993
4465
|
/**
|
|
3994
|
-
* Post to Slack Channel
|
|
3995
|
-
*
|
|
3996
4466
|
* Send a message to a Slack channel via a connected bot.
|
|
3997
4467
|
*
|
|
3998
|
-
*
|
|
4468
|
+
* @remarks
|
|
3999
4469
|
* - The user is responsible for connecting their Slack workspace and selecting the channel
|
|
4000
4470
|
* - Supports both simple text messages and slack blocks messages
|
|
4001
4471
|
* - Text messages can use limited markdown (slack-only fomatting—e.g., headers are just rendered as bold)
|
|
4472
|
+
*
|
|
4473
|
+
* @example
|
|
4474
|
+
* ```typescript
|
|
4475
|
+
* const result = await agent.postToSlackChannel({
|
|
4476
|
+
* channelId: ``,
|
|
4477
|
+
* messageType: "string",
|
|
4478
|
+
* message: ``,
|
|
4479
|
+
* connectionId: ``,
|
|
4480
|
+
* });
|
|
4481
|
+
* ```
|
|
4002
4482
|
*/
|
|
4003
4483
|
postToSlackChannel(step: PostToSlackChannelStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<PostToSlackChannelStepOutput>>;
|
|
4004
4484
|
/**
|
|
4005
|
-
* [X] Create post
|
|
4006
|
-
*
|
|
4007
4485
|
* Create a post on X (Twitter) from the connected account.
|
|
4008
4486
|
*
|
|
4009
|
-
*
|
|
4487
|
+
* @remarks
|
|
4010
4488
|
* - Requires an X OAuth connection (connectionId).
|
|
4011
4489
|
* - Posts are plain text. Maximum 280 characters.
|
|
4490
|
+
*
|
|
4491
|
+
* @example
|
|
4492
|
+
* ```typescript
|
|
4493
|
+
* const result = await agent.postToX({
|
|
4494
|
+
* text: ``,
|
|
4495
|
+
* connectionId: ``,
|
|
4496
|
+
* });
|
|
4497
|
+
* ```
|
|
4012
4498
|
*/
|
|
4013
4499
|
postToX(step: PostToXStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<PostToXStepOutput>>;
|
|
4014
4500
|
/**
|
|
4015
|
-
* Post to Zapier
|
|
4016
|
-
*
|
|
4017
4501
|
* Send data to a Zapier Zap via webhook and return the response.
|
|
4018
4502
|
*
|
|
4019
|
-
*
|
|
4503
|
+
* @remarks
|
|
4020
4504
|
* - The webhook URL must be configured in the Zapier Zap settings
|
|
4021
4505
|
* - Input keys and values are sent as the JSON body of the POST request
|
|
4022
4506
|
* - The webhook response (JSON or plain text) is returned as the output
|
|
4507
|
+
*
|
|
4508
|
+
* @example
|
|
4509
|
+
* ```typescript
|
|
4510
|
+
* const result = await agent.postToZapier({
|
|
4511
|
+
* webhookUrl: ``,
|
|
4512
|
+
* input: {},
|
|
4513
|
+
* });
|
|
4514
|
+
* ```
|
|
4023
4515
|
*/
|
|
4024
4516
|
postToZapier(step: PostToZapierStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<PostToZapierStepOutput>>;
|
|
4025
4517
|
/**
|
|
4026
|
-
* Query Data Source
|
|
4027
|
-
*
|
|
4028
4518
|
* Search a vector data source (RAG) and return relevant document chunks.
|
|
4029
4519
|
*
|
|
4030
|
-
*
|
|
4520
|
+
* @remarks
|
|
4031
4521
|
* - Queries a vectorized data source and returns the most relevant chunks.
|
|
4032
4522
|
* - Useful for retrieval-augmented generation (RAG) workflows.
|
|
4523
|
+
*
|
|
4524
|
+
* @example
|
|
4525
|
+
* ```typescript
|
|
4526
|
+
* const result = await agent.queryDataSource({
|
|
4527
|
+
* dataSourceId: ``,
|
|
4528
|
+
* query: ``,
|
|
4529
|
+
* maxResults: 0,
|
|
4530
|
+
* });
|
|
4531
|
+
* ```
|
|
4033
4532
|
*/
|
|
4034
4533
|
queryDataSource(step: QueryDataSourceStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<QueryDataSourceStepOutput>>;
|
|
4035
4534
|
/**
|
|
4036
|
-
* Query External SQL Database
|
|
4037
|
-
*
|
|
4038
4535
|
* Execute a SQL query against an external database connected to the workspace.
|
|
4039
4536
|
*
|
|
4040
|
-
*
|
|
4537
|
+
* @remarks
|
|
4041
4538
|
* - Requires a database connection configured in the workspace.
|
|
4042
4539
|
* - Supports PostgreSQL (including Supabase), MySQL, and MSSQL.
|
|
4043
4540
|
* - Results can be returned as JSON or CSV.
|
|
4541
|
+
*
|
|
4542
|
+
* @example
|
|
4543
|
+
* ```typescript
|
|
4544
|
+
* const result = await agent.queryExternalDatabase({
|
|
4545
|
+
* connectionId: ``,
|
|
4546
|
+
* query: ``,
|
|
4547
|
+
* outputFormat: "json",
|
|
4548
|
+
* });
|
|
4549
|
+
* ```
|
|
4044
4550
|
*/
|
|
4045
4551
|
queryExternalDatabase(step: QueryExternalDatabaseStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<QueryExternalDatabaseStepOutput>>;
|
|
4046
4552
|
/**
|
|
4047
|
-
* Redact PII
|
|
4048
|
-
*
|
|
4049
4553
|
* Replace personally identifiable information in text with placeholders using Microsoft Presidio.
|
|
4050
4554
|
*
|
|
4051
|
-
*
|
|
4555
|
+
* @remarks
|
|
4052
4556
|
* - PII is replaced with entity type placeholders (e.g. "Call me at <PHONE_NUMBER>").
|
|
4053
4557
|
* - If entities is empty, returns empty text immediately without processing.
|
|
4558
|
+
*
|
|
4559
|
+
* @example
|
|
4560
|
+
* ```typescript
|
|
4561
|
+
* const result = await agent.redactPII({
|
|
4562
|
+
* input: ``,
|
|
4563
|
+
* language: ``,
|
|
4564
|
+
* entities: [],
|
|
4565
|
+
* });
|
|
4566
|
+
* ```
|
|
4054
4567
|
*/
|
|
4055
4568
|
redactPII(step: RedactPIIStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<RedactPIIStepOutput>>;
|
|
4056
4569
|
/**
|
|
4057
|
-
* Remove Background From Image
|
|
4058
|
-
*
|
|
4059
4570
|
* Remove the background from an image using AI, producing a transparent PNG.
|
|
4060
4571
|
*
|
|
4061
|
-
*
|
|
4572
|
+
* @remarks
|
|
4062
4573
|
* - Uses the Bria background removal model via fal.ai.
|
|
4063
4574
|
* - Output is re-hosted on the CDN as a PNG with transparency.
|
|
4575
|
+
*
|
|
4576
|
+
* @example
|
|
4577
|
+
* ```typescript
|
|
4578
|
+
* const result = await agent.removeBackgroundFromImage({
|
|
4579
|
+
* imageUrl: ``,
|
|
4580
|
+
* });
|
|
4581
|
+
* ```
|
|
4064
4582
|
*/
|
|
4065
4583
|
removeBackgroundFromImage(step: RemoveBackgroundFromImageStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<RemoveBackgroundFromImageStepOutput>>;
|
|
4066
4584
|
/**
|
|
4067
|
-
* Resize Video
|
|
4068
|
-
*
|
|
4069
4585
|
* Resize a video file
|
|
4070
4586
|
*
|
|
4071
|
-
*
|
|
4072
|
-
*
|
|
4587
|
+
* @example
|
|
4588
|
+
* ```typescript
|
|
4589
|
+
* const result = await agent.resizeVideo({
|
|
4590
|
+
* videoUrl: ``,
|
|
4591
|
+
* mode: "fit",
|
|
4592
|
+
* });
|
|
4593
|
+
* ```
|
|
4073
4594
|
*/
|
|
4074
4595
|
resizeVideo(step: ResizeVideoStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<ResizeVideoStepOutput>>;
|
|
4075
4596
|
/**
|
|
4076
|
-
* Run Packaged Workflow
|
|
4077
|
-
*
|
|
4078
4597
|
* Run a packaged workflow ("custom block")
|
|
4079
4598
|
*
|
|
4080
|
-
*
|
|
4599
|
+
* @remarks
|
|
4081
4600
|
* - From the user's perspective, packaged workflows are just ordinary blocks. Behind the scenes, they operate like packages/libraries in a programming language, letting the user execute custom functionality.
|
|
4082
4601
|
* - Some of these packaged workflows are available as part of MindStudio's "Standard Library" and available to every user.
|
|
4083
4602
|
* - Available packaged workflows are documented here as individual blocks, but the runPackagedWorkflow block is how they need to be wrapped in order to be executed correctly.
|
|
4603
|
+
*
|
|
4604
|
+
* @example
|
|
4605
|
+
* ```typescript
|
|
4606
|
+
* const result = await agent.runPackagedWorkflow({
|
|
4607
|
+
* appId: ``,
|
|
4608
|
+
* workflowId: ``,
|
|
4609
|
+
* inputVariables: {},
|
|
4610
|
+
* outputVariables: {},
|
|
4611
|
+
* name: ``,
|
|
4612
|
+
* });
|
|
4613
|
+
* ```
|
|
4084
4614
|
*/
|
|
4085
4615
|
runPackagedWorkflow(step: RunPackagedWorkflowStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<RunPackagedWorkflowStepOutput>>;
|
|
4086
4616
|
/**
|
|
4087
|
-
* [Facebook] Scrape Page
|
|
4088
|
-
*
|
|
4089
4617
|
* Scrape a Facebook page
|
|
4618
|
+
*
|
|
4619
|
+
* @example
|
|
4620
|
+
* ```typescript
|
|
4621
|
+
* const result = await agent.scrapeFacebookPage({
|
|
4622
|
+
* pageUrl: ``,
|
|
4623
|
+
* });
|
|
4624
|
+
* ```
|
|
4090
4625
|
*/
|
|
4091
4626
|
scrapeFacebookPage(step: ScrapeFacebookPageStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<ScrapeFacebookPageStepOutput>>;
|
|
4092
4627
|
/**
|
|
4093
|
-
* [Facebook] Scrape Posts for Page
|
|
4094
|
-
*
|
|
4095
4628
|
* Get all the posts for a Facebook page
|
|
4629
|
+
*
|
|
4630
|
+
* @example
|
|
4631
|
+
* ```typescript
|
|
4632
|
+
* const result = await agent.scrapeFacebookPosts({
|
|
4633
|
+
* pageUrl: ``,
|
|
4634
|
+
* });
|
|
4635
|
+
* ```
|
|
4096
4636
|
*/
|
|
4097
4637
|
scrapeFacebookPosts(step: ScrapeFacebookPostsStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<ScrapeFacebookPostsStepOutput>>;
|
|
4098
4638
|
/**
|
|
4099
|
-
* [Instagram] Scrape Comments
|
|
4100
|
-
*
|
|
4101
4639
|
* Get all the comments for an Instagram post
|
|
4640
|
+
*
|
|
4641
|
+
* @example
|
|
4642
|
+
* ```typescript
|
|
4643
|
+
* const result = await agent.scrapeInstagramComments({
|
|
4644
|
+
* postUrl: ``,
|
|
4645
|
+
* resultsLimit: ``,
|
|
4646
|
+
* });
|
|
4647
|
+
* ```
|
|
4102
4648
|
*/
|
|
4103
4649
|
scrapeInstagramComments(step: ScrapeInstagramCommentsStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<ScrapeInstagramCommentsStepOutput>>;
|
|
4104
4650
|
/**
|
|
4105
|
-
* [Instagram] Scrape Mentions
|
|
4106
|
-
*
|
|
4107
4651
|
* Scrape an Instagram profile's mentions
|
|
4652
|
+
*
|
|
4653
|
+
* @example
|
|
4654
|
+
* ```typescript
|
|
4655
|
+
* const result = await agent.scrapeInstagramMentions({
|
|
4656
|
+
* profileUrl: ``,
|
|
4657
|
+
* resultsLimit: ``,
|
|
4658
|
+
* });
|
|
4659
|
+
* ```
|
|
4108
4660
|
*/
|
|
4109
4661
|
scrapeInstagramMentions(step: ScrapeInstagramMentionsStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<ScrapeInstagramMentionsStepOutput>>;
|
|
4110
4662
|
/**
|
|
4111
|
-
* [Instagram] Scrape Posts
|
|
4112
|
-
*
|
|
4113
4663
|
* Get all the posts for an Instagram profile
|
|
4664
|
+
*
|
|
4665
|
+
* @example
|
|
4666
|
+
* ```typescript
|
|
4667
|
+
* const result = await agent.scrapeInstagramPosts({
|
|
4668
|
+
* profileUrl: ``,
|
|
4669
|
+
* resultsLimit: ``,
|
|
4670
|
+
* onlyPostsNewerThan: ``,
|
|
4671
|
+
* });
|
|
4672
|
+
* ```
|
|
4114
4673
|
*/
|
|
4115
4674
|
scrapeInstagramPosts(step: ScrapeInstagramPostsStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<ScrapeInstagramPostsStepOutput>>;
|
|
4116
4675
|
/**
|
|
4117
|
-
* [Instagram] Scrape Profile
|
|
4118
|
-
*
|
|
4119
4676
|
* Scrape an Instagram profile
|
|
4677
|
+
*
|
|
4678
|
+
* @example
|
|
4679
|
+
* ```typescript
|
|
4680
|
+
* const result = await agent.scrapeInstagramProfile({
|
|
4681
|
+
* profileUrl: ``,
|
|
4682
|
+
* });
|
|
4683
|
+
* ```
|
|
4120
4684
|
*/
|
|
4121
4685
|
scrapeInstagramProfile(step: ScrapeInstagramProfileStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<ScrapeInstagramProfileStepOutput>>;
|
|
4122
4686
|
/**
|
|
4123
|
-
* [Instagram] Scrape Reels
|
|
4124
|
-
*
|
|
4125
4687
|
* Get all the reels for an Instagram profile
|
|
4688
|
+
*
|
|
4689
|
+
* @example
|
|
4690
|
+
* ```typescript
|
|
4691
|
+
* const result = await agent.scrapeInstagramReels({
|
|
4692
|
+
* profileUrl: ``,
|
|
4693
|
+
* resultsLimit: ``,
|
|
4694
|
+
* });
|
|
4695
|
+
* ```
|
|
4126
4696
|
*/
|
|
4127
4697
|
scrapeInstagramReels(step: ScrapeInstagramReelsStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<ScrapeInstagramReelsStepOutput>>;
|
|
4128
4698
|
/**
|
|
4129
|
-
* Scrape LinkedIn Company
|
|
4130
|
-
*
|
|
4131
4699
|
* Scrape public company data from a LinkedIn company page.
|
|
4132
4700
|
*
|
|
4133
|
-
*
|
|
4701
|
+
* @remarks
|
|
4134
4702
|
* - Requires a LinkedIn company URL (e.g. https://www.linkedin.com/company/mindstudioai).
|
|
4135
4703
|
* - Returns structured company data including description, employees, updates, and similar companies.
|
|
4704
|
+
*
|
|
4705
|
+
* @example
|
|
4706
|
+
* ```typescript
|
|
4707
|
+
* const result = await agent.scrapeLinkedInCompany({
|
|
4708
|
+
* url: ``,
|
|
4709
|
+
* });
|
|
4710
|
+
* ```
|
|
4136
4711
|
*/
|
|
4137
4712
|
scrapeLinkedInCompany(step: ScrapeLinkedInCompanyStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<ScrapeLinkedInCompanyStepOutput>>;
|
|
4138
4713
|
/**
|
|
4139
|
-
* Scrape LinkedIn Profile
|
|
4140
|
-
*
|
|
4141
4714
|
* Scrape public profile data from a LinkedIn profile page.
|
|
4142
4715
|
*
|
|
4143
|
-
*
|
|
4716
|
+
* @remarks
|
|
4144
4717
|
* - Requires a LinkedIn profile URL (e.g. https://www.linkedin.com/in/username).
|
|
4145
4718
|
* - Returns structured profile data including experience, education, articles, and activities.
|
|
4719
|
+
*
|
|
4720
|
+
* @example
|
|
4721
|
+
* ```typescript
|
|
4722
|
+
* const result = await agent.scrapeLinkedInProfile({
|
|
4723
|
+
* url: ``,
|
|
4724
|
+
* });
|
|
4725
|
+
* ```
|
|
4146
4726
|
*/
|
|
4147
4727
|
scrapeLinkedInProfile(step: ScrapeLinkedInProfileStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<ScrapeLinkedInProfileStepOutput>>;
|
|
4148
4728
|
/**
|
|
4149
|
-
* [Meta Threads] Scrape Profile
|
|
4150
|
-
*
|
|
4151
4729
|
* Scrape a Meta Threads profile
|
|
4730
|
+
*
|
|
4731
|
+
* @example
|
|
4732
|
+
* ```typescript
|
|
4733
|
+
* const result = await agent.scrapeMetaThreadsProfile({
|
|
4734
|
+
* profileUrl: ``,
|
|
4735
|
+
* });
|
|
4736
|
+
* ```
|
|
4152
4737
|
*/
|
|
4153
4738
|
scrapeMetaThreadsProfile(step: ScrapeMetaThreadsProfileStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<ScrapeMetaThreadsProfileStepOutput>>;
|
|
4154
4739
|
/**
|
|
4155
|
-
* Scrape URL
|
|
4156
|
-
*
|
|
4157
4740
|
* Extract text, HTML, or structured content from one or more web pages.
|
|
4158
4741
|
*
|
|
4159
|
-
*
|
|
4742
|
+
* @remarks
|
|
4160
4743
|
* - Accepts a single URL or multiple URLs (as a JSON array, comma-separated, or newline-separated).
|
|
4161
4744
|
* - Output format controls the result shape: "text" returns markdown, "html" returns raw HTML, "json" returns structured scraper data.
|
|
4162
4745
|
* - Can optionally capture a screenshot of each page.
|
|
4746
|
+
*
|
|
4747
|
+
* @example
|
|
4748
|
+
* ```typescript
|
|
4749
|
+
* const result = await agent.scrapeUrl({
|
|
4750
|
+
* url: ``,
|
|
4751
|
+
* });
|
|
4752
|
+
* ```
|
|
4163
4753
|
*/
|
|
4164
4754
|
scrapeUrl(step: ScrapeUrlStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<ScrapeUrlStepOutput>>;
|
|
4165
4755
|
/**
|
|
4166
|
-
* Scrape X Post
|
|
4167
|
-
*
|
|
4168
4756
|
* Scrape data from a single X (Twitter) post by URL.
|
|
4169
4757
|
*
|
|
4170
|
-
*
|
|
4758
|
+
* @remarks
|
|
4171
4759
|
* - Returns structured post data (text, html, optional json/screenshot/metadata).
|
|
4172
4760
|
* - Optionally saves the text content to a variable.
|
|
4761
|
+
*
|
|
4762
|
+
* @example
|
|
4763
|
+
* ```typescript
|
|
4764
|
+
* const result = await agent.scrapeXPost({
|
|
4765
|
+
* url: ``,
|
|
4766
|
+
* });
|
|
4767
|
+
* ```
|
|
4173
4768
|
*/
|
|
4174
4769
|
scrapeXPost(step: ScrapeXPostStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<ScrapeXPostStepOutput>>;
|
|
4175
4770
|
/**
|
|
4176
|
-
* Scrape X Profile
|
|
4177
|
-
*
|
|
4178
4771
|
* Scrape public profile data from an X (Twitter) account by URL.
|
|
4179
4772
|
*
|
|
4180
|
-
*
|
|
4773
|
+
* @remarks
|
|
4181
4774
|
* - Returns structured profile data.
|
|
4182
4775
|
* - Optionally saves the result to a variable.
|
|
4776
|
+
*
|
|
4777
|
+
* @example
|
|
4778
|
+
* ```typescript
|
|
4779
|
+
* const result = await agent.scrapeXProfile({
|
|
4780
|
+
* url: ``,
|
|
4781
|
+
* });
|
|
4782
|
+
* ```
|
|
4183
4783
|
*/
|
|
4184
4784
|
scrapeXProfile(step: ScrapeXProfileStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<ScrapeXProfileStepOutput>>;
|
|
4185
4785
|
/**
|
|
4186
|
-
* Search Google
|
|
4187
|
-
*
|
|
4188
4786
|
* Search the web using Google and return structured results.
|
|
4189
4787
|
*
|
|
4190
|
-
*
|
|
4788
|
+
* @remarks
|
|
4191
4789
|
* - Defaults to us/english, but can optionally specify country and/or language.
|
|
4192
4790
|
* - Defaults to any time, but can optionally specify last hour, last day, week, month, or year.
|
|
4193
4791
|
* - Defaults to top 30 results, but can specify 1 to 100 results to return.
|
|
4792
|
+
*
|
|
4793
|
+
* @example
|
|
4794
|
+
* ```typescript
|
|
4795
|
+
* const result = await agent.searchGoogle({
|
|
4796
|
+
* query: ``,
|
|
4797
|
+
* exportType: "text",
|
|
4798
|
+
* });
|
|
4799
|
+
* ```
|
|
4194
4800
|
*/
|
|
4195
4801
|
searchGoogle(step: SearchGoogleStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<SearchGoogleStepOutput>>;
|
|
4196
4802
|
/**
|
|
4197
|
-
* Search Google Images
|
|
4198
|
-
*
|
|
4199
4803
|
* Search Google Images and return image results with URLs and metadata.
|
|
4200
4804
|
*
|
|
4201
|
-
*
|
|
4805
|
+
* @remarks
|
|
4202
4806
|
* - Defaults to us/english, but can optionally specify country and/or language.
|
|
4203
4807
|
* - Defaults to any time, but can optionally specify last hour, last day, week, month, or year.
|
|
4204
4808
|
* - Defaults to top 30 results, but can specify 1 to 100 results to return.
|
|
4809
|
+
*
|
|
4810
|
+
* @example
|
|
4811
|
+
* ```typescript
|
|
4812
|
+
* const result = await agent.searchGoogleImages({
|
|
4813
|
+
* query: ``,
|
|
4814
|
+
* exportType: "text",
|
|
4815
|
+
* });
|
|
4816
|
+
* ```
|
|
4205
4817
|
*/
|
|
4206
4818
|
searchGoogleImages(step: SearchGoogleImagesStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<SearchGoogleImagesStepOutput>>;
|
|
4207
4819
|
/**
|
|
4208
|
-
* Search Google News
|
|
4209
|
-
*
|
|
4210
4820
|
* Search Google News for recent news articles matching a query.
|
|
4211
4821
|
*
|
|
4212
|
-
*
|
|
4822
|
+
* @remarks
|
|
4213
4823
|
* - Defaults to top 30 results, but can specify 1 to 100 results to return.
|
|
4824
|
+
*
|
|
4825
|
+
* @example
|
|
4826
|
+
* ```typescript
|
|
4827
|
+
* const result = await agent.searchGoogleNews({
|
|
4828
|
+
* text: ``,
|
|
4829
|
+
* exportType: "text",
|
|
4830
|
+
* });
|
|
4831
|
+
* ```
|
|
4214
4832
|
*/
|
|
4215
4833
|
searchGoogleNews(step: SearchGoogleNewsStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<SearchGoogleNewsStepOutput>>;
|
|
4216
4834
|
/**
|
|
4217
|
-
* Search Google Trends
|
|
4218
|
-
*
|
|
4219
4835
|
* Fetch Google Trends data for a search term.
|
|
4220
4836
|
*
|
|
4221
|
-
*
|
|
4837
|
+
* @remarks
|
|
4222
4838
|
* - date accepts shorthand ("now 1-H", "today 1-m", "today 5-y", etc.) or custom "yyyy-mm-dd yyyy-mm-dd" ranges.
|
|
4223
4839
|
* - data_type controls the shape of returned data: TIMESERIES, GEO_MAP, GEO_MAP_0, RELATED_TOPICS, or RELATED_QUERIES.
|
|
4840
|
+
*
|
|
4841
|
+
* @example
|
|
4842
|
+
* ```typescript
|
|
4843
|
+
* const result = await agent.searchGoogleTrends({
|
|
4844
|
+
* text: ``,
|
|
4845
|
+
* hl: ``,
|
|
4846
|
+
* geo: ``,
|
|
4847
|
+
* data_type: "TIMESERIES",
|
|
4848
|
+
* cat: ``,
|
|
4849
|
+
* date: ``,
|
|
4850
|
+
* ts: ``,
|
|
4851
|
+
* });
|
|
4852
|
+
* ```
|
|
4224
4853
|
*/
|
|
4225
4854
|
searchGoogleTrends(step: SearchGoogleTrendsStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<SearchGoogleTrendsStepOutput>>;
|
|
4226
4855
|
/**
|
|
4227
|
-
* Search Perplexity
|
|
4228
|
-
*
|
|
4229
4856
|
* Search the web using the Perplexity API and return structured results.
|
|
4230
4857
|
*
|
|
4231
|
-
*
|
|
4858
|
+
* @remarks
|
|
4232
4859
|
* - Defaults to US results. Use countryCode (ISO code) to filter by country.
|
|
4233
4860
|
* - Returns 10 results by default, configurable from 1 to 20.
|
|
4234
4861
|
* - The variable receives text or JSON depending on exportType. The direct execution output always returns structured results.
|
|
4862
|
+
*
|
|
4863
|
+
* @example
|
|
4864
|
+
* ```typescript
|
|
4865
|
+
* const result = await agent.searchPerplexity({
|
|
4866
|
+
* query: ``,
|
|
4867
|
+
* exportType: "text",
|
|
4868
|
+
* });
|
|
4869
|
+
* ```
|
|
4235
4870
|
*/
|
|
4236
4871
|
searchPerplexity(step: SearchPerplexityStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<SearchPerplexityStepOutput>>;
|
|
4237
4872
|
/**
|
|
4238
|
-
* [X] Search Posts
|
|
4239
|
-
*
|
|
4240
4873
|
* Search recent X (Twitter) posts matching a query.
|
|
4241
4874
|
*
|
|
4242
|
-
*
|
|
4875
|
+
* @remarks
|
|
4243
4876
|
* - Searches only the past 7 days of posts.
|
|
4244
4877
|
* - Query supports X API v2 search operators (up to 512 characters).
|
|
4245
|
-
*
|
|
4246
4878
|
* Available search operators in query:
|
|
4247
|
-
*
|
|
4248
4879
|
* | Operator | Description |
|
|
4249
4880
|
* | -----------------| -------------------------------------------------|
|
|
4250
4881
|
* | from: | Posts from a specific user (e.g., from:elonmusk) |
|
|
@@ -4259,269 +4890,443 @@ interface StepMethods {
|
|
|
4259
4890
|
* | - | Excludes specific terms (e.g., -spam) |
|
|
4260
4891
|
* | () | Groups terms or operators (e.g., (AI OR ML)) |
|
|
4261
4892
|
* | AND, OR, NOT | Boolean logic for combining or excluding terms |
|
|
4262
|
-
*
|
|
4263
4893
|
* Conjunction-Required Operators (must be combined with a standalone operator):
|
|
4264
|
-
*
|
|
4265
4894
|
* | Operator | Description |
|
|
4266
4895
|
* | ------------ | -----------------------------------------------|
|
|
4267
4896
|
* | has:media | Posts containing media (images, videos, or GIFs) |
|
|
4268
4897
|
* | has:links | Posts containing URLs |
|
|
4269
4898
|
* | is:retweet | Filters retweets |
|
|
4270
4899
|
* | is:reply | Filters replies |
|
|
4271
|
-
*
|
|
4272
4900
|
* For example, has:media alone is invalid, but #AI has:media is valid.
|
|
4901
|
+
*
|
|
4902
|
+
* @example
|
|
4903
|
+
* ```typescript
|
|
4904
|
+
* const result = await agent.searchXPosts({
|
|
4905
|
+
* query: ``,
|
|
4906
|
+
* scope: "recent",
|
|
4907
|
+
* options: {},
|
|
4908
|
+
* });
|
|
4909
|
+
* ```
|
|
4273
4910
|
*/
|
|
4274
4911
|
searchXPosts(step: SearchXPostsStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<SearchXPostsStepOutput>>;
|
|
4275
4912
|
/**
|
|
4276
|
-
* [YouTube] Search Videos
|
|
4277
|
-
*
|
|
4278
4913
|
* Search for YouTube videos by keyword.
|
|
4279
4914
|
*
|
|
4280
|
-
*
|
|
4915
|
+
* @remarks
|
|
4281
4916
|
* - Supports pagination (up to 5 pages) and country/language filters.
|
|
4282
4917
|
* - Use the filter/filterType fields for YouTube search parameter (sp) filters.
|
|
4918
|
+
*
|
|
4919
|
+
* @example
|
|
4920
|
+
* ```typescript
|
|
4921
|
+
* const result = await agent.searchYoutube({
|
|
4922
|
+
* query: ``,
|
|
4923
|
+
* limitPages: ``,
|
|
4924
|
+
* filter: ``,
|
|
4925
|
+
* filterType: ``,
|
|
4926
|
+
* });
|
|
4927
|
+
* ```
|
|
4283
4928
|
*/
|
|
4284
4929
|
searchYoutube(step: SearchYoutubeStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<SearchYoutubeStepOutput>>;
|
|
4285
4930
|
/**
|
|
4286
|
-
* [YouTube] Search Trends
|
|
4287
|
-
*
|
|
4288
4931
|
* Retrieve trending videos on YouTube by category and region.
|
|
4289
4932
|
*
|
|
4290
|
-
*
|
|
4933
|
+
* @remarks
|
|
4291
4934
|
* - Categories: "now" (trending now), "music", "gaming", "films".
|
|
4292
4935
|
* - Supports country and language filtering.
|
|
4936
|
+
*
|
|
4937
|
+
* @example
|
|
4938
|
+
* ```typescript
|
|
4939
|
+
* const result = await agent.searchYoutubeTrends({
|
|
4940
|
+
* bp: "now",
|
|
4941
|
+
* hl: ``,
|
|
4942
|
+
* gl: ``,
|
|
4943
|
+
* });
|
|
4944
|
+
* ```
|
|
4293
4945
|
*/
|
|
4294
4946
|
searchYoutubeTrends(step: SearchYoutubeTrendsStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<SearchYoutubeTrendsStepOutput>>;
|
|
4295
4947
|
/**
|
|
4296
|
-
* Send Email
|
|
4297
|
-
*
|
|
4298
4948
|
* Send an email to one or more configured recipient addresses.
|
|
4299
4949
|
*
|
|
4300
|
-
*
|
|
4950
|
+
* @remarks
|
|
4301
4951
|
* - Recipient email addresses are resolved from OAuth connections configured by the app creator. The user running the workflow does not specify the recipient directly.
|
|
4302
4952
|
* - If the body is a URL to a hosted HTML file on the CDN, the HTML is fetched and used as the email body.
|
|
4303
4953
|
* - When generateHtml is enabled, the body text is converted to a styled HTML email using an AI model.
|
|
4304
4954
|
* - connectionId can be a comma-separated list to send to multiple recipients.
|
|
4305
4955
|
* - The special connectionId "trigger_email" uses the email address that triggered the workflow.
|
|
4956
|
+
*
|
|
4957
|
+
* @example
|
|
4958
|
+
* ```typescript
|
|
4959
|
+
* const result = await agent.sendEmail({
|
|
4960
|
+
* subject: ``,
|
|
4961
|
+
* body: ``,
|
|
4962
|
+
* connectionId: ``,
|
|
4963
|
+
* });
|
|
4964
|
+
* ```
|
|
4306
4965
|
*/
|
|
4307
4966
|
sendEmail(step: SendEmailStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<SendEmailStepOutput>>;
|
|
4308
4967
|
/**
|
|
4309
|
-
* Send SMS
|
|
4310
|
-
*
|
|
4311
4968
|
* Send an SMS text message to a phone number configured via OAuth connection.
|
|
4312
4969
|
*
|
|
4313
|
-
*
|
|
4970
|
+
* @remarks
|
|
4314
4971
|
* - User is responsible for configuring the connection to the number (MindStudio requires double opt-in to prevent spam)
|
|
4972
|
+
*
|
|
4973
|
+
* @example
|
|
4974
|
+
* ```typescript
|
|
4975
|
+
* const result = await agent.sendSMS({
|
|
4976
|
+
* body: ``,
|
|
4977
|
+
* connectionId: ``,
|
|
4978
|
+
* });
|
|
4979
|
+
* ```
|
|
4315
4980
|
*/
|
|
4316
4981
|
sendSMS(step: SendSMSStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<SendSMSStepOutput>>;
|
|
4317
4982
|
/**
|
|
4318
|
-
* Set Run Title
|
|
4319
|
-
*
|
|
4320
4983
|
* Set the title of the agent run for the user's history
|
|
4984
|
+
*
|
|
4985
|
+
* @example
|
|
4986
|
+
* ```typescript
|
|
4987
|
+
* const result = await agent.setRunTitle({
|
|
4988
|
+
* title: ``,
|
|
4989
|
+
* });
|
|
4990
|
+
* ```
|
|
4321
4991
|
*/
|
|
4322
4992
|
setRunTitle(step: SetRunTitleStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<SetRunTitleStepOutput>>;
|
|
4323
4993
|
/**
|
|
4324
|
-
* Set Variable
|
|
4325
|
-
*
|
|
4326
4994
|
* Explicitly set a variable to a given value.
|
|
4327
4995
|
*
|
|
4328
|
-
*
|
|
4996
|
+
* @remarks
|
|
4329
4997
|
* - Useful for bootstrapping global variables or setting constants.
|
|
4330
4998
|
* - The variable name and value both support variable interpolation.
|
|
4331
4999
|
* - The type field is a UI hint only (controls input widget in the editor).
|
|
5000
|
+
*
|
|
5001
|
+
* @example
|
|
5002
|
+
* ```typescript
|
|
5003
|
+
* const result = await agent.setVariable({
|
|
5004
|
+
* value: ``,
|
|
5005
|
+
* type: "imageUrl",
|
|
5006
|
+
* });
|
|
5007
|
+
* ```
|
|
4332
5008
|
*/
|
|
4333
5009
|
setVariable(step: SetVariableStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<SetVariableStepOutput>>;
|
|
4334
5010
|
/**
|
|
4335
|
-
* Send Telegram Audio
|
|
4336
|
-
*
|
|
4337
5011
|
* Send an audio file to a Telegram chat as music or a voice note via a bot.
|
|
4338
5012
|
*
|
|
4339
|
-
*
|
|
5013
|
+
* @remarks
|
|
4340
5014
|
* - "audio" mode sends as a standard audio file. "voice" mode sends as a voice message (re-uploads the file for large file support).
|
|
5015
|
+
*
|
|
5016
|
+
* @example
|
|
5017
|
+
* ```typescript
|
|
5018
|
+
* const result = await agent.telegramSendAudio({
|
|
5019
|
+
* botToken: ``,
|
|
5020
|
+
* chatId: ``,
|
|
5021
|
+
* audioUrl: ``,
|
|
5022
|
+
* mode: "audio",
|
|
5023
|
+
* });
|
|
5024
|
+
* ```
|
|
4341
5025
|
*/
|
|
4342
5026
|
telegramSendAudio(step: TelegramSendAudioStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<TelegramSendAudioStepOutput>>;
|
|
4343
5027
|
/**
|
|
4344
|
-
* Send Telegram File
|
|
4345
|
-
*
|
|
4346
5028
|
* Send a document/file to a Telegram chat via a bot.
|
|
5029
|
+
*
|
|
5030
|
+
* @example
|
|
5031
|
+
* ```typescript
|
|
5032
|
+
* const result = await agent.telegramSendFile({
|
|
5033
|
+
* botToken: ``,
|
|
5034
|
+
* chatId: ``,
|
|
5035
|
+
* fileUrl: ``,
|
|
5036
|
+
* });
|
|
5037
|
+
* ```
|
|
4347
5038
|
*/
|
|
4348
5039
|
telegramSendFile(step: TelegramSendFileStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<TelegramSendFileStepOutput>>;
|
|
4349
5040
|
/**
|
|
4350
|
-
* Send Telegram Image
|
|
4351
|
-
*
|
|
4352
5041
|
* Send an image to a Telegram chat via a bot.
|
|
5042
|
+
*
|
|
5043
|
+
* @example
|
|
5044
|
+
* ```typescript
|
|
5045
|
+
* const result = await agent.telegramSendImage({
|
|
5046
|
+
* botToken: ``,
|
|
5047
|
+
* chatId: ``,
|
|
5048
|
+
* imageUrl: ``,
|
|
5049
|
+
* });
|
|
5050
|
+
* ```
|
|
4353
5051
|
*/
|
|
4354
5052
|
telegramSendImage(step: TelegramSendImageStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<TelegramSendImageStepOutput>>;
|
|
4355
5053
|
/**
|
|
4356
|
-
* Send Telegram Message
|
|
4357
|
-
*
|
|
4358
5054
|
* Send a text message to a Telegram chat via a bot.
|
|
4359
5055
|
*
|
|
4360
|
-
*
|
|
5056
|
+
* @remarks
|
|
4361
5057
|
* - Messages are sent using MarkdownV2 formatting. Special characters are auto-escaped.
|
|
4362
5058
|
* - botToken format is "botId:token" — both parts are required.
|
|
5059
|
+
*
|
|
5060
|
+
* @example
|
|
5061
|
+
* ```typescript
|
|
5062
|
+
* const result = await agent.telegramSendMessage({
|
|
5063
|
+
* botToken: ``,
|
|
5064
|
+
* chatId: ``,
|
|
5065
|
+
* text: ``,
|
|
5066
|
+
* });
|
|
5067
|
+
* ```
|
|
4363
5068
|
*/
|
|
4364
5069
|
telegramSendMessage(step: TelegramSendMessageStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<TelegramSendMessageStepOutput>>;
|
|
4365
5070
|
/**
|
|
4366
|
-
* Send Telegram Video
|
|
4367
|
-
*
|
|
4368
5071
|
* Send a video to a Telegram chat via a bot.
|
|
5072
|
+
*
|
|
5073
|
+
* @example
|
|
5074
|
+
* ```typescript
|
|
5075
|
+
* const result = await agent.telegramSendVideo({
|
|
5076
|
+
* botToken: ``,
|
|
5077
|
+
* chatId: ``,
|
|
5078
|
+
* videoUrl: ``,
|
|
5079
|
+
* });
|
|
5080
|
+
* ```
|
|
4369
5081
|
*/
|
|
4370
5082
|
telegramSendVideo(step: TelegramSendVideoStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<TelegramSendVideoStepOutput>>;
|
|
4371
5083
|
/**
|
|
4372
|
-
* Telegram Set Typing
|
|
4373
|
-
*
|
|
4374
5084
|
* Show the "typing..." indicator in a Telegram chat via a bot.
|
|
4375
5085
|
*
|
|
4376
|
-
*
|
|
5086
|
+
* @remarks
|
|
4377
5087
|
* - The typing indicator automatically expires after a few seconds. Use this right before sending a message for a natural feel.
|
|
5088
|
+
*
|
|
5089
|
+
* @example
|
|
5090
|
+
* ```typescript
|
|
5091
|
+
* const result = await agent.telegramSetTyping({
|
|
5092
|
+
* botToken: ``,
|
|
5093
|
+
* chatId: ``,
|
|
5094
|
+
* });
|
|
5095
|
+
* ```
|
|
4378
5096
|
*/
|
|
4379
5097
|
telegramSetTyping(step: TelegramSetTypingStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<TelegramSetTypingStepOutput>>;
|
|
4380
5098
|
/**
|
|
4381
|
-
* Text to Speech
|
|
4382
|
-
*
|
|
4383
5099
|
* Generate an audio file from provided text using a speech model.
|
|
4384
5100
|
*
|
|
4385
|
-
*
|
|
5101
|
+
* @remarks
|
|
4386
5102
|
* - The text field contains the exact words to be spoken (not instructions).
|
|
4387
5103
|
* - In foreground mode, the audio is displayed to the user. In background mode, the URL is saved to a variable.
|
|
5104
|
+
*
|
|
5105
|
+
* @example
|
|
5106
|
+
* ```typescript
|
|
5107
|
+
* const result = await agent.textToSpeech({
|
|
5108
|
+
* text: ``,
|
|
5109
|
+
* });
|
|
5110
|
+
* ```
|
|
4388
5111
|
*/
|
|
4389
5112
|
textToSpeech(step: TextToSpeechStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<TextToSpeechStepOutput>>;
|
|
4390
5113
|
/**
|
|
4391
|
-
* Transcribe Audio
|
|
4392
|
-
*
|
|
4393
5114
|
* Convert an audio file to text using a transcription model.
|
|
4394
5115
|
*
|
|
4395
|
-
*
|
|
5116
|
+
* @remarks
|
|
4396
5117
|
* - The prompt field provides optional context to improve transcription accuracy (e.g. language, speaker names, domain).
|
|
5118
|
+
*
|
|
5119
|
+
* @example
|
|
5120
|
+
* ```typescript
|
|
5121
|
+
* const result = await agent.transcribeAudio({
|
|
5122
|
+
* audioUrl: ``,
|
|
5123
|
+
* prompt: ``,
|
|
5124
|
+
* });
|
|
5125
|
+
* ```
|
|
4397
5126
|
*/
|
|
4398
5127
|
transcribeAudio(step: TranscribeAudioStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<TranscribeAudioStepOutput>>;
|
|
4399
5128
|
/**
|
|
4400
|
-
* Trim Media
|
|
4401
|
-
*
|
|
4402
5129
|
* Trim an audio or video clip
|
|
4403
5130
|
*
|
|
4404
|
-
*
|
|
4405
|
-
*
|
|
5131
|
+
* @example
|
|
5132
|
+
* ```typescript
|
|
5133
|
+
* const result = await agent.trimMedia({
|
|
5134
|
+
* inputUrl: ``,
|
|
5135
|
+
* });
|
|
5136
|
+
* ```
|
|
4406
5137
|
*/
|
|
4407
5138
|
trimMedia(step: TrimMediaStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<TrimMediaStepOutput>>;
|
|
4408
5139
|
/**
|
|
4409
|
-
* [Google Calendar] Update Event
|
|
4410
|
-
*
|
|
4411
5140
|
* Update an existing event on a Google Calendar. Only specified fields are changed.
|
|
4412
5141
|
*
|
|
4413
|
-
*
|
|
5142
|
+
* @remarks
|
|
4414
5143
|
* - Requires a Google OAuth connection with Calendar events scope.
|
|
4415
5144
|
* - Fetches the existing event first, then applies only the provided updates. Omitted fields are left unchanged.
|
|
4416
5145
|
* - Attendees are specified as one email address per line, and replace the entire attendee list.
|
|
5146
|
+
*
|
|
5147
|
+
* @example
|
|
5148
|
+
* ```typescript
|
|
5149
|
+
* const result = await agent.updateGoogleCalendarEvent({
|
|
5150
|
+
* connectionId: ``,
|
|
5151
|
+
* eventId: ``,
|
|
5152
|
+
* });
|
|
5153
|
+
* ```
|
|
4417
5154
|
*/
|
|
4418
5155
|
updateGoogleCalendarEvent(step: UpdateGoogleCalendarEventStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<UpdateGoogleCalendarEventStepOutput>>;
|
|
4419
5156
|
/**
|
|
4420
|
-
* [Google] Update Google Doc
|
|
4421
|
-
*
|
|
4422
5157
|
* Update the contents of an existing Google Document.
|
|
4423
5158
|
*
|
|
4424
|
-
*
|
|
5159
|
+
* @remarks
|
|
4425
5160
|
* - operationType controls how content is applied: "addToTop" prepends, "addToBottom" appends, "overwrite" replaces all content.
|
|
4426
5161
|
* - textType determines how the text field is interpreted: "plain" for plain text, "html" for HTML markup, "markdown" for Markdown.
|
|
5162
|
+
*
|
|
5163
|
+
* @example
|
|
5164
|
+
* ```typescript
|
|
5165
|
+
* const result = await agent.updateGoogleDoc({
|
|
5166
|
+
* documentId: ``,
|
|
5167
|
+
* connectionId: ``,
|
|
5168
|
+
* text: ``,
|
|
5169
|
+
* textType: "plain",
|
|
5170
|
+
* operationType: "addToTop",
|
|
5171
|
+
* });
|
|
5172
|
+
* ```
|
|
4427
5173
|
*/
|
|
4428
5174
|
updateGoogleDoc(step: UpdateGoogleDocStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<UpdateGoogleDocStepOutput>>;
|
|
4429
5175
|
/**
|
|
4430
|
-
* [Google] Update Google Sheet
|
|
4431
|
-
*
|
|
4432
5176
|
* Update a Google Spreadsheet with new data.
|
|
4433
5177
|
*
|
|
4434
|
-
*
|
|
5178
|
+
* @remarks
|
|
4435
5179
|
* - operationType controls how data is written: "addToBottom" appends rows, "overwrite" replaces all data, "range" writes to a specific cell range.
|
|
4436
5180
|
* - Data should be provided as CSV in the text field.
|
|
5181
|
+
*
|
|
5182
|
+
* @example
|
|
5183
|
+
* ```typescript
|
|
5184
|
+
* const result = await agent.updateGoogleSheet({
|
|
5185
|
+
* text: ``,
|
|
5186
|
+
* connectionId: ``,
|
|
5187
|
+
* spreadsheetId: ``,
|
|
5188
|
+
* range: ``,
|
|
5189
|
+
* operationType: "addToBottom",
|
|
5190
|
+
* });
|
|
5191
|
+
* ```
|
|
4437
5192
|
*/
|
|
4438
5193
|
updateGoogleSheet(step: UpdateGoogleSheetStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<UpdateGoogleSheetStepOutput>>;
|
|
4439
5194
|
/**
|
|
4440
|
-
* Upload Data Source Document
|
|
4441
|
-
*
|
|
4442
5195
|
* Upload a file into an existing data source from a URL or raw text content.
|
|
4443
5196
|
*
|
|
4444
|
-
*
|
|
5197
|
+
* @remarks
|
|
4445
5198
|
* - If "file" is a single URL, the file is downloaded from that URL and uploaded.
|
|
4446
5199
|
* - If "file" is any other string, a .txt document is created from that content and uploaded.
|
|
4447
5200
|
* - The block waits (polls) for processing to complete before transitioning, up to 5 minutes.
|
|
4448
5201
|
* - Once processing finishes, vectors are loaded into Milvus so the data source is immediately queryable.
|
|
4449
5202
|
* - Supported file types (when using a URL) are the same as the data source upload UI (PDF, DOCX, TXT, etc.).
|
|
5203
|
+
*
|
|
5204
|
+
* @example
|
|
5205
|
+
* ```typescript
|
|
5206
|
+
* const result = await agent.uploadDataSourceDocument({
|
|
5207
|
+
* dataSourceId: ``,
|
|
5208
|
+
* file: ``,
|
|
5209
|
+
* fileName: ``,
|
|
5210
|
+
* });
|
|
5211
|
+
* ```
|
|
4450
5212
|
*/
|
|
4451
5213
|
uploadDataSourceDocument(step: UploadDataSourceDocumentStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<UploadDataSourceDocumentStepOutput>>;
|
|
4452
5214
|
/**
|
|
4453
|
-
* Upscale Image
|
|
4454
|
-
*
|
|
4455
5215
|
* Increase the resolution of an image using AI upscaling.
|
|
4456
5216
|
*
|
|
4457
|
-
*
|
|
5217
|
+
* @remarks
|
|
4458
5218
|
* - Output is re-hosted on the CDN as a PNG.
|
|
5219
|
+
*
|
|
5220
|
+
* @example
|
|
5221
|
+
* ```typescript
|
|
5222
|
+
* const result = await agent.upscaleImage({
|
|
5223
|
+
* imageUrl: ``,
|
|
5224
|
+
* targetResolution: "2k",
|
|
5225
|
+
* engine: "standard",
|
|
5226
|
+
* });
|
|
5227
|
+
* ```
|
|
4459
5228
|
*/
|
|
4460
5229
|
upscaleImage(step: UpscaleImageStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<UpscaleImageStepOutput>>;
|
|
4461
5230
|
/**
|
|
4462
|
-
* Upscale Video
|
|
4463
|
-
*
|
|
4464
5231
|
* Upscale a video file
|
|
4465
5232
|
*
|
|
4466
|
-
*
|
|
4467
|
-
*
|
|
5233
|
+
* @example
|
|
5234
|
+
* ```typescript
|
|
5235
|
+
* const result = await agent.upscaleVideo({
|
|
5236
|
+
* videoUrl: ``,
|
|
5237
|
+
* targetResolution: "720p",
|
|
5238
|
+
* engine: "standard",
|
|
5239
|
+
* });
|
|
5240
|
+
* ```
|
|
4468
5241
|
*/
|
|
4469
5242
|
upscaleVideo(step: UpscaleVideoStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<UpscaleVideoStepOutput>>;
|
|
4470
5243
|
/**
|
|
4471
|
-
* User Message
|
|
4472
|
-
*
|
|
4473
5244
|
* Send a message to an AI model and return the response, or echo a system message.
|
|
4474
5245
|
*
|
|
4475
|
-
*
|
|
5246
|
+
* @remarks
|
|
4476
5247
|
* - Source "user" sends the message to an LLM and returns the model's response.
|
|
4477
5248
|
* - Source "system" echoes the message content directly (no AI call).
|
|
4478
5249
|
* - Mode "background" saves the result to a variable. Mode "foreground" streams it to the user (not available in direct execution).
|
|
4479
5250
|
* - Structured output (JSON/CSV) can be enforced via structuredOutputType and structuredOutputExample.
|
|
5251
|
+
*
|
|
5252
|
+
* @example
|
|
5253
|
+
* ```typescript
|
|
5254
|
+
* const result = await agent.generateText({
|
|
5255
|
+
* message: ``,
|
|
5256
|
+
* });
|
|
5257
|
+
* ```
|
|
4480
5258
|
*/
|
|
4481
5259
|
generateText(step: UserMessageStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<UserMessageStepOutput>>;
|
|
4482
5260
|
/**
|
|
4483
|
-
* Video Face Swap
|
|
4484
|
-
*
|
|
4485
5261
|
* Swap faces in a video file
|
|
4486
5262
|
*
|
|
4487
|
-
*
|
|
4488
|
-
*
|
|
5263
|
+
* @example
|
|
5264
|
+
* ```typescript
|
|
5265
|
+
* const result = await agent.videoFaceSwap({
|
|
5266
|
+
* videoUrl: ``,
|
|
5267
|
+
* faceImageUrl: ``,
|
|
5268
|
+
* targetIndex: 0,
|
|
5269
|
+
* engine: ``,
|
|
5270
|
+
* });
|
|
5271
|
+
* ```
|
|
4489
5272
|
*/
|
|
4490
5273
|
videoFaceSwap(step: VideoFaceSwapStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<VideoFaceSwapStepOutput>>;
|
|
4491
5274
|
/**
|
|
4492
|
-
* Remove Video Background
|
|
4493
|
-
*
|
|
4494
5275
|
* Remove or replace background from a video
|
|
4495
5276
|
*
|
|
4496
|
-
*
|
|
4497
|
-
*
|
|
5277
|
+
* @example
|
|
5278
|
+
* ```typescript
|
|
5279
|
+
* const result = await agent.videoRemoveBackground({
|
|
5280
|
+
* videoUrl: ``,
|
|
5281
|
+
* newBackground: "transparent",
|
|
5282
|
+
* engine: ``,
|
|
5283
|
+
* });
|
|
5284
|
+
* ```
|
|
4498
5285
|
*/
|
|
4499
5286
|
videoRemoveBackground(step: VideoRemoveBackgroundStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<VideoRemoveBackgroundStepOutput>>;
|
|
4500
5287
|
/**
|
|
4501
|
-
* Remove Video Watermark
|
|
4502
|
-
*
|
|
4503
5288
|
* Remove a watermark from a video
|
|
4504
5289
|
*
|
|
4505
|
-
*
|
|
4506
|
-
*
|
|
5290
|
+
* @example
|
|
5291
|
+
* ```typescript
|
|
5292
|
+
* const result = await agent.videoRemoveWatermark({
|
|
5293
|
+
* videoUrl: ``,
|
|
5294
|
+
* engine: ``,
|
|
5295
|
+
* });
|
|
5296
|
+
* ```
|
|
4507
5297
|
*/
|
|
4508
5298
|
videoRemoveWatermark(step: VideoRemoveWatermarkStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<VideoRemoveWatermarkStepOutput>>;
|
|
4509
5299
|
/**
|
|
4510
|
-
* Watermark Image
|
|
4511
|
-
*
|
|
4512
5300
|
* Overlay a watermark image onto another image.
|
|
4513
5301
|
*
|
|
4514
|
-
*
|
|
5302
|
+
* @remarks
|
|
4515
5303
|
* - The watermark is placed at the specified corner with configurable padding and width.
|
|
5304
|
+
*
|
|
5305
|
+
* @example
|
|
5306
|
+
* ```typescript
|
|
5307
|
+
* const result = await agent.watermarkImage({
|
|
5308
|
+
* imageUrl: ``,
|
|
5309
|
+
* watermarkImageUrl: ``,
|
|
5310
|
+
* corner: "top-left",
|
|
5311
|
+
* paddingPx: 0,
|
|
5312
|
+
* widthPx: 0,
|
|
5313
|
+
* });
|
|
5314
|
+
* ```
|
|
4516
5315
|
*/
|
|
4517
5316
|
watermarkImage(step: WatermarkImageStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<WatermarkImageStepOutput>>;
|
|
4518
5317
|
/**
|
|
4519
|
-
* Watermark Video
|
|
4520
|
-
*
|
|
4521
5318
|
* Add an image watermark to a video
|
|
4522
5319
|
*
|
|
4523
|
-
*
|
|
4524
|
-
*
|
|
5320
|
+
* @example
|
|
5321
|
+
* ```typescript
|
|
5322
|
+
* const result = await agent.watermarkVideo({
|
|
5323
|
+
* videoUrl: ``,
|
|
5324
|
+
* imageUrl: ``,
|
|
5325
|
+
* corner: "top-left",
|
|
5326
|
+
* paddingPx: 0,
|
|
5327
|
+
* widthPx: 0,
|
|
5328
|
+
* });
|
|
5329
|
+
* ```
|
|
4525
5330
|
*/
|
|
4526
5331
|
watermarkVideo(step: WatermarkVideoStepInput, options?: StepExecutionOptions): Promise<StepExecutionResult<WatermarkVideoStepOutput>>;
|
|
4527
5332
|
}
|