Documentation

Everything you need to deploy and configure your Nubiq AI chatbot.

Sign up at /register. You'll get a free plan with 100 messages/month.

Go to Dashboard → Documents → Upload. Supported formats: PDF, DOCX, XLSX, PPTX, CSV, JSON, HTML, Markdown, TXT.

Go to Dashboard → Playground. Chat with your bot to verify it answers from your knowledge base.

Go to Dashboard → Widgets. Copy the snippet and paste it before </body> on your website.

<script>
  window.NubiqConfig = {
    siteKey: "YOUR_SITE_KEY",
    apiBase: "https://your-domain.com"
  };
</script>
<script src="https://your-domain.com/widget.js" async defer></script>

primaryColor (hex), locale (es/en/pt), position (bottom-right/bottom-left), theme (light/dark/auto), title (string).

WordPress: Install the Nubiq Chat plugin from wp-admin. Shopify: Use our Liquid snippet. Wix/Squarespace: Use Code Injection. See /integrations/ in the repo.

1. Create a WhatsApp Business API app at Meta. 2. In Dashboard → Channels, add WhatsApp config with access_token, phone_number_id, and app_secret. 3. Set webhook URL to: https://your-domain.com/api/channels/whatsapp/webhook

1. Create a bot via @BotFather. 2. Add Telegram config with bot_token. 3. Set webhook: https://your-domain.com/api/channels/telegram/webhook

1. Create an app in Discord Developer Portal. 2. Set Interactions Endpoint URL to: https://your-domain.com/api/channels/discord/webhook. 3. Create a /chat slash command.

POST /api/auth/register , Create account
POST /api/auth/login , Get JWT tokens
POST /api/auth/refresh , Refresh access token
GET /api/auth/me , Current user info

POST /api/guest/sessions , Create guest session
POST /api/chat/messages , Send message (returns AI response)
GET /api/chat/stream , SSE streaming response
GET /api/chat/history , Message history

GET /api/documents , List documents
POST /api/documents/upload , Upload file
POST /api/documents/index , Trigger indexing
GET /api/documents/retrieve , RAG search

GET /api/conversations , List (cursor paginated)
GET /api/conversations/{thread_id} , Detail
POST /api/conversations/{thread_id}/claim , Claim for agent
POST /api/conversations/{thread_id}/reply , Agent reply
POST /api/conversations/{thread_id}/close , Close conversation

GET /api/billing/plans , Available plans
GET /api/billing/usage , Current usage vs limits
GET /api/billing/subscription , Current subscription
POST /api/billing/checkout , Create Stripe checkout session

Each profile has: name, tone (formal/casual/technical), language, system prompt, welcome message, fallback message, business hours, and linked widget.

Toggle capabilities: booking, cancel_booking, faq, create_ticket, check_ticket, handoff, collect_info, business_hours, notify, custom.

Built-in tools: get_available_slots, book_appointment, cancel_appointment, create_ticket, check_ticket_status, search_knowledge, collect_contact_info, transfer_to_human, get_business_hours, send_notification.

Configure LLM providers (Gemini, Qwen, DeepSeek, GLM, MiniMax) with temperature, max_tokens, and system prompt overrides per route policy.