Documentation

Getting started

Getting Started with EasyRAG

EasyRAG is a RAG-as-a-Service platform:
you upload files → we index them → you query them with a single API call.

This guide will help you get your first dataset online and start asking questions.


1. Create an account & get your API key

After signing in at https://easyrag.com, open:

Dashboard → API Keys → Generate key

You will use this key from your backend to authenticate.

Never expose your API key in browser code.
Use frontend tokens instead (see /docs/tokens).


2. Create a dataset

A dataset is just an identifier (string).
You can pick any name:

  • my-company-docs
  • customer-support-knowledge

You do not need to pre-register a dataset.
It will be created automatically when you upload your first file.


3. Upload your first file

Example using curl:

bash
curl -X POST https://api.easyrag.com/v1/files/upload \ -H "X-easyrag-key: YOUR_API_KEY" \ -F "datasetId=my-company-docs" \ -F "file=@./handbook.pdf"

If successful, EasyRAG:

  • uploads the file
  • extracts text
  • vectorizes content
  • inserts it into the vector db
  • bills credits (see /docs/credits-billing)