The First Retriever for any Website! The RAG.pro retriever is an agent that can filter your query by specified domains. We handle the RAG pipeline for you so you don't have to set up your own retriever!
You can find your API key on the Account Page. Keep it secure and include it in your requests as shown below.
All requests should be made to the following endpoint:
https://2q5vp3y0d0.execute-api.us-east-1.amazonaws.com/dev/retrieve
Include your API key in the request headers as x-api-key
.
Example Header:
x-api-key: YOUR_API_KEY
Send a POST request with a JSON payload containing the following parameters.
Headers:
x-api-key
(string, required): Your API key.Body:
queryStringParameters
(object, required):query
(string, required): The query string you want to send.model
(string, required): The size of the model to use. Options are "small"
, "medium"
, or "large"
.sources
(string, required): Whether to return sources. Options are "true"
or "false"
.multiValueQueryStringParameters
(object, optional):urls
(array of strings, optional): A list of URLs to filter search domains.{
"headers": {
"x-api-key": "YOUR_API_KEY"
},
"queryStringParameters": {
"query": "What is RAG?",
"model": "small",
"sources": "true"
},
"multiValueQueryStringParameters": {
"urls": [
"https://docs.example.com/rag"
]
}
}
The API responds with a JSON array containing the response content and metadata.
[
{
"page_content": "Your answer here...",
"metadata": {
"source": [
"https://www.relevant-site.com"
]
}
}
]
The API uses standard HTTP status codes to indicate success or failure.
Use the urls
parameter to focus the agent's knowledge on specific websites.
curl -X POST \
'https://2q5vp3y0d0.execute-api.us-east-1.amazonaws.com/dev/retrieve' \
-H 'Content-Type: application/json' \
-H 'x-api-key: YOUR_API_KEY' \
-d '{
"queryStringParameters": {
"query": "What is RAG?",
"model": "small",
"sources": "true"
},
"multiValueQueryStringParameters": {
"urls": [
"https://docs.aws.amazon.com/"
]
}
}'