Installation

Get up and running with Weavz in a few minutes. You'll create an account, generate an API key, and install the SDK.

Create an Account

1. Go to platform.weavz.io and sign up
2. Create your first organization — this is your top-level container for all resources
3. Optionally, create a workspace to scope your integrations (e.g., "production", "staging")

Generate an API Key

1. In the dashboard, go to Settings → API Keys
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 are scoped to your organization and grant access to all resources within it.

Install the SDK

TypeScript

npm install @weavz/sdk

Initialize the client:

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

Python

pip install weavz-sdk

Initialize the client:

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

Verify Your Setup

Test your API key with a simple request:

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

You should get a JSON response listing all available integrations:

{
  "data": [
    {
      "name": "slack",
      "displayName": "Slack",
      "description": "...",
      "auth": { "type": "OAUTH2", ... },
      "actions": [...],
      "triggers": [...]
    },
    ...
  ]
}

Or verify using the SDK:

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

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

• Quick Start — build your first integration
• Organizations & Workspaces — understand the resource hierarchy