Chat using Functions with OpenAI (ChatGPT) API on Exchange Rate Updated from CurrencyScoop API

Pipedream makes it easy to connect APIs for OpenAI (ChatGPT), CurrencyScoop and 2,500+ other apps remarkably fast.

Trigger workflow on

Exchange Rate Updated from the CurrencyScoop API

Next, do this

Chat using Functions with the OpenAI (ChatGPT) API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

Getting Started#

This integration creates a workflow with a CurrencyScoop trigger and OpenAI (ChatGPT) action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the Exchange Rate Updated trigger
1. Connect your CurrencyScoop account
2. Configure timer
3. Select a Base Currency
4. Select a Target Currency
5. Optional- Configure Threshold
Configure the Chat using Functions action
1. Connect your OpenAI (ChatGPT) account
2. Configure alert
3. Select a Model
4. Configure Chat Input
5. Configure Functions
6. Optional- Configure Instructions
7. Optional- Select a Tool Choice
8. Optional- Configure Parallel Function Calling
9. Optional- Configure Previous Response ID
10. Optional- Select a Truncation
11. Optional- Select a Response Format
12. Optional- Configure Skip This Step
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Details#

This integration uses pre-built, source-available components from Pipedream's GitHub repo. These components are developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

Trigger#

Exchange Rate Updated on CurrencyScoop

Description:Emit new event when the exchange rate for a currency is updated [See the documentation](https://currencybeacon.com/api-documentation)

Version:0.0.1

Key:currencyscoop-exchange-rate-updated

View on GitHub

CurrencyScoop Overview#

The CurrencyScoop API offers real-time and historical exchange rate data, as well as currency conversion and time-series data. By integrating with Pipedream, users can create automated workflows that react to currency fluctuations, update pricing in their apps, or generate financial reports. Pipedream's serverless architecture enables running these workflows on a schedule or in response to certain triggers without managing any infrastructure.

Trigger Code#

import { defineSource } from "@pipedream/types";
import app from "../../app/currencyscoop.app.mjs";
import { DEFAULT_POLLING_SOURCE_TIMER_INTERVAL } from "@pipedream/platform";
export default defineSource({
    key: "currencyscoop-exchange-rate-updated",
    name: "Exchange Rate Updated",
    description: "Emit new event when the exchange rate for a currency is updated [See the documentation](https://currencybeacon.com/api-documentation)",
    version: "0.0.1",
    type: "source",
    dedupe: "unique",
    props: {
        app,
        timer: {
            type: "$.interface.timer",
            default: {
                intervalSeconds: DEFAULT_POLLING_SOURCE_TIMER_INTERVAL,
            },
        },
        db: "$.service.db",
        base: {
            propDefinition: [
                app,
                "currency",
            ],
        },
        targetCurrency: {
            propDefinition: [
                app,
                "targetCurrency",
            ],
        },
        threshold: {
            type: "string",
            label: "Threshold",
            description: "If specified, a new event will only be emitted when the rate has changed by at least this amount since the last event. For example, if `Threshold` is **0.2** and the initial rate obtained is **3.0**, a new event will only be emitted when it reaches **2.8** or **3.2**.",
            optional: true,
        },
    },
    hooks: {
        async deploy() {
            await this.getAndProcessData();
        },
    },
    methods: {
        setLastValue(value) {
            this.db.set("lastValue", value);
        },
        getLastValue() {
            return this.db.get("lastValue");
        },
        setLastConfig(value) {
            this.db.set("lastConfig", value);
        },
        getLastConfig() {
            return this.db.get("lastConfig");
        },
        async getAndProcessData() {
            const { base, targetCurrency, threshold, } = this;
            const params = {
                $: this,
                params: {
                    base,
                    symbols: targetCurrency,
                },
            };
            const response = await this.app.getLatestRates(params);
            const { response: { rates } } = response;
            const value = rates[targetCurrency];
            const currentConfig = [
                base,
                targetCurrency,
            ].join();
            const lastConfig = this.getLastConfig();
            if (currentConfig === lastConfig) {
                const lastValue = this.getLastValue();
                if (lastValue) {
                    const variation = Math.abs(value - lastValue);
                    if (!variation || (threshold && variation < Math.abs(Number(threshold))))
                        return;
                }
            }
            this.setLastConfig(currentConfig);
            this.setLastValue(value);
            this.emitEvent(response);
        },
        emitEvent(data) {
            const { response: { date: ts, base, rates, }, } = data;
            const [name, amount,] = Object.entries(rates)[0];
            this.$emit(data, {
                id: ts,
                summary: `New rate: 1 ${base} = ${amount} ${name}`,
                ts,
            });
        },
    },
    async run() {
        await this.getAndProcessData();
    },
});

Trigger Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.

Label	Prop	Type	Description
CurrencyScoop	`app`	`app`	This component uses the CurrencyScoop app.
	`timer`	`$.interface.timer`
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
Base Currency	`base`	`string`	Select a value from the drop down menu:`{ "label": "United Arab Emirates dirham", "value": "AED" }{ "label": "Afghan afghani", "value": "AFN" }{ "label": "Albanian lek", "value": "ALL" }{ "label": "Armenian dram", "value": "AMD" }{ "label": "Netherlands Antillean guilder", "value": "ANG" }{ "label": "Angolan kwanza", "value": "AOA" }{ "label": "Argentine peso", "value": "ARS" }{ "label": "Australian dollar", "value": "AUD" }{ "label": "Aruban florin", "value": "AWG" }{ "label": "Azerbaijani manat", "value": "AZN" }{ "label": "Bosnia and Herzegovina convertible mark", "value": "BAM" }{ "label": "Barbados dollar", "value": "BBD" }{ "label": "Bangladeshi taka", "value": "BDT" }{ "label": "Bulgarian lev", "value": "BGN" }{ "label": "Bahraini dinar", "value": "BHD" }{ "label": "Burundian franc", "value": "BIF" }{ "label": "Bermudian dollar", "value": "BMD" }{ "label": "Brunei dollar", "value": "BND" }{ "label": "Boliviano", "value": "BOB" }{ "label": "Brazilian real", "value": "BRL" }{ "label": "Bahamian dollar", "value": "BSD" }{ "label": "Bhutanese ngultrum", "value": "BTN" }{ "label": "Botswana pula", "value": "BWP" }{ "label": "Belarusian ruble", "value": "BYN" }{ "label": "Belize dollar", "value": "BZD" }{ "label": "Canadian dollar", "value": "CAD" }{ "label": "Congolese franc", "value": "CDF" }{ "label": "Swiss franc", "value": "CHF" }{ "label": "Unidad de Fomento (funds code)", "value": "CLF" }{ "label": "Chilean peso", "value": "CLP" }{ "label": "Renminbi (Chinese) yuan", "value": "CNY" }{ "label": "Colombian peso", "value": "COP" }{ "label": "Costa Rican colon", "value": "CRC" }{ "label": "Cuban convertible peso", "value": "CUC" }{ "label": "Cuban peso", "value": "CUP" }{ "label": "Cape Verdean escudo", "value": "CVE" }{ "label": "Czech koruna", "value": "CZK" }{ "label": "Djiboutian franc", "value": "DJF" }{ "label": "Danish krone", "value": "DKK" }{ "label": "Dominican peso", "value": "DOP" }{ "label": "Algerian dinar", "value": "DZD" }{ "label": "Egyptian pound", "value": "EGP" }{ "label": "Eritrean nakfa", "value": "ERN" }{ "label": "Ethiopian birr", "value": "ETB" }{ "label": "Euro", "value": "EUR" }{ "label": "Fiji dollar", "value": "FJD" }{ "label": "Falkland Islands pound", "value": "FKP" }{ "label": "Pound sterling", "value": "GBP" }{ "label": "Georgian lari", "value": "GEL" }{ "label": "Ghanaian cedi", "value": "GHS" }{ "label": "Gibraltar pound", "value": "GIP" }{ "label": "Gambian dalasi", "value": "GMD" }{ "label": "Guinean franc", "value": "GNF" }{ "label": "Guatemalan quetzal", "value": "GTQ" }{ "label": "Guyanese dollar", "value": "GYD" }{ "label": "Hong Kong dollar", "value": "HKD" }{ "label": "Honduran lempira", "value": "HNL" }{ "label": "Croatian kuna", "value": "HRK" }{ "label": "Haitian gourde", "value": "HTG" }{ "label": "Hungarian forint", "value": "HUF" }{ "label": "Indonesian rupiah", "value": "IDR" }{ "label": "Israeli new shekel", "value": "ILS" }{ "label": "Indian rupee", "value": "INR" }{ "label": "Iraqi dinar", "value": "IQD" }{ "label": "Iranian rial", "value": "IRR" }{ "label": "Icelandic króna", "value": "ISK" }{ "label": "Jamaican dollar", "value": "JMD" }{ "label": "Jordanian dinar", "value": "JOD" }{ "label": "Japanese yen", "value": "JPY" }{ "label": "Kenyan shilling", "value": "KES" }{ "label": "Kyrgyzstani som", "value": "KGS" }{ "label": "Cambodian riel", "value": "KHR" }{ "label": "Comoro franc", "value": "KMF" }{ "label": "North Korean won", "value": "KPW" }{ "label": "South Korean won", "value": "KRW" }{ "label": "Kuwaiti dinar", "value": "KWD" }{ "label": "Cayman Islands dollar", "value": "KYD" }{ "label": "Kazakhstani tenge", "value": "KZT" }{ "label": "Lao kip", "value": "LAK" }{ "label": "Lebanese pound", "value": "LBP" }{ "label": "Sri Lankan rupee", "value": "LKR" }{ "label": "Liberian dollar", "value": "LRD" }{ "label": "Lesotho loti", "value": "LSL" }{ "label": "Libyan dinar", "value": "LYD" }{ "label": "Moroccan dirham", "value": "MAD" }{ "label": "Moldovan leu", "value": "MDL" }{ "label": "Malagasy ariary", "value": "MGA" }{ "label": "Macedonian denar", "value": "MKD" }{ "label": "Myanmar kyat", "value": "MMK" }{ "label": "Mongolian tögrög", "value": "MNT" }{ "label": "Macanese pataca", "value": "MOP" }{ "label": "Mauritanian ouguiya", "value": "MRU" }{ "label": "Mauritian rupee", "value": "MUR" }{ "label": "Maldivian rufiyaa", "value": "MVR" }{ "label": "Malawian kwacha", "value": "MWK" }{ "label": "Mexican peso", "value": "MXN" }{ "label": "Mexican Unidad de Inversion (UDI) (funds code)", "value": "MXV" }{ "label": "Malaysian ringgit", "value": "MYR" }{ "label": "Mozambican metical", "value": "MZN" }{ "label": "Namibian dollar", "value": "NAD" }{ "label": "Nigerian naira", "value": "NGN" }{ "label": "Nicaraguan córdoba", "value": "NIO" }{ "label": "Norwegian krone", "value": "NOK" }{ "label": "Nepalese rupee", "value": "NPR" }{ "label": "New Zealand dollar", "value": "NZD" }{ "label": "Omani rial", "value": "OMR" }{ "label": "Panamanian balboa", "value": "PAB" }{ "label": "Peruvian sol", "value": "PEN" }{ "label": "Papua New Guinean kina", "value": "PGK" }{ "label": "Philippine peso[13]", "value": "PHP" }{ "label": "Pakistani rupee", "value": "PKR" }{ "label": "Polish złoty", "value": "PLN" }{ "label": "Paraguayan guaraní", "value": "PYG" }{ "label": "Qatari riyal", "value": "QAR" }{ "label": "Romanian leu", "value": "RON" }{ "label": "Serbian dinar", "value": "RSD" }{ "label": "Russian ruble", "value": "RUB" }{ "label": "Rwandan franc", "value": "RWF" }{ "label": "Saudi riyal", "value": "SAR" }{ "label": "Solomon Islands dollar", "value": "SBD" }{ "label": "Seychelles rupee", "value": "SCR" }{ "label": "Sudanese pound", "value": "SDG" }{ "label": "Swedish krona/kronor", "value": "SEK" }{ "label": "Singapore dollar", "value": "SGD" }{ "label": "Saint Helena pound", "value": "SHP" }{ "label": "Sierra Leonean leone", "value": "SLL" }{ "label": "Somali shilling", "value": "SOS" }{ "label": "Surinamese dollar", "value": "SRD" }{ "label": "São Tomé and Príncipe dobra", "value": "STN" }{ "label": "Salvadoran colón", "value": "SVC" }{ "label": "Syrian pound", "value": "SYP" }{ "label": "Swazi lilangeni", "value": "SZL" }{ "label": "Thai baht", "value": "THB" }{ "label": "Tajikistani somoni", "value": "TJS" }{ "label": "Turkmenistan manat", "value": "TMT" }{ "label": "Tunisian dinar", "value": "TND" }{ "label": "Tongan paʻanga", "value": "TOP" }{ "label": "Turkish lira", "value": "TRY" }{ "label": "Trinidad and Tobago dollar", "value": "TTD" }{ "label": "New Taiwan dollar", "value": "TWD" }{ "label": "Tanzanian shilling", "value": "TZS" }{ "label": "Ukrainian hryvnia", "value": "UAH" }{ "label": "Ugandan shilling", "value": "UGX" }{ "label": "United States dollar", "value": "USD" }{ "label": "Uruguayan peso", "value": "UYU" }{ "label": "Uzbekistan som", "value": "UZS" }{ "label": "Venezuelan bolívar soberano[13]", "value": "VES" }{ "label": "Vietnamese đồng", "value": "VND" }{ "label": "Vanuatu vatu", "value": "VUV" }{ "label": "Samoan tala", "value": "WST" }{ "label": "CFA franc BEAC", "value": "XAF" }{ "label": "Silver (one troy ounce)", "value": "XAG" }{ "label": "Gold (one troy ounce)", "value": "XAU" }{ "label": "East Caribbean dollar", "value": "XCD" }{ "label": "Special drawing rights", "value": "XDR" }{ "label": "CFA franc BCEAO", "value": "XOF" }{ "label": "Palladium (one troy ounce)", "value": "XPD" }{ "label": "CFP franc (franc Pacifique)", "value": "XPF" }{ "label": "Platinum (one troy ounce)", "value": "XPT" }{ "label": "Yemeni rial", "value": "YER" }{ "label": "South African rand", "value": "ZAR" }{ "label": "Zambian kwacha", "value": "ZMW" }{ "label": "Zimbabwean dollar", "value": "ZWL" }`
Target Currency	`targetCurrency`	`string`	Select a value from the drop down menu:`{ "label": "United Arab Emirates dirham", "value": "AED" }{ "label": "Afghan afghani", "value": "AFN" }{ "label": "Albanian lek", "value": "ALL" }{ "label": "Armenian dram", "value": "AMD" }{ "label": "Netherlands Antillean guilder", "value": "ANG" }{ "label": "Angolan kwanza", "value": "AOA" }{ "label": "Argentine peso", "value": "ARS" }{ "label": "Australian dollar", "value": "AUD" }{ "label": "Aruban florin", "value": "AWG" }{ "label": "Azerbaijani manat", "value": "AZN" }{ "label": "Bosnia and Herzegovina convertible mark", "value": "BAM" }{ "label": "Barbados dollar", "value": "BBD" }{ "label": "Bangladeshi taka", "value": "BDT" }{ "label": "Bulgarian lev", "value": "BGN" }{ "label": "Bahraini dinar", "value": "BHD" }{ "label": "Burundian franc", "value": "BIF" }{ "label": "Bermudian dollar", "value": "BMD" }{ "label": "Brunei dollar", "value": "BND" }{ "label": "Boliviano", "value": "BOB" }{ "label": "Brazilian real", "value": "BRL" }{ "label": "Bahamian dollar", "value": "BSD" }{ "label": "Bhutanese ngultrum", "value": "BTN" }{ "label": "Botswana pula", "value": "BWP" }{ "label": "Belarusian ruble", "value": "BYN" }{ "label": "Belize dollar", "value": "BZD" }{ "label": "Canadian dollar", "value": "CAD" }{ "label": "Congolese franc", "value": "CDF" }{ "label": "Swiss franc", "value": "CHF" }{ "label": "Unidad de Fomento (funds code)", "value": "CLF" }{ "label": "Chilean peso", "value": "CLP" }{ "label": "Renminbi (Chinese) yuan", "value": "CNY" }{ "label": "Colombian peso", "value": "COP" }{ "label": "Costa Rican colon", "value": "CRC" }{ "label": "Cuban convertible peso", "value": "CUC" }{ "label": "Cuban peso", "value": "CUP" }{ "label": "Cape Verdean escudo", "value": "CVE" }{ "label": "Czech koruna", "value": "CZK" }{ "label": "Djiboutian franc", "value": "DJF" }{ "label": "Danish krone", "value": "DKK" }{ "label": "Dominican peso", "value": "DOP" }{ "label": "Algerian dinar", "value": "DZD" }{ "label": "Egyptian pound", "value": "EGP" }{ "label": "Eritrean nakfa", "value": "ERN" }{ "label": "Ethiopian birr", "value": "ETB" }{ "label": "Euro", "value": "EUR" }{ "label": "Fiji dollar", "value": "FJD" }{ "label": "Falkland Islands pound", "value": "FKP" }{ "label": "Pound sterling", "value": "GBP" }{ "label": "Georgian lari", "value": "GEL" }{ "label": "Ghanaian cedi", "value": "GHS" }{ "label": "Gibraltar pound", "value": "GIP" }{ "label": "Gambian dalasi", "value": "GMD" }{ "label": "Guinean franc", "value": "GNF" }{ "label": "Guatemalan quetzal", "value": "GTQ" }{ "label": "Guyanese dollar", "value": "GYD" }{ "label": "Hong Kong dollar", "value": "HKD" }{ "label": "Honduran lempira", "value": "HNL" }{ "label": "Croatian kuna", "value": "HRK" }{ "label": "Haitian gourde", "value": "HTG" }{ "label": "Hungarian forint", "value": "HUF" }{ "label": "Indonesian rupiah", "value": "IDR" }{ "label": "Israeli new shekel", "value": "ILS" }{ "label": "Indian rupee", "value": "INR" }{ "label": "Iraqi dinar", "value": "IQD" }{ "label": "Iranian rial", "value": "IRR" }{ "label": "Icelandic króna", "value": "ISK" }{ "label": "Jamaican dollar", "value": "JMD" }{ "label": "Jordanian dinar", "value": "JOD" }{ "label": "Japanese yen", "value": "JPY" }{ "label": "Kenyan shilling", "value": "KES" }{ "label": "Kyrgyzstani som", "value": "KGS" }{ "label": "Cambodian riel", "value": "KHR" }{ "label": "Comoro franc", "value": "KMF" }{ "label": "North Korean won", "value": "KPW" }{ "label": "South Korean won", "value": "KRW" }{ "label": "Kuwaiti dinar", "value": "KWD" }{ "label": "Cayman Islands dollar", "value": "KYD" }{ "label": "Kazakhstani tenge", "value": "KZT" }{ "label": "Lao kip", "value": "LAK" }{ "label": "Lebanese pound", "value": "LBP" }{ "label": "Sri Lankan rupee", "value": "LKR" }{ "label": "Liberian dollar", "value": "LRD" }{ "label": "Lesotho loti", "value": "LSL" }{ "label": "Libyan dinar", "value": "LYD" }{ "label": "Moroccan dirham", "value": "MAD" }{ "label": "Moldovan leu", "value": "MDL" }{ "label": "Malagasy ariary", "value": "MGA" }{ "label": "Macedonian denar", "value": "MKD" }{ "label": "Myanmar kyat", "value": "MMK" }{ "label": "Mongolian tögrög", "value": "MNT" }{ "label": "Macanese pataca", "value": "MOP" }{ "label": "Mauritanian ouguiya", "value": "MRU" }{ "label": "Mauritian rupee", "value": "MUR" }{ "label": "Maldivian rufiyaa", "value": "MVR" }{ "label": "Malawian kwacha", "value": "MWK" }{ "label": "Mexican peso", "value": "MXN" }{ "label": "Mexican Unidad de Inversion (UDI) (funds code)", "value": "MXV" }{ "label": "Malaysian ringgit", "value": "MYR" }{ "label": "Mozambican metical", "value": "MZN" }{ "label": "Namibian dollar", "value": "NAD" }{ "label": "Nigerian naira", "value": "NGN" }{ "label": "Nicaraguan córdoba", "value": "NIO" }{ "label": "Norwegian krone", "value": "NOK" }{ "label": "Nepalese rupee", "value": "NPR" }{ "label": "New Zealand dollar", "value": "NZD" }{ "label": "Omani rial", "value": "OMR" }{ "label": "Panamanian balboa", "value": "PAB" }{ "label": "Peruvian sol", "value": "PEN" }{ "label": "Papua New Guinean kina", "value": "PGK" }{ "label": "Philippine peso[13]", "value": "PHP" }{ "label": "Pakistani rupee", "value": "PKR" }{ "label": "Polish złoty", "value": "PLN" }{ "label": "Paraguayan guaraní", "value": "PYG" }{ "label": "Qatari riyal", "value": "QAR" }{ "label": "Romanian leu", "value": "RON" }{ "label": "Serbian dinar", "value": "RSD" }{ "label": "Russian ruble", "value": "RUB" }{ "label": "Rwandan franc", "value": "RWF" }{ "label": "Saudi riyal", "value": "SAR" }{ "label": "Solomon Islands dollar", "value": "SBD" }{ "label": "Seychelles rupee", "value": "SCR" }{ "label": "Sudanese pound", "value": "SDG" }{ "label": "Swedish krona/kronor", "value": "SEK" }{ "label": "Singapore dollar", "value": "SGD" }{ "label": "Saint Helena pound", "value": "SHP" }{ "label": "Sierra Leonean leone", "value": "SLL" }{ "label": "Somali shilling", "value": "SOS" }{ "label": "Surinamese dollar", "value": "SRD" }{ "label": "São Tomé and Príncipe dobra", "value": "STN" }{ "label": "Salvadoran colón", "value": "SVC" }{ "label": "Syrian pound", "value": "SYP" }{ "label": "Swazi lilangeni", "value": "SZL" }{ "label": "Thai baht", "value": "THB" }{ "label": "Tajikistani somoni", "value": "TJS" }{ "label": "Turkmenistan manat", "value": "TMT" }{ "label": "Tunisian dinar", "value": "TND" }{ "label": "Tongan paʻanga", "value": "TOP" }{ "label": "Turkish lira", "value": "TRY" }{ "label": "Trinidad and Tobago dollar", "value": "TTD" }{ "label": "New Taiwan dollar", "value": "TWD" }{ "label": "Tanzanian shilling", "value": "TZS" }{ "label": "Ukrainian hryvnia", "value": "UAH" }{ "label": "Ugandan shilling", "value": "UGX" }{ "label": "United States dollar", "value": "USD" }{ "label": "Uruguayan peso", "value": "UYU" }{ "label": "Uzbekistan som", "value": "UZS" }{ "label": "Venezuelan bolívar soberano[13]", "value": "VES" }{ "label": "Vietnamese đồng", "value": "VND" }{ "label": "Vanuatu vatu", "value": "VUV" }{ "label": "Samoan tala", "value": "WST" }{ "label": "CFA franc BEAC", "value": "XAF" }{ "label": "Silver (one troy ounce)", "value": "XAG" }{ "label": "Gold (one troy ounce)", "value": "XAU" }{ "label": "East Caribbean dollar", "value": "XCD" }{ "label": "Special drawing rights", "value": "XDR" }{ "label": "CFA franc BCEAO", "value": "XOF" }{ "label": "Palladium (one troy ounce)", "value": "XPD" }{ "label": "CFP franc (franc Pacifique)", "value": "XPF" }{ "label": "Platinum (one troy ounce)", "value": "XPT" }{ "label": "Yemeni rial", "value": "YER" }{ "label": "South African rand", "value": "ZAR" }{ "label": "Zambian kwacha", "value": "ZMW" }{ "label": "Zimbabwean dollar", "value": "ZWL" }`
Threshold	`threshold`	`string`	If specified, a new event will only be emitted when the rate has changed by at least this amount since the last event. For example, if `Threshold` is 0.2 and the initial rate obtained is 3.0, a new event will only be emitted when it reaches 2.8 or 3.2.

Trigger Authentication#

CurrencyScoop uses API keys for authentication. When you connect your CurrencyScoop account, Pipedream securely stores the keys so you can easily authenticate to CurrencyScoop APIs in both code and no-code steps.

About CurrencyScoop#

CurrencyBeacon is a developer friendly, easy-to-use REST API with real-time and historical exchange rates for fiat currencies and cryptocurrencies.

Action#

Chat using Functions on OpenAI (ChatGPT)

Description:Chat with your models and allow them to invoke functions. Optionally, you can build and invoke workflows as functions. [See the documentation](https://platform.openai.com/docs/guides/function-calling)

Version:0.0.4

Key:openai-chat-using-functions

View on GitHub

OpenAI (ChatGPT) Overview#

OpenAI provides a suite of powerful AI models through its API, enabling developers to integrate advanced natural language processing and generative capabilities into their applications. Here’s an overview of the services offered by OpenAI's API:

Use Python or Node.js code to make fully authenticated API requests with your OpenAI account:

Action Code#

import openai from "../../openai.app.mjs";
import common from "../common/common.mjs";
import constants from "../../common/constants.mjs";

export default {
  ...common,
  name: "Chat using Functions",
  version: "0.0.4",
  key: "openai-chat-using-functions",
  description: "Chat with your models and allow them to invoke functions. Optionally, you can build and invoke workflows as functions. [See the documentation](https://platform.openai.com/docs/guides/function-calling)",
  type: "action",
  props: {
    openai,
    alert: {
      type: "alert",
      alertType: "info",
      content: "Provide function names and parameters, and the model will either answer the question directly or decide to invoke one of the functions, returning a function call that adheres to your specified schema. Add a custom code step that includes all available functions which can be invoked based on the model's response - [you can even build an entire workflow as a function](https://pipedream.com/docs/workflows/building-workflows/code/nodejs/#invoke-another-workflow)! Once the appropriate function or workflow is executed, continue the overall execution or pass the result back to the model for further analysis. For more details, [see this guide](https://platform.openai.com/docs/guides/function-calling?api-mode=responses#overview) and this [walkthrough](https://pipedream.com/blog/introducing-enhanced-openai-chat-actions-for-pipedream/#using-pipedream-workflows-as-functions).",
    },
    modelId: {
      propDefinition: [
        openai,
        "chatCompletionModelId",
      ],
    },
    input: {
      type: "string",
      label: "Chat Input",
      description: "Text inputs to the model used to generate a response",
    },
    functions: {
      type: "string",
      label: "Functions",
      description: "A valid JSON array of functions using OpenAI's function schema definition. [See guide here](https://platform.openai.com/docs/guides/function-calling?api-mode=responses&example=search-knowledge-base#defining-functions).",
      default:
`[
  {
    "type": "function",
    "name": "your_function_name",
    "description": "Details on when and how to use the function",
    "strict": true,
    "parameters": {
      "type": "object",
      "properties": {
        "property_name": {
          "type": "property_type",
          "description": "A description for this property"
        },
        "another_property_name": {
          "type": "property_type",
          "description": "A description for this property"
        }
      },
      "required": [
        "list",
        "of",
        "required",
        "properties",
        "for",
        "this",
        "object"
      ],
      "additionalProperties": false
    }
  }
]`,
    },
    instructions: {
      type: "string",
      label: "Instructions",
      description: "Inserts a system (or developer) message as the first item in the model's context",
      optional: true,
    },
    toolChoice: {
      type: "string",
      label: "Tool Choice",
      description: "- **auto**: The model decides whether and how many functions to call.\n- **required**: The model must call one or more functions.\n- **function_name**: Enter a custom expression to force the model to call this specific function.",
      optional: true,
      default: "auto",
      options: [
        "auto",
        "required",
      ],
    },
    parallelToolCalls: {
      type: "boolean",
      label: "Parallel Function Calling",
      description: "Allow or prevent the model to call multiple functions in a single turn",
      optional: true,
      default: true,
    },
    previousResponseId: {
      type: "string",
      label: "Previous Response ID",
      description: "The unique ID of the previous response to the model. Use this to create multi-turn conversations",
      optional: true,
    },
    truncation: {
      type: "string",
      label: "Truncation",
      description: "Specifies the truncation mode for the response if it's larger than the context window size",
      optional: true,
      default: "auto",
      options: [
        "auto",
        "disabled",
      ],
    },
    responseFormat: {
      type: "string",
      label: "Response Format",
      description: "- **Text**: Returns unstructured text output.\n- **JSON Schema**: Enables you to define a [specific structure for the model's output using a JSON schema](https://platform.openai.com/docs/guides/structured-outputs?api-mode=responses).",
      options: [
        "text",
        "json_schema",
      ],
      default: "text",
      optional: true,
      reloadProps: true,
    },
    skipThisStep: {
      type: "boolean",
      label: "Skip This Step",
      description: "Pass in a boolean custom expression to skip this step's execution at runtime",
      optional: true,
      default: false,
    },
  },
  additionalProps() {
    const {
      modelId,
      responseFormat,
    } = this;
    const props = {};

    if (this.openai.isReasoningModel(modelId)) {
      props.reasoningEffort = {
        type: "string",
        label: "Reasoning Effort",
        description: "Constrains effort on reasoning for reasoning models",
        optional: true,
        options: [
          "low",
          "medium",
          "high",
        ],
      };

      // aparrently not supported yet as of 12/march/2025
      // props.generateSummary = {
      //   type: "string",
      //   label: "Generate Reasoning Summary",
      //   description: "A summary of the reasoning performed by the model",
      //   optional: true,
      //   options: [
      //     "concise",
      //     "detailed",
      //   ],
      // };
    }

    if (responseFormat === constants.CHAT_RESPONSE_FORMAT.JSON_SCHEMA.value) {
      props.jsonSchema = {
        type: "string",
        label: "JSON Schema",
        description: "Define the schema that the model's output must adhere to. [Generate one here](https://platform.openai.com/docs/guides/structured-outputs/supported-schemas).",
      };
    }

    return props;
  },
  methods: {
    ...common.methods,
  },
  async run({ $ }) {
    if (this.skipThisStep) {
      $.export("$summary", "Step execution skipped");
      return;
    }

    const data = {
      model: this.modelId,
      input: this.input,
      instructions: this.instructions,
      previous_response_id: this.previousResponseId,
      truncation: this.truncation,
      parallel_tool_calls: this.parallelToolCalls,
      tools: [],
    };

    let functions = this.functions;
    if (typeof functions === "string") {
      try {
        functions = JSON.parse(functions);
      } catch (error) {
        throw new Error("Invalid JSON format in the provided Functions Schema");
      }
    }

    if (Array.isArray(functions)) {
      data.tools.push(...functions);
    } else {
      data.tools.push(functions);
    }

    if (this.toolChoice) {
      if (this.toolChoice === "auto" || this.toolChoice === "required") {
        data.tool_choice = this.toolChoice;
      } else {
        data.tool_choice = {
          type: "function",
          name: this.toolChoice,
        };
      }
    }

    if (this.openai.isReasoningModel(this.modelId) && this.reasoningEffort) {
      data.reasoning = {
        ...data.reasoning,
        effort: this.reasoningEffort,
      };
    }

    if (this.openai.isReasoningModel(this.modelId) && this.generateSummary) {
      data.reasoning = {
        ...data.reasoning,
        generate_summary: this.generateSummary,
      };
    }

    if (this.responseFormat === constants.CHAT_RESPONSE_FORMAT.JSON_SCHEMA.value) {
      try {
        data.text = {
          format: {
            type: this.responseFormat,
            ...JSON.parse(this.jsonSchema),
          },
        };
      } catch (error) {
        throw new Error("Invalid JSON format in the provided JSON Schema");
      }
    }

    const response = await this.openai.responses({
      $,
      data,
    });

    if (response) {
      $.export("$summary", `Successfully sent chat with id ${response.id}`);
      $.export("chat_responses", response.output);
    }

    return response;
  },
};

Action Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI.

Label	Prop	Type	Description
OpenAI (ChatGPT)	`openai`	`app`	This component uses the OpenAI (ChatGPT) app.
Model	`modelId`	`string`	Select a value from the drop down menu.
Chat Input	`input`	`string`	Text inputs to the model used to generate a response
Functions	`functions`	`string`	A valid JSON array of functions using OpenAI's function schema definition. See guide here
Instructions	`instructions`	`string`	Inserts a system (or developer) message as the first item in the model's context
Tool Choice	`toolChoice`	`string`	Select a value from the drop down menu:`autorequired`
Parallel Function Calling	`parallelToolCalls`	`boolean`	Allow or prevent the model to call multiple functions in a single turn
Previous Response ID	`previousResponseId`	`string`	The unique ID of the previous response to the model. Use this to create multi-turn conversations
Truncation	`truncation`	`string`	Select a value from the drop down menu:`autodisabled`
Response Format	`responseFormat`	`string`	Select a value from the drop down menu:`textjson_schema`
Skip This Step	`skipThisStep`	`boolean`	Pass in a boolean custom expression to skip this step's execution at runtime

Chat using Functions with OpenAI (ChatGPT) API on Exchange Rate Updated from CurrencyScoop API

Pipedream makes it easy to connect APIs for OpenAI (ChatGPT), CurrencyScoop and 2,500+ other apps remarkably fast.

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

1-24of2,500+apps by most popular

1
-
24
of
2,500+
apps by most popular