RAG Query
curl --request POST \
--url https://api.intelligence.io.solutions/api/r2r/v3/retrieval/rag \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"query": "<string>",
"search_mode": "custom",
"search_settings": {
"use_hybrid_search": false,
"use_semantic_search": true,
"use_fulltext_search": false,
"filters": "<string>",
"limit": 10,
"offset": "0",
"include_metadatas": true,
"include_scores": true,
"search_strategy": "vanilla",
"hybrid_settings": {
"full_text_weight": 1,
"semantic_weight": 5,
"full_text_limit": 200,
"rrf_k": 50
},
"chunk_settings": {
"probes": 10,
"ef_search": 40,
"enabled": true
},
"graph_settings": {
"limits": "<array>",
"enabled": true
},
"num_sub_queries": 5
},
"rag_generation_config": {
"model": "<string>",
"temperature": 123,
"top_p": 123,
"max_tokens_to_sample": 123,
"stream": true,
"functions": "<array>",
"tools": "<array>",
"add_generation_kwargs": "<array>",
"api_base": "<string>",
"response_format": [
{
"Base Model": {}
}
],
"extended_thinking": false,
"thinking_budget": 123,
"reasoning_effort": "<string>"
},
"task_prompt": "<string>",
"include_title_if_available": false,
"include_web_search": false
}
'import requests
url = "https://api.intelligence.io.solutions/api/r2r/v3/retrieval/rag"
payload = {
"query": "<string>",
"search_mode": "custom",
"search_settings": {
"use_hybrid_search": False,
"use_semantic_search": True,
"use_fulltext_search": False,
"filters": "<string>",
"limit": 10,
"offset": "0",
"include_metadatas": True,
"include_scores": True,
"search_strategy": "vanilla",
"hybrid_settings": {
"full_text_weight": 1,
"semantic_weight": 5,
"full_text_limit": 200,
"rrf_k": 50
},
"chunk_settings": {
"probes": 10,
"ef_search": 40,
"enabled": True
},
"graph_settings": {
"limits": "<array>",
"enabled": True
},
"num_sub_queries": 5
},
"rag_generation_config": {
"model": "<string>",
"temperature": 123,
"top_p": 123,
"max_tokens_to_sample": 123,
"stream": True,
"functions": "<array>",
"tools": "<array>",
"add_generation_kwargs": "<array>",
"api_base": "<string>",
"response_format": [{ "Base Model": {} }],
"extended_thinking": False,
"thinking_budget": 123,
"reasoning_effort": "<string>"
},
"task_prompt": "<string>",
"include_title_if_available": False,
"include_web_search": False
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
query: '<string>',
search_mode: 'custom',
search_settings: {
use_hybrid_search: false,
use_semantic_search: true,
use_fulltext_search: false,
filters: '<string>',
limit: 10,
offset: '0',
include_metadatas: true,
include_scores: true,
search_strategy: 'vanilla',
hybrid_settings: {full_text_weight: 1, semantic_weight: 5, full_text_limit: 200, rrf_k: 50},
chunk_settings: {probes: 10, ef_search: 40, enabled: true},
graph_settings: {limits: '<array>', enabled: true},
num_sub_queries: 5
},
rag_generation_config: {
model: '<string>',
temperature: 123,
top_p: 123,
max_tokens_to_sample: 123,
stream: true,
functions: '<array>',
tools: '<array>',
add_generation_kwargs: '<array>',
api_base: '<string>',
response_format: [{'Base Model': {}}],
extended_thinking: false,
thinking_budget: 123,
reasoning_effort: '<string>'
},
task_prompt: '<string>',
include_title_if_available: false,
include_web_search: false
})
};
fetch('https://api.intelligence.io.solutions/api/r2r/v3/retrieval/rag', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.intelligence.io.solutions/api/r2r/v3/retrieval/rag",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'query' => '<string>',
'search_mode' => 'custom',
'search_settings' => [
'use_hybrid_search' => false,
'use_semantic_search' => true,
'use_fulltext_search' => false,
'filters' => '<string>',
'limit' => 10,
'offset' => '0',
'include_metadatas' => true,
'include_scores' => true,
'search_strategy' => 'vanilla',
'hybrid_settings' => [
'full_text_weight' => 1,
'semantic_weight' => 5,
'full_text_limit' => 200,
'rrf_k' => 50
],
'chunk_settings' => [
'probes' => 10,
'ef_search' => 40,
'enabled' => true
],
'graph_settings' => [
'limits' => '<array>',
'enabled' => true
],
'num_sub_queries' => 5
],
'rag_generation_config' => [
'model' => '<string>',
'temperature' => 123,
'top_p' => 123,
'max_tokens_to_sample' => 123,
'stream' => true,
'functions' => '<array>',
'tools' => '<array>',
'add_generation_kwargs' => '<array>',
'api_base' => '<string>',
'response_format' => [
[
'Base Model' => [
]
]
],
'extended_thinking' => false,
'thinking_budget' => 123,
'reasoning_effort' => '<string>'
],
'task_prompt' => '<string>',
'include_title_if_available' => false,
'include_web_search' => false
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.intelligence.io.solutions/api/r2r/v3/retrieval/rag"
payload := strings.NewReader("{\n \"query\": \"<string>\",\n \"search_mode\": \"custom\",\n \"search_settings\": {\n \"use_hybrid_search\": false,\n \"use_semantic_search\": true,\n \"use_fulltext_search\": false,\n \"filters\": \"<string>\",\n \"limit\": 10,\n \"offset\": \"0\",\n \"include_metadatas\": true,\n \"include_scores\": true,\n \"search_strategy\": \"vanilla\",\n \"hybrid_settings\": {\n \"full_text_weight\": 1,\n \"semantic_weight\": 5,\n \"full_text_limit\": 200,\n \"rrf_k\": 50\n },\n \"chunk_settings\": {\n \"probes\": 10,\n \"ef_search\": 40,\n \"enabled\": true\n },\n \"graph_settings\": {\n \"limits\": \"<array>\",\n \"enabled\": true\n },\n \"num_sub_queries\": 5\n },\n \"rag_generation_config\": {\n \"model\": \"<string>\",\n \"temperature\": 123,\n \"top_p\": 123,\n \"max_tokens_to_sample\": 123,\n \"stream\": true,\n \"functions\": \"<array>\",\n \"tools\": \"<array>\",\n \"add_generation_kwargs\": \"<array>\",\n \"api_base\": \"<string>\",\n \"response_format\": [\n {\n \"Base Model\": {}\n }\n ],\n \"extended_thinking\": false,\n \"thinking_budget\": 123,\n \"reasoning_effort\": \"<string>\"\n },\n \"task_prompt\": \"<string>\",\n \"include_title_if_available\": false,\n \"include_web_search\": false\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.intelligence.io.solutions/api/r2r/v3/retrieval/rag")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"query\": \"<string>\",\n \"search_mode\": \"custom\",\n \"search_settings\": {\n \"use_hybrid_search\": false,\n \"use_semantic_search\": true,\n \"use_fulltext_search\": false,\n \"filters\": \"<string>\",\n \"limit\": 10,\n \"offset\": \"0\",\n \"include_metadatas\": true,\n \"include_scores\": true,\n \"search_strategy\": \"vanilla\",\n \"hybrid_settings\": {\n \"full_text_weight\": 1,\n \"semantic_weight\": 5,\n \"full_text_limit\": 200,\n \"rrf_k\": 50\n },\n \"chunk_settings\": {\n \"probes\": 10,\n \"ef_search\": 40,\n \"enabled\": true\n },\n \"graph_settings\": {\n \"limits\": \"<array>\",\n \"enabled\": true\n },\n \"num_sub_queries\": 5\n },\n \"rag_generation_config\": {\n \"model\": \"<string>\",\n \"temperature\": 123,\n \"top_p\": 123,\n \"max_tokens_to_sample\": 123,\n \"stream\": true,\n \"functions\": \"<array>\",\n \"tools\": \"<array>\",\n \"add_generation_kwargs\": \"<array>\",\n \"api_base\": \"<string>\",\n \"response_format\": [\n {\n \"Base Model\": {}\n }\n ],\n \"extended_thinking\": false,\n \"thinking_budget\": 123,\n \"reasoning_effort\": \"<string>\"\n },\n \"task_prompt\": \"<string>\",\n \"include_title_if_available\": false,\n \"include_web_search\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.intelligence.io.solutions/api/r2r/v3/retrieval/rag")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"query\": \"<string>\",\n \"search_mode\": \"custom\",\n \"search_settings\": {\n \"use_hybrid_search\": false,\n \"use_semantic_search\": true,\n \"use_fulltext_search\": false,\n \"filters\": \"<string>\",\n \"limit\": 10,\n \"offset\": \"0\",\n \"include_metadatas\": true,\n \"include_scores\": true,\n \"search_strategy\": \"vanilla\",\n \"hybrid_settings\": {\n \"full_text_weight\": 1,\n \"semantic_weight\": 5,\n \"full_text_limit\": 200,\n \"rrf_k\": 50\n },\n \"chunk_settings\": {\n \"probes\": 10,\n \"ef_search\": 40,\n \"enabled\": true\n },\n \"graph_settings\": {\n \"limits\": \"<array>\",\n \"enabled\": true\n },\n \"num_sub_queries\": 5\n },\n \"rag_generation_config\": {\n \"model\": \"<string>\",\n \"temperature\": 123,\n \"top_p\": 123,\n \"max_tokens_to_sample\": 123,\n \"stream\": true,\n \"functions\": \"<array>\",\n \"tools\": \"<array>\",\n \"add_generation_kwargs\": \"<array>\",\n \"api_base\": \"<string>\",\n \"response_format\": [\n {\n \"Base Model\": {}\n }\n ],\n \"extended_thinking\": false,\n \"thinking_budget\": 123,\n \"reasoning_effort\": \"<string>\"\n },\n \"task_prompt\": \"<string>\",\n \"include_title_if_available\": false,\n \"include_web_search\": false\n}"
response = http.request(request)
puts response.read_body{
"key": "value"
}{}""Retrieval
RAG Query
The R2R RAG Query endpoint performs Retrieval-Augmented Generation by combining semantic search, graph-enhanced context, and LLM generation. It supports streaming, source citation, and multiple model providers for contextually accurate AI responses.
POST
/
api
/
r2r
/
v3
/
retrieval
/
rag
RAG Query
curl --request POST \
--url https://api.intelligence.io.solutions/api/r2r/v3/retrieval/rag \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"query": "<string>",
"search_mode": "custom",
"search_settings": {
"use_hybrid_search": false,
"use_semantic_search": true,
"use_fulltext_search": false,
"filters": "<string>",
"limit": 10,
"offset": "0",
"include_metadatas": true,
"include_scores": true,
"search_strategy": "vanilla",
"hybrid_settings": {
"full_text_weight": 1,
"semantic_weight": 5,
"full_text_limit": 200,
"rrf_k": 50
},
"chunk_settings": {
"probes": 10,
"ef_search": 40,
"enabled": true
},
"graph_settings": {
"limits": "<array>",
"enabled": true
},
"num_sub_queries": 5
},
"rag_generation_config": {
"model": "<string>",
"temperature": 123,
"top_p": 123,
"max_tokens_to_sample": 123,
"stream": true,
"functions": "<array>",
"tools": "<array>",
"add_generation_kwargs": "<array>",
"api_base": "<string>",
"response_format": [
{
"Base Model": {}
}
],
"extended_thinking": false,
"thinking_budget": 123,
"reasoning_effort": "<string>"
},
"task_prompt": "<string>",
"include_title_if_available": false,
"include_web_search": false
}
'import requests
url = "https://api.intelligence.io.solutions/api/r2r/v3/retrieval/rag"
payload = {
"query": "<string>",
"search_mode": "custom",
"search_settings": {
"use_hybrid_search": False,
"use_semantic_search": True,
"use_fulltext_search": False,
"filters": "<string>",
"limit": 10,
"offset": "0",
"include_metadatas": True,
"include_scores": True,
"search_strategy": "vanilla",
"hybrid_settings": {
"full_text_weight": 1,
"semantic_weight": 5,
"full_text_limit": 200,
"rrf_k": 50
},
"chunk_settings": {
"probes": 10,
"ef_search": 40,
"enabled": True
},
"graph_settings": {
"limits": "<array>",
"enabled": True
},
"num_sub_queries": 5
},
"rag_generation_config": {
"model": "<string>",
"temperature": 123,
"top_p": 123,
"max_tokens_to_sample": 123,
"stream": True,
"functions": "<array>",
"tools": "<array>",
"add_generation_kwargs": "<array>",
"api_base": "<string>",
"response_format": [{ "Base Model": {} }],
"extended_thinking": False,
"thinking_budget": 123,
"reasoning_effort": "<string>"
},
"task_prompt": "<string>",
"include_title_if_available": False,
"include_web_search": False
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
query: '<string>',
search_mode: 'custom',
search_settings: {
use_hybrid_search: false,
use_semantic_search: true,
use_fulltext_search: false,
filters: '<string>',
limit: 10,
offset: '0',
include_metadatas: true,
include_scores: true,
search_strategy: 'vanilla',
hybrid_settings: {full_text_weight: 1, semantic_weight: 5, full_text_limit: 200, rrf_k: 50},
chunk_settings: {probes: 10, ef_search: 40, enabled: true},
graph_settings: {limits: '<array>', enabled: true},
num_sub_queries: 5
},
rag_generation_config: {
model: '<string>',
temperature: 123,
top_p: 123,
max_tokens_to_sample: 123,
stream: true,
functions: '<array>',
tools: '<array>',
add_generation_kwargs: '<array>',
api_base: '<string>',
response_format: [{'Base Model': {}}],
extended_thinking: false,
thinking_budget: 123,
reasoning_effort: '<string>'
},
task_prompt: '<string>',
include_title_if_available: false,
include_web_search: false
})
};
fetch('https://api.intelligence.io.solutions/api/r2r/v3/retrieval/rag', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.intelligence.io.solutions/api/r2r/v3/retrieval/rag",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'query' => '<string>',
'search_mode' => 'custom',
'search_settings' => [
'use_hybrid_search' => false,
'use_semantic_search' => true,
'use_fulltext_search' => false,
'filters' => '<string>',
'limit' => 10,
'offset' => '0',
'include_metadatas' => true,
'include_scores' => true,
'search_strategy' => 'vanilla',
'hybrid_settings' => [
'full_text_weight' => 1,
'semantic_weight' => 5,
'full_text_limit' => 200,
'rrf_k' => 50
],
'chunk_settings' => [
'probes' => 10,
'ef_search' => 40,
'enabled' => true
],
'graph_settings' => [
'limits' => '<array>',
'enabled' => true
],
'num_sub_queries' => 5
],
'rag_generation_config' => [
'model' => '<string>',
'temperature' => 123,
'top_p' => 123,
'max_tokens_to_sample' => 123,
'stream' => true,
'functions' => '<array>',
'tools' => '<array>',
'add_generation_kwargs' => '<array>',
'api_base' => '<string>',
'response_format' => [
[
'Base Model' => [
]
]
],
'extended_thinking' => false,
'thinking_budget' => 123,
'reasoning_effort' => '<string>'
],
'task_prompt' => '<string>',
'include_title_if_available' => false,
'include_web_search' => false
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.intelligence.io.solutions/api/r2r/v3/retrieval/rag"
payload := strings.NewReader("{\n \"query\": \"<string>\",\n \"search_mode\": \"custom\",\n \"search_settings\": {\n \"use_hybrid_search\": false,\n \"use_semantic_search\": true,\n \"use_fulltext_search\": false,\n \"filters\": \"<string>\",\n \"limit\": 10,\n \"offset\": \"0\",\n \"include_metadatas\": true,\n \"include_scores\": true,\n \"search_strategy\": \"vanilla\",\n \"hybrid_settings\": {\n \"full_text_weight\": 1,\n \"semantic_weight\": 5,\n \"full_text_limit\": 200,\n \"rrf_k\": 50\n },\n \"chunk_settings\": {\n \"probes\": 10,\n \"ef_search\": 40,\n \"enabled\": true\n },\n \"graph_settings\": {\n \"limits\": \"<array>\",\n \"enabled\": true\n },\n \"num_sub_queries\": 5\n },\n \"rag_generation_config\": {\n \"model\": \"<string>\",\n \"temperature\": 123,\n \"top_p\": 123,\n \"max_tokens_to_sample\": 123,\n \"stream\": true,\n \"functions\": \"<array>\",\n \"tools\": \"<array>\",\n \"add_generation_kwargs\": \"<array>\",\n \"api_base\": \"<string>\",\n \"response_format\": [\n {\n \"Base Model\": {}\n }\n ],\n \"extended_thinking\": false,\n \"thinking_budget\": 123,\n \"reasoning_effort\": \"<string>\"\n },\n \"task_prompt\": \"<string>\",\n \"include_title_if_available\": false,\n \"include_web_search\": false\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.intelligence.io.solutions/api/r2r/v3/retrieval/rag")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"query\": \"<string>\",\n \"search_mode\": \"custom\",\n \"search_settings\": {\n \"use_hybrid_search\": false,\n \"use_semantic_search\": true,\n \"use_fulltext_search\": false,\n \"filters\": \"<string>\",\n \"limit\": 10,\n \"offset\": \"0\",\n \"include_metadatas\": true,\n \"include_scores\": true,\n \"search_strategy\": \"vanilla\",\n \"hybrid_settings\": {\n \"full_text_weight\": 1,\n \"semantic_weight\": 5,\n \"full_text_limit\": 200,\n \"rrf_k\": 50\n },\n \"chunk_settings\": {\n \"probes\": 10,\n \"ef_search\": 40,\n \"enabled\": true\n },\n \"graph_settings\": {\n \"limits\": \"<array>\",\n \"enabled\": true\n },\n \"num_sub_queries\": 5\n },\n \"rag_generation_config\": {\n \"model\": \"<string>\",\n \"temperature\": 123,\n \"top_p\": 123,\n \"max_tokens_to_sample\": 123,\n \"stream\": true,\n \"functions\": \"<array>\",\n \"tools\": \"<array>\",\n \"add_generation_kwargs\": \"<array>\",\n \"api_base\": \"<string>\",\n \"response_format\": [\n {\n \"Base Model\": {}\n }\n ],\n \"extended_thinking\": false,\n \"thinking_budget\": 123,\n \"reasoning_effort\": \"<string>\"\n },\n \"task_prompt\": \"<string>\",\n \"include_title_if_available\": false,\n \"include_web_search\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.intelligence.io.solutions/api/r2r/v3/retrieval/rag")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"query\": \"<string>\",\n \"search_mode\": \"custom\",\n \"search_settings\": {\n \"use_hybrid_search\": false,\n \"use_semantic_search\": true,\n \"use_fulltext_search\": false,\n \"filters\": \"<string>\",\n \"limit\": 10,\n \"offset\": \"0\",\n \"include_metadatas\": true,\n \"include_scores\": true,\n \"search_strategy\": \"vanilla\",\n \"hybrid_settings\": {\n \"full_text_weight\": 1,\n \"semantic_weight\": 5,\n \"full_text_limit\": 200,\n \"rrf_k\": 50\n },\n \"chunk_settings\": {\n \"probes\": 10,\n \"ef_search\": 40,\n \"enabled\": true\n },\n \"graph_settings\": {\n \"limits\": \"<array>\",\n \"enabled\": true\n },\n \"num_sub_queries\": 5\n },\n \"rag_generation_config\": {\n \"model\": \"<string>\",\n \"temperature\": 123,\n \"top_p\": 123,\n \"max_tokens_to_sample\": 123,\n \"stream\": true,\n \"functions\": \"<array>\",\n \"tools\": \"<array>\",\n \"add_generation_kwargs\": \"<array>\",\n \"api_base\": \"<string>\",\n \"response_format\": [\n {\n \"Base Model\": {}\n }\n ],\n \"extended_thinking\": false,\n \"thinking_budget\": 123,\n \"reasoning_effort\": \"<string>\"\n },\n \"task_prompt\": \"<string>\",\n \"include_title_if_available\": false,\n \"include_web_search\": false\n}"
response = http.request(request)
puts response.read_body{
"key": "value"
}{}""The RAG Query endpoint executes a Retrieval-Augmented Generation (RAG) workflow by combining semantic search, optional knowledge graph integration, and large language model (LLM) generation.
It returns contextually grounded, source-cited responses derived from your document corpus and external web content (if enabled).
This endpoint is ideal for applications that require explainable AI answers, document-grounded responses, and real-time contextual reasoning.
All search parameters available in the
Parameters:
Each event type corresponds to a distinct phase of the retrieval and generation workflow.
Example Response:
Key Features
- Combined retrieval and generation: Merges vector search, optional graph traversal, and LLM output generation in one request.
- Automatic source citation: Each referenced document includes a unique citation identifier.
- Streaming and non-streaming modes: Supports token-level updates or full-response delivery.
- Provider flexibility: Compatible with OpenAI, Anthropic, Ollama, and other LiteLLM-supported models.
- Web search integration: Optionally augments internal context with real-time external data.
Model Support
| Provider | Description |
|---|---|
| OpenAI | Default provider supporting GPT-based models (gpt-4o, gpt-4o-mini, etc.). |
| Anthropic | Supports Claude models (requires ANTHROPIC_API_KEY). |
| Ollama | Enables local model execution via Ollama runtime. |
| LiteLLM | Provides access to additional supported model providers. |
Request Body
The request body combines search configuration (for retrieval) and generation configuration (for LLM behavior).All search parameters available in the
/search endpoint can be reused here, including filters, hybrid search, and graph-enhanced retrieval.
Generation Configuration
Control model behavior using therag_generation_config object.
Example:
{
"model": "openai/gpt-4o-mini",
"temperature": 0.7,
"max_tokens": 1500,
"stream": true
}
model: Specifies the model used for generation.temperature: Controls output randomness (0 for deterministic, 1 for creative).max_tokens: Sets maximum output length.stream: Enables or disables token streaming for real-time responses.
Streaming Responses
Whenstream: true is enabled, the API emits Server-Sent Events (SSE) during processing.Each event type corresponds to a distinct phase of the retrieval and generation workflow.
| Event Type | Description |
|---|---|
search_results | Contains the initial search results from your documents. |
message | Streams partial tokens as the model generates them. |
citation | Emits citation metadata when a source is referenced. |
final_answer | Contains the complete, generated response with structured citations. |
{
"generated_answer": "DeepSeek-R1 is a model that demonstrates impressive performance...[1]",
"search_results": { ... },
"citations": [
{
"id": "cit.123456",
"object": "citation",
"payload": { ... }
}
]
}
Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Body
application/json
The user's question
Default value of custom allows full control over search settings. Pre-configured search modes: basic: A simple semantic-based search. advanced: A more powerful hybrid search combining semantic and full-text. custom: Full control via search_settings. If filters or limit are provided alongside basic or advanced, they will override the default settings for that mode.
Available options:
basic, advanced, custom The search configuration object. If search_mode is custom, these settings are used as-is. For basic or advanced, these settings will override the default mode configuration. Common overrides include filters to narrow results and limit to control how many results are returned.
Show child attributes
Show child attributes
Configuration for RAG generation
Show child attributes
Show child attributes
Optional custom prompt to override default
Include document titles in responses when available
Include web search results provided to the LLM.
Response
200
Example:
"value"
Was this page helpful?
⌘I