Skip to main content

Usage

Check for available Bundles and Plugins​

Although you can check available bundles and plugins on TaskingAI official documentation, it is also possible to check them programmatically.

Check available Bundles​

To check available bundles, send a get request to v1/bundles:

curl --location 'http://127.0.0.1:8030/v1/bundles'

Check available Plugins under a Bundle​

To check available plugins under a bundle, send a get request to v1/bundles/{bundle_id}:

Example for checking available plugins under coin_market_cap bundle:

curl --location 'http://127.0.0.1:8030/v1/plugins?bundle_id=coin_market_cap'

In the returned response, you should be able to find a list of plugin information including bundle_id, plugin_id, input_schema, output_schema, and more.

Execute a Plugin​

To execute a plugin, you need to first acquire the bundle_id, plugin_id for identifying the target plugin. You also need to provide the required input_params and credentials for the plugin to execute the task.

Once you have all that information prepared, call the v1/execute endpoint with a POST request:

Here's an example of requesting CoinMarketCap API to get the latest Bitcoin price:

curl --location 'http://127.0.0.1:8030/v1/execute' \
--header 'Content-Type: application/json' \
--data '{
    "bundle_id": "coin_market_cap",
    "plugin_id": "get_latest_coin_data",
    "input_params": {
        "symbol": "BTC"
    },
    "credentials": {
        "COIN_MARKET_CAP_API_KEY":"YOUR_COIN_MARKET_CAP_API_KEY"
    }
}'