Skip to main content
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>'
{
  "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": {}
}

​
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

ParameterTypeRequiredDescription
config_idstringYesUnique 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

​
x-api-key
string
header
required

Path Parameters

​
config_id
string
required

The unique ID of the RAG configuration to retrieve.

Response

Successful Response

​
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
boolean
​
meta_data
object