Skip to content

fix: cleaned the FAQ related to API validation #538

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

Merged
merged 1 commit into from
Nov 15, 2024
Merged

fix: cleaned the FAQ related to API validation #538

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
12 changes: 5 additions & 7 deletions nbs/docs/getting-started/5_faq.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -168,14 +168,12 @@
"<details>\n",
" <summary>What if my API key isn't validating?</summary>\n",
"\n",
"If when you validate your API key, it returns\n",
"If when you validate your API key, it returns `False`\n",
"\n",
"`False`\n",
"\n",
"* Check that your API key is active in your dashboard\n",
"\n",
"* Consider any firewalls your organization might have. There may be restricted access. If so, you can whitelist our endpoints. \n",
"https://dashboard.nixtla.io/api and https://api.nixtla.io/\n",
"* If you are targeting an Azure endpoint, getting `False` from the `NixtlaClient.validate_api_key` method is expected. You can skip this step when taregting an Azure endpoint and proceed diretly to forecasting instead.\n",
"* If you are not taregting an Azure endpoint, then you should check the following:\n",
" * Check that your API key is active in your dashboard by visiting https://dashboard.nixtla.io/\n",
" * Consider any firewalls your organization might have. There may be restricted access. If so, you can whitelist our endpoint https://api.nixtla.io/\n",
"\n",
"</details>"
]
Expand Down