Overview

RAG-as-a-Service API (1.0.0)

Managed RAG API for developers building AI-powered features. Upload documents, we parse/chunk/embed/index them, you search with natural language.

Authentication

The API uses two authentication schemes:

• API Key (BearerApiKey): Used for all /api/v1/* endpoints. Pass your API key in the Authorization: Bearer <API_KEY> header.
• JWT (BearerJWT): Used for dashboard auth endpoints (/api/auth/me, /api/auth/api-key/regenerate). Obtained via /api/auth/signup or /api/auth/login.

Error Handling

All errors follow a consistent envelope format:

{
  "error": {
    "code": "ERROR_CODE",
    "message": "Human-readable message",
    "details": {}
  }
}

Pagination

List endpoints use cursor-based pagination. Pass the cursor value from the previous response’s meta.cursor field to fetch the next page.

Rate Limiting

Rate limits are enforced per plan. When exceeded, the API returns 429 with a RATE_LIMIT_EXCEEDED error code.

• License: Proprietary
• OpenAPI version: 3.0.3

Authentication

BearerApiKey

API key authentication. Pass your API key in the Authorization header: Authorization: Bearer rag_live_...

API keys are generated during signup and can be regenerated via the dashboard auth endpoints. Keys are hashed with SHA-256 at rest.

Security scheme type: http

BearerJWT

JWT authentication for dashboard endpoints. Obtain a token via /api/auth/signup or /api/auth/login. Pass it in the Authorization header: Authorization: Bearer <JWT>

Security scheme type: http

Bearer format: JWT