Interface ToolHttpRequestNodeParameters

Source
interface ToolHttpRequestNodeParameters {
    authentication?:
        | "none"
        | "predefinedCredentialType"
        | "genericCredentialType";
    cssSelector?: string;
    dataField?: string;
    elementsToOmit?: string;
    fields?: string;
    fieldsToInclude?: "all"
    | "selected"
    | "except";
    genericAuthType?:
        | "actionNetworkApi"
        | "activeCampaignApi"
        | "acuitySchedulingApi"
        | "acuitySchedulingOAuth2Api"
        | "adaloApi"
        | "affinityApi"
        | "mySql"
        | "postgres"
        | "agileCrmApi"
        | "airtableApi"
        | "airtableTokenApi"
        | "airtableOAuth2Api"
        | "airtopApi"
        | "anthropicApi"
        | "apiTemplateIoApi"
        | "asanaApi"
        | "asanaOAuth2Api"
        | "automizyApi"
        | "autopilotApi"
        | "aws"
        | "microsoftAzureCosmosDbSharedKeyApi"
        | "azureStorageOAuth2Api"
        | "azureStorageSharedKeyApi"
        | "bambooHrApi"
        | "bannerbearApi"
        | "baserowApi"
        | "beeminderApi"
        | "beeminderOAuth2Api"
        | "bitbucketApi"
        | "bitlyApi"
        | "bitlyOAuth2Api"
        | "bitwardenApi"
        | "boxOAuth2Api"
        | "brandfetchApi"
        | "sendInBlueApi"
        | "bubbleApi"
        | "calApi"
        | "calendlyApi"
        | "calendlyOAuth2Api"
        | "chargebeeApi"
        | "httpBasicAuth"
        | "circleCiApi"
        | "ciscoWebexOAuth2Api"
        | "clearbitApi"
        | "clickUpApi"
        | "clickUpOAuth2Api"
        | "clockifyApi"
        | "cloudflareApi"
        | "cockpitApi"
        | "codaApi"
        | "contentfulApi"
        | "convertKitApi"
        | "copperApi"
        | "cortexApi"
        | "crateDb"
        | "crowdDevApi"
        | "customerIoApi"
        | "deepLApi"
        | "demioApi"
        | "dhlApi"
        | "discordBotApi"
        | "discordOAuth2Api"
        | "discordWebhookApi"
        | "discourseApi"
        | "disqusApi"
        | "githubApi"
        | "driftApi"
        | "driftOAuth2Api"
        | "dropboxApi"
        | "dropboxOAuth2Api"
        | "dropcontactApi"
        | "erpNextApi"
        | "egoiApi"
        | "elasticSecurityApi"
        | "elasticsearchApi"
        | "imap"
        | "smtp"
        | "azureOpenAiApi"
        | "cohereApi"
        | "googlePalmApi"
        | "googleApi"
        | "huggingFaceApi"
        | "mistralCloudApi"
        | "ollamaApi"
        | "openAiApi"
        | "emeliaApi"
        | "eventbriteApi"
        | "eventbriteOAuth2Api"
        | "facebookGraphApi"
        | "facebookLeadAdsOAuth2Api"
        | "facebookGraphAppApi"
        | "figmaApi"
        | "fileMaker"
        | "flowApi"
        | "formIoApi"
        | "formstackApi"
        | "formstackOAuth2Api"
        | "freshdeskApi"
        | "freshserviceApi"
        | "freshworksCrmApi"
        | "ftp"
        | "sftp"
        | "gSuiteAdminOAuth2Api"
        | "getResponseApi"
        | "getResponseOAuth2Api"
        | "ghostAdminApi"
        | "ghostContentApi"
        | "gitPassword"
        | "githubOAuth2Api"
        | "gitlabApi"
        | "gitlabOAuth2Api"
        | "gmailOAuth2"
        | "goToWebinarOAuth2Api"
        | "gongApi"
        | "gongOAuth2Api"
        | "googleAdsOAuth2Api"
        | "googleAnalyticsOAuth2"
        | "googleBigQueryOAuth2Api"
        | "googleBooksOAuth2Api"
        | "googleBusinessProfileOAuth2Api"
        | "googleCalendarOAuth2Api"
        | "googleChatOAuth2Api"
        | "googleCloudNaturalLanguageOAuth2Api"
        | "googleCloudStorageOAuth2Api"
        | "googleContactsOAuth2Api"
        | "googleDocsOAuth2Api"
        | "googleDriveOAuth2Api"
        | "googleFirebaseCloudFirestoreOAuth2Api"
        | "googleFirebaseRealtimeDatabaseOAuth2Api"
        | "googlePerspectiveOAuth2Api"
        | "googleSheetsTriggerOAuth2Api"
        | "googleSheetsOAuth2Api"
        | "googleSlidesOAuth2Api"
        | "googleTasksOAuth2Api"
        | "googleTranslateOAuth2Api"
        | "gotifyApi"
        | "grafanaApi"
        | "httpCustomAuth"
        | "httpDigestAuth"
        | "httpHeaderAuth"
        | "httpQueryAuth"
        | "oAuth1Api"
        | "oAuth2Api"
        | "gristApi"
        | "gumroadApi"
        | "haloPSAApi"
        | "harvestApi"
        | "harvestOAuth2Api"
        | "helpScoutOAuth2Api"
        | "highLevelApi"
        | "highLevelOAuth2Api"
        | "homeAssistantApi"
        | "azureEntraCognitiveServicesOAuth2Api"
        | "deepSeekApi"
        | "groqApi"
        | "milvusApi"
        | "motorheadApi"
        | "openRouterApi"
        | "pineconeApi"
        | "qdrantApi"
        | "searXngApi"
        | "serpApi"
        | "vercelAiGatewayApi"
        | "weaviateApi"
        | "wolframAlphaApi"
        | "xAiApi"
        | "xataApi"
        | "zepApi"
        | "alienVaultApi"
        | "amqp"
        | "auth0ManagementApi"
        | "carbonBlackApi"
        | "ciscoMerakiApi"
        | "ciscoSecureEndpointApi"
        | "ciscoUmbrellaApi"
        | "convertApi"
        | "crowdStrikeOAuth2Api"
        | "datadogApi"
        | "dfirIrisApi"
        | "dynatraceApi"
        | "f5BigIpApi"
        | "filescanApi"
        | "fortiGateApi"
        | "googleOAuth2Api"
        | "httpBearerAuth"
        | "httpSslAuth"
        | "hubspotApi"
        | "hubspotAppToken"
        | "hubspotDeveloperApi"
        | "hubspotOAuth2Api"
        | "humanticAiApi"
        | "hunterApi"
        | "hybridAnalysisApi"
        | "impervaWafApi"
        | "intercomApi"
        | "invoiceNinjaApi"
        | "iterableApi"
        | "jenkinsApi"
        | "jinaAiApi"
        | "jiraSoftwareCloudApi"
        | "jiraSoftwareServerApi"
        | "jiraSoftwareServerPatApi"
        | "jotFormApi"
        | "jwtAuth"
        | "kafka"
        | "keapOAuth2Api"
        | "kibanaApi"
        | "kitemakerApi"
        | "koBoToolboxApi"
        | "ldap"
        | "lemlistApi"
        | "lineNotifyOAuth2Api"
        | "linearApi"
        | "linearOAuth2Api"
        | "lingvaNexApi"
        | "linkedInCommunityManagementOAuth2Api"
        | "linkedInOAuth2Api"
        | "loneScaleApi"
        | "magento2Api"
        | "mailcheckApi"
        | "mailchimpApi"
        | "mailchimpOAuth2Api"
        | "mailerLiteApi"
        | "mailgunApi"
        | "mailjetEmailApi"
        | "mailjetSmsApi"
        | "malcoreApi"
        | "mandrillApi"
        | "marketstackApi"
        | "matrixApi"
        | "mattermostApi"
        | "mauticApi"
        | "mauticOAuth2Api"
        | "mediumApi"
        | "mediumOAuth2Api"
        | "messageBirdApi"
        | "metabaseApi"
        | "microsoftAzureMonitorOAuth2Api"
        | "microsoftDynamicsOAuth2Api"
        | "microsoftEntraOAuth2Api"
        | "microsoftExcelOAuth2Api"
        | "microsoftGraphSecurityOAuth2Api"
        | "microsoftOAuth2Api"
        | "microsoftOneDriveOAuth2Api"
        | "microsoftOutlookOAuth2Api"
        | "microsoftSharePointOAuth2Api"
        | "microsoftSql"
        | "microsoftTeamsOAuth2Api"
        | "microsoftToDoOAuth2Api"
        | "mindeeInvoiceApi"
        | "mindeeReceiptApi"
        | "miroOAuth2Api"
        | "mispApi"
        | "mistApi"
        | "moceanApi"
        | "mondayComApi"
        | "mondayComOAuth2Api"
        | "mongoDb"
        | "monicaCrmApi"
        | "mqtt"
        | "msg91Api"
        | "n8nApi"
        | "nasaApi"
        | "netlifyApi"
        | "citrixAdcApi"
        | "nextCloudApi"
        | "nextCloudOAuth2Api"
        | "nocoDb"
        | "nocoDbApiToken"
        | "notionApi"
        | "notionOAuth2Api"
        | "npmApi"
        | "odooApi"
        | "oktaApi"
        | "oneSimpleApi"
        | "onfleetApi"
        | "openCtiApi"
        | "openWeatherMapApi"
        | "orbitApi"
        | "ouraApi"
        | "paddleApi"
        | "pagerDutyApi"
        | "pagerDutyOAuth2Api"
        | "payPalApi"
        | "peekalinkApi"
        | "perplexityApi"
        | "phantombusterApi"
        | "philipsHueOAuth2Api"
        | "pipedriveApi"
        | "pipedriveOAuth2Api"
        | "plivoApi"
        | "postHogApi"
        | "postmarkApi"
        | "profitWellApi"
        | "pushbulletOAuth2Api"
        | "pushcutApi"
        | "pushoverApi"
        | "qRadarApi"
        | "qualysApi"
        | "questDb"
        | "quickbaseApi"
        | "quickBooksOAuth2Api"
        | "rabbitmq"
        | "raindropOAuth2Api"
        | "rapid7InsightVmApi"
        | "recordedFutureApi"
        | "redditOAuth2Api"
        | "redis"
        | "rocketchatApi"
        | "rundeckApi"
        | "s3"
        | "salesforceJwtApi"
        | "salesforceOAuth2Api"
        | "salesmateApi"
        | "seaTableApi"
        | "securityScorecardApi"
        | "segmentApi"
        | "sekoiaApi"
        | "sendGridApi"
        | "sendyApi"
        | "sentryIoApi"
        | "sentryIoOAuth2Api"
        | "sentryIoServerApi"
        | "serviceNowBasicApi"
        | "serviceNowOAuth2Api"
        | "shopifyAccessTokenApi"
        | "shopifyApi"
        | "shopifyOAuth2Api"
        | "shufflerApi"
        | "signl4Api"
        | "slackApi"
        | "slackOAuth2Api"
        | "sms77Api"
        | "snowflake"
        | "solarWindsIpamApi"
        | "solarWindsObservabilityApi"
        | "splunkApi"
        | "spontitApi"
        | "spotifyOAuth2Api"
        | "sshPassword"
        | "sshPrivateKey"
        | "stackbyApi"
        | "storyblokContentApi"
        | "storyblokManagementApi"
        | "strapiApi"
        | "strapiTokenApi"
        | "stravaOAuth2Api"
        | "stripeApi"
        | "supabaseApi"
        | "surveyMonkeyApi"
        | "surveyMonkeyOAuth2Api"
        | "syncroMspApi"
        | "sysdigApi"
        | "taigaApi"
        | "tapfiliateApi"
        | "telegramApi"
        | "theHiveApi"
        | "theHiveProjectApi"
        | "timescaleDb"
        | "todoistApi"
        | "todoistOAuth2Api"
        | "togglApi"
        | "totpApi"
        | "travisCiApi"
        | "trellixEpoApi"
        | "trelloApi"
        | "twakeCloudApi"
        | "twakeServerApi"
        | "twilioApi"
        | "twistOAuth2Api"
        | "twitterOAuth1Api"
        | "twitterOAuth2Api"
        | "typeformApi"
        | "typeformOAuth2Api"
        | "uprocApi"
        | "unleashedSoftwareApi"
        | "upleadApi"
        | "uptimeRobotApi"
        | "urlScanIoApi"
        | "venafiTlsProtectCloudApi"
        | "venafiTlsProtectDatacenterApi"
        | "veroApi"
        | "verticaApi"
        | "virusTotalApi"
        | "vonageApi"
        | "webflowApi"
        | "webflowOAuth2Api"
        | "wekanApi"
        | "whatsAppApi"
        | "whatsAppTriggerApi"
        | "wiseApi"
        | "wooCommerceApi"
        | "wordpressApi"
        | "workableApi"
        | "wufooApi"
        | "xeroOAuth2Api"
        | "youTubeOAuth2Api"
        | "yourlsApi"
        | "zabbixApi"
        | "zammadBasicAuthApi"
        | "zammadTokenAuthApi"
        | "zendeskApi"
        | "zendeskOAuth2Api"
        | "zohoOAuth2Api"
        | "zoomApi"
        | "zoomOAuth2Api"
        | "zscalerZiaApi"
        | "zulipApi";
    jsonBody?: string;
    jsonHeaders?: string;
    jsonQuery?: string;
    maxLength?: number;
    method?: "GET"
    | "POST"
    | "DELETE"
    | "PATCH"
    | "PUT";
    nodeCredentialType?:
        | "actionNetworkApi"
        | "activeCampaignApi"
        | "acuitySchedulingApi"
        | "acuitySchedulingOAuth2Api"
        | "adaloApi"
        | "affinityApi"
        | "mySql"
        | "postgres"
        | "agileCrmApi"
        | "airtableApi"
        | "airtableTokenApi"
        | "airtableOAuth2Api"
        | "airtopApi"
        | "anthropicApi"
        | "apiTemplateIoApi"
        | "asanaApi"
        | "asanaOAuth2Api"
        | "automizyApi"
        | "autopilotApi"
        | "aws"
        | "microsoftAzureCosmosDbSharedKeyApi"
        | "azureStorageOAuth2Api"
        | "azureStorageSharedKeyApi"
        | "bambooHrApi"
        | "bannerbearApi"
        | "baserowApi"
        | "beeminderApi"
        | "beeminderOAuth2Api"
        | "bitbucketApi"
        | "bitlyApi"
        | "bitlyOAuth2Api"
        | "bitwardenApi"
        | "boxOAuth2Api"
        | "brandfetchApi"
        | "sendInBlueApi"
        | "bubbleApi"
        | "calApi"
        | "calendlyApi"
        | "calendlyOAuth2Api"
        | "chargebeeApi"
        | "httpBasicAuth"
        | "circleCiApi"
        | "ciscoWebexOAuth2Api"
        | "clearbitApi"
        | "clickUpApi"
        | "clickUpOAuth2Api"
        | "clockifyApi"
        | "cloudflareApi"
        | "cockpitApi"
        | "codaApi"
        | "contentfulApi"
        | "convertKitApi"
        | "copperApi"
        | "cortexApi"
        | "crateDb"
        | "crowdDevApi"
        | "customerIoApi"
        | "deepLApi"
        | "demioApi"
        | "dhlApi"
        | "discordBotApi"
        | "discordOAuth2Api"
        | "discordWebhookApi"
        | "discourseApi"
        | "disqusApi"
        | "githubApi"
        | "driftApi"
        | "driftOAuth2Api"
        | "dropboxApi"
        | "dropboxOAuth2Api"
        | "dropcontactApi"
        | "erpNextApi"
        | "egoiApi"
        | "elasticSecurityApi"
        | "elasticsearchApi"
        | "imap"
        | "smtp"
        | "azureOpenAiApi"
        | "cohereApi"
        | "googlePalmApi"
        | "googleApi"
        | "huggingFaceApi"
        | "mistralCloudApi"
        | "ollamaApi"
        | "openAiApi"
        | "emeliaApi"
        | "eventbriteApi"
        | "eventbriteOAuth2Api"
        | "facebookGraphApi"
        | "facebookLeadAdsOAuth2Api"
        | "facebookGraphAppApi"
        | "figmaApi"
        | "fileMaker"
        | "flowApi"
        | "formIoApi"
        | "formstackApi"
        | "formstackOAuth2Api"
        | "freshdeskApi"
        | "freshserviceApi"
        | "freshworksCrmApi"
        | "ftp"
        | "sftp"
        | "gSuiteAdminOAuth2Api"
        | "getResponseApi"
        | "getResponseOAuth2Api"
        | "ghostAdminApi"
        | "ghostContentApi"
        | "gitPassword"
        | "githubOAuth2Api"
        | "gitlabApi"
        | "gitlabOAuth2Api"
        | "gmailOAuth2"
        | "goToWebinarOAuth2Api"
        | "gongApi"
        | "gongOAuth2Api"
        | "googleAdsOAuth2Api"
        | "googleAnalyticsOAuth2"
        | "googleBigQueryOAuth2Api"
        | "googleBooksOAuth2Api"
        | "googleBusinessProfileOAuth2Api"
        | "googleCalendarOAuth2Api"
        | "googleChatOAuth2Api"
        | "googleCloudNaturalLanguageOAuth2Api"
        | "googleCloudStorageOAuth2Api"
        | "googleContactsOAuth2Api"
        | "googleDocsOAuth2Api"
        | "googleDriveOAuth2Api"
        | "googleFirebaseCloudFirestoreOAuth2Api"
        | "googleFirebaseRealtimeDatabaseOAuth2Api"
        | "googlePerspectiveOAuth2Api"
        | "googleSheetsTriggerOAuth2Api"
        | "googleSheetsOAuth2Api"
        | "googleSlidesOAuth2Api"
        | "googleTasksOAuth2Api"
        | "googleTranslateOAuth2Api"
        | "gotifyApi"
        | "grafanaApi"
        | "httpCustomAuth"
        | "httpDigestAuth"
        | "httpHeaderAuth"
        | "httpQueryAuth"
        | "oAuth1Api"
        | "oAuth2Api"
        | "gristApi"
        | "gumroadApi"
        | "haloPSAApi"
        | "harvestApi"
        | "harvestOAuth2Api"
        | "helpScoutOAuth2Api"
        | "highLevelApi"
        | "highLevelOAuth2Api"
        | "homeAssistantApi"
        | "azureEntraCognitiveServicesOAuth2Api"
        | "deepSeekApi"
        | "groqApi"
        | "milvusApi"
        | "motorheadApi"
        | "openRouterApi"
        | "pineconeApi"
        | "qdrantApi"
        | "searXngApi"
        | "serpApi"
        | "vercelAiGatewayApi"
        | "weaviateApi"
        | "wolframAlphaApi"
        | "xAiApi"
        | "xataApi"
        | "zepApi"
        | "alienVaultApi"
        | "amqp"
        | "auth0ManagementApi"
        | "carbonBlackApi"
        | "ciscoMerakiApi"
        | "ciscoSecureEndpointApi"
        | "ciscoUmbrellaApi"
        | "convertApi"
        | "crowdStrikeOAuth2Api"
        | "datadogApi"
        | "dfirIrisApi"
        | "dynatraceApi"
        | "f5BigIpApi"
        | "filescanApi"
        | "fortiGateApi"
        | "googleOAuth2Api"
        | "httpBearerAuth"
        | "httpSslAuth"
        | "hubspotApi"
        | "hubspotAppToken"
        | "hubspotDeveloperApi"
        | "hubspotOAuth2Api"
        | "humanticAiApi"
        | "hunterApi"
        | "hybridAnalysisApi"
        | "impervaWafApi"
        | "intercomApi"
        | "invoiceNinjaApi"
        | "iterableApi"
        | "jenkinsApi"
        | "jinaAiApi"
        | "jiraSoftwareCloudApi"
        | "jiraSoftwareServerApi"
        | "jiraSoftwareServerPatApi"
        | "jotFormApi"
        | "jwtAuth"
        | "kafka"
        | "keapOAuth2Api"
        | "kibanaApi"
        | "kitemakerApi"
        | "koBoToolboxApi"
        | "ldap"
        | "lemlistApi"
        | "lineNotifyOAuth2Api"
        | "linearApi"
        | "linearOAuth2Api"
        | "lingvaNexApi"
        | "linkedInCommunityManagementOAuth2Api"
        | "linkedInOAuth2Api"
        | "loneScaleApi"
        | "magento2Api"
        | "mailcheckApi"
        | "mailchimpApi"
        | "mailchimpOAuth2Api"
        | "mailerLiteApi"
        | "mailgunApi"
        | "mailjetEmailApi"
        | "mailjetSmsApi"
        | "malcoreApi"
        | "mandrillApi"
        | "marketstackApi"
        | "matrixApi"
        | "mattermostApi"
        | "mauticApi"
        | "mauticOAuth2Api"
        | "mediumApi"
        | "mediumOAuth2Api"
        | "messageBirdApi"
        | "metabaseApi"
        | "microsoftAzureMonitorOAuth2Api"
        | "microsoftDynamicsOAuth2Api"
        | "microsoftEntraOAuth2Api"
        | "microsoftExcelOAuth2Api"
        | "microsoftGraphSecurityOAuth2Api"
        | "microsoftOAuth2Api"
        | "microsoftOneDriveOAuth2Api"
        | "microsoftOutlookOAuth2Api"
        | "microsoftSharePointOAuth2Api"
        | "microsoftSql"
        | "microsoftTeamsOAuth2Api"
        | "microsoftToDoOAuth2Api"
        | "mindeeInvoiceApi"
        | "mindeeReceiptApi"
        | "miroOAuth2Api"
        | "mispApi"
        | "mistApi"
        | "moceanApi"
        | "mondayComApi"
        | "mondayComOAuth2Api"
        | "mongoDb"
        | "monicaCrmApi"
        | "mqtt"
        | "msg91Api"
        | "n8nApi"
        | "nasaApi"
        | "netlifyApi"
        | "citrixAdcApi"
        | "nextCloudApi"
        | "nextCloudOAuth2Api"
        | "nocoDb"
        | "nocoDbApiToken"
        | "notionApi"
        | "notionOAuth2Api"
        | "npmApi"
        | "odooApi"
        | "oktaApi"
        | "oneSimpleApi"
        | "onfleetApi"
        | "openCtiApi"
        | "openWeatherMapApi"
        | "orbitApi"
        | "ouraApi"
        | "paddleApi"
        | "pagerDutyApi"
        | "pagerDutyOAuth2Api"
        | "payPalApi"
        | "peekalinkApi"
        | "perplexityApi"
        | "phantombusterApi"
        | "philipsHueOAuth2Api"
        | "pipedriveApi"
        | "pipedriveOAuth2Api"
        | "plivoApi"
        | "postHogApi"
        | "postmarkApi"
        | "profitWellApi"
        | "pushbulletOAuth2Api"
        | "pushcutApi"
        | "pushoverApi"
        | "qRadarApi"
        | "qualysApi"
        | "questDb"
        | "quickbaseApi"
        | "quickBooksOAuth2Api"
        | "rabbitmq"
        | "raindropOAuth2Api"
        | "rapid7InsightVmApi"
        | "recordedFutureApi"
        | "redditOAuth2Api"
        | "redis"
        | "rocketchatApi"
        | "rundeckApi"
        | "s3"
        | "salesforceJwtApi"
        | "salesforceOAuth2Api"
        | "salesmateApi"
        | "seaTableApi"
        | "securityScorecardApi"
        | "segmentApi"
        | "sekoiaApi"
        | "sendGridApi"
        | "sendyApi"
        | "sentryIoApi"
        | "sentryIoOAuth2Api"
        | "sentryIoServerApi"
        | "serviceNowBasicApi"
        | "serviceNowOAuth2Api"
        | "shopifyAccessTokenApi"
        | "shopifyApi"
        | "shopifyOAuth2Api"
        | "shufflerApi"
        | "signl4Api"
        | "slackApi"
        | "slackOAuth2Api"
        | "sms77Api"
        | "snowflake"
        | "solarWindsIpamApi"
        | "solarWindsObservabilityApi"
        | "splunkApi"
        | "spontitApi"
        | "spotifyOAuth2Api"
        | "sshPassword"
        | "sshPrivateKey"
        | "stackbyApi"
        | "storyblokContentApi"
        | "storyblokManagementApi"
        | "strapiApi"
        | "strapiTokenApi"
        | "stravaOAuth2Api"
        | "stripeApi"
        | "supabaseApi"
        | "surveyMonkeyApi"
        | "surveyMonkeyOAuth2Api"
        | "syncroMspApi"
        | "sysdigApi"
        | "taigaApi"
        | "tapfiliateApi"
        | "telegramApi"
        | "theHiveApi"
        | "theHiveProjectApi"
        | "timescaleDb"
        | "todoistApi"
        | "todoistOAuth2Api"
        | "togglApi"
        | "totpApi"
        | "travisCiApi"
        | "trellixEpoApi"
        | "trelloApi"
        | "twakeCloudApi"
        | "twakeServerApi"
        | "twilioApi"
        | "twistOAuth2Api"
        | "twitterOAuth1Api"
        | "twitterOAuth2Api"
        | "typeformApi"
        | "typeformOAuth2Api"
        | "uprocApi"
        | "unleashedSoftwareApi"
        | "upleadApi"
        | "uptimeRobotApi"
        | "urlScanIoApi"
        | "venafiTlsProtectCloudApi"
        | "venafiTlsProtectDatacenterApi"
        | "veroApi"
        | "verticaApi"
        | "virusTotalApi"
        | "vonageApi"
        | "webflowApi"
        | "webflowOAuth2Api"
        | "wekanApi"
        | "whatsAppApi"
        | "whatsAppTriggerApi"
        | "wiseApi"
        | "wooCommerceApi"
        | "wordpressApi"
        | "workableApi"
        | "wufooApi"
        | "xeroOAuth2Api"
        | "youTubeOAuth2Api"
        | "yourlsApi"
        | "zabbixApi"
        | "zammadBasicAuthApi"
        | "zammadTokenAuthApi"
        | "zendeskApi"
        | "zendeskOAuth2Api"
        | "zohoOAuth2Api"
        | "zoomApi"
        | "zoomOAuth2Api"
        | "zscalerZiaApi"
        | "zulipApi";
    onlyContent?: boolean;
    optimizeResponse?: boolean;
    parametersBody?: {
        values: {
            name?: string;
            value?: string;
            valueProvider?: | "modelRequired"
            | "modelOptional"
            | "fieldValue";
        }[];
    };
    parametersHeaders?: {
        values: {
            name?: string;
            value?: string;
            valueProvider?: | "modelRequired"
            | "modelOptional"
            | "fieldValue";
        }[];
    };
    parametersQuery?: {
        values: {
            name?: string;
            value?: string;
            valueProvider?: | "modelRequired"
            | "modelOptional"
            | "fieldValue";
        }[];
    };
    placeholderDefinitions?: {
        values: {
            description?: string;
            name?: string;
            type?: | "string"
            | "number"
            | "boolean"
            | "json"
            | "not specified";
        }[];
    };
    responseType?: "json"
    | "text"
    | "html";
    sendBody?: boolean;
    sendHeaders?: boolean;
    sendQuery?: boolean;
    specifyBody?: "json" | "model" | "keypair";
    specifyHeaders?: "json" | "model" | "keypair";
    specifyQuery?: "json" | "model" | "keypair";
    toolDescription?: string;
    truncateResponse?: boolean;
    url?: string;
}

Properties§

Source§

readonly authentication?:
    | "none"
    | "predefinedCredentialType"
    | "genericCredentialType"

Select the type of authentication to use if needed, authentication would be done by n8n and your credentials will not be shared with the LLM Default: "none"

Source§

readonly cssSelector?: string

Select specific element(e.g. body) or multiple elements(e.g. div) of chosen type in the response HTML. Default: "body"

Source§

readonly dataField?: string

Specify the name of the field in the response containing the data

Source§

readonly elementsToOmit?: string

Comma-separated list of selectors that would be excluded when extracting content

Source§

readonly fields?: string

Comma-separated list of the field names. Supports dot notation. You can drag the selected fields from the input panel.

Source§

readonly fieldsToInclude?: "all" | "selected" | "except"

What fields response object should include Default: "all"

Source§

readonly genericAuthType?:
    | "actionNetworkApi"
    | "activeCampaignApi"
    | "acuitySchedulingApi"
    | "acuitySchedulingOAuth2Api"
    | "adaloApi"
    | "affinityApi"
    | "mySql"
    | "postgres"
    | "agileCrmApi"
    | "airtableApi"
    | "airtableTokenApi"
    | "airtableOAuth2Api"
    | "airtopApi"
    | "anthropicApi"
    | "apiTemplateIoApi"
    | "asanaApi"
    | "asanaOAuth2Api"
    | "automizyApi"
    | "autopilotApi"
    | "aws"
    | "microsoftAzureCosmosDbSharedKeyApi"
    | "azureStorageOAuth2Api"
    | "azureStorageSharedKeyApi"
    | "bambooHrApi"
    | "bannerbearApi"
    | "baserowApi"
    | "beeminderApi"
    | "beeminderOAuth2Api"
    | "bitbucketApi"
    | "bitlyApi"
    | "bitlyOAuth2Api"
    | "bitwardenApi"
    | "boxOAuth2Api"
    | "brandfetchApi"
    | "sendInBlueApi"
    | "bubbleApi"
    | "calApi"
    | "calendlyApi"
    | "calendlyOAuth2Api"
    | "chargebeeApi"
    | "httpBasicAuth"
    | "circleCiApi"
    | "ciscoWebexOAuth2Api"
    | "clearbitApi"
    | "clickUpApi"
    | "clickUpOAuth2Api"
    | "clockifyApi"
    | "cloudflareApi"
    | "cockpitApi"
    | "codaApi"
    | "contentfulApi"
    | "convertKitApi"
    | "copperApi"
    | "cortexApi"
    | "crateDb"
    | "crowdDevApi"
    | "customerIoApi"
    | "deepLApi"
    | "demioApi"
    | "dhlApi"
    | "discordBotApi"
    | "discordOAuth2Api"
    | "discordWebhookApi"
    | "discourseApi"
    | "disqusApi"
    | "githubApi"
    | "driftApi"
    | "driftOAuth2Api"
    | "dropboxApi"
    | "dropboxOAuth2Api"
    | "dropcontactApi"
    | "erpNextApi"
    | "egoiApi"
    | "elasticSecurityApi"
    | "elasticsearchApi"
    | "imap"
    | "smtp"
    | "azureOpenAiApi"
    | "cohereApi"
    | "googlePalmApi"
    | "googleApi"
    | "huggingFaceApi"
    | "mistralCloudApi"
    | "ollamaApi"
    | "openAiApi"
    | "emeliaApi"
    | "eventbriteApi"
    | "eventbriteOAuth2Api"
    | "facebookGraphApi"
    | "facebookLeadAdsOAuth2Api"
    | "facebookGraphAppApi"
    | "figmaApi"
    | "fileMaker"
    | "flowApi"
    | "formIoApi"
    | "formstackApi"
    | "formstackOAuth2Api"
    | "freshdeskApi"
    | "freshserviceApi"
    | "freshworksCrmApi"
    | "ftp"
    | "sftp"
    | "gSuiteAdminOAuth2Api"
    | "getResponseApi"
    | "getResponseOAuth2Api"
    | "ghostAdminApi"
    | "ghostContentApi"
    | "gitPassword"
    | "githubOAuth2Api"
    | "gitlabApi"
    | "gitlabOAuth2Api"
    | "gmailOAuth2"
    | "goToWebinarOAuth2Api"
    | "gongApi"
    | "gongOAuth2Api"
    | "googleAdsOAuth2Api"
    | "googleAnalyticsOAuth2"
    | "googleBigQueryOAuth2Api"
    | "googleBooksOAuth2Api"
    | "googleBusinessProfileOAuth2Api"
    | "googleCalendarOAuth2Api"
    | "googleChatOAuth2Api"
    | "googleCloudNaturalLanguageOAuth2Api"
    | "googleCloudStorageOAuth2Api"
    | "googleContactsOAuth2Api"
    | "googleDocsOAuth2Api"
    | "googleDriveOAuth2Api"
    | "googleFirebaseCloudFirestoreOAuth2Api"
    | "googleFirebaseRealtimeDatabaseOAuth2Api"
    | "googlePerspectiveOAuth2Api"
    | "googleSheetsTriggerOAuth2Api"
    | "googleSheetsOAuth2Api"
    | "googleSlidesOAuth2Api"
    | "googleTasksOAuth2Api"
    | "googleTranslateOAuth2Api"
    | "gotifyApi"
    | "grafanaApi"
    | "httpCustomAuth"
    | "httpDigestAuth"
    | "httpHeaderAuth"
    | "httpQueryAuth"
    | "oAuth1Api"
    | "oAuth2Api"
    | "gristApi"
    | "gumroadApi"
    | "haloPSAApi"
    | "harvestApi"
    | "harvestOAuth2Api"
    | "helpScoutOAuth2Api"
    | "highLevelApi"
    | "highLevelOAuth2Api"
    | "homeAssistantApi"
    | "azureEntraCognitiveServicesOAuth2Api"
    | "deepSeekApi"
    | "groqApi"
    | "milvusApi"
    | "motorheadApi"
    | "openRouterApi"
    | "pineconeApi"
    | "qdrantApi"
    | "searXngApi"
    | "serpApi"
    | "vercelAiGatewayApi"
    | "weaviateApi"
    | "wolframAlphaApi"
    | "xAiApi"
    | "xataApi"
    | "zepApi"
    | "alienVaultApi"
    | "amqp"
    | "auth0ManagementApi"
    | "carbonBlackApi"
    | "ciscoMerakiApi"
    | "ciscoSecureEndpointApi"
    | "ciscoUmbrellaApi"
    | "convertApi"
    | "crowdStrikeOAuth2Api"
    | "datadogApi"
    | "dfirIrisApi"
    | "dynatraceApi"
    | "f5BigIpApi"
    | "filescanApi"
    | "fortiGateApi"
    | "googleOAuth2Api"
    | "httpBearerAuth"
    | "httpSslAuth"
    | "hubspotApi"
    | "hubspotAppToken"
    | "hubspotDeveloperApi"
    | "hubspotOAuth2Api"
    | "humanticAiApi"
    | "hunterApi"
    | "hybridAnalysisApi"
    | "impervaWafApi"
    | "intercomApi"
    | "invoiceNinjaApi"
    | "iterableApi"
    | "jenkinsApi"
    | "jinaAiApi"
    | "jiraSoftwareCloudApi"
    | "jiraSoftwareServerApi"
    | "jiraSoftwareServerPatApi"
    | "jotFormApi"
    | "jwtAuth"
    | "kafka"
    | "keapOAuth2Api"
    | "kibanaApi"
    | "kitemakerApi"
    | "koBoToolboxApi"
    | "ldap"
    | "lemlistApi"
    | "lineNotifyOAuth2Api"
    | "linearApi"
    | "linearOAuth2Api"
    | "lingvaNexApi"
    | "linkedInCommunityManagementOAuth2Api"
    | "linkedInOAuth2Api"
    | "loneScaleApi"
    | "magento2Api"
    | "mailcheckApi"
    | "mailchimpApi"
    | "mailchimpOAuth2Api"
    | "mailerLiteApi"
    | "mailgunApi"
    | "mailjetEmailApi"
    | "mailjetSmsApi"
    | "malcoreApi"
    | "mandrillApi"
    | "marketstackApi"
    | "matrixApi"
    | "mattermostApi"
    | "mauticApi"
    | "mauticOAuth2Api"
    | "mediumApi"
    | "mediumOAuth2Api"
    | "messageBirdApi"
    | "metabaseApi"
    | "microsoftAzureMonitorOAuth2Api"
    | "microsoftDynamicsOAuth2Api"
    | "microsoftEntraOAuth2Api"
    | "microsoftExcelOAuth2Api"
    | "microsoftGraphSecurityOAuth2Api"
    | "microsoftOAuth2Api"
    | "microsoftOneDriveOAuth2Api"
    | "microsoftOutlookOAuth2Api"
    | "microsoftSharePointOAuth2Api"
    | "microsoftSql"
    | "microsoftTeamsOAuth2Api"
    | "microsoftToDoOAuth2Api"
    | "mindeeInvoiceApi"
    | "mindeeReceiptApi"
    | "miroOAuth2Api"
    | "mispApi"
    | "mistApi"
    | "moceanApi"
    | "mondayComApi"
    | "mondayComOAuth2Api"
    | "mongoDb"
    | "monicaCrmApi"
    | "mqtt"
    | "msg91Api"
    | "n8nApi"
    | "nasaApi"
    | "netlifyApi"
    | "citrixAdcApi"
    | "nextCloudApi"
    | "nextCloudOAuth2Api"
    | "nocoDb"
    | "nocoDbApiToken"
    | "notionApi"
    | "notionOAuth2Api"
    | "npmApi"
    | "odooApi"
    | "oktaApi"
    | "oneSimpleApi"
    | "onfleetApi"
    | "openCtiApi"
    | "openWeatherMapApi"
    | "orbitApi"
    | "ouraApi"
    | "paddleApi"
    | "pagerDutyApi"
    | "pagerDutyOAuth2Api"
    | "payPalApi"
    | "peekalinkApi"
    | "perplexityApi"
    | "phantombusterApi"
    | "philipsHueOAuth2Api"
    | "pipedriveApi"
    | "pipedriveOAuth2Api"
    | "plivoApi"
    | "postHogApi"
    | "postmarkApi"
    | "profitWellApi"
    | "pushbulletOAuth2Api"
    | "pushcutApi"
    | "pushoverApi"
    | "qRadarApi"
    | "qualysApi"
    | "questDb"
    | "quickbaseApi"
    | "quickBooksOAuth2Api"
    | "rabbitmq"
    | "raindropOAuth2Api"
    | "rapid7InsightVmApi"
    | "recordedFutureApi"
    | "redditOAuth2Api"
    | "redis"
    | "rocketchatApi"
    | "rundeckApi"
    | "s3"
    | "salesforceJwtApi"
    | "salesforceOAuth2Api"
    | "salesmateApi"
    | "seaTableApi"
    | "securityScorecardApi"
    | "segmentApi"
    | "sekoiaApi"
    | "sendGridApi"
    | "sendyApi"
    | "sentryIoApi"
    | "sentryIoOAuth2Api"
    | "sentryIoServerApi"
    | "serviceNowBasicApi"
    | "serviceNowOAuth2Api"
    | "shopifyAccessTokenApi"
    | "shopifyApi"
    | "shopifyOAuth2Api"
    | "shufflerApi"
    | "signl4Api"
    | "slackApi"
    | "slackOAuth2Api"
    | "sms77Api"
    | "snowflake"
    | "solarWindsIpamApi"
    | "solarWindsObservabilityApi"
    | "splunkApi"
    | "spontitApi"
    | "spotifyOAuth2Api"
    | "sshPassword"
    | "sshPrivateKey"
    | "stackbyApi"
    | "storyblokContentApi"
    | "storyblokManagementApi"
    | "strapiApi"
    | "strapiTokenApi"
    | "stravaOAuth2Api"
    | "stripeApi"
    | "supabaseApi"
    | "surveyMonkeyApi"
    | "surveyMonkeyOAuth2Api"
    | "syncroMspApi"
    | "sysdigApi"
    | "taigaApi"
    | "tapfiliateApi"
    | "telegramApi"
    | "theHiveApi"
    | "theHiveProjectApi"
    | "timescaleDb"
    | "todoistApi"
    | "todoistOAuth2Api"
    | "togglApi"
    | "totpApi"
    | "travisCiApi"
    | "trellixEpoApi"
    | "trelloApi"
    | "twakeCloudApi"
    | "twakeServerApi"
    | "twilioApi"
    | "twistOAuth2Api"
    | "twitterOAuth1Api"
    | "twitterOAuth2Api"
    | "typeformApi"
    | "typeformOAuth2Api"
    | "uprocApi"
    | "unleashedSoftwareApi"
    | "upleadApi"
    | "uptimeRobotApi"
    | "urlScanIoApi"
    | "venafiTlsProtectCloudApi"
    | "venafiTlsProtectDatacenterApi"
    | "veroApi"
    | "verticaApi"
    | "virusTotalApi"
    | "vonageApi"
    | "webflowApi"
    | "webflowOAuth2Api"
    | "wekanApi"
    | "whatsAppApi"
    | "whatsAppTriggerApi"
    | "wiseApi"
    | "wooCommerceApi"
    | "wordpressApi"
    | "workableApi"
    | "wufooApi"
    | "xeroOAuth2Api"
    | "youTubeOAuth2Api"
    | "yourlsApi"
    | "zabbixApi"
    | "zammadBasicAuthApi"
    | "zammadTokenAuthApi"
    | "zendeskApi"
    | "zendeskOAuth2Api"
    | "zohoOAuth2Api"
    | "zoomApi"
    | "zoomOAuth2Api"
    | "zscalerZiaApi"
    | "zulipApi"

Source§

readonly jsonBody?: string

Type options: {"rows":5}

Source§

readonly jsonHeaders?: string

Type options: {"rows":5}

Source§

readonly jsonQuery?: string

Type options: {"rows":5}

Source§

readonly maxLength?: number

Default: 1000 Type options: {"minValue":1}

Source§

readonly method?: "GET" | "POST" | "DELETE" | "PATCH" | "PUT"

Default: "GET"

Source§

readonly nodeCredentialType?:
    | "actionNetworkApi"
    | "activeCampaignApi"
    | "acuitySchedulingApi"
    | "acuitySchedulingOAuth2Api"
    | "adaloApi"
    | "affinityApi"
    | "mySql"
    | "postgres"
    | "agileCrmApi"
    | "airtableApi"
    | "airtableTokenApi"
    | "airtableOAuth2Api"
    | "airtopApi"
    | "anthropicApi"
    | "apiTemplateIoApi"
    | "asanaApi"
    | "asanaOAuth2Api"
    | "automizyApi"
    | "autopilotApi"
    | "aws"
    | "microsoftAzureCosmosDbSharedKeyApi"
    | "azureStorageOAuth2Api"
    | "azureStorageSharedKeyApi"
    | "bambooHrApi"
    | "bannerbearApi"
    | "baserowApi"
    | "beeminderApi"
    | "beeminderOAuth2Api"
    | "bitbucketApi"
    | "bitlyApi"
    | "bitlyOAuth2Api"
    | "bitwardenApi"
    | "boxOAuth2Api"
    | "brandfetchApi"
    | "sendInBlueApi"
    | "bubbleApi"
    | "calApi"
    | "calendlyApi"
    | "calendlyOAuth2Api"
    | "chargebeeApi"
    | "httpBasicAuth"
    | "circleCiApi"
    | "ciscoWebexOAuth2Api"
    | "clearbitApi"
    | "clickUpApi"
    | "clickUpOAuth2Api"
    | "clockifyApi"
    | "cloudflareApi"
    | "cockpitApi"
    | "codaApi"
    | "contentfulApi"
    | "convertKitApi"
    | "copperApi"
    | "cortexApi"
    | "crateDb"
    | "crowdDevApi"
    | "customerIoApi"
    | "deepLApi"
    | "demioApi"
    | "dhlApi"
    | "discordBotApi"
    | "discordOAuth2Api"
    | "discordWebhookApi"
    | "discourseApi"
    | "disqusApi"
    | "githubApi"
    | "driftApi"
    | "driftOAuth2Api"
    | "dropboxApi"
    | "dropboxOAuth2Api"
    | "dropcontactApi"
    | "erpNextApi"
    | "egoiApi"
    | "elasticSecurityApi"
    | "elasticsearchApi"
    | "imap"
    | "smtp"
    | "azureOpenAiApi"
    | "cohereApi"
    | "googlePalmApi"
    | "googleApi"
    | "huggingFaceApi"
    | "mistralCloudApi"
    | "ollamaApi"
    | "openAiApi"
    | "emeliaApi"
    | "eventbriteApi"
    | "eventbriteOAuth2Api"
    | "facebookGraphApi"
    | "facebookLeadAdsOAuth2Api"
    | "facebookGraphAppApi"
    | "figmaApi"
    | "fileMaker"
    | "flowApi"
    | "formIoApi"
    | "formstackApi"
    | "formstackOAuth2Api"
    | "freshdeskApi"
    | "freshserviceApi"
    | "freshworksCrmApi"
    | "ftp"
    | "sftp"
    | "gSuiteAdminOAuth2Api"
    | "getResponseApi"
    | "getResponseOAuth2Api"
    | "ghostAdminApi"
    | "ghostContentApi"
    | "gitPassword"
    | "githubOAuth2Api"
    | "gitlabApi"
    | "gitlabOAuth2Api"
    | "gmailOAuth2"
    | "goToWebinarOAuth2Api"
    | "gongApi"
    | "gongOAuth2Api"
    | "googleAdsOAuth2Api"
    | "googleAnalyticsOAuth2"
    | "googleBigQueryOAuth2Api"
    | "googleBooksOAuth2Api"
    | "googleBusinessProfileOAuth2Api"
    | "googleCalendarOAuth2Api"
    | "googleChatOAuth2Api"
    | "googleCloudNaturalLanguageOAuth2Api"
    | "googleCloudStorageOAuth2Api"
    | "googleContactsOAuth2Api"
    | "googleDocsOAuth2Api"
    | "googleDriveOAuth2Api"
    | "googleFirebaseCloudFirestoreOAuth2Api"
    | "googleFirebaseRealtimeDatabaseOAuth2Api"
    | "googlePerspectiveOAuth2Api"
    | "googleSheetsTriggerOAuth2Api"
    | "googleSheetsOAuth2Api"
    | "googleSlidesOAuth2Api"
    | "googleTasksOAuth2Api"
    | "googleTranslateOAuth2Api"
    | "gotifyApi"
    | "grafanaApi"
    | "httpCustomAuth"
    | "httpDigestAuth"
    | "httpHeaderAuth"
    | "httpQueryAuth"
    | "oAuth1Api"
    | "oAuth2Api"
    | "gristApi"
    | "gumroadApi"
    | "haloPSAApi"
    | "harvestApi"
    | "harvestOAuth2Api"
    | "helpScoutOAuth2Api"
    | "highLevelApi"
    | "highLevelOAuth2Api"
    | "homeAssistantApi"
    | "azureEntraCognitiveServicesOAuth2Api"
    | "deepSeekApi"
    | "groqApi"
    | "milvusApi"
    | "motorheadApi"
    | "openRouterApi"
    | "pineconeApi"
    | "qdrantApi"
    | "searXngApi"
    | "serpApi"
    | "vercelAiGatewayApi"
    | "weaviateApi"
    | "wolframAlphaApi"
    | "xAiApi"
    | "xataApi"
    | "zepApi"
    | "alienVaultApi"
    | "amqp"
    | "auth0ManagementApi"
    | "carbonBlackApi"
    | "ciscoMerakiApi"
    | "ciscoSecureEndpointApi"
    | "ciscoUmbrellaApi"
    | "convertApi"
    | "crowdStrikeOAuth2Api"
    | "datadogApi"
    | "dfirIrisApi"
    | "dynatraceApi"
    | "f5BigIpApi"
    | "filescanApi"
    | "fortiGateApi"
    | "googleOAuth2Api"
    | "httpBearerAuth"
    | "httpSslAuth"
    | "hubspotApi"
    | "hubspotAppToken"
    | "hubspotDeveloperApi"
    | "hubspotOAuth2Api"
    | "humanticAiApi"
    | "hunterApi"
    | "hybridAnalysisApi"
    | "impervaWafApi"
    | "intercomApi"
    | "invoiceNinjaApi"
    | "iterableApi"
    | "jenkinsApi"
    | "jinaAiApi"
    | "jiraSoftwareCloudApi"
    | "jiraSoftwareServerApi"
    | "jiraSoftwareServerPatApi"
    | "jotFormApi"
    | "jwtAuth"
    | "kafka"
    | "keapOAuth2Api"
    | "kibanaApi"
    | "kitemakerApi"
    | "koBoToolboxApi"
    | "ldap"
    | "lemlistApi"
    | "lineNotifyOAuth2Api"
    | "linearApi"
    | "linearOAuth2Api"
    | "lingvaNexApi"
    | "linkedInCommunityManagementOAuth2Api"
    | "linkedInOAuth2Api"
    | "loneScaleApi"
    | "magento2Api"
    | "mailcheckApi"
    | "mailchimpApi"
    | "mailchimpOAuth2Api"
    | "mailerLiteApi"
    | "mailgunApi"
    | "mailjetEmailApi"
    | "mailjetSmsApi"
    | "malcoreApi"
    | "mandrillApi"
    | "marketstackApi"
    | "matrixApi"
    | "mattermostApi"
    | "mauticApi"
    | "mauticOAuth2Api"
    | "mediumApi"
    | "mediumOAuth2Api"
    | "messageBirdApi"
    | "metabaseApi"
    | "microsoftAzureMonitorOAuth2Api"
    | "microsoftDynamicsOAuth2Api"
    | "microsoftEntraOAuth2Api"
    | "microsoftExcelOAuth2Api"
    | "microsoftGraphSecurityOAuth2Api"
    | "microsoftOAuth2Api"
    | "microsoftOneDriveOAuth2Api"
    | "microsoftOutlookOAuth2Api"
    | "microsoftSharePointOAuth2Api"
    | "microsoftSql"
    | "microsoftTeamsOAuth2Api"
    | "microsoftToDoOAuth2Api"
    | "mindeeInvoiceApi"
    | "mindeeReceiptApi"
    | "miroOAuth2Api"
    | "mispApi"
    | "mistApi"
    | "moceanApi"
    | "mondayComApi"
    | "mondayComOAuth2Api"
    | "mongoDb"
    | "monicaCrmApi"
    | "mqtt"
    | "msg91Api"
    | "n8nApi"
    | "nasaApi"
    | "netlifyApi"
    | "citrixAdcApi"
    | "nextCloudApi"
    | "nextCloudOAuth2Api"
    | "nocoDb"
    | "nocoDbApiToken"
    | "notionApi"
    | "notionOAuth2Api"
    | "npmApi"
    | "odooApi"
    | "oktaApi"
    | "oneSimpleApi"
    | "onfleetApi"
    | "openCtiApi"
    | "openWeatherMapApi"
    | "orbitApi"
    | "ouraApi"
    | "paddleApi"
    | "pagerDutyApi"
    | "pagerDutyOAuth2Api"
    | "payPalApi"
    | "peekalinkApi"
    | "perplexityApi"
    | "phantombusterApi"
    | "philipsHueOAuth2Api"
    | "pipedriveApi"
    | "pipedriveOAuth2Api"
    | "plivoApi"
    | "postHogApi"
    | "postmarkApi"
    | "profitWellApi"
    | "pushbulletOAuth2Api"
    | "pushcutApi"
    | "pushoverApi"
    | "qRadarApi"
    | "qualysApi"
    | "questDb"
    | "quickbaseApi"
    | "quickBooksOAuth2Api"
    | "rabbitmq"
    | "raindropOAuth2Api"
    | "rapid7InsightVmApi"
    | "recordedFutureApi"
    | "redditOAuth2Api"
    | "redis"
    | "rocketchatApi"
    | "rundeckApi"
    | "s3"
    | "salesforceJwtApi"
    | "salesforceOAuth2Api"
    | "salesmateApi"
    | "seaTableApi"
    | "securityScorecardApi"
    | "segmentApi"
    | "sekoiaApi"
    | "sendGridApi"
    | "sendyApi"
    | "sentryIoApi"
    | "sentryIoOAuth2Api"
    | "sentryIoServerApi"
    | "serviceNowBasicApi"
    | "serviceNowOAuth2Api"
    | "shopifyAccessTokenApi"
    | "shopifyApi"
    | "shopifyOAuth2Api"
    | "shufflerApi"
    | "signl4Api"
    | "slackApi"
    | "slackOAuth2Api"
    | "sms77Api"
    | "snowflake"
    | "solarWindsIpamApi"
    | "solarWindsObservabilityApi"
    | "splunkApi"
    | "spontitApi"
    | "spotifyOAuth2Api"
    | "sshPassword"
    | "sshPrivateKey"
    | "stackbyApi"
    | "storyblokContentApi"
    | "storyblokManagementApi"
    | "strapiApi"
    | "strapiTokenApi"
    | "stravaOAuth2Api"
    | "stripeApi"
    | "supabaseApi"
    | "surveyMonkeyApi"
    | "surveyMonkeyOAuth2Api"
    | "syncroMspApi"
    | "sysdigApi"
    | "taigaApi"
    | "tapfiliateApi"
    | "telegramApi"
    | "theHiveApi"
    | "theHiveProjectApi"
    | "timescaleDb"
    | "todoistApi"
    | "todoistOAuth2Api"
    | "togglApi"
    | "totpApi"
    | "travisCiApi"
    | "trellixEpoApi"
    | "trelloApi"
    | "twakeCloudApi"
    | "twakeServerApi"
    | "twilioApi"
    | "twistOAuth2Api"
    | "twitterOAuth1Api"
    | "twitterOAuth2Api"
    | "typeformApi"
    | "typeformOAuth2Api"
    | "uprocApi"
    | "unleashedSoftwareApi"
    | "upleadApi"
    | "uptimeRobotApi"
    | "urlScanIoApi"
    | "venafiTlsProtectCloudApi"
    | "venafiTlsProtectDatacenterApi"
    | "veroApi"
    | "verticaApi"
    | "virusTotalApi"
    | "vonageApi"
    | "webflowApi"
    | "webflowOAuth2Api"
    | "wekanApi"
    | "whatsAppApi"
    | "whatsAppTriggerApi"
    | "wiseApi"
    | "wooCommerceApi"
    | "wordpressApi"
    | "workableApi"
    | "wufooApi"
    | "xeroOAuth2Api"
    | "youTubeOAuth2Api"
    | "yourlsApi"
    | "zabbixApi"
    | "zammadBasicAuthApi"
    | "zammadTokenAuthApi"
    | "zendeskApi"
    | "zendeskOAuth2Api"
    | "zohoOAuth2Api"
    | "zoomApi"
    | "zoomOAuth2Api"
    | "zscalerZiaApi"
    | "zulipApi"

Source§

readonly onlyContent?: boolean

Whether to return only content of html elements, stripping html tags and attributes

Source§

readonly optimizeResponse?: boolean

Whether the optimize the tool response to reduce amount of data passed to the LLM that could lead to better result and reduce cost

Source§

readonly parametersBody?: {
    values: {
        name?: string;
        value?: string;
        valueProvider?:
            | "modelRequired"
            | "modelOptional"
            | "fieldValue";
    }[];
}

Default: {"values":[{"name":""}]} Type options: {"multipleValues":true}

Source§

readonly parametersHeaders?: {
    values: {
        name?: string;
        value?: string;
        valueProvider?:
            | "modelRequired"
            | "modelOptional"
            | "fieldValue";
    }[];
}

Default: {"values":[{"name":""}]} Type options: {"multipleValues":true}

Source§

readonly parametersQuery?: {
    values: {
        name?: string;
        value?: string;
        valueProvider?:
            | "modelRequired"
            | "modelOptional"
            | "fieldValue";
    }[];
}

Default: {"values":[{"name":""}]} Type options: {"multipleValues":true}

Source§

readonly placeholderDefinitions?: {
    values: {
        description?: string;
        name?: string;
        type?:
            | "string"
            | "number"
            | "boolean"
            | "json"
            | "not specified";
    }[];
}

Default: [] Type options: {"multipleValues":true}

Source§

readonly responseType?: "json" | "text" | "html"

Default: "json"

Source§

readonly sendBody?: boolean

Whether the request has body or not

Source§

readonly sendHeaders?: boolean

Whether the request has headers or not

Source§

readonly sendQuery?: boolean

Whether the request has query params or not

Source§

readonly specifyBody?: "json" | "model" | "keypair"

Default: "keypair"

Source§

readonly specifyHeaders?: "json" | "model" | "keypair"

Default: "keypair"

Source§

readonly specifyQuery?: "json" | "model" | "keypair"

Default: "keypair"

Source§

readonly toolDescription?: string

Explain to LLM what this tool does, better description would allow LLM to produce expected result Type options: {"rows":3}

Source§

readonly truncateResponse?: boolean

Source§

readonly url?: string