Merge branch 'main' of https://github.com/unifyai/unify-docs

docs/api/first_request.rst

@@ -43,7 +43,9 @@ The easiest way to use the Unify API is through the `unifyai <https://pypi.org/p
 
     pip install unifyai
 
-To use it in your script, import the package and initialize a :code:`Unify` client with your :code:`UNIFY API KEY`. You can then query any endpoint through the :code:`.generate` method. To specify the endpoint, you can use the model and provider Ids from above. 
+To use it in your script, import the package and insert the line :code:`UNIFY_KEY="Your_API_Key"` into the :code:`.env` file of your project. You can also pass your key into the :code:`api_key` argument or the Unify client but we recommend you store your key in an environment file for safety. We will assume you added your key to your :code:`.env` file for the remaining code examples.
+
+You are now ready to query any endpoint through the :code:`.generate` method. To specify the endpoint, you can use the model and provider Ids from above. 
 
 .. code-block:: python
 

docs/home/home.rst

@@ -19,4 +19,18 @@ We recommend you give the concepts section a quick read to get familiar with rou
 * **Make your first request**: The api guides explains how to start querying endpoints and using the router with our API.  
 
 .. warning::
-    Throughout the guides, you'll notice some sections marked as (Beta). **Any section marked as Beta is currently not available** and only illustrate planned features we are currently working on. We're constantly iterating on our roadmap so if you'd like to leave some feedback or suggestion on features you'd like to see, `we'd love to discuss <https://calendly.com/daniel-lenton/beta-discussion>`_ this with you!
+    Throughout the guides, you'll notice some sections marked as (Beta). **Any section marked as Beta is currently not available** and only illustrate planned features we are currently working on. We're constantly iterating on our roadmap so if you'd like to leave some feedback or suggestion on features you'd like to see, `we'd love to discuss <https://calendly.com/daniel-lenton/beta-discussion>`_ this with you!
+
+Welcome Gift
+------------
+
+Before diving in, you may have received a code to increase your credits. If that's the case, you can activate it with a simple request to this endpoint once you've grabbed your API key from the console:
+
+.. code-block:: bash
+
+    curl -X 'POST' \
+    'https://api.unify.ai/v0/promo?code=<CODE>' \
+    -H 'accept: application/json' \
+    -H 'Authorization: Bearer <YOUR_UNIFY_KEY>'
+
+Simply replace :code:`<CODE>` with your top up code and :code:`<YOUR_UNIFY_KEY>` with your API Key in the request, and you're ready to take-off with extra credits! 🚀

docs/interfaces/building_router.rst

@@ -3,8 +3,8 @@ Building a custom router
 
 In this section, you'll learn how to train and customize a router through the console.
 
-Training a custom router
-------------------------
+Training a custom router (Beta)
+-------------------------------
 
 Going to the :code:`Routers` page, you can add a new router by first clicking on :code:`Add Router`. The upload window enables you to name the router, and specify the endpoints to route between and datasets to train on.
 
@@ -44,8 +44,8 @@ With the benchmarks done, the router is moved to the training stage and, accordi
 
 Once the router training is complete, you will receive a second email. The router performance can now be visualized on the :code:`Dashboard` page.
 
-Customizing your router
------------------------
+Customizing your router (Beta)
+------------------------------
 
 Now that we have a trained router, the next step is to explore the various possible configurations for this router, each trading off quality, speed and cost in different variations. These various options can be visualized in the :code:`Dashboard`.
 

docs/interfaces/connecting_stack.rst

@@ -3,8 +3,8 @@ Connecting your stack
 
 In this section, you'll learn how to add your own endpoints and datasets to the console.
 
-Custom endpoints
-----------------
+Custom endpoints (Beta)
+-----------------------
 
 Prerequisite
 ^^^^^^^^^^^^