From bc4b1384e9837cd33d6d2d04b238224b7aa90999 Mon Sep 17 00:00:00 2001
From: Evandro Myller <22429+emyller@users.noreply.github.com>
Date: Wed, 21 Oct 2026 15:03:39 +0000
Subject: [PATCH] docs: Show the `api` option in the quickstart's
 `flagsmith.init` snippets

Generated with [Linear](https://linear.app/flagsmith/agent-session/827482a6-287d-4d10-a82a-b2dc9a13834e)

Co-authored-by: linear-code[bot] <222613912+linear-code[bot]@users.noreply.github.com>
---
 docs/docs/getting-started/quick-start.md | 8 +++++++-
 1 file changed, 7 insertions(+), 1 deletion(-)

diff --git a/docs/docs/getting-started/quick-start.md b/docs/docs/getting-started/quick-start.md
index 60d0f755f120..dc14aba8286d 100644
--- a/docs/docs/getting-started/quick-start.md
+++ b/docs/docs/getting-started/quick-start.md
@@ -80,12 +80,14 @@ We can now connect to the Flagsmith API and get our Flags. When you initialise t
 
 ![SDK Keys](/img/quickstart/demo_create_6.png)
 
-Then paste your API key into the code below:
+Then paste your API key into the code below. If you are self-hosting Flagsmith or using a private cloud instance, also uncomment the `api` option and set it to the URL of your Flagsmith API. You can leave it out if you are using Flagsmith SaaS.
 
 ```html
 <script>
  flagsmith.init({
   environmentID: '<add your API key here!>',
+  // Self-hosted or private cloud only: point the SDK at your own Flagsmith API
+  // api: 'https://flagsmith.example.com/api/v1/',
   onChange: (oldFlags, params) => {},
  });
 </script>
@@ -106,6 +108,8 @@ Let's hook this value up to our button, so that the value of the flag controls w
 <script>
  flagsmith.init({
   environmentID: '<add your API key here!>',
+  // Self-hosted or private cloud only: point the SDK at your own Flagsmith API
+  // api: 'https://flagsmith.example.com/api/v1/',
   onChange: (oldFlags, params) => {
    if (flagsmith.hasFeature('show_demo_button')) {
     var submit_button = document.getElementById('submit_button');
@@ -131,6 +135,8 @@ Our entire web page now reads like this:
   <script>
    flagsmith.init({
     environmentID: 'ZfmJTbLQZrhZVHkVhXbsNi',
+    // Self-hosted or private cloud only: point the SDK at your own Flagsmith API
+    // api: 'https://flagsmith.example.com/api/v1/',
     onChange: (oldFlags, params) => {
      if (flagsmith.hasFeature('show_demo_button')) {
       var submit_button = document.getElementById('submit_button');