Integrate the power of language models with your company’s data to deliver accurate and contextualized answers.
Access internal knowledge sources easily — such as documents, databases, or company archives — and get more complete, reliable, and informative answers thanks to the RAG system and the LLM model.
All the knowledge you need
Here you can find some advice to consider to approach this API. If you prefer, we provide code samples, OAS3 documentation, the ability to try the API live via the Swagger UI or import the entire collection into Postman. We also offer a Sandbox environment where you can experiment with all kinds of requests completely free of charge.
Useful tips to start with
ai
Get the token in the appropriate section before you start.
Use the the online tool or generate it via API. Set the expire date, a usefull name and now add a bunch of scopes to limit the possible actions your token can do.
RAG
Methods for RAG Creation, File Management, and Querying
RAG Creation
POST /rag
This method creates a RAG and defines its options.
File Upload for RAG
POST /rag/{ragId}/documents
This method uploads a file to the RAG and sets its options.
List Your RAGs
GET /rag
This method returns a list of RAGs associated with your account.
Retrieve a Specific RAG
GET /rag/{ragId}
This method retrieves a specific RAG based on its ID.
Retrieve a Specific File in a RAG
GET /rag/{ragId}/documents/{fileId}
This method retrieves a specific file from a RAG by its ID.
Start Indexing
PATCH /rag/{ragId}
This method starts the indexing process for a specific RAG.
RAG Search
POST /rag-search
Searches for documents within a RAG based on a query.
RAG Search with Answer
POST /rag-search-with-answer
Generates an AI answer using RAG.
RAG Conversation
POST /rag-conversation
Conversational chat session with a RAG system.
Delete a Document
DELETE /rag/{ragId}/documents/{fileId}
This method deletes a single file from a RAG by its ID.
Delete a RAG
DELETE /rag/{ragId}
This method deletes a RAG by its ID.
RAG Creation
POST /rag
This method creates a RAG and defines its options.
File Upload for RAG
POST /rag/{ragId}/documents
This method uploads a file to the RAG and sets its options.
List Your RAGs
GET /rag
This method returns a list of RAGs associated with your account.
Retrieve a Specific RAG
GET /rag/{ragId}
This method retrieves a specific RAG based on its ID.
Retrieve a Specific File in a RAG
GET /rag/{ragId}/documents/{fileId}
This method retrieves a specific file from a RAG by its ID.
Start Indexing
PATCH /rag/{ragId}
This method starts the indexing process for a specific RAG.
RAG Search
POST /rag-search
Searches for documents within a RAG based on a query.
RAG Search with Answer
POST /rag-search-with-answer
Generates an AI answer using RAG.
RAG Conversation
POST /rag-conversation
Conversational chat session with a RAG system.
Delete a Document
DELETE /rag/{ragId}/documents/{fileId}
This method deletes a single file from a RAG by its ID.
Delete a RAG
DELETE /rag/{ragId}
This method deletes a RAG by its ID.
- Oas file url https://console.openapi.com/oas/en/ai.openapi.json
- Production domain ai.openapi.com
- Sandbox domain test.ai.openapi.com
- Production Scopes 7
-
Sandbox Scopes 7
- POST test.ai.openapi.com/rag
- GET test.ai.openapi.com/rag
- PATCH test.ai.openapi.com/rag
- DELETE test.ai.openapi.com/rag
- POST test.ai.openapi.com/rag-search
- POST test.ai.openapi.com/rag-search-with-answer
- POST test.ai.openapi.com/rag-conversation
Redoc missing.