Get site settings
curl --request GET \
--url https://api.vacademy.ai/catalog/v1/site \
--header 'X-API-Key: <api-key>'const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.vacademy.ai/catalog/v1/site', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.vacademy.ai/catalog/v1/site"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text){
"institute": {
"id": "2719d8d1-43fd-4f9f-97af-a5b067d770a6",
"name": "Brahm Varchas Shiksha",
"logo_url": "https://cdn.example.com/logo.png"
},
"course_base_url": "https://learning.brahmvarchas.org/store",
"languages": [
{
"code": "en",
"label": "English"
},
{
"code": "hi",
"label": "Hindi"
}
],
"formats": [
{
"key": "elearning",
"label": "Interactive, self-paced E-learning"
},
{
"key": "ebook",
"label": "E-books"
},
{
"key": "live",
"label": "Live sessions"
},
{
"key": "video",
"label": "Video"
},
{
"key": "animation",
"label": "Short film / Animation"
},
{
"key": "article",
"label": "Articles-essays"
},
{
"key": "merch",
"label": "Merchandise (in collaboration)"
},
{
"key": "audiobook",
"label": "Audio Book"
}
],
"currency": "INR",
"price_visible": true
}Site
Get site settings
The institute, where its course pages live, and the languages, formats, currency and price visibility of its catalogue. Use it to build filters.
Scope: catalog:read. Cacheable for 60 s.
GET
/
site
Get site settings
curl --request GET \
--url https://api.vacademy.ai/catalog/v1/site \
--header 'X-API-Key: <api-key>'const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.vacademy.ai/catalog/v1/site', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.vacademy.ai/catalog/v1/site"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text){
"institute": {
"id": "2719d8d1-43fd-4f9f-97af-a5b067d770a6",
"name": "Brahm Varchas Shiksha",
"logo_url": "https://cdn.example.com/logo.png"
},
"course_base_url": "https://learning.brahmvarchas.org/store",
"languages": [
{
"code": "en",
"label": "English"
},
{
"code": "hi",
"label": "Hindi"
}
],
"formats": [
{
"key": "elearning",
"label": "Interactive, self-paced E-learning"
},
{
"key": "ebook",
"label": "E-books"
},
{
"key": "live",
"label": "Live sessions"
},
{
"key": "video",
"label": "Video"
},
{
"key": "animation",
"label": "Short film / Animation"
},
{
"key": "article",
"label": "Articles-essays"
},
{
"key": "merch",
"label": "Merchandise (in collaboration)"
},
{
"key": "audiobook",
"label": "Audio Book"
}
],
"currency": "INR",
"price_visible": true
}Authorizations
ApiKeyBearer
Your publishable Catalogue API key (vak_pub_…).
Response
The site.
Show child attributes
Show child attributes
Where course pages live on the hosted site, e.g. https://learning.brahmvarchas.org/store.
Course languages; empty when the site has them off.
Show child attributes
Show child attributes
Every format the site defines, in display order.
Show child attributes
Show child attributes
The most common currency across courses.
False when the institute hides prices on its catalogue.