API Reference

A REST API built for retrieval at scale.

Predictable, resource-oriented endpoints, bearer-token auth and JSON everywhere. Every BeastRAG capability is one HTTPS call away.

Endpoints

POST/v1/ingestStream documents into an index. Accepts files, URLs or raw text.
POST/v1/queryRun a hybrid retrieval query with optional SlimContext™ compression.
POST/v1/agents/runLaunch an agentic workflow with tool calling and step tracing.
GET/v1/indexesList indexes and their ingest status.
POST/v1/indexesCreate a new index with a chosen embedding model.
GET/v1/keysList and rotate API keys for your workspace.
Request
curl https://api.beastrag.com/v1/query \
  -H "Authorization: Bearer $BEAST_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "index": "annual-reports",
    "prompt": "Summarize FY25 revenue risk",
    "mode": "agentic",
    "slim_context": true,
    "top_k": 8
  }'
200 OK
{
  "text": "FY25 revenue risk is concentrated in...",
  "sources": [
    { "doc": "10-K.pdf", "page": 42, "score": 0.93 }
  ],
  "tokens_in": 1840,
  "tokens_saved": 1120,
  "latency_ms": 38
}

Looking for typed clients? Browse the SDKs.