Personal Project API Keys

Overview

Personal Project API Keys give individual users direct, credentialed access to the Fuel iX API. Rather than relying on shared or organization-level credentials, each user manages their own personal projects — named groupings that hold one or more API key pairs, scoped to the API products the user is entitled to access.

This feature is distinct from Fuel iX Powered Apps keys, which are used for system-level or team-level integrations. Personal projects are intended for individual developer use: prototyping, local development, and personal integrations.

---

Key Concepts

---

Who Can Use This Feature

Personal Project API Keys are available to any user who has been onboarded through the developer portal (dx-portal). There are no role restrictions beyond standard portal access.

---

Personal Projects Interface

Finding Your Projects

Navigate to Personal project in the portal sidebar. The Apps index page lists all of your personal projects. Each project card shows the project name and is clickable to open the project detail view.

Project Detail View

The project detail view is the central interface for managing a project and its keys. It is divided into several sections:

• Project header — project name with an edit option; description; delete project button
• Credentials — the list of API keys associated with this project
• Permissions — the API products this project is permitted to access
• Project Details — metadata including the internal App ID and the owner email address

---

Creating a Personal Project

1. From the Personal project index page, select New Personal Project.
2. In the modal that opens, enter:
   • Personal Project Name (required): must start with a letter or number; may contain letters, numbers, spaces, hyphens, underscores, periods, dollar signs, and percent signs
   • Description (optional): a plain-text description of the project's purpose
3. The API Permissions section lists the available API products. All products are enabled by default. Toggle off any products this project should not have access to. At least one product must remain enabled.
4. If the Vectors toggle is visible, enable it to grant this project access to Turbopuffer namespace-scoped vector storage.
5. Select Create Project.

On success, the portal navigates to the new project's detail page. An initial default API key named "Default API key" is automatically created and associated with all selected products.

Note: Project names must be unique within your account. If you use a name that is already taken, an error will be shown.

---

Managing API Keys

Viewing Keys

All credentials for a project are listed in the Credentials section of the project detail view. Each key row shows:

• The key value (masked as •••••••••••• by default)
• The key status badge: approved (green) or the current status (red) if not approved
• The creation date
• "Expires" — Fuel iX API keys expiration dates
• The last used timestamp (currently reflects the issuance date)

Revealing a Key

Each key row includes a Show key / Hide key toggle. Selecting it reveals the full key value in the row. Selecting it again masks it. Keys are masked by default to prevent accidental exposure.

Copying a Key

Select anywhere on the key display area (or the copy icon) to copy the key value to your clipboard. Only the key — not the secret — is copied.

Generating a New Key

1. From the project detail page, select Generate New Key.
2. A new key is created and immediately associated with all API products the project is configured to access (all products except ax-api are included by default).
3. The new key appears in the Credentials list with approved status.

There is no upper limit displayed in the UI; a project can hold multiple active keys simultaneously.

Key Status: Approve and Revoke

Each key can be set to approved or revoked. A revoked key is blocked from making API requests but is not deleted — it can be re-approved at any time.

To change a key's status:

1. Select the edit (pencil) icon on the key row.
2. The Edit API Key dialog opens, showing the current status toggle (on = approved, off = revoked).
3. Toggle the switch to the desired state.
4. Select Save Changes. The Save Changes button is only enabled after the status has changed from its current value.
5. The dialog closes and the key badge updates to reflect the new status.

Note: Changing status to approved calls the Apigee approve endpoint; changing to revoked calls the Apigee revoke endpoint. Both operations are synchronous — the UI reflects the updated state immediately on success.

Deleting a Key

1. Select the delete (trash) icon on the key row.
2. A confirmation dialog appears asking you to confirm the deletion.
3. Confirm to permanently remove the key.

Deleted keys cannot be recovered. Any integration using the deleted key will begin receiving authentication errors immediately.

---

Managing the Project

Editing Project Name or Description

1. Select the edit icon next to the project name or description.
2. An inline input appears. Make your changes.
3. Confirm the edit. The change is saved to the DisplayName or Description attribute on the Apigee developer app.

Project name validation applies: the name must start with a letter or number and may not contain unsupported special characters.

Deleting a Project

1. Select the Delete Project button in the project header area.
2. A confirmation dialog appears.
3. Confirm to permanently delete the project and all its associated keys.

Deleting a project removes all credentials associated with it from Apigee. This action cannot be undone. Any active keys under the project will immediately stop working.

---

API Permissions

The Permissions section of the project detail view shows which API products the project is associated with. Products are displayed as toggle switches.

Currently, the permissions display is read-only (toggles are visible but not interactive). The set of products a project has access to is determined at project creation time. Contact an administrator if you need to change the product associations for an existing project.

Vector Access

If the Vectors feature is enabled for your organisation, a Vectors toggle appears in both the project creation modal and the project detail view. When enabled, the project is granted access to Turbopuffer namespace-scoped vector database storage, which is stored as a userId attribute on the Apigee developer app.

---

Project Details Panel

The Project Details section at the bottom of the project detail view shows:

These values are read-only and are used for support and debugging purposes.

---

Security Guidance

Important: Do not share your API key with others or expose it in the browser or other client-side code. To protect your account's security, Fuel iX may automatically disable any API key that has leaked publicly.

Best practices for handling personal project API keys:

• Store keys in environment variables or a secrets manager — never hardcode them in source files
• Use .gitignore or equivalent to prevent .env files from being committed to version control
• Generate a separate key per environment (development, staging, production) so that rotation or revocation in one environment does not affect others
• Revoke keys that are no longer in use rather than leaving them active
• If you suspect a key has been exposed, revoke it immediately from the portal and generate a new one

---

Workflow Summary

Create a project and get your first key

Apps index → Create New Personal Project
  → Enter name + description
  → Configure API product permissions
  → Create Project
  → Navigate to project detail page
  → Default API key is pre-created and visible in Credentials

Generate an additional key

Project detail page → Generate New Key
  → New key appears in Credentials list (approved, full access to project products)

Revoke a key temporarily

Project detail page → key row → edit icon
  → Edit API Key dialog → toggle status off (revoked)
  → Save Changes

Re-approve a revoked key

Project detail page → key row → edit icon
  → Edit API Key dialog → toggle status on (approved)
  → Save Changes

Permanently remove a key

Project detail page → key row → delete icon → confirm

Delete a project

Project detail page → Delete Project button → confirm

---

Related Documentation

• [[Service Accounts - User Guide]] — Organisation-level credentials for system and team integrations
• Apigee Developer Apps documentation (internal reference)
• Fuel iX API Reference — endpoints available to API key holders