Skip to content

Commit

Permalink
fix: cleaned the FAQ related to API validation (#538)
Browse files Browse the repository at this point in the history
  • Loading branch information
ngupta23 authored Nov 15, 2024
1 parent 5b8ecfc commit 2846b35
Showing 1 changed file with 5 additions and 7 deletions.
12 changes: 5 additions & 7 deletions nbs/docs/getting-started/5_faq.ipynb
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

0 comments on commit 2846b35

Please sign in to comment.