Skip to main content

​
1. Sign up

Visit your SupaProxy instance and create an account. The signup wizard has three steps:
  1. Organisation: name your organisation (e.g. “Acme Corp”)
  2. Account: create your admin account (name, email, password)
  3. Workspace: create your first workspace and assign it to a team
Everything is created in a single API call. You are automatically signed in and redirected to the workspace.

​
2. Configure your workspace

Inside the workspace, use the tabs to set up:
  • Connections: add an MCP server or REST API so the AI has tools to call
  • Consumers: bind a Slack channel, API key, or other entry point
  • Knowledge: add documents and pages for context
  • Compliance: configure guardrails like PII filtering and cost caps
  • Settings: set the system prompt, model, and workspace name

​
3. Set up integrations

Go to Settings in the top navigation to configure organisation-level integrations:
  • AI provider: add your AI provider API key, used by all workspaces for queries
  • Messaging bot: add your Slack bot credentials (shared by all workspaces; individual workspaces bind channels to it)

​
4. Query

Once a connection is configured, you can query the workspace: 
curl -X POST https://your-instance/api/workspaces/ws-example/query \
  -H "Content-Type: application/json" \
  -H "Cookie: supaproxy_session=YOUR_JWT" \
  -d '{"query": "What is the status of order ORD-2026-001?"}'
All queries are logged in the Observability tab with tokens, cost, duration, and tools called.

​
Next steps

Add a connection

Connect an MCP server, REST API, or database.

Add a consumer

Bind a Slack channel, API key, or WhatsApp number.

Configure guardrails

Set up PII filtering, cost caps, and rate limits.

API reference

Explore all available endpoints.