Learn how to use our Process and Forget RAG system API to build privacy-focused applications.
Our API is built on a fundamental privacy principle: process and forget. This means:
Note: To use our API, you'll need to be approved for the beta program. Contact us at beta@augmentedretrieval.com to request access.
You provide your own API keys for OpenAI and your vector database (Pinecone or Supabase) with each request. We never store your credentials on our servers.
Query multiple knowledge sources through a single API call by specifying custom indexes and controlling result counts.
/api/v1/chroma/storeStore multiple documents in ChromaDB with batch processing
{
"chromadb": {
"chroma_url": "http://your-chromadb-instance:8001"
},
"openai": {
"api_key": "your-openai-api-key"
},
"collection_name": "test_collection",
"documents": [
{
"id": "doc1",
"content": "This is the content of the first document",
"metadata": {
"source": "user_manual",
"category": "instructions"
}
},
{
"id": "doc2",
"content": "This is the content of the second document with different information",
"metadata": {
"source": "faq",
"category": "troubleshooting"
}
}
]
}Response: A success message with the count of documents stored.
{
"message": "Successfully stored 2 documents in collection test_collection"
}/api/v1/modular/queryQuery the RAG system with your question and optional conversation history
{
"query": {
"question": "How do I add a file attachment?",
"history": [ /* Optional conversation history */ ]
},
"sources_config": {
"custom_indexes": "my_knowledge_base,documentation",
"custom_indexes_top_k": 5
},
"credentials": {
"openai": {
"api_key": "your_openai_api_key"
},
/* Use either Pinecone OR Supabase credentials based on your setup */
"pinecone": {
"api_key": "your_pinecone_api_key",
"environment": "your_pinecone_environment"
}
/* OR */
/*
"supabase": {
"url": "your_supabase_url",
"key": "your_supabase_service_role_key"
}
*/
}
}query.questionThe user's questionquery.historyOptional conversation historysources_config.custom_indexesComma-separated list of indexes to querycredentialsYour OpenAI and Pinecone credentials/api/v1/modular/query-htmlSame as query endpoint but returns HTML-formatted responses
This endpoint accepts the same parameters as the regular query endpoint but returns responses formatted in HTML for easier display in web applications.
/api/v1/modular/documents/processProcess a document with instant deletion after vectorization
{
"document": "Your document content or base64 encoded file",
"metadata": {"title": "Important Document", "type": "policy"},
"index_name": "my_knowledge_base",
"credentials": {
"openai": {"api_key": "your_openai_api_key"},
/* Use either Pinecone OR Supabase credentials based on your setup */
"pinecone": {"api_key": "your_pinecone_api_key", "environment": "your_env"}
/* OR */
/*
"supabase": {
"url": "your_supabase_url",
"key": "your_supabase_service_role_key"
}
*/
}
}documentDocument text or base64 encoded filemetadataDocument metadata (title, type, etc.)index_namePinecone index to store vectorscredentialsYour OpenAI and Pinecone credentials/api/v1/modular/ingestion/documentationScrape and ingest multiple documentation URLs
{
"urls": [
"https://example.com/documentation/page1.html",
"https://example.com/documentation/page2.html"
],
"single_page": true,
"max_pages": 100,
"credentials": {
"openai": {"api_key": "your_openai_api_key"},
/* Use either Pinecone OR Supabase credentials based on your setup */
"pinecone": {"api_key": "your_pinecone_api_key", "environment": "your_env"}
/* OR */
/*
"supabase": {
"url": "your_supabase_url",
"key": "your_supabase_service_role_key"
}
*/
}
}This endpoint automatically scrapes multiple documentation URLs, processes the content, and stores the embeddings in your vector database. The original content is immediately discarded after processing.
Required for generating embeddings and retrieving context-aware responses.
Get from OpenAIOption 1: Use Pinecone for storing and retrieving vector embeddings.
Get from PineconeOption 2: Use Supabase pgvector for storing and retrieving vector embeddings.
Get from SupabaseNote: Your API keys are never stored on our servers. They are used only for the duration of your request and immediately discarded afterward.