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.

Plinqx supports two authentication methods: API keys for programmatic access and session-based authentication for the admin portal.

​
API Key Authentication

API keys are the primary method for authenticating AI clients and external integrations.

​
Header Authentication

Include your API key in the Authorization header: 
Authorization: Bearer plinqx_xxxxxxxxxxxxxxxxxxxx

​
Query Parameter Authentication

For MCP clients, you can pass the API key as a query parameter: 
?api_key=plinqx_xxxxxxxxxxxxxxxxxxxx
Header authentication is recommended for security. Query parameters may be logged in server logs.

​
API Key Scopes

API keys are scoped to Collections:
  • Collection Access: Key can only access tools in assigned Collections
  • Permission Filtering: Keys can filter which permissions are available
  • Audit Trail: All requests are tracked by API key
An API key can be linked to multiple Collections, giving it access to all tools in those Collections.

​
Session Authentication

The admin portal uses session-based authentication:
  • Login: Email and password authentication
  • Session Cookie: Browser stores session cookie automatically
  • Logout: Session is invalidated on logout
Session authentication is handled automatically by the browser. You don’t need to manage sessions manually.

​
Error Responses

​
401 Unauthorized

{
  "error": {
    "message": "Invalid or expired API key",
    "code": "UNAUTHORIZED"
  }
}

​
403 Forbidden

{
  "error": {
    "message": "Insufficient permissions",
    "code": "FORBIDDEN"
  }
}

​
Best Practices

Use Header Auth

Prefer header authentication over query parameters

Rotate Keys

Rotate API keys periodically for security

Limit Scope

Only grant access to Collections that are needed

Monitor Usage

Review API key usage in audit logs

​
Next Steps

Create API Keys

Generate API keys for your integrations

MCP Protocol

Learn about MCP authentication