# SupaProxy

## Docs

- [Authentication](https://docs.supaproxy.cloud/api-reference/authentication.md): Signup, login, session, and logout endpoints.
- [Connections](https://docs.supaproxy.cloud/api-reference/connections.md): MCP connection testing, saving, and deletion.
- [Consumers](https://docs.supaproxy.cloud/api-reference/consumers.md): Consumer connection and channel binding endpoints.
- [Conversations](https://docs.supaproxy.cloud/api-reference/conversations.md): List, detail, and close conversation endpoints.
- [Organisation](https://docs.supaproxy.cloud/api-reference/organisation.md): Organisation CRUD, settings, integrations, and user management.
- [API overview](https://docs.supaproxy.cloud/api-reference/overview.md): Authentication, base URL, and conventions for the SupaProxy API.
- [Query](https://docs.supaproxy.cloud/api-reference/query.md): Execute a query through the agent loop.
- [Queues](https://docs.supaproxy.cloud/api-reference/queues.md): Background job queue management endpoints.
- [Workspaces](https://docs.supaproxy.cloud/api-reference/workspaces.md): Workspace CRUD, dashboard, and activity endpoints.
- [Compliance](https://docs.supaproxy.cloud/concepts/compliance.md): Guardrails for PII filtering, cost caps, rate limits, and enforcement order.
- [Connections](https://docs.supaproxy.cloud/concepts/connections.md): Data sources the AI can call. MCP servers, tool discovery, and the agent loop.
- [Consumers](https://docs.supaproxy.cloud/concepts/consumers.md): Entry points where users interact with the AI. Slack, API, WhatsApp, and more.
- [Conversations](https://docs.supaproxy.cloud/concepts/conversations.md): Multi-turn chat sessions. Lifecycle, stats, and analysis.
- [Knowledge](https://docs.supaproxy.cloud/concepts/knowledge.md): Indexed documents, source types, and per-workspace isolation.
- [Observability](https://docs.supaproxy.cloud/concepts/observability.md): Audit logs, dashboard metrics, and what gets logged.
- [Workspaces](https://docs.supaproxy.cloud/concepts/workspaces.md): Isolated AI environments for teams. Lifecycle, configuration, and what a workspace contains.
- [Add a connection](https://docs.supaproxy.cloud/guides/add-connection.md): Connect an MCP server, REST API, or database to a workspace.
- [Add a consumer](https://docs.supaproxy.cloud/guides/add-consumer.md): Bind a Slack channel, API key, or other entry point to a workspace.
- [Add knowledge sources](https://docs.supaproxy.cloud/guides/add-knowledge.md): Add wiki pages, files, and inline text to a workspace's knowledge base.
- [Configure guardrails](https://docs.supaproxy.cloud/guides/configure-guardrails.md): Set up PII filtering, write confirmation, cost caps, and rate limits.
- [Deploy to production](https://docs.supaproxy.cloud/guides/deploy.md): Containers, environment variables, security checklist, and scaling.
- [Self-hosting on DigitalOcean](https://docs.supaproxy.cloud/guides/self-hosting.md): Deploy SupaProxy to a single DigitalOcean droplet with Docker Compose and automatic SSL.
- [What is SupaProxy](https://docs.supaproxy.cloud/introduction.md): An AI operations platform that gives organisations a single place to govern AI, including connections, compliance, observability, and delivery.
- [Connection Plugins](https://docs.supaproxy.cloud/plugins/connections.md): Build custom connection plugins for SupaProxy. HTTP, STDIO, authenticated transports, and more.
- [Consumer Plugins](https://docs.supaproxy.cloud/plugins/consumers.md): Build custom consumer plugins for SupaProxy. Slack, API, and any messaging platform.
- [Knowledge Source Plugins](https://docs.supaproxy.cloud/plugins/knowledge-sources.md): Build custom knowledge source plugins for SupaProxy. URLs, Confluence, inline text, and more.
- [Plugin Architecture](https://docs.supaproxy.cloud/plugins/overview.md): Extend SupaProxy with plugin packages for consumers, connections, knowledge sources, and AI providers.
- [Provider Plugins](https://docs.supaproxy.cloud/plugins/providers.md): Build custom AI provider plugins for SupaProxy. Anthropic, OpenAI, and any LLM backend.
- [Quick start](https://docs.supaproxy.cloud/quickstart.md): Get up and running with SupaProxy in under 5 minutes.
- [Architecture](https://docs.supaproxy.cloud/reference/architecture.md): System overview, stack, and how the pieces connect.
- [Environment variables](https://docs.supaproxy.cloud/reference/environment-variables.md): All configuration variables for the SupaProxy server and dashboard.
- [Open Source vs Cloud](https://docs.supaproxy.cloud/reference/open-source-vs-cloud.md): How SupaProxy Cloud builds on the open-source server, and what's different.
- [Client](https://docs.supaproxy.cloud/sdk/client.md): SupaProxyClient class reference.
- [Error handling](https://docs.supaproxy.cloud/sdk/error-handling.md): How to handle errors from the SupaProxy SDK.
- [Installation](https://docs.supaproxy.cloud/sdk/installation.md): Install and configure the SupaProxy SDK.
- [Methods](https://docs.supaproxy.cloud/sdk/methods.md): Detailed reference for all SDK methods with parameters and return types.
- [SDK overview](https://docs.supaproxy.cloud/sdk/overview.md): TypeScript SDK for the SupaProxy API. Typed methods, error handling, and cookie-based auth.
- [Types](https://docs.supaproxy.cloud/sdk/types.md): TypeScript types exported by the SDK.

## OpenAPI Specs

- [openapi](https://docs.supaproxy.cloud/api-reference/openapi.json)

## Optional

- [GitHub](https://github.com/NumstackPtyLtd/supaproxy-server)