{"id":28402427,"url":"https://github.com/lobehub/chat-plugins-gateway","last_synced_at":"2025-06-25T17:31:06.792Z","repository":{"id":188721006,"uuid":"678070552","full_name":"lobehub/chat-plugins-gateway","owner":"lobehub","description":"🧩 / 🚪 Plugins Gateway - The LobeChat Plugins Gateway is a backend service that serves as a gateway for LobeChat plugins. We deploy this service using Vercel. The primary API POST /api/v1/runner is deployed as an Edge Function.","archived":false,"fork":false,"pushed_at":"2023-12-28T13:40:27.000Z","size":142,"stargazers_count":23,"open_issues_count":2,"forks_count":14,"subscribers_count":5,"default_branch":"main","last_synced_at":"2025-06-18T12:34:36.158Z","etag":null,"topics":["function-calling","gateway","lobe-chat","lobe-chat-plugin","lobehub"],"latest_commit_sha":null,"homepage":"http://chat-plugins-gateway.lobehub.com","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/lobehub.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null},"funding":{"github":"lobehub","open_collective":"lobehub"}},"created_at":"2023-08-13T15:35:04.000Z","updated_at":"2025-04-07T15:48:57.000Z","dependencies_parsed_at":"2023-08-19T09:39:13.798Z","dependency_job_id":"1370dba2-8f2f-438f-9d9a-65339c8203eb","html_url":"https://github.com/lobehub/chat-plugins-gateway","commit_stats":null,"previous_names":["lobehub/chat-plugin-market","lobehub/chat-plugins-server","lobehub/chat-plugins-gateway"],"tags_count":31,"template":false,"template_full_name":"arvinxx/vercel-serverless-api-template","purl":"pkg:github/lobehub/chat-plugins-gateway","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lobehub%2Fchat-plugins-gateway","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lobehub%2Fchat-plugins-gateway/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lobehub%2Fchat-plugins-gateway/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lobehub%2Fchat-plugins-gateway/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/lobehub","download_url":"https://codeload.github.com/lobehub/chat-plugins-gateway/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lobehub%2Fchat-plugins-gateway/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":260765637,"owners_count":23059314,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["function-calling","gateway","lobe-chat","lobe-chat-plugin","lobehub"],"created_at":"2025-06-01T15:37:55.049Z","updated_at":"2025-06-25T17:31:06.761Z","avatar_url":"https://github.com/lobehub.png","language":"TypeScript","readme":"\u003ca name=\"readme-top\"\u003e\u003c/a\u003e\n\n\u003cdiv align=\"center\"\u003e\n\n\u003cimg height=\"120\" src=\"https://registry.npmmirror.com/@lobehub/assets-emoji/1.3.0/files/assets/puzzle-piece.webp\"\u003e\n\u003cimg height=\"120\" src=\"https://gw.alipayobjects.com/zos/kitchen/qJ3l3EPsdW/split.svg\"\u003e\n\u003cimg height=\"120\" src=\"https://registry.npmmirror.com/@lobehub/assets-emoji/1.3.0/files/assets/door.webp\"\u003e\n\n\u003ch1\u003eLobeChat Plugins Gateway\u003c/h1\u003e\n\nPlugin Gateway Service for Lobe Chat and Lobe Web\n\n[![][🤯-🧩-lobehub-shield]][🤯-🧩-lobehub-link]\n[![][npm-release-shield]][npm-release-link]\n[![][github-releasedate-shield]][github-releasedate-link]\n[![][github-action-test-shield]][github-action-test-link]\n[![][github-action-release-shield]][github-action-release-link]\u003cbr/\u003e\n[![][github-contributors-shield]][github-contributors-link]\n[![][github-forks-shield]][github-forks-link]\n[![][github-stars-shield]][github-stars-link]\n[![][github-issues-shield]][github-issues-link]\n[![][github-license-shield]][github-license-link]\n\n**English** · [简体中文](./README.zh-CN.md) · [Changelog](./CHANGELOG.md) · [Report Bug][github-issues-link] · [Request Feature][github-issues-link]\n\n![](https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/rainbow.png)\n\n\u003c/div\u003e\n\n\u003cdetails\u003e\n\u003csummary\u003e\u003ckbd\u003eTable of contents\u003c/kbd\u003e\u003c/summary\u003e\n\n#### TOC\n\n- [👋 Intro](#-intro)\n- [🤯 Usage](#-usage)\n  - [Base URLs](#base-urls)\n  - [POST Plugin Gateway](#post-plugin-gateway)\n- [🛳 Self Hosting](#-self-hosting)\n  - [Deploy to Vercel](#deploy-to-vercel)\n- [📦 Plugin Ecosystem](#-plugin-ecosystem)\n- [⌨️ Local Development](#️-local-development)\n- [🤝 Contributing](#-contributing)\n- [🔗 Links](#-links)\n\n####\n\n\u003c/details\u003e\n\n## 👋 Intro\n\nLobeChat Plugins Gateway is a backend service that provides a gateway for LobeChat plugins. We use [vercel](https://vercel.com/) to deploy this service. The main API `POST /api/v1/runner` is deployed as an [Edge Function](https://vercel.com/docs/functions/edge-functions).\n\nThe gateway service fetches lobe plugins index from the [LobeChat Plugins](https://github.com/lobehub/lobe-chat-plugins), if you want to add your plugin to the index, please [submit a PR](https://github.com/lobehub/lobe-chat-plugins/pulls) to the LobeChat Plugins repository.\n\n\u003cdiv align=\"right\"\u003e\n\n[![][back-to-top]](#readme-top)\n\n\u003c/div\u003e\n\n## 🤯 Usage\n\n### Base URLs\n\n| Environment | URL                                            |\n| ----------- | ---------------------------------------------- |\n| `PROD`      | \u003chttps://chat-plugins-gateway.lobehub.com\u003e     |\n| `DEV`       | \u003chttps://chat-plugins-gateway-dev.lobehub.com\u003e |\n\n### POST Plugin Gateway\n\n\u003e **Note**\\\n\u003e **POST** `/api/v1/runner`\\\n\u003e Interface to communicate with the LobeChat plugin. This interface describes how to use the LobeChat plugin gateway API to send requests and get responses\n\n#### Body Request Parameters\n\n```json\n{\n  \"arguments\": \"{\\n  \\\"city\\\": \\\"杭州\\\"\\n}\",\n  \"name\": \"realtimeWeather\"\n}\n```\n\n#### Response\n\n```json\n[\n  {\n    \"city\": \"杭州市\",\n    \"adcode\": \"330100\",\n    \"province\": \"浙江\",\n    \"reporttime\": \"2023-08-17 23:32:22\",\n    \"casts\": [\n      {\n        \"date\": \"2023-08-17\",\n        \"week\": \"4\",\n        \"dayweather\": \"小雨\",\n        \"nightweather\": \"小雨\",\n        \"daytemp\": \"33\",\n        \"nighttemp\": \"24\",\n        \"daywind\": \"东\",\n        \"nightwind\": \"东\",\n        \"daypower\": \"≤3\",\n        \"nightpower\": \"≤3\",\n        \"daytemp_float\": \"33.0\",\n        \"nighttemp_float\": \"24.0\"\n      },\n      {\n        \"date\": \"2023-08-18\",\n        \"week\": \"5\",\n        \"dayweather\": \"小雨\",\n        \"nightweather\": \"小雨\",\n        \"daytemp\": \"32\",\n        \"nighttemp\": \"23\",\n        \"daywind\": \"东北\",\n        \"nightwind\": \"东北\",\n        \"daypower\": \"4\",\n        \"nightpower\": \"4\",\n        \"daytemp_float\": \"32.0\",\n        \"nighttemp_float\": \"23.0\"\n      },\n      {\n        \"date\": \"2023-08-19\",\n        \"week\": \"6\",\n        \"dayweather\": \"小雨\",\n        \"nightweather\": \"雷阵雨\",\n        \"daytemp\": \"32\",\n        \"nighttemp\": \"24\",\n        \"daywind\": \"东\",\n        \"nightwind\": \"东\",\n        \"daypower\": \"4\",\n        \"nightpower\": \"4\",\n        \"daytemp_float\": \"32.0\",\n        \"nighttemp_float\": \"24.0\"\n      },\n      {\n        \"date\": \"2023-08-20\",\n        \"week\": \"7\",\n        \"dayweather\": \"雷阵雨\",\n        \"nightweather\": \"多云\",\n        \"daytemp\": \"33\",\n        \"nighttemp\": \"25\",\n        \"daywind\": \"东\",\n        \"nightwind\": \"东\",\n        \"daypower\": \"≤3\",\n        \"nightpower\": \"≤3\",\n        \"daytemp_float\": \"33.0\",\n        \"nighttemp_float\": \"25.0\"\n      }\n    ]\n  }\n]\n```\n\nSee [API Document](https://apifox.com/apidoc/shared-c574e77f-4230-4727-9c05-c5c9988eed06) for more information.\n\n\u003cdiv align=\"right\"\u003e\n\n[![][back-to-top]](#readme-top)\n\n\u003c/div\u003e\n\n## 🛳 Self Hosting\n\nIf you want to deploy this service by yourself, you can follow the steps below.\n\n### Deploy to Vercel\n\nClick button below to deploy your private plugins' gateway.\n\n[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Flobehub%2Fchat-plugins-gateway\u0026project-name=chat-plugins-gateway\u0026repository-name=chat-plugins-gateway)\n\nIf you want to make some customization, you can add environment variable:\n\n- `PLUGINS_INDEX_URL`: You can change the default plugins index url as your need.\n\n\u003cdiv align=\"right\"\u003e\n\n[![][back-to-top]](#readme-top)\n\n\u003c/div\u003e\n\n## 📦 Plugin Ecosystem\n\nPlugins provide a means to extend the Function Calling capabilities of LobeChat. They can be used to introduce new function calls and even new ways to render message results. If you are interested in plugin development, please refer to our [📘 Plugin Development Guide](https://github.com/lobehub/lobe-chat/wiki/Plugin-Development) in the Wiki.\n\n- [lobe-chat-plugins][lobe-chat-plugins]: This is the plugin index for LobeChat. It accesses index.json from this repository to display a list of available plugins for LobeChat to the user.\n- [chat-plugin-template][chat-plugin-template]: This is the plugin template for LobeChat plugin development.\n- [@lobehub/chat-plugin-sdk][chat-plugin-sdk]: The LobeChat Plugin SDK assists you in creating exceptional chat plugins for Lobe Chat.\n- [@lobehub/chat-plugins-gateway][chat-plugins-gateway]: The LobeChat Plugins Gateway is a backend service that provides a gateway for LobeChat plugins. We deploy this service using Vercel. The primary API POST /api/v1/runner is deployed as an Edge Function.\n\n\u003cdiv align=\"right\"\u003e\n\n[![][back-to-top]](#readme-top)\n\n\u003c/div\u003e\n\n## ⌨️ Local Development\n\nYou can use Github Codespaces for online development:\n\n[![][github-codespace-shield]][github-codespace-link]\n\nOr clone it for local development:\n\n[![][bun-shield]][bun-link]\n\n```bash\n$ git clone https://github.com/lobehub/chat-plugins-gateway.git\n$ cd chat-plugins-gateway\n$ bun install\n$ bun dev\n```\n\n\u003cdiv align=\"right\"\u003e\n\n[![][back-to-top]](#readme-top)\n\n\u003c/div\u003e\n\n## 🤝 Contributing\n\nContributions of all types are more than welcome, if you are interested in contributing code, feel free to check out our GitHub [Issues][github-issues-link] to get stuck in to show us what you’re made of.\n\n[![][pr-welcome-shield]][pr-welcome-link]\n\n[![][github-contrib-shield]][github-contrib-link]\n\n\u003cdiv align=\"right\"\u003e\n\n[![][back-to-top]](#readme-top)\n\n\u003c/div\u003e\n\n## 🔗 Links\n\n- **[🤖 Lobe Chat](https://github.com/lobehub/lobe-chat)** - An open-source, extensible (Function Calling), high-performance chatbot framework. It supports one-click free deployment of your private ChatGPT/LLM web application.\n- **[🧩 / 🏪 Plugin Index](https://github.com/lobehub/lobe-chat-plugins)** - This is the plugin index for LobeChat. It accesses index.json from this repository to display a list of available plugins for Function Calling to the user.\n\n\u003cdiv align=\"right\"\u003e\n\n[![][back-to-top]](#readme-top)\n\n\u003c/div\u003e\n\n---\n\n#### 📝 License\n\nCopyright © 2023 [LobeHub][profile-link]. \u003cbr /\u003e\nThis project is [MIT](./LICENSE) licensed.\n\n\u003c!-- LINK GROUP --\u003e\n\n[🤯-🧩-lobehub-link]: https://github.com/lobehub/lobe-chat-plugins\n[🤯-🧩-lobehub-shield]: https://img.shields.io/badge/%F0%9F%A4%AF%20%26%20%F0%9F%A7%A9%20LobeHub-Plugin-95f3d9?labelColor=black\u0026style=flat-square\n[back-to-top]: https://img.shields.io/badge/-BACK_TO_TOP-black?style=flat-square\n[bun-link]: https://bun.sh\n[bun-shield]: https://img.shields.io/badge/-speedup%20with%20bun-black?logo=bun\u0026style=for-the-badge\n[chat-plugin-sdk]: https://github.com/lobehub/chat-plugin-sdk\n[chat-plugin-template]: https://github.com/lobehub/chat-plugin-\n[chat-plugins-gateway]: https://github.com/lobehub/chat-plugins-gateway\n[github-action-release-link]: https://github.com/lobehub/chat-plugins-gateway/actions/workflows/release.yml\n[github-action-release-shield]: https://img.shields.io/github/actions/workflow/status/lobehub/chat-plugins-gateway/release.yml?label=release\u0026labelColor=black\u0026logo=githubactions\u0026logoColor=white\u0026style=flat-square\n[github-action-test-link]: https://github.com/lobehub/chat-plugins-gateway/actions/workflows/test.yml\n[github-action-test-shield]: https://img.shields.io/github/actions/workflow/status/lobehub/chat-plugins-gateway/test.yml?label=test\u0026labelColor=black\u0026logo=githubactions\u0026logoColor=white\u0026style=flat-square\n[github-codespace-link]: https://codespaces.new/lobehub/chat-plugins-gateway\n[github-codespace-shield]: https://github.com/codespaces/badge.svg\n[github-contrib-link]: https://github.com/lobehub/chat-plugins-gateway/graphs/contributors\n[github-contrib-shield]: https://contrib.rocks/image?repo=lobehub%2Fchat-plugins-gateway\n[github-contributors-link]: https://github.com/lobehub/chat-plugins-gateway/graphs/contributors\n[github-contributors-shield]: https://img.shields.io/github/contributors/lobehub/chat-plugins-gateway?color=c4f042\u0026labelColor=black\u0026style=flat-square\n[github-forks-link]: https://github.com/lobehub/chat-plugins-gateway/network/members\n[github-forks-shield]: https://img.shields.io/github/forks/lobehub/chat-plugins-gateway?color=8ae8ff\u0026labelColor=black\u0026style=flat-square\n[github-issues-link]: https://github.com/lobehub/chat-plugins-gateway/issues\n[github-issues-shield]: https://img.shields.io/github/issues/lobehub/chat-plugins-gateway?color=ff80eb\u0026labelColor=black\u0026style=flat-square\n[github-license-link]: https://github.com/lobehub/chat-plugins-gateway/blob/main/LICENSE\n[github-license-shield]: https://img.shields.io/github/license/lobehub/chat-plugins-gateway?color=white\u0026labelColor=black\u0026style=flat-square\n[github-releasedate-link]: https://github.com/lobehub/chat-plugins-gateway/releases\n[github-releasedate-shield]: https://img.shields.io/github/release-date/lobehub/chat-plugins-gateway?labelColor=black\u0026style=flat-square\n[github-stars-link]: https://github.com/lobehub/chat-plugins-gateway/network/stargazers\n[github-stars-shield]: https://img.shields.io/github/stars/lobehub/chat-plugins-gateway?color=ffcb47\u0026labelColor=black\u0026style=flat-square\n[lobe-chat-plugins]: https://github.com/lobehub/lobe-chat-plugins\n[npm-release-link]: https://www.npmjs.com/package/@lobehub/chat-plugins-gateway\n[npm-release-shield]: https://img.shields.io/npm/v/@lobehub/chat-plugins-gateway?color=369eff\u0026labelColor=black\u0026logo=npm\u0026logoColor=white\u0026style=flat-square\n[pr-welcome-link]: https://github.com/lobehub/chat-plugins-gateway/pulls\n[pr-welcome-shield]: https://img.shields.io/badge/%F0%9F%A4%AF%20PR%20WELCOME-%E2%86%92-ffcb47?labelColor=black\u0026style=for-the-badge\n[profile-link]: https://github.com/lobehub\n","funding_links":["https://github.com/sponsors/lobehub","https://opencollective.com/lobehub"],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flobehub%2Fchat-plugins-gateway","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flobehub%2Fchat-plugins-gateway","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flobehub%2Fchat-plugins-gateway/lists"}