Documentation

Getting Started

ShBot is a multi-tenant RAG (Retrieval-Augmented Generation) API. You upload your documents, and your users get an AI assistant that answers questions based only on those documents.

Step 1 — Register

Create an account at /register. Use your organisation name and a valid email. Registration is instant but access is gated.

Step 2 — Wait for approval

Your account starts in PENDING state. An admin reviews and approves it. You will be notified out-of-band when approved. Check your Dashboard for status updates.

Step 3 — Receive your credentials

On approval the admin receives two credentials and shares them with you:

Key	Type	Usage
appKey	UUID (public)	Identifies your tenant on every request
apiKey	64-char hex (secret)	Authenticates your requests — keep this private

Important: The raw apiKey is shown only once at approval time. Store it securely immediately. If lost, rotate via Dashboard → API Keys → Rotate Keys.

Step 4 — Upload documents

Go to the Documents tab and upload your knowledge base files (PDF or TXT only, max 50 MB each). Wait until status shows READY before querying.

Step 5 — Start querying

curl -X POST https://api.uat.bot.shoum.in/api/v1/chat \
  -H "Content-Type: application/json" \
  -H "x-app-key: YOUR_APP_KEY" \
  -H "x-api-key: YOUR_API_KEY" \
  -d '{"query": "What are your pricing plans?"}'

Base URL

https://api.uat.bot.shoum.in/api/v1

All endpoints are prefixed with /api/v1.