Skip to main content

Documentation Index

Fetch the complete documentation index at: https://hypha-docs.plinqx.app/llms.txt

Use this file to discover all available pages before exploring further.

API keys authenticate AI clients and control which Collections (and therefore which tools) they can access.

​
Overview

API keys provide:
  • Authentication: AI clients use API keys to authenticate with Plinqx
  • Access Control: Keys are scoped to specific Collections
  • Audit Trail: All requests are tracked by API key
  • Permission Filtering: Keys can filter which permissions are available

​
Creating API Keys

1

Navigate to API Keys

Click API Keys in the sidebar.
2

Create API Key

Click Create API Key.
3

Configure Key

Provide:
  • Name: Descriptive name (e.g., “ChatGPT Production”)
  • Collections: Select which Collections this key can access
  • Scopes: Optional permission scopes (leave empty for all permissions)
4

Copy Key

Copy your API key immediately - you won’t be able to see it again!
The key is shown once: plinqx_xxxxxxxxxxxxxxxxxxxx

​
Key Scopes

API keys can be scoped to specific Collections:
  • Selected Collections: Key can only access tools in these Collections
  • All Collections: Key can access all Collections (admin only)
An API key can be linked to multiple Collections, giving it access to all tools in those Collections.

​
Permission Scoping

API keys can filter permissions:
  • Empty Scopes: Key has all permissions of the associated Principal
  • Specific Scopes: Key only has the listed permissions (intersection with Principal permissions)
Use permission scoping to create limited-access keys for specific use cases.

​
Managing API Keys

​
Viewing Keys

The API Keys page shows:
  • Key name
  • Associated Collections
  • Created date
  • Last used date
  • Status (active/revoked)

​
Rotating Keys

To rotate an API key:
1

Create New Key

Create a new API key with the same Collections.
2

Update Clients

Update AI clients to use the new key.
3

Revoke Old Key

Revoke the old key once all clients are updated.

​
Revoking Keys

To revoke an API key:
  1. Open the key details
  2. Click Revoke
  3. Confirm revocation
Revoked keys cannot be restored. You must create a new key.

​
Using API Keys

AI clients authenticate using the API key in the request header: 
Authorization: Bearer plinqx_xxxxxxxxxxxxxxxxxxxx
Or as a query parameter (for MCP clients): 
?api_key=plinqx_xxxxxxxxxxxxxxxxxxxx

​
Best Practices

Use Descriptive Names

Name keys clearly (e.g., “ChatGPT Production”, “Claude Sandbox”)

Limit Scope

Only grant access to Collections that are needed

Rotate Regularly

Rotate keys periodically for security

Monitor Usage

Review last used dates to identify unused keys

​
Next Steps

Connect ChatGPT

Use your API key to connect ChatGPT

Create Collections

Set up Collections for your API keys