Skip to content

docs(Quick start): Include the api argument in the flagsmith.init example #8821

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
emyller wants to merge 2 commits into from
+3 −1
Closed

docs(Quick start): Include the api argument in the flagsmith.init example #8821

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
172dda3
docs: Show the `api` option in the quick start guide's `flagsmith.ini…
emyller Oct 21, 2026
c1b6906
docs: Keep the quick start `api` hint on a single line
emyller Oct 21, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion docs/docs/getting-started/quick-start.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,13 +86,15 @@ Then paste your API key into the code below:
<script>
flagsmith.init({
environmentID: '<add your API key here!>',
// api: 'https://flagsmith.example.com/api/v1/', // Self-hosted or private cloud only: set to your Flagsmith API URL
onChange: (oldFlags, params) => {},
});
</script>
```

Now when the browser opens the web page, it will download the Javascript SDK and make a call to `edge.api.flagsmith.com`
to get the flags for our Environment. You can see this in the browser network tab:
(or your own Flagsmith API, if you set the `api` option) to get the flags for our Environment. You can see this in the
browser network tab:

<div style={{textAlign: 'center'}}><img width="75%" src="/img/quickstart/demo_create_7.png"/></div>

Expand Down
Loading