Coze | How to create your own Plugin

In this video, the process of creating a custom plugin for a bot using the Coze platform is explained. The viewer is guided through selecting an API, such as the New York Times API, and setting up the necessary parameters like headers, authorization, and location options. The tutorial covers naming the tool, configuring the HTTP method, and input/output parameters. It also demonstrates how to use the debug console to test the API connection and ensure it's functioning correctly. The summary highlights the importance of understanding API documentation and publishing the plugin for use across different bots. The video concludes with an example of how the bot can be used to retrieve top world news stories from the New York Times, showcasing the plugin's integration and functionality.

Takeaways

• 🔌 A plugin is a set of tools that can enhance a bot's capabilities by adding one or more APIs.
• 📚 To add a plugin, select from a list of services or create your own by connecting to an API like the New York Times.
• ✍️ When creating a plugin, you may need to provide headers, which are used to pass additional information in API requests.
• 🔑 Choose an authorization method for your plugin, which can be service-based, no authorization, or OAuth.
• 📍 Determine the location option for your plugin, which could be header or query, based on the API's requirements.
• 🔍 Use the API's documentation or developer portal to find parameter names and API keys.
• 🛠️ Create a tool by giving it a name, description, and setting the HTTP method, with GET being a common choice.
• 📏 Define input and output parameters based on the API's requirements, which may not be necessary for some APIs.
• 💻 Use the debug console to test if your API connection is working and to view the results in JSON format.
• 🗣️ The bot will provide responses in natural language when interacting with users.
• 🔄 Ensure to publish your plugin to make it accessible across different bots you're working on.
• 📌 If the API requires personal information, indicate this during the publishing process; otherwise, publish directly.

Q & A

What is a plugin in the context of enhancing a bot's capabilities?

A plugin is a set of tools that contains one or more APIs, which can be added to a bot to enhance its capabilities.

How do you add a plugin to a bot using Coze?

You simply click on 'add plugin' and you will be presented with a list of different services that you can add to your bot.

What is an API and how does it relate to creating a plugin?

An API, or Application Programming Interface, is a set of protocols and tools for building software applications. It is used to create a plugin by connecting to a service like the New York Times API.

Why are headers used in API requests?

Headers are used in API requests to pass additional information between the client and the server, which can include content type and authentication tokens.

What is the role of the authorization method in creating a plugin?

The authorization method determines how the plugin will authenticate with the API. Options include service, no authorization, or OAuth.

What is the significance of the location option in the plugin creation process?

The location option determines whether the parameters are passed in the header or the query of the API request, based on the requirements of the API being used.

How can you find information about an API's parameters or API keys?

You can find this information in the API's documentation or developer portal.

What is the purpose of the debug console in the plugin creation process?

The debug console allows you to test and see if your API connection is working correctly by displaying the results of the API call.

What is the format of the results displayed in the debug console?

The results in the debug console are displayed in JSON format.

How can you ensure that your plugin is accessible on any bot you're working on?

You need to publish your plugin so that it can be accessed on any bot.

What should you do if the API you're using requires personal information?

If the API requires personal information, you should click 'yes' on the form. If not, you can cancel out the form and click 'no' to publish directly.

How can you add a custom plugin to your bot using Coze?

After creating a custom plugin, you can add it to your bot by navigating to the bot's workspace, clicking 'add', and then selecting the plugin from 'my tools'.

Outlines

00:00

🔌 Adding a Plugin to Enhance Bot Capabilities

The video script introduces the concept of a plug-in as a set of tools containing one or more APIs that can enhance a bot's capabilities. It guides the viewer through the process of adding a plug-in to a bot by clicking 'add plugin' and selecting from a list of services. The example used is connecting to the New York Times API, which involves naming the API, providing a description, and pasting the provided URL. The process also includes setting headers, choosing an authorization method, and deciding on the location option based on the API's requirements. The video emphasizes the importance of understanding API documentation for parameter names and keys. After confirming the API connection through a debug console, the viewer is shown how to create a tool, input basic information, and adjust HTTP methods. The script concludes with a demonstration of how the new plugin fetches top news articles from the New York Times and how to publish and add the plugin to a bot for use.

Keywords

Plug-in

A plug-in is a software component that adds a specific feature or functionality to an existing computer program. In the context of the video, it refers to the integration of external services or APIs into a bot to enhance its capabilities. For instance, the video demonstrates how to add a plug-in by connecting to the New York Times API.

API (Application Programming Interface)

An API is a set of protocols and tools that allows different software applications to communicate with each other. It is a crucial component in creating plug-ins, as it defines how software components should interact. The video uses the New York Times API to fetch top news stories, showcasing how APIs can be utilized to extend a bot's functionality.

Headers

In the context of web development and APIs, headers are data sent along with an HTTP request that provide additional information to the server. They can include details like content type and authentication tokens. The video mentions headers in relation to setting up the New York Times API, indicating their importance in API requests.

Authorization Method

This refers to the process or protocol used to verify the identity of a user or service making a request to an API. The video discusses choosing an authorization method for the plug-in, highlighting the importance of security in accessing and using APIs.

Location Option

This is a setting that determines where certain parameters are included in an API request, typically either in the header, query, or body of the request. The video mentions choosing the 'query' location option for the New York Times API, which is relevant for specifying search terms in the URL.

Tool

In the context of the video, a tool refers to a specific function or operation that can be performed using a plug-in. The creation of a tool involves setting up the basic information, input parameters, and output parameters based on the requirements of the API being used.

HTTP Method

HTTP methods are the types of requests that can be made when interacting with an API. Common methods include GET, POST, PUT, and DELETE. The video specifically mentions using the GET method for the New York Times API, which is typically used for retrieving data.

Input Parameters

Input parameters are the variables or pieces of data that are required by an API to perform an operation. The video notes that the necessity of input parameters depends on the specific API and its requirements, and for the New York Times API, no input parameters are needed.

Output Parameters

Output parameters are the results or data returned by an API after performing an operation. The video mentions that the output from the New York Times API is received in JSON format, which is then used to provide information in a natural language response by the bot.

Debug Console

A debug console is a tool that allows developers to test and debug their code by running it and observing the output or any errors that occur. In the video, the debug console is used to verify that the API connection is working correctly and to display the results of the API call.

Publish

Publishing, in the context of the video, refers to making a plug-in available for use. After setting up and testing a plug-in, it must be published to be accessible on any bot that the user is working on. The video instructs on how to publish a plug-in to make it operational.

Personal Information

This refers to any data that can be used to identify an individual, such as names, addresses, or identification numbers. The video asks whether the API requires personal information, which is an important consideration for privacy and data protection when creating and using plug-ins.

Highlights

A plugin is a set of tools containing one or more APIs that can enhance a bot's capabilities.

To add a plugin, click 'add plugin' to get a list of different services to choose from.

Custom plugins can be created by connecting to an API like the New York Times API.

When creating a plugin, provide a name, description, and URL for the API.

Headers are used in API requests to pass additional information between the client and server.

Choose an authorization method for the plugin, such as service, no authorization, or OAuth.

Select the location option based on the API's requirements, such as header or query.

The API documentation or developer portal provides information on parameter names and API keys.

Create a tool by giving it a name, description, and optionally editing the path and HTTP method.

Input and output parameters depend on the API's requirements and may not be needed for some APIs.

Use the debug console to check if the API connection is working and to view the results in JSON format.

Publish the plugin to make it accessible on any bot you're working on.

If the API requires personal information, indicate this during the publishing process.

Add the plugin to your bot's workspace to start using it in conversations.

Custom plugins can be combined with store plugins to enhance the bot's functionality.

The bot can provide responses in natural language based on the plugin's API data.

Explore different endpoints provided by the API to create multiple tools for a plugin.

The New York Times API provides direct links, short descriptions, and pictures for news articles.