SDKs

Airweave provides a Python and TypeScript SDK to help you integrate with your applications and extend functionality.

Python SDK

$
pip install airweave-sdk

The Python SDK provides a complete interface to Airweave’s functionality:

1
from airweave import AirweaveClient
2
3
client = AirweaveClient(api_key="your-api-key")
4
5
# List all sources
6
sources = client.sources.list()
7
8
# List all source connections
9
connections = client.sources.list_connected_integrations(
10
  integration_type="source"
11
)
12
13
# Create one-off sync job
14
source_connection_id = connections[0].id
15
16
job = client.sync.create_sync(
17
  name="My first sync",
18
  source_connection_id=source_connection_id,
19
  run_immediately=True
20
)

TypeScript/JavaScript SDK

$
npm install @airweave/sdk
>
# or
>
yarn add @airweave/sdk

The TypeScript SDK provides type-safe access to Airweave:

1
import { AirweaveClient } from "@airweave/sdk";
2
3
const client = new AirweaveClient({
4
  apiKey: "your-api-key",
5
});
6
7
// List all sources
8
const sources = await client.sources.list();
9
10
// List all source connections
11
const connections = await client.sources.list_connected_integrations({
12
  integration_type: "source",
13
});
14
15
// Create one-off sync job
16
const job = await client.sync.create_sync({
17
  name: "My first sync",
18
  source_connection_id: connections[0].id,
19
  run_immediately: true,
20
});

SDK Features

All SDKs provide:

• Type Safety: Full TypeScript/Python type definitions
• Authentication: API key and OAuth2 support
• Error Handling: Detailed error messages and retry logic
• Rate Limiting: Automatic rate limit handling
• Async Support: Native async/await patterns