Skip to main content
The ReyGrid API is the HTTP interface to the ReyGrid RAG platform. It lets you chat with your RAG agents, keep persistent conversations per user, manage their knowledge, search it, and track your usage. This reference is generated from the API’s OpenAPI specification (version 1.0.3).

​
Base URL

​
Making requests

  • Send and receive JSON (Content-Type: application/json).
  • Authenticate with a Bearer API key in the Authorization header. Only GET /ping is public. See Authentication.
  • Path segments such as agentId and conversationRef are plain strings. URL-encode them if they contain special characters.

​
Response format

Successful responses are JSON objects with "success": true. Failures use one of two shapes; see Errors.

​
Pagination

List endpoints accept two query parameters. Each list response includes a pagination object:
Conversations add totalConversations, messages add totalMessages and sources add totalSources. Keep requesting the next page while hasNextPage is true.

​
Endpoints

conversationRef accepts either a conversationId or a persistent userId. See Persistent conversations.

​
SDKs

Prefer a typed client? Use the Python or TypeScript SDK.