Skip to main content

​
Endpoint

This document uses the Neko Cat project as an example to explain the structure of Endpoints within a plugin. Endpoints are HTTP interfaces exposed by the plugin, which can be used for integration with external systems. For the complete plugin code, please refer to the GitHub repository.

​
Group Definition

An Endpoint group is a collection of multiple Endpoints. When creating a new Endpoint within a Dify plugin, you might need to fill in the following configuration. Besides the Endpoint Name, you can add new form items by writing the group’s configuration information. After clicking save, you can see the multiple interfaces it contains, which will use the same configuration information.

​
Structure

  • settings (map[string] ProviderConfig): Endpoint configuration definition.
  • endpoints (list[string], required): Points to the specific endpoint interface definitions.
settings:
  api_key:
    type: secret-input
    required: true
    label:
      en_US: API key
      zh_Hans: API key
      ja_Jp: API key
      pt_BR: API key
    placeholder:
      en_US: Please input your API key
      zh_Hans: 请输入你的 API key
      ja_Jp: あなたの API key を入れてください
      pt_BR: Por favor, insira sua chave API
endpoints:
  - endpoints/duck.yaml
  - endpoints/neko.yaml

​
Interface Definition

  • path (string): Follows the Werkzeug interface standard.
  • method (string): Interface method, only supports HEAD, GET, POST, PUT, DELETE, OPTIONS.
  • extra (object): Configuration information beyond the basic details.
    • python (object)
      • source (string): The source code that implements this interface.
path: "/duck/<app_id>"
method: "GET"
extra:
  python:
    source: "endpoints/duck.py"

​
Interface Implementation

You need to implement a subclass that inherits from dify_plugin.Endpoint and implement the _invoke method.
  • Input Parameters
    • r (Request): The Request object from werkzeug.
    • values (Mapping): Path parameters parsed from the path.
    • settings (Mapping): Configuration information for this Endpoint.
  • Return
    • A Response object from werkzeug, supports streaming responses.
    • Directly returning a string is not supported.
Example code: 
import json
from typing import Mapping
from werkzeug import Request, Response
from dify_plugin import Endpoint

class Duck(Endpoint):
    def _invoke(self, r: Request, values: Mapping, settings: Mapping) -> Response:
        """
        Invokes the endpoint with the given request.
        """
        app_id = values["app_id"]

        def generator():
            yield f"{app_id} <br>"

        return Response(generator(), status=200, content_type="text/html")

​
Notes

  • Endpoints are only instantiated when the plugin is called; they are not long-running services.
  • Pay attention to security when developing Endpoints and avoid executing dangerous operations.
  • Endpoints can be used to handle Webhook callbacks or provide interfaces for other systems to connect.
If you are learning plugin development, it is recommended to first read the Getting Started with Plugin Development and the Developer Cheatsheet.
Edit this page | Report an issue