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.
Collections
Collections are the primary way you organize and control access to tools. Think of them as curated toolboxes that you expose to specific AI clients.Each API key is scoped to one or more Collections. AI clients can only access tools in their assigned Collections.
Why Collections Matter
- Access Control: Different API keys can access different Collections
- Tool Curation: Choose exactly which tools AI clients can use
- Policy Scope: Apply policies at the Collection level
- Organization: Group related tools logically
Principals
Principals represent identities in Plinqx - both human users and AI agents.| Principal Type | Description |
|---|---|
| USER | Human users accessing the admin portal |
| SYSTEM | System-level operations |
| INTEGRATION | External integrations and AI clients |
| EXTERNAL_APPROVER | External parties who approve requests |
Vault
The Vault is Plinqx’s centralized credential management system. Instead of storing credentials directly in tools, you store them in the Vault and reference them by name.Supported Credential Types
- API Key - Simple key-based authentication
- Bearer Token - JWT or OAuth tokens
- Basic Auth - Username/password combinations
- OAuth2 Client Credentials - Machine-to-machine OAuth
- OAuth2 Authorization Code - User-delegated OAuth with refresh
Vault References
Reference Vault credentials in tool configurations using the syntax:Policies
Policies define governance rules that apply to tool executions. They can require approvals, limit rates, mask sensitive data, and more.Policy Scopes
| Scope | Applies To |
|---|---|
| Global | All tool executions tenant-wide |
| Collection | All tools in a specific Collection |
| Tool | A specific tool only |
| Principal | Requests from a specific Principal |
Rule Types
| Rule | Description |
|---|---|
| Approval | Require approval before execution |
| Rate Limit | Limit calls per time window |
| Quota | Limit total calls per period |
| Field Mask | Redact sensitive fields in responses |
| Deny | Block execution entirely |
| Allow | Explicitly allow (bypass other rules) |
Flows
Flows are multi-step workflows that chain actions together. They can be triggered by webhooks, schedules, or exposed as MCP tools themselves.Flow Components
- Trigger: What starts the flow (webhook, schedule, manual)
- Actions: Steps that execute (tool calls, transformations)
- Conditions: Logic for branching
- Outputs: What the flow returns
Store Exposure
Store Exposure controls which AI platforms can discover and use your tools. Plinqx supports:- ChatGPT - OpenAI’s GPT Store
- Claude - Anthropic’s Claude integrations
- Google Gemini - Google’s AI platform
Store Exposure is configured per-tool. You can expose different tools to different AI platforms.
Next Steps
Create Collections
Learn how to organize your tools
Set Up Governance
Configure policies and approvals