Documentation

Connect your applications to Ragger with our comprehensive guides

Get Started with Ragger

Automated registration and onboarding - get your account instantly

Via WhatsApp

Send a WhatsApp message with the word "ragger" to our automated registration system. The system will automatically create your account, manage your registration, and handle onboarding.

Send WhatsApp Message

Via Email

Send an email to our automated registration system. The system will automatically create your account and respond with your credentials and API endpoint.

Send Email

Automated Account Creation

Both WhatsApp and email registration are fully automated. The system will instantly create your account, manage your registration, handle onboarding, and respond with your API endpoint URL and account credentials. No manual intervention required!

Need help? Contact sales at sales.ragger@1nga.com

For Site Owners

Simple steps to connect your website to Ragger without writing code

Step 1: Get Your API Endpoint

After subscribing to Ragger, you'll receive your API endpoint URL. For hosted service users, this will be provided upon account setup. It will look something like:

https://api.rager.com/your-account

Save this URL—you'll need it for the next steps. Note: Self-hosted deployment is available for subscribers and enterprise customers. Contact us at sales.ragger@1nga.com for self-hosting options.

Step 2: Create Your rager.json File

Create a file named rager.json in your website's root directory. This file tells Ragger which pages to index.

{
  "$schema": "https://rager.1nga.com/schema/v1",
  "version": "1.0.0",
  "siteId": "your-unique-site-id",
  "name": "Your Website Name",
  "description": "Description of your website",
  "endpoints": [
    {
      "path": "/docs",
      "type": "markdown",
      "title": "Documentation"
    },
    {
      "path": "/about",
      "type": "html",
      "title": "About Page"
    }
  ],
  "settings": {
    "autoUpdate": true,
    "updateInterval": "24h"
  }
}

Replace your-unique-site-id with a unique identifier for your site, and add the pages you want to make searchable in the endpoints array.

Step 3: Submit Your Configuration

Share your rager.json file and your website URL with your development team. They will process it through Ragger's API to make your content searchable.

Once processed, your website content will be indexed and ready for intelligent search queries.

For Developers

Technical integration guide for connecting applications to Ragger

API Base URL

All API requests should be made to your Ragger hosted service endpoint (provided upon subscription):

BASE_URL = "https://api.rager.com/your-account"

Self-Hosting Available: Subscribers and enterprise customers can deploy Ragger on their own infrastructure. Contact us at sales.ragger@1nga.com to discuss self-hosting options and requirements.

1. Process rager.json Configuration

Submit a website's rager.json configuration to index all content:

POST /api/rager/process
Content-Type: application/json

{
  "rager_json": {
    "$schema": "https://rager.1nga.com/schema/v1",
    "version": "1.0.0",
    "siteId": "site-123",
    "name": "My Website",
    "endpoints": [
      {"path": "/docs", "type": "markdown"},
      {"path": "/api-docs", "type": "openapi"}
    ]
  },
  "base_url": "https://example.com"
}

This will automatically extract content from all specified endpoints and make them searchable.

2. Add Documents Directly

Add individual documents to the vector store:

POST /api/documents
Content-Type: application/json

{
  "content": "Your document content here...",
  "metadata": {
    "title": "Document Title",
    "source": "https://example.com/page"
  }
}

3. Search Documents

Search for relevant documents using semantic search:

POST /api/documents/search
Content-Type: application/json

{
  "query": "What is your question?",
  "k": 5
}

Returns the top k most relevant documents based on semantic similarity.

4. RAG Query (Complete Pipeline)

Get AI-generated answers based on your documents:

POST /api/rag/query
Content-Type: application/json

{
  "query": "Explain how authentication works",
  "k": 4
}

This endpoint retrieves relevant documents and generates a contextual answer using AI.

5. Health Check

Verify your connection to Ragger:

GET /health

MCP Integration Guide

Connect Ragger to Model Context Protocol (MCP) servers for AI assistant integration

What is MCP?

Model Context Protocol (MCP) is a standard for connecting AI assistants to external data sources and tools. By integrating Ragger with MCP, you can enable AI assistants to search and retrieve information from your documents.

Setting Up MCP Server

Create an MCP server configuration file to connect your AI assistant to Ragger:

{
  "mcpServers": {
    "ragger": {
      "command": "npx",
      "args": [
        "-y",
        "@modelcontextprotocol/server-ragger",
        "--api-url",
        "https://your-ragger-instance.com"
      ]
    }
  }
}

Replace https://your-ragger-instance.com with your Ragger hosted service endpoint (provided upon subscription). For self-hosted deployments, use your self-hosted instance URL.

MCP Resources

Once configured, your MCP server will expose the following resources:

  • ragger://documents

    List all indexed documents

  • ragger://search

    Search documents by query

  • ragger://query

    Perform RAG queries for AI-generated answers

Using MCP with AI Assistants

After configuration, your AI assistant can:

  • Search your documents when answering questions
  • Retrieve relevant information from your indexed content
  • Provide context-aware answers based on your documentation

Example Usage

Once configured, you can ask your AI assistant: "Search my documentation for authentication methods" and it will query Ragger to find relevant information from your indexed documents.

Complete API Reference

All available endpoints for programmatic access

Health & Info

GET /health Check API health status
GET / Get API information and available endpoints

Document Management

POST /api/documents Add a document to the vector store
GET /api/documents List all documents
GET /api/documents/:id Get a specific document
DELETE /api/documents/:id Delete a document

Search & Query

POST /api/documents/search Search for similar documents
POST /api/rag/query Perform RAG query with AI-generated answers
GET /api/rag/stats Get vector store statistics

Website Configuration

POST /api/rager/process Process rager.json configuration file
POST /api/rager/validate Validate rager.json file format

Self-Hosting Options

Deploy Ragger on your own infrastructure for maximum control

Available for Subscribers & Enterprise

Self-hosted deployment is available for subscribers and enterprise customers who require complete infrastructure control and data sovereignty.

What's Included

  • Complete deployment package and documentation
  • Docker containers and orchestration configs
  • Priority support and setup assistance
  • Custom configuration and integration support

Get Started with Self-Hosting

Contact our sales team at sales.ragger@1nga.com to discuss self-hosting requirements, infrastructure needs, and deployment options. We'll help you get Ragger running on your infrastructure with full support.

Need Help?

If you need assistance with integration, have questions about connecting your application, or want to discuss self-hosting options, we're here to help.

Contact Sales & Support

sales.ragger@1nga.com