OSA Chat Widget Demo

Try it out

Click the chat button in the bottom-right corner to start a conversation.

Ask questions about:

HED (Hierarchical Event Descriptors)
HED validation and annotation
BIDS (Brain Imaging Data Structure)

Features

Health Status Shows real-time backend connectivity

Markdown Support Tables, code blocks, lists, links

Resizable Drag top-left corner to resize

Configurable Customize title, messages, colors

Chat History Persists across page reloads

Bot Protection Optional Turnstile integration

Basic Integration

Add this to your website:

<script src="https://osa-demo.pages.dev/osa-chat-widget.js"></script>

Custom Configuration

Customize the widget appearance and behavior:

<script src="https://osa-demo.pages.dev/osa-chat-widget.js"></script>
<script>
  OSAChatWidget.setConfig({
    // Branding
    title: 'BIDS Assistant',
    placeholder: 'Ask about BIDS...',
    initialMessage: 'Hi! I can help with BIDS questions.',
    showExperimentalBadge: true,

    // Suggested questions
    suggestedQuestions: [
      'What is BIDS?',
      'How do I organize my data?',
      'Explain BIDS validation errors.'
    ],

    // Footer link
    repoUrl: 'https://github.com/OpenScience-Collective/osa',
    repoName: 'Open Science Assistant',

    // Optional: Turnstile for bot protection
    turnstileSiteKey: 'YOUR_SITE_KEY'
  });
</script>

Configuration Options

title - Widget header title (default: "HED Assistant")
placeholder - Input placeholder text
initialMessage - First greeting message from the assistant
suggestedQuestions - Array of clickable suggestion buttons
showExperimentalBadge - Show/hide "Experimental" badge
repoUrl - URL for the "Powered by" footer link
repoName - Name shown in footer link
turnstileSiteKey - Cloudflare Turnstile site key (optional)
apiEndpoint - Backend API URL (default: OSA worker)
storageKey - localStorage key for chat history

API Endpoints

The widget connects to:

POST /hed/ask - Single question
POST /hed/chat - Multi-turn conversation
GET /health - Backend status check

Backend: https://osa-worker.shirazi-10f.workers.dev