SDKs
Official TypeScript and Python SDKs for the Weavz public API.
SDKs
Weavz provides hand-written SDKs for the customer-facing API surface. They wrap REST endpoints with resource-specific clients while preserving the same product primitives used in the dashboard and API reference.
| SDK | Use it for |
|---|---|
| TypeScript SDK | Node.js and TypeScript backends, framework adapters, compile-time integration/action names, and generated action input types |
| Python SDK | Python backends, agent frameworks, script-based workflows, and generated Pydantic action input validation |
Generated Integration Catalog
Both SDKs include generated integration action input coverage from the same integration registry used by the API and docs.
| Need | TypeScript | Python | Runtime API |
|---|---|---|---|
| List known integrations | integrationNames | INTEGRATION_ACTIONS.keys() | GET /api/v1/integrations |
| List actions for an integration | integrationActions.slack | get_action_names("slack") | GET /api/v1/integrations?name=slack |
| Type or validate action input | ActionInput<"slack", "send_channel_message"> | SlackSendChannelMessageInput or validate_action_input(...) | Integration actions[*].props metadata |
| Resolve dynamic dropdowns | typed client.integrations.resolveOptions(...) | client.integrations.resolve_options(...) | POST /api/v1/integrations/{name}/properties/options |
Use the generated SDK helpers when the integration/action is known at build time. Use the runtime Integrations API when you are building dynamic catalogs, configuration UIs, or supporting integrations released after your SDK version.
Shared Naming Model
The SDKs use the same conceptual fields as the API:
| Concept | REST / TypeScript | Python |
|---|---|---|
| Catalog integration slug | integrationName | integration_name |
| Workspace integration create alias | alias | integration_alias on workspace methods |
| Execution selector alias | integrationAlias | integration_alias |
| Exact configured integration selector | workspaceIntegrationId | workspace_integration_id |
| Connection selector | connectionExternalId | connection_external_id |
| End-user selector | endUserId | end_user_id |
Review Identifier Model and Integration Selectors before wiring multi-tenant or repeated-integration flows.