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

curl --request GET \
  --url https://api.vacademy.ai/catalog/v1/site \
  --header 'X-API-Key: <api-key>'

200

Example

{
  "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

X-API-Key · string · header · required

Your publishable Catalogue API key (vak_pub_…).

Response

200

application/json

The site.

institute · object · required

Show child attributes

course_base_url · string | null · required

Where course pages live on the hosted site, e.g. https://learning.brahmvarchas.org/store.

languages · object[] · required

Course languages; empty when the site has them off.

Show child attributes

formats · object[] · required

Every format the site defines, in display order.

Show child attributes

currency · string | null · required

The most common currency across courses.

price_visible · boolean · required

False when the institute hides prices on its catalogue.