Projects and keys (#119)

Author: NirBenita

.gitignore

@@ -1,2 +1,2 @@
-# Claude Code settings
 .claude/
+.package-lock.json

api-reference/introduction.mdx

@@ -4,5 +4,14 @@ title: "Introduction"
 
 The following is a list of publicly available APIs you can use with the [Traceloop platform](https://app.traceloop.com).
 
-All APIs require an API key to be used. You can get one by [signing up](https://app.traceloop.com),
-and then going to the [API Keys](https://app.traceloop.com/settings/api-keys) page.
+All APIs require an API key to be used for authentication.
+
+<Note>
+  **To generate an API key:**
+  1. [Sign up](https://app.traceloop.com) for a Traceloop account if you haven't already
+  2. Go to [Settings → Organization](https://app.traceloop.com/settings/api-keys)
+  3. Select a project and environment
+  4. Click **Generate API key** and copy it immediately
+
+  [Detailed instructions →](/settings/managing-api-keys)
+</Note>

datasets/sdk-usage.mdx

@@ -37,9 +37,8 @@ const client = traceloop.getClient();
 </CodeGroup>
 
 <Note>
-  Make sure you've created an API key and set it as an environment variable
-  `TRACELOOP_API_KEY` before you start. Check out the SDK's [getting started
-  guide](/openllmetry/getting-started-python) for more information.
+  **Prerequisites:** You need an API key set as the environment variable `TRACELOOP_API_KEY`.
+  [Generate one in Settings →](/settings/managing-api-keys)
 </Note>
 
 The SDK fetches your datasets from Traceloop servers. Changes made to a draft dataset version are immediately available in the UI.

experiments/running-from-code.mdx

@@ -39,9 +39,8 @@ const client = traceloop.getClient();
 </CodeGroup>
 
 <Note>
-  Make sure you've created an API key and set it as an environment variable
-  `TRACELOOP_API_KEY` before you start. Check out the SDK's [getting started
-  guide](/openllmetry/getting-started-python) for more information.
+  **Prerequisites:** You need an API key set as the environment variable `TRACELOOP_API_KEY`.
+  [Generate one in Settings →](/settings/managing-api-keys)
 </Note>
 
 

img/settings/project-dark.png

@@ -178,6 +178,13 @@
       "group": "Prompt Management",
       "pages": ["prompts/quick-start", "prompts/registry", "prompts/sdk-usage"]
     },
+    {
+      "group": "Settings",
+      "pages": [
+        "settings/managing-api-keys",
+        "settings/projects-and-environments"
+      ]
+    },
     {
       "group": "Integrations",
       "pages": ["integrations/posthog"]

img/settings/project-light.png

@@ -109,21 +109,29 @@ For Traceloop, read on. For other options, see [Exporting](/openllmetry/integrat
 
 ### Using Traceloop Cloud
 
-Go to [Traceloop](https://app.traceloop.com), and create a new account.
-Then, click on **Environments** on the left-hand navigation bar. Or go to directly to https://app.traceloop.com/settings/api-keys.
-Click **Generate API Key** to generate an API key for the developement environment and click **Copy API Key** to copy it over.
+<Note>
+  You need an API key to send traces to Traceloop.
+  [Generate one in Settings](https://app.traceloop.com/settings/api-keys) by selecting
+  a project and environment, then click **Generate API key**.
 
-<Warning>Make sure to copy it as it won't be shown again.</Warning>
+  ⚠️ **Important:** Copy the key immediately - it won't be shown again after you close or reload the page.
 
-<Frame>
-  <img className="block dark:hidden" src="/img/api-key-light.png" />
-  <img className="hidden dark:block" src="/img/api-key-dark.png" />
-</Frame>
+  [Detailed instructions →](/settings/managing-api-keys)
+</Note>
+
+Set the API key as an environment variable in your app named `TRACELOOP_API_KEY`:
 
-Set the copied Traceloop's API key as an environment variable in your app named `TRACELOOP_API_KEY`.
+```bash
+export TRACELOOP_API_KEY=your_api_key_here
+```
 
 Done! You'll get instant visibility into everything that's happening with your LLM.
 If you're calling a vector DB, or any other external service or database, you'll also see it in the Traceloop dashboard.
 
+<Tip>
+  **Not seeing traces?** Make sure you're viewing the correct project and environment in the
+  dashboard that matches your API key. See [Troubleshooting](/settings/managing-api-keys#troubleshooting).
+</Tip>
+
 </Step>
 </Steps>