Managing API keys

An API key is the credential used when calling endpoint APIs and the Neutree control plane API.

An API key inherits the creator’s permissions in the corresponding workspace. When a user calls the control plane API, the platform authenticates based on the API key’s permissions. When a user calls an endpoint API, the platform tracks usage based on the API key.

Creating an API key

To achieve more granular control over permission management and usage tracking, it is recommended to create a separate API key for each AI application.

1. Log in to the Neutree management interface, click API key in the left menu, then click Create on the right.
2. Select a Workspace for the API key and enter a Name. These cannot be edited after the API key is created.
3. After confirming the configuration, click Save to complete creation.

Note

The API key value cannot be viewed again after creation. Copy it immediately and store it securely.

Viewing API keys

Log in to the Neutree management interface and click API Key in the left menu. The API key list on the right shows all API keys. Click an API key name to view details, including usage statistics for that API key.

Note

Neutree aggregates usage information every 5 minutes. After a user calls the API, the usage information for that user will appear on the details page only after one aggregation cycle completes.

Deleting API keys

You can delete one or more API keys at a time.

1. Log in to the Neutree management interface, click the menu icon (…) in the API key list or details page, and select Delete; or select multiple API keys in the list and click Delete above the list.
2. In the dialog that appears, confirm and click Delete. The selected API keys will be permanently deleted.