{"id":14970877,"url":"https://github.com/openassistantgpt/chatbot-sdk","last_synced_at":"2025-10-26T14:30:56.173Z","repository":{"id":249317605,"uuid":"830139998","full_name":"OpenAssistantGPT/chatbot-sdk","owner":"OpenAssistantGPT","description":"A SDK for building and deploying your own chatbot using NextJS and Vercel. Created by OpenAssistantGPT","archived":false,"fork":false,"pushed_at":"2024-10-08T23:29:15.000Z","size":2949,"stargazers_count":24,"open_issues_count":5,"forks_count":8,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-10-11T05:01:17.393Z","etag":null,"topics":["ai","ai-sdk","assistant-api","chatbot","chatbot-framework","chatbots","chatgpt","chatgpt-api","chatgpt-ui","openai","openai-api","sdk"],"latest_commit_sha":null,"homepage":"https://sdk.openassistantgpt.io","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/OpenAssistantGPT.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":".github/SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-07-17T17:09:26.000Z","updated_at":"2024-10-04T20:02:45.000Z","dependencies_parsed_at":"2024-08-07T13:37:46.519Z","dependency_job_id":null,"html_url":"https://github.com/OpenAssistantGPT/chatbot-sdk","commit_stats":null,"previous_names":["openassistantgpt/openassistantgpt-sdk","openassistantgpt/chatbot-sdk"],"tags_count":37,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OpenAssistantGPT%2Fchatbot-sdk","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OpenAssistantGPT%2Fchatbot-sdk/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OpenAssistantGPT%2Fchatbot-sdk/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OpenAssistantGPT%2Fchatbot-sdk/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/OpenAssistantGPT","download_url":"https://codeload.github.com/OpenAssistantGPT/chatbot-sdk/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":219862782,"owners_count":16555951,"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":["ai","ai-sdk","assistant-api","chatbot","chatbot-framework","chatbots","chatgpt","chatgpt-api","chatgpt-ui","openai","openai-api","sdk"],"created_at":"2024-09-24T13:44:16.994Z","updated_at":"2025-10-26T14:30:55.753Z","avatar_url":"https://github.com/OpenAssistantGPT.png","language":"TypeScript","readme":"![hero illustration](./assets/hero.gif)\n\n# OpenAssistantGPT SDK\n\nThis SDK is an extension of the vercel/ai SDK with more features, addapted to our use case and maintained by the OpenAssistantGPT team.\nIf you want more information about OpenAssistantGPT you can find it [here](https://www.openassistantgpt.io/).\n\nWe also provide our chatbot with our [hosted version](https://www.openassistantgpt.io/), with adavanced analytics, crawling for custom content and advanced security.\n\n# Deploy example\n\nDeploy our basic example using [Vercel](https://vercel.com):\n\n[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2FOpenAssistantGPT%2FOpenAssistantGPT-SDK%2Ftree%2Fmain%2Fexamples%2Fnext-website\u0026env=OPENAI_ASSISTANT_ID,OPENAI_API_KEY\u0026envDescription=Find%20all%20informations%20in%20OpenAI%20Platform.\u0026envLink=https%3A%2F%2Fplatform.openai.com%2F)\n\nFor more information about the example give a look at this [README.md](https://github.com/OpenAssistantGPT/chatbot-sdk/tree/main/examples/next-website#openassistantgpt-sdk-nextjs-and-openai-chat-example).\n\nAll examples\n\n- [Basic Website](./examples/next-website/README.md)\n- [Window Style Integration](./examples/website-chatbot-window/README.md)\n- [Custom API](./examples/website-custom-api//README.md)\n\n# Installation\n\nYou will need Node.js 18+ and pnpm install on your local development machine.\n\n```bash\nnpm install openassistantgpt\n```\n\n# Usage\n\n## Import Default CSS\n\nImport the default CSS files to ensure correct styling is applied. For NextJS apps - this should be added to your [layout file](https://github.com/OpenAssistantGPT/chatbot-sdk/blob/main/examples/next-website/app/layout.tsx#L1).\n\n```\nimport \"@openassistantgpt/ui/dist/index.css\"\n```\n\n## @openassistantgpt/assistant\n\nFirst you need to import our library and configure the POST and GET method. This will setup the backend correctly.\n\n```bash\nnpm install @openassistantgpt/assistant\n```\n\nThen you have to setup you environment variables by creating your `.env` file\n\n```\nOPENAI_API_KEY=xxxxxxx\nOPENAI_ASSISTANT_ID=xxxxxx\n```\n\nOnce the package is installed and your environment variables are configured create the route file `/api/chat/[[...openassistantgpt]]/route.ts`\n\n```js\nimport { OpenAssistantGPT } from '@openassistantgpt/assistant';\n\n// In OpenAssistantGPT handler you must enter your base path.\n// The base path is everything before the [[...openassistantgpt]] part of the route.\nconst httpHandler = new OpenAssistantGPT('/api/chat/').handler;\n\nexport { httpHandler as GET, httpHandler as POST };\n```\n\n## @openassistantgpt/ui\n\nFirst you need to import our library and configure your component to use it.\n\n```bash\nnpm install @openassistantgpt/ui\n```\n\nOnce the UI package is installed create the `page.tsx` file and configure your chatbot like you want.\n\n```js\n'use client';\n\nimport { OpenAssistantGPTChat, ChatbotConfig } from '@openassistantgpt/ui';\n\nexport default function ChatPage() {\n  const chatbot: ChatbotConfig = {\n    id: '12345',\n    name: 'OpenAssistantGPT',\n\n    chatTitle: 'Chat with OpenAssistantGPT',\n    welcomeMessage:\n      \"Welcome to OpenAssistantGPT! 🚀 I'm your AI assistant, crafted using this platform. How may I assist you today?\",\n    chatMessagePlaceHolder: 'Ask us any question...',\n\n    rightToLeftLanguage: false,\n\n    bubbleColor: 'linear-gradient(to top left, #003366, #336699)',\n    bubbleTextColor: '#FFFFFF',\n\n    chatHeaderBackgroundColor: '#FFFFFF',\n    chatHeaderTextColor: '#52525b',\n\n    chatbotReplyBackgroundColor: '#e4e4e7',\n    chatbotReplyTextColor: '#000000',\n\n    userReplyBackgroundColor: '#e4e4e7',\n    userReplyTextColor: '#000000',\n\n    chatbotLogoURL:\n      'https://gwetfkan2dovfoiz.public.blob.vercel-storage.com/search-8jZhOvOBPxuTmohrup5TPvSzrjsyog.png',\n    chatInputStyle: 'default',\n\n    chatHistoryEnabled: true,\n    chatFileAttachementEnabled: true,\n\n    displayFooterText: true,\n    footerLink: 'https://www.openassistantgpt.io',\n    footerTextName: 'OpenAssistantGPT',\n\n    messageSourceText: '',\n    withChatMessageIcon: true,\n  };\n\n  return (\n    \u003cOpenAssistantGPTChat\n      chatbot={chatbot}\n      path=\"/api/chat/assistant\"\n      defaultMessage=\"\"\n    /\u003e\n  );\n}\n```\n\n## Community\n\nThe OpenAssistantGPT SDK community can be found on [GitHub Discussions](https://github.com/OpenAssistantGPT/OpenAssistantGPT-SDK/discussions) where you can ask questions, voice ideas, and share your projects with other people.\n\n## Contributing\n\nContributions to the OpenAssistantGPT SDK are welcome and highly appreciated. However, before you jump right into it, we would like you to review our [Contribution Guidelines](https://github.com/OpenAssistantGPT/OpenAssistantGPT-SDK/blob/main/CONTRIBUTING.md) to make sure you have smooth experience contributing to OpenAssistantGPT SDK.\n\n## Authors\n\nOpenAssistantGPT team members, with contributions from the [Open Source Community](https://github.com/OpenAssistantGPT/OpenAssistantGPT-SDK/graphs/contributors).\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopenassistantgpt%2Fchatbot-sdk","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fopenassistantgpt%2Fchatbot-sdk","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopenassistantgpt%2Fchatbot-sdk/lists"}