Get Rag Config
curl --request GET \
--url https://rag-prod.studio.lyzr.ai/v3/rag/{config_id}/ \
--header 'x-api-key: <api-key>'import requests
url = "https://rag-prod.studio.lyzr.ai/v3/rag/{config_id}/"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://rag-prod.studio.lyzr.ai/v3/rag/{config_id}/', 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://rag-prod.studio.lyzr.ai/v3/rag/{config_id}/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://rag-prod.studio.lyzr.ai/v3/rag/{config_id}/"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://rag-prod.studio.lyzr.ai/v3/rag/{config_id}/")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://rag-prod.studio.lyzr.ai/v3/rag/{config_id}/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"id": "<string>",
"user_id": "<string>",
"llm_credential_id": "<string>",
"embedding_credential_id": "<string>",
"vector_db_credential_id": "<string>",
"description": "<string>",
"collection_name": "<string>",
"llm_model": "<string>",
"embedding_model": "<string>",
"vector_store_provider": "<string>",
"semantic_data_model": true,
"meta_data": {}
}{
"detail": "Invalid Permission"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}API Reference
Get RAG configuration
GET
/
rag
/
{config_id}
/
Get Rag Config
curl --request GET \
--url https://rag-prod.studio.lyzr.ai/v3/rag/{config_id}/ \
--header 'x-api-key: <api-key>'import requests
url = "https://rag-prod.studio.lyzr.ai/v3/rag/{config_id}/"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://rag-prod.studio.lyzr.ai/v3/rag/{config_id}/', 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://rag-prod.studio.lyzr.ai/v3/rag/{config_id}/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://rag-prod.studio.lyzr.ai/v3/rag/{config_id}/"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://rag-prod.studio.lyzr.ai/v3/rag/{config_id}/")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://rag-prod.studio.lyzr.ai/v3/rag/{config_id}/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"id": "<string>",
"user_id": "<string>",
"llm_credential_id": "<string>",
"embedding_credential_id": "<string>",
"vector_db_credential_id": "<string>",
"description": "<string>",
"collection_name": "<string>",
"llm_model": "<string>",
"embedding_model": "<string>",
"vector_store_provider": "<string>",
"semantic_data_model": true,
"meta_data": {}
}{
"detail": "Invalid Permission"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Description
Retrieves the configuration of a specific RAG (Retrieval-Augmented Generation) instance using its unique ID.Endpoint
GET/v3/rag/{config_id}/
Base URL
https://rag-dev.test.studio.lyzr.ai
Authentication
- Requires API Key (
x-api-key) in the request header.
Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
config_id | string | Yes | Unique identifier of the RAG config. |
Request Example (cURL)
curl -X GET "https://rag-dev.test.studio.lyzr.ai/v3/rag/8544/" \
-H "accept: application/json" \
-H "x-api-key: sk-default-Bk19s6ZUGIBoBkJNdkJ8YfcPLwULRXcH"
Response
200 - Successful Response
{
"id": "string",
"user_id": "string",
"llm_credential_id": "string",
"embedding_credential_id": "string",
"vector_db_credential_id": "string",
"description": "",
"collection_name": "string",
"llm_model": "string",
"embedding_model": "string",
"vector_store_provider": "string",
"semantic_data_model": false,
"meta_data": {}
}
403 - Invalid Permission
{
"detail": "Invalid Permission"
}
422 - Validation Error
{
"detail": [
{
"loc": ["string", 0],
"msg": "string",
"type": "string"
}
]
}
Authorizations
Path Parameters
The unique ID of the RAG configuration to retrieve.
⌘I