Overview

CompanyRAG Indexer API - API Key Authentication 1.0.0

OpenAPI specification for all endpoints in the CompanyRAG Indexer that support API Key authentication.

All endpoints in this specification require authentication via API Key using the Authorization header with Bearer token format.

API Keys are generated via the admin panel and have the format rag_<64-character-hex-string>.

Authentication Header:

Authorization: Bearer rag_<api-key>

Alternative (Cookie-based for browser clients): The API also supports access_token cookie as fallback authentication.

Most errors follow this format:

{
  "error": "Error message description"
}

A few endpoints (noted per-operation below) return a plain-text body via http.Error instead of this JSON shape.

Common HTTP status codes:

400 Bad Request: Invalid request parameters
401 Unauthorized: Missing or invalid authentication
403 Forbidden: Insufficient permissions
404 Not Found: Resource not found
409 Conflict: Resource state conflict (e.g. duplicate, cannot retry/delete in current state)
500 Internal Server Error: Server-side error

Information

API Key authentication using Bearer token. Format: Bearer rag_<64-character-hex>

Example:

Authorization: Bearer rag_a1b2c3d4e5f6...

Security scheme type: http