Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.openchatwidget.com/llms.txt

Use this file to discover all available pages before exploring further.

Open Chat Widget ships with three example repos. Each one has its own dedicated docs page with install, environment variable setup, and local run instructions.
Open Chat Widget opened on the Next.js landing page example.

​
Next.js landing page

Next.js landing page

Next.js App Router app with the widget mounted in the page and a serverless POST /api/chat route using OpenRouter openai/gpt-5-mini:online.
  • Repo folder: examples/nextjs-landing-page
  • Docs page: /example-nextjs-landing-page

​
Next.js portfolio chat

Next.js portfolio chat

Next.js App Router portfolio site with the widget mounted in the app layout and a POST /api/chat route that answers from resume context.
  • Repo folder: examples/nextjs-portfolio-chat
  • Docs page: /example-nextjs-portfolio-chat

​
React + Express example

React + Express example

Vite frontend + Express backend with gpt-5-mini and native OpenAI web_search.
  • Repo folder: examples/basic-react-express-app
  • Docs page: /example-basic-react-express-app

​
Which example should you start from?

Use the Next.js example

Start here if your app already uses App Router and you want the widget and route handler in one project.

Use the portfolio example

Start here if you want an App Router portfolio starter where your agent answers questions about you from structured resume data.

Use the Express example

Start here if you want a standalone backend or you need to keep the agent outside the frontend app.