Quickstart

$
curl -X POST 'https://api.airweave.ai/collections' \
>
  -H 'x-api-key: YOUR_API_KEY' \
>
  -H 'Content-Type: application/json' \
>
  -d '{
>
    "name": "My First Collection"
>
  }'

1
{
2
  "id": "123e4567-e89b-12d3-a456-426614174000",
3
  "name": "My First Collection",
4
  "readable_id": "my-first-collection-abc123",
5
  "created_at": "2024-01-15T10:30:00Z",
6
  "status": "NEEDS SOURCE"
7
}

1
from airweave import AirweaveSDK
2
3
client = AirweaveSDK(api_key="YOUR_API_KEY")
4
5
collection = client.collections.create_collection(
6
    name="My First Collection"
7
)
8
9
print(f"Created collection: {collection.readable_id}")

$
pip install airweave-sdk

1
import { AirweaveSDKClient } from "@airweave/sdk";
2
3
const client = new AirweaveSDKClient({
4
  apiKey: "YOUR_API_KEY"
5
});
6
7
const collection = await client.collections.createCollection({
8
  name: "My First Collection"
9
});
10
11
console.log(`Created collection: ${collection.readableId}`);

$
npm install @airweave/sdk

$
curl -X POST 'https://api.airweave.ai/source-connections' \
>
  -H 'x-api-key: YOUR_API_KEY' \
>
  -H 'Content-Type: application/json' \
>
  -d '{
>
    "name": "My Stripe Connection",
>
    "short_name": "stripe",
>
    "collection": "my-first-collection-abc123",
>
    "auth_fields": {
>
      "api_key": "sk_test_your_stripe_api_key"
>
    },
>
    "config_fields": {},
>
    "sync_immediately": true
>
  }'

1
{
2
  "id": "123e4567-e89b-12d3-a456-426614174000",
3
  "name": "My Stripe Connection",
4
  "short_name": "stripe",
5
  "collection": "my-first-collection-abc123",
6
  "status": "SYNCING",
7
  "created_at": "2024-01-15T10:30:00Z",
8
  "sync_id": "456e7890-e89b-12d3-a456-426614174000"
9
}

1
from airweave import AirweaveSDK
2
3
client = AirweaveSDK(api_key="YOUR_API_KEY")
4
5
source_connection = client.source_connections.create_source_connection(
6
    name="My Stripe Connection",
7
    short_name="stripe",
8
    collection="my-first-collection-abc123",
9
    auth_fields={
10
        "api_key": "sk_test_your_stripe_api_key"
11
    },
12
    config_fields={},
13
    sync_immediately=True
14
)
15
16
print(f"Created connection: {source_connection.id}")
17
print(f"Status: {source_connection.status}")

1
import { AirweaveSDKClient } from "@airweave/sdk";
2
3
const client = new AirweaveSDKClient({
4
  apiKey: "YOUR_API_KEY"
5
});
6
7
const sourceConnection = await client.sourceConnections.createSourceConnection({
8
  name: "My Stripe Connection",
9
  shortName: "stripe",
10
  collection: "my-first-collection-abc123",
11
  authFields: {
12
    apiKey: "sk_test_your_stripe_api_key"
13
  },
14
  configFields: {},
15
  syncImmediately: true
16
});
17
18
console.log(`Created connection: ${sourceConnection.id}`);
19
console.log(`Status: ${sourceConnection.status}`);

$
curl -X GET 'https://api.airweave.ai/collections/my-first-collection-abc123/search?query=What%20are%20our%20product%20features&response_type=raw' \
>
  -H 'x-api-key: YOUR_API_KEY' \
>
  -H 'Content-Type: application/json'

1
{
2
  "results": [
3
    {
4
      "content": "Our key product features include semantic search, real-time sync, and 28+ data connectors...",
5
      "source": "notion",
6
      "document_id": "abc123",
7
      "relevance_score": 0.95,
8
      "metadata": {
9
        "title": "Product Overview",
10
        "url": "https://notion.so/product-overview"
11
      }
12
    }
13
  ],
14
  "response_type": "raw",
15
  "completion": null,
16
  "status": "success"
17
}

$
curl -X GET 'https://api.airweave.ai/collections/my-first-collection-abc123/search?query=What%20are%20our%20product%20features&response_type=completion' \
>
  -H 'x-api-key: YOUR_API_KEY' \
>
  -H 'Content-Type: application/json'

1
{
2
  "results": [
3
    {
4
      "content": "Our key product features include semantic search, real-time sync, and 28+ data connectors...",
5
      "source": "notion",
6
      "document_id": "abc123",
7
      "relevance_score": 0.95,
8
      "metadata": {
9
        "title": "Product Overview",
10
        "url": "https://notion.so/product-overview"
11
      }
12
    }
13
  ],
14
  "response_type": "completion",
15
  "completion": "Based on your documentation, your product offers three main features: 1) Semantic search that understands natural language queries, 2) Real-time data synchronization across all connected sources, and 3) A comprehensive library of 28+ pre-built data connectors including popular tools like Notion, Slack, and GitHub.",
16
  "status": "success"
17
}

1
from airweave import AirweaveSDK
2
from airweave.schemas import ResponseType
3
4
client = AirweaveSDK(api_key="YOUR_API_KEY")
5
6
# Raw search results
7
results = client.collections.search_collection(
8
    readable_id="my-first-collection-abc123",
9
    query="What are our product features?",
10
    response_type=ResponseType.RAW
11
)
12
13
print(f"Found {len(results.results)} relevant documents:")
14
for result in results.results:
15
    print(f"📄 {result.metadata.title}")
16
    print(f"📝 {result.content[:200]}...")
17
    print(f"🔗 {result.metadata.url}\n")

1
from airweave import AirweaveSDK
2
from airweave.schemas import ResponseType
3
4
client = AirweaveSDK(api_key="YOUR_API_KEY")
5
6
# AI completion based on search results
7
results = client.collections.search_collection(
8
    readable_id="my-first-collection-abc123",
9
    query="What are our product features?",
10
    response_type=ResponseType.COMPLETION
11
)
12
13
print("🤖 AI Response:")
14
print(results.completion)
15
print(f"\n📚 Based on {len(results.results)} sources:")
16
for result in results.results:
17
    print(f"  • {result.metadata.title}")

1
import { AirweaveSDKClient, ResponseType } from "@airweave/sdk";
2
3
const client = new AirweaveSDKClient({ apiKey: "YOUR_API_KEY" });
4
5
// Raw search results
6
const results = await client.collections.searchCollection(
7
  "my-first-collection-abc123",
8
  {
9
    query: "What are our product features?",
10
    responseType: ResponseType.RAW
11
  }
12
);
13
14
console.log(`Found ${results.results.length} relevant documents:`);
15
results.results.forEach(result => {
16
  console.log(`📄 ${result.metadata.title}`);
17
  console.log(`📝 ${result.content.substring(0, 200)}...`);
18
  console.log(`🔗 ${result.metadata.url}\n`);
19
});

1
import { AirweaveSDKClient, ResponseType } from "@airweave/sdk";
2
3
const client = new AirweaveSDKClient({ apiKey: "YOUR_API_KEY" });
4
5
// AI completion based on search results
6
const results = await client.collections.searchCollection(
7
  "my-first-collection-abc123",
8
  {
9
    query: "What are our product features?",
10
    responseType: ResponseType.COMPLETION
11
  }
12
);
13
14
console.log("🤖 AI Response:");
15
console.log(results.completion);
16
console.log(`\n📚 Based on ${results.results.length} sources:`);
17
results.results.forEach(result => {
18
  console.log(`  • ${result.metadata.title}`);
19
});