Creating an API Key
Your API key is essential for connecting your AI chat model with Proxi.
Watch the video above or follow these steps to generate your API key, and remember to store it securely as it will only be shown once upon creation.
Step 1: Navigate to the API Keys Page
-
Log In:
Start by logging into your Proxi account. -
Go to the API Keys Page:
Visit the API Keys page to manage your API keys.
Step 2: Create a New API Key
-
Click “Create New API Key”:
On the API Keys page, locate and click the Create New API Key button. This will open a new page for generating your key. -
Enter a Name for Your API Key:
- Naming Convention:
The name should be specific to the AI agent for which the key will be used. This helps you easily identify and manage your keys later. - Type in the Name:
Enter a meaningful name (e.g., “Slack Summarizer” or “Daily Planner”).
- Naming Convention:
-
Select Scopes:
Choose the scopes that define the functionality this API key can access. We recommend selecting only the scopes that are essential for your agent’s tasks. For example, if your agent only needs to read calendar events, select just thegoogle-calendar.calendar.events:read
scope rather than every available scope. This minimizes access, reduces risk, and ensures that the key grants only the permissions needed for its specific purpose. -
Generate the API Key:
Once you’ve entered the name and selected the desired scopes, your API key will be generated automatically.
Step 3: Securely Store Your API Key
-
Important:
This API key is displayed only once upon creation.
Make sure to:- Store it securely: Save your API key in a secure location, such as a password manager.
- Treat it like a password: If you lose it, it cannot be recovered, and you will need to generate a new key.
-
Optional:
If you plan to connect your AI chat model (e.g. ChatGPT) with Proxi, click on the View Spec button after creating your API key. This will navigate you to a page that displays your custom OpenAPI specification—detailing the endpoints your API key can access—which is useful when configuring your ChatGPT integration.
Next Steps
With your account set up, you’re now ready to take the next steps:
- Connect Gmail to ChatGPT: Finally, pair your Gmail account with ChatGPT using Proxi as a bridge by following our Connect Gmail to ChatGPT guide.
Need Help?
If you encounter any issues while setting up your account or have any questions, please:
- Contact Support: Email us at myproxi@proton.me
- Join Our Discord: Connect with our community on Discord