Installation

Get up and running with Weavz in a few minutes. You'll create an account, generate an API key, install an SDK for backend provisioning, and optionally install the CLI for terminal and coding agent workflows. For AI-native SaaS products, the SDK is usually your provisioning layer: your backend creates workspaces, adds workspace integrations, registers end users, creates MCP servers, and mints scoped MCP tokens for your agent harness.

Create an Account

1. Click Get Started on the Weavz website and sign up in the dashboard
2. Create your first organization — this is your top-level container for all resources
3. The dashboard creates a Production workspace and opens its setup hub
4. Use Templates when you want a prepared workspace, OAuth MCP server, and curated integrations in one flow

Generate an API Key

1. In the dashboard, go to API & SDKs
2. Click Create API Key
3. Give it a name (e.g., "Backend Server")
4. Copy the key — it starts with wvz_ and won't be shown again

API keys can be organization-scoped or limited to selected workspaces. Enable Human Gates decision permission when a backend should approve, reject, or cancel gated requests.

Install SDKs and CLI

TypeScript

npm install @weavz-io/sdk

Initialize the client:

import { WeavzClient } from '@weavz-io/sdk'
 
const weavz = new WeavzClient({
  apiKey: process.env.WEAVZ_API_KEY, // wvz_...
  baseUrl: 'https://platform.weavz.io',  // optional, this is the default
})

Python

pip install weavz-io-sdk

Initialize the client:

import os
from weavz_sdk import WeavzClient
 
weavz = WeavzClient(
    api_key=os.environ["WEAVZ_API_KEY"],  # wvz_...
    base_url="https://platform.weavz.io",      # optional, this is the default
)

CLI

Use the CLI when a developer, operator, or coding agent needs to work against the connected Weavz workspace from a terminal:

brew install weavz/tap/weavz
weavz login

npm install -g @weavz-io/cli
weavz login --no-open

The CLI signs in with device OAuth and uses the hosted /mcp/weavz connector. It does not replace your wvz_... API key for backend REST or SDK calls.

Verify Your Setup

Test your API key with a simple request:

curl https://platform.weavz.io/api/v1/integrations \
  -H "Authorization: Bearer wvz_your_api_key_here"

const { integrations, total } = await weavz.integrations.list()
console.log(`Available integrations: ${total ?? integrations.length}`)

result = weavz.integrations.list()
print(f"Available integrations: {result['total']}")

const res = await fetch('https://platform.weavz.io/api/v1/integrations', {
  headers: { 'Authorization': 'Bearer wvz_your_api_key_here' },
})
const data = await res.json()
console.log(`Available integrations: ${data.total}`)

import httpx
 
res = httpx.get(
    "https://platform.weavz.io/api/v1/integrations",
    headers={"Authorization": "Bearer wvz_your_api_key_here"},
)
data = res.json()
print(f"Available integrations: {data['total']}")

You should get a JSON response listing all available integrations:

{
  "integrations": [
    {
      "name": "slack",
      "displayName": "Slack",
      "description": "...",
      "auth": { "type": "OAUTH2" },
      "actions": {
        "send_channel_message": {
          "displayName": "Send Channel Message"
        }
      },
      "triggers": {}
    }
  ],
  "total": 1,
  "registered": ["slack"]
}

Base URL

For enterprise on-premise deployments, use your dedicated deployment URL. Contact sales for details.

Authentication

All API requests require authentication via the Authorization header:

Authorization: Bearer wvz_your_api_key_here

The SDK handles this automatically when you pass apiKey during initialization.

Rate Limits

API requests are rate-limited based on your plan tier. Rate limit information is returned in response headers:

Next Steps

• AI-Native SaaS Path — create workspace integrations, end-user auth, MCP servers, and per-user MCP tokens for agent harnesses
• Quick Start — build your first integration
• Setup Templates — create a prepared workspace and MCP server from the dashboard
• Organizations & Workspaces — understand the resource hierarchy