Skip to content

API reference

The complete reference of the public /v1 API of RAG Platform 1.1, generated from RAG Web 1.1.0.

Open the API reference Download openapi.json

The reference is rendered in your browser from the OpenAPI document.

Notes on the document

  • Upload fields are not in the schema. POST /v1/RAG/upload reads its multipart/form-data body directly. The fields are file, purpose, ApplicationId, InstanceId and the optional EntityId. See the quickstart.
  • Paths are listed with the capitalization of the code (/v1/RAG/…, /v1/Chat/…). Routes are case-insensitive, so /v1/rag/completions works too.
  • Authentication: every operation except GET /version requires the API key as a bearer token.
  • The document's info.version field says 1.0.0. That's a default of the generator, not the RAG Web version. The document belongs to RAG Web 1.1.0.