@airweave/sdk 0.9.49 → 0.9.50

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (46) hide show
  1. package/dist/cjs/Client.js +2 -2
  2. package/dist/cjs/api/resources/collections/client/Client.d.ts +3 -53
  3. package/dist/cjs/api/resources/collections/client/Client.js +5 -261
  4. package/dist/cjs/api/resources/collections/client/requests/index.d.ts +0 -2
  5. package/dist/cjs/api/resources/collections/index.d.ts +1 -0
  6. package/dist/cjs/api/resources/collections/index.js +1 -0
  7. package/dist/cjs/api/resources/collections/resources/index.d.ts +2 -0
  8. package/dist/cjs/api/resources/collections/resources/index.js +41 -0
  9. package/dist/cjs/api/resources/collections/resources/search/client/Client.d.ts +90 -0
  10. package/dist/cjs/api/resources/collections/resources/search/client/Client.js +330 -0
  11. package/dist/cjs/api/resources/collections/resources/search/client/index.d.ts +2 -0
  12. package/dist/cjs/api/resources/collections/resources/search/client/index.js +17 -0
  13. package/dist/cjs/api/resources/collections/{client → resources/search/client}/requests/ClassicSearchRequest.d.ts +3 -2
  14. package/dist/cjs/api/resources/collections/{client → resources/search/client}/requests/InstantSearchRequest.d.ts +4 -2
  15. package/dist/cjs/api/resources/collections/resources/search/client/requests/index.d.ts +2 -0
  16. package/dist/cjs/api/resources/collections/resources/search/client/requests/index.js +2 -0
  17. package/dist/cjs/api/resources/collections/resources/search/index.d.ts +1 -0
  18. package/dist/cjs/api/resources/collections/resources/search/index.js +17 -0
  19. package/dist/cjs/version.d.ts +1 -1
  20. package/dist/cjs/version.js +1 -1
  21. package/dist/esm/Client.mjs +2 -2
  22. package/dist/esm/api/resources/collections/client/Client.d.mts +3 -53
  23. package/dist/esm/api/resources/collections/client/Client.mjs +5 -261
  24. package/dist/esm/api/resources/collections/client/requests/index.d.mts +0 -2
  25. package/dist/esm/api/resources/collections/index.d.mts +1 -0
  26. package/dist/esm/api/resources/collections/index.mjs +1 -0
  27. package/dist/esm/api/resources/collections/resources/index.d.mts +2 -0
  28. package/dist/esm/api/resources/collections/resources/index.mjs +2 -0
  29. package/dist/esm/api/resources/collections/resources/search/client/Client.d.mts +90 -0
  30. package/dist/esm/api/resources/collections/resources/search/client/Client.mjs +293 -0
  31. package/dist/esm/api/resources/collections/resources/search/client/index.d.mts +2 -0
  32. package/dist/esm/api/resources/collections/resources/search/client/index.mjs +1 -0
  33. package/dist/esm/api/resources/collections/{client → resources/search/client}/requests/ClassicSearchRequest.d.mts +3 -2
  34. package/dist/esm/api/resources/collections/{client → resources/search/client}/requests/InstantSearchRequest.d.mts +4 -2
  35. package/dist/esm/api/resources/collections/resources/search/client/requests/index.d.mts +2 -0
  36. package/dist/esm/api/resources/collections/resources/search/client/requests/index.mjs +1 -0
  37. package/dist/esm/api/resources/collections/resources/search/index.d.mts +1 -0
  38. package/dist/esm/api/resources/collections/resources/search/index.mjs +1 -0
  39. package/dist/esm/version.d.mts +1 -1
  40. package/dist/esm/version.mjs +1 -1
  41. package/package.json +1 -1
  42. package/reference.md +331 -325
  43. /package/dist/cjs/api/resources/collections/{client → resources/search/client}/requests/ClassicSearchRequest.js +0 -0
  44. /package/dist/cjs/api/resources/collections/{client → resources/search/client}/requests/InstantSearchRequest.js +0 -0
  45. /package/dist/esm/api/resources/collections/{client → resources/search/client}/requests/ClassicSearchRequest.mjs +0 -0
  46. /package/dist/esm/api/resources/collections/{client → resources/search/client}/requests/InstantSearchRequest.mjs +0 -0
package/reference.md CHANGED
@@ -508,7 +508,9 @@ await client.collections.update("customer-support-tickets-x7k9m", {
508
508
  </dl>
509
509
  </details>
510
510
 
511
- <details><summary><code>client.collections.<a href="/src/api/resources/collections/client/Client.ts">instantSearch</a>(readableId, { ...params }) -> AirweaveSDK.SearchV2Response</code></summary>
511
+ ## source-connections
512
+
513
+ <details><summary><code>client.sourceConnections.<a href="/src/api/resources/sourceConnections/client/Client.ts">list</a>({ ...params }) -> AirweaveSDK.SourceConnectionListItem[]</code></summary>
512
514
  <dl>
513
515
  <dd>
514
516
 
@@ -520,7 +522,13 @@ await client.collections.update("customer-support-tickets-x7k9m", {
520
522
  <dl>
521
523
  <dd>
522
524
 
523
- Direct vector search.
525
+ Retrieve all source connections for your organization.
526
+
527
+ Returns a lightweight list of source connections with essential fields for
528
+ display and navigation. Use the collection filter to see connections within
529
+ a specific collection.
530
+
531
+ For full connection details including sync history, use the GET /{id} endpoint.
524
532
 
525
533
  </dd>
526
534
  </dl>
@@ -536,8 +544,10 @@ Direct vector search.
536
544
  <dd>
537
545
 
538
546
  ```typescript
539
- await client.collections.instantSearch("readable_id", {
540
- query: "query",
547
+ await client.sourceConnections.list({
548
+ collection: "collection",
549
+ skip: 0,
550
+ limit: 100,
541
551
  });
542
552
  ```
543
553
 
@@ -554,15 +564,7 @@ await client.collections.instantSearch("readable_id", {
554
564
  <dl>
555
565
  <dd>
556
566
 
557
- **readableId:** `string`
558
-
559
- </dd>
560
- </dl>
561
-
562
- <dl>
563
- <dd>
564
-
565
- **request:** `AirweaveSDK.InstantSearchRequest`
567
+ **request:** `AirweaveSDK.ListSourceConnectionsGetRequest`
566
568
 
567
569
  </dd>
568
570
  </dl>
@@ -570,7 +572,7 @@ await client.collections.instantSearch("readable_id", {
570
572
  <dl>
571
573
  <dd>
572
574
 
573
- **requestOptions:** `Collections.RequestOptions`
575
+ **requestOptions:** `SourceConnections.RequestOptions`
574
576
 
575
577
  </dd>
576
578
  </dl>
@@ -581,7 +583,7 @@ await client.collections.instantSearch("readable_id", {
581
583
  </dl>
582
584
  </details>
583
585
 
584
- <details><summary><code>client.collections.<a href="/src/api/resources/collections/client/Client.ts">classicSearch</a>(readableId, { ...params }) -> AirweaveSDK.SearchV2Response</code></summary>
586
+ <details><summary><code>client.sourceConnections.<a href="/src/api/resources/sourceConnections/client/Client.ts">create</a>({ ...params }) -> AirweaveSDK.SourceConnection</code></summary>
585
587
  <dl>
586
588
  <dd>
587
589
 
@@ -593,7 +595,16 @@ await client.collections.instantSearch("readable_id", {
593
595
  <dl>
594
596
  <dd>
595
597
 
596
- AI-optimized search.
598
+ Create a new source connection to sync data from an external source.
599
+
600
+ The authentication method determines the creation flow:
601
+
602
+ - **Direct**: Provide credentials (API key, token) directly. Connection is created immediately.
603
+ - **OAuth Browser**: Returns a connection with an `auth_url` to redirect users for authentication.
604
+ - **OAuth Token**: Provide an existing OAuth token. Connection is created immediately.
605
+ - **Auth Provider**: Use a pre-configured auth provider (e.g., Composio, Pipedream).
606
+
607
+ After successful authentication, data sync can begin automatically or on-demand.
597
608
 
598
609
  </dd>
599
610
  </dl>
@@ -609,8 +620,9 @@ AI-optimized search.
609
620
  <dd>
610
621
 
611
622
  ```typescript
612
- await client.collections.classicSearch("readable_id", {
613
- query: "query",
623
+ await client.sourceConnections.create({
624
+ short_name: "github",
625
+ readable_collection_id: "customer-support-tickets-x7k9m",
614
626
  });
615
627
  ```
616
628
 
@@ -627,15 +639,7 @@ await client.collections.classicSearch("readable_id", {
627
639
  <dl>
628
640
  <dd>
629
641
 
630
- **readableId:** `string`
631
-
632
- </dd>
633
- </dl>
634
-
635
- <dl>
636
- <dd>
637
-
638
- **request:** `AirweaveSDK.ClassicSearchRequest`
642
+ **request:** `AirweaveSDK.SourceConnectionCreate`
639
643
 
640
644
  </dd>
641
645
  </dl>
@@ -643,7 +647,7 @@ await client.collections.classicSearch("readable_id", {
643
647
  <dl>
644
648
  <dd>
645
649
 
646
- **requestOptions:** `Collections.RequestOptions`
650
+ **requestOptions:** `SourceConnections.RequestOptions`
647
651
 
648
652
  </dd>
649
653
  </dl>
@@ -654,7 +658,7 @@ await client.collections.classicSearch("readable_id", {
654
658
  </dl>
655
659
  </details>
656
660
 
657
- <details><summary><code>client.collections.<a href="/src/api/resources/collections/client/Client.ts">agenticSearch</a>(readableId, { ...params }) -> AirweaveSDK.SearchV2Response</code></summary>
661
+ <details><summary><code>client.sourceConnections.<a href="/src/api/resources/sourceConnections/client/Client.ts">get</a>(sourceConnectionId) -> AirweaveSDK.SourceConnection</code></summary>
658
662
  <dl>
659
663
  <dd>
660
664
 
@@ -666,12 +670,18 @@ await client.collections.classicSearch("readable_id", {
666
670
  <dl>
667
671
  <dd>
668
672
 
669
- Agent that iteratively searches, reads, navigates hierarchies, and collects results.
673
+ Retrieve details of a specific source connection.
670
674
 
671
- </dd>
672
- </dl>
673
- </dd>
674
- </dl>
675
+ Returns complete information about the connection including:
676
+
677
+ - Configuration settings
678
+ - Authentication status
679
+ - Sync schedule and history
680
+ - Entity statistics
681
+ </dd>
682
+ </dl>
683
+ </dd>
684
+ </dl>
675
685
 
676
686
  #### 🔌 Usage
677
687
 
@@ -682,9 +692,7 @@ Agent that iteratively searches, reads, navigates hierarchies, and collects resu
682
692
  <dd>
683
693
 
684
694
  ```typescript
685
- await client.collections.agenticSearch("readable_id", {
686
- query: "query",
687
- });
695
+ await client.sourceConnections.get("550e8400-e29b-41d4-a716-446655440000");
688
696
  ```
689
697
 
690
698
  </dd>
@@ -700,15 +708,7 @@ await client.collections.agenticSearch("readable_id", {
700
708
  <dl>
701
709
  <dd>
702
710
 
703
- **readableId:** `string`
704
-
705
- </dd>
706
- </dl>
707
-
708
- <dl>
709
- <dd>
710
-
711
- **request:** `AirweaveSDK.AgenticSearchRequest`
711
+ **sourceConnectionId:** `string` — Unique identifier of the source connection (UUID)
712
712
 
713
713
  </dd>
714
714
  </dl>
@@ -716,7 +716,7 @@ await client.collections.agenticSearch("readable_id", {
716
716
  <dl>
717
717
  <dd>
718
718
 
719
- **requestOptions:** `Collections.RequestOptions`
719
+ **requestOptions:** `SourceConnections.RequestOptions`
720
720
 
721
721
  </dd>
722
722
  </dl>
@@ -727,7 +727,7 @@ await client.collections.agenticSearch("readable_id", {
727
727
  </dl>
728
728
  </details>
729
729
 
730
- <details><summary><code>client.collections.<a href="/src/api/resources/collections/client/Client.ts">streamAgenticSearch</a>(readableId, { ...params }) -> core.Stream&lt;AirweaveSDK.AgenticSearchEvent&gt;</code></summary>
730
+ <details><summary><code>client.sourceConnections.<a href="/src/api/resources/sourceConnections/client/Client.ts">delete</a>(sourceConnectionId) -> AirweaveSDK.SourceConnection</code></summary>
731
731
  <dl>
732
732
  <dd>
733
733
 
@@ -739,7 +739,23 @@ await client.collections.agenticSearch("readable_id", {
739
739
  <dl>
740
740
  <dd>
741
741
 
742
- Streaming agentic search via Server-Sent Events. Returns real-time events as the agent searches.
742
+ Permanently delete a source connection and all its synced data.
743
+
744
+ **What happens when you delete:**
745
+
746
+ 1. Any running sync is cancelled and the API waits (up to 15 s) for the
747
+ worker to stop writing.
748
+ 2. The source connection, sync configuration, job history, and entity
749
+ metadata are cascade-deleted from the database.
750
+ 3. A background cleanup workflow is scheduled to remove data from the
751
+ vector database (Vespa) and raw data storage (ARF). This may take
752
+ several minutes for large datasets but does **not** block the response.
753
+
754
+ The API returns immediately after step 2. Vector database cleanup happens
755
+ asynchronously -- the data becomes unsearchable as soon as the database
756
+ records are deleted.
757
+
758
+ **Warning**: This action cannot be undone.
743
759
 
744
760
  </dd>
745
761
  </dl>
@@ -755,12 +771,7 @@ Streaming agentic search via Server-Sent Events. Returns real-time events as the
755
771
  <dd>
756
772
 
757
773
  ```typescript
758
- const response = await client.collections.streamAgenticSearch("readable_id", {
759
- query: "query",
760
- });
761
- for await (const item of response) {
762
- console.log(item);
763
- }
774
+ await client.sourceConnections.delete("550e8400-e29b-41d4-a716-446655440000");
764
775
  ```
765
776
 
766
777
  </dd>
@@ -776,15 +787,7 @@ for await (const item of response) {
776
787
  <dl>
777
788
  <dd>
778
789
 
779
- **readableId:** `string`
780
-
781
- </dd>
782
- </dl>
783
-
784
- <dl>
785
- <dd>
786
-
787
- **request:** `AirweaveSDK.AgenticSearchRequest`
790
+ **sourceConnectionId:** `string` — Unique identifier of the source connection to delete (UUID)
788
791
 
789
792
  </dd>
790
793
  </dl>
@@ -792,7 +795,7 @@ for await (const item of response) {
792
795
  <dl>
793
796
  <dd>
794
797
 
795
- **requestOptions:** `Collections.RequestOptions`
798
+ **requestOptions:** `SourceConnections.RequestOptions`
796
799
 
797
800
  </dd>
798
801
  </dl>
@@ -803,9 +806,7 @@ for await (const item of response) {
803
806
  </dl>
804
807
  </details>
805
808
 
806
- ## source-connections
807
-
808
- <details><summary><code>client.sourceConnections.<a href="/src/api/resources/sourceConnections/client/Client.ts">list</a>({ ...params }) -> AirweaveSDK.SourceConnectionListItem[]</code></summary>
809
+ <details><summary><code>client.sourceConnections.<a href="/src/api/resources/sourceConnections/client/Client.ts">update</a>(sourceConnectionId, { ...params }) -> AirweaveSDK.SourceConnection</code></summary>
809
810
  <dl>
810
811
  <dd>
811
812
 
@@ -817,13 +818,16 @@ for await (const item of response) {
817
818
  <dl>
818
819
  <dd>
819
820
 
820
- Retrieve all source connections for your organization.
821
+ Update an existing source connection's configuration.
821
822
 
822
- Returns a lightweight list of source connections with essential fields for
823
- display and navigation. Use the collection filter to see connections within
824
- a specific collection.
823
+ You can modify:
825
824
 
826
- For full connection details including sync history, use the GET /{id} endpoint.
825
+ - **Name and description**: Display information
826
+ - **Configuration**: Source-specific settings (e.g., repository name, filters)
827
+ - **Schedule**: Cron expression for automatic syncs
828
+ - **Authentication**: Update credentials (direct auth only)
829
+
830
+ Only include the fields you want to change; omitted fields retain their current values.
827
831
 
828
832
  </dd>
829
833
  </dl>
@@ -839,11 +843,7 @@ For full connection details including sync history, use the GET /{id} endpoint.
839
843
  <dd>
840
844
 
841
845
  ```typescript
842
- await client.sourceConnections.list({
843
- collection: "collection",
844
- skip: 0,
845
- limit: 100,
846
- });
846
+ await client.sourceConnections.update("550e8400-e29b-41d4-a716-446655440000");
847
847
  ```
848
848
 
849
849
  </dd>
@@ -859,7 +859,15 @@ await client.sourceConnections.list({
859
859
  <dl>
860
860
  <dd>
861
861
 
862
- **request:** `AirweaveSDK.ListSourceConnectionsGetRequest`
862
+ **sourceConnectionId:** `string` — Unique identifier of the source connection to update (UUID)
863
+
864
+ </dd>
865
+ </dl>
866
+
867
+ <dl>
868
+ <dd>
869
+
870
+ **request:** `AirweaveSDK.SourceConnectionUpdate`
863
871
 
864
872
  </dd>
865
873
  </dl>
@@ -878,7 +886,7 @@ await client.sourceConnections.list({
878
886
  </dl>
879
887
  </details>
880
888
 
881
- <details><summary><code>client.sourceConnections.<a href="/src/api/resources/sourceConnections/client/Client.ts">create</a>({ ...params }) -> AirweaveSDK.SourceConnection</code></summary>
889
+ <details><summary><code>client.sourceConnections.<a href="/src/api/resources/sourceConnections/client/Client.ts">run</a>(sourceConnectionId, { ...params }) -> AirweaveSDK.SourceConnectionJob</code></summary>
882
890
  <dl>
883
891
  <dd>
884
892
 
@@ -890,16 +898,14 @@ await client.sourceConnections.list({
890
898
  <dl>
891
899
  <dd>
892
900
 
893
- Create a new source connection to sync data from an external source.
894
-
895
- The authentication method determines the creation flow:
901
+ Trigger a data synchronization job for a source connection.
896
902
 
897
- - **Direct**: Provide credentials (API key, token) directly. Connection is created immediately.
898
- - **OAuth Browser**: Returns a connection with an `auth_url` to redirect users for authentication.
899
- - **OAuth Token**: Provide an existing OAuth token. Connection is created immediately.
900
- - **Auth Provider**: Use a pre-configured auth provider (e.g., Composio, Pipedream).
903
+ Starts an asynchronous sync job that pulls the latest data from the connected
904
+ source. The job runs in the background and you can monitor its progress using
905
+ the jobs endpoint.
901
906
 
902
- After successful authentication, data sync can begin automatically or on-demand.
907
+ For continuous sync connections, this performs an incremental sync by default.
908
+ Use `force_full_sync=true` to perform a complete re-sync of all data.
903
909
 
904
910
  </dd>
905
911
  </dl>
@@ -915,9 +921,8 @@ After successful authentication, data sync can begin automatically or on-demand.
915
921
  <dd>
916
922
 
917
923
  ```typescript
918
- await client.sourceConnections.create({
919
- short_name: "github",
920
- readable_collection_id: "customer-support-tickets-x7k9m",
924
+ await client.sourceConnections.run("550e8400-e29b-41d4-a716-446655440000", {
925
+ force_full_sync: false,
921
926
  });
922
927
  ```
923
928
 
@@ -934,7 +939,15 @@ await client.sourceConnections.create({
934
939
  <dl>
935
940
  <dd>
936
941
 
937
- **request:** `AirweaveSDK.SourceConnectionCreate`
942
+ **sourceConnectionId:** `string` — Unique identifier of the source connection to sync (UUID)
943
+
944
+ </dd>
945
+ </dl>
946
+
947
+ <dl>
948
+ <dd>
949
+
950
+ **request:** `AirweaveSDK.RunSourceConnectionsSourceConnectionIdRunPostRequest`
938
951
 
939
952
  </dd>
940
953
  </dl>
@@ -953,7 +966,7 @@ await client.sourceConnections.create({
953
966
  </dl>
954
967
  </details>
955
968
 
956
- <details><summary><code>client.sourceConnections.<a href="/src/api/resources/sourceConnections/client/Client.ts">get</a>(sourceConnectionId) -> AirweaveSDK.SourceConnection</code></summary>
969
+ <details><summary><code>client.sourceConnections.<a href="/src/api/resources/sourceConnections/client/Client.ts">getSourceConnectionJobs</a>(sourceConnectionId, { ...params }) -> AirweaveSDK.SourceConnectionJob[]</code></summary>
957
970
  <dl>
958
971
  <dd>
959
972
 
@@ -965,14 +978,21 @@ await client.sourceConnections.create({
965
978
  <dl>
966
979
  <dd>
967
980
 
968
- Retrieve details of a specific source connection.
981
+ Retrieve the sync job history for a source connection.
969
982
 
970
- Returns complete information about the connection including:
983
+ Returns a list of sync jobs ordered by creation time (newest first). Each job
984
+ includes status, timing information, and entity counts.
971
985
 
972
- - Configuration settings
973
- - Authentication status
974
- - Sync schedule and history
975
- - Entity statistics
986
+ Job statuses:
987
+
988
+ - **PENDING**: Job is queued, waiting for the worker to pick it up
989
+ - **RUNNING**: Sync is actively pulling and processing data
990
+ - **COMPLETED**: Sync finished successfully
991
+ - **FAILED**: Sync encountered an unrecoverable error
992
+ - **CANCELLING**: Cancellation has been requested. The worker is
993
+ gracefully stopping the pipeline and cleaning up destination data.
994
+ - **CANCELLED**: Sync was cancelled. The worker has fully stopped
995
+ and destination data cleanup has been scheduled.
976
996
  </dd>
977
997
  </dl>
978
998
  </dd>
@@ -987,7 +1007,9 @@ Returns complete information about the connection including:
987
1007
  <dd>
988
1008
 
989
1009
  ```typescript
990
- await client.sourceConnections.get("550e8400-e29b-41d4-a716-446655440000");
1010
+ await client.sourceConnections.getSourceConnectionJobs("550e8400-e29b-41d4-a716-446655440000", {
1011
+ limit: 100,
1012
+ });
991
1013
  ```
992
1014
 
993
1015
  </dd>
@@ -1011,6 +1033,14 @@ await client.sourceConnections.get("550e8400-e29b-41d4-a716-446655440000");
1011
1033
  <dl>
1012
1034
  <dd>
1013
1035
 
1036
+ **request:** `AirweaveSDK.GetSourceConnectionJobsSourceConnectionsSourceConnectionIdJobsGetRequest`
1037
+
1038
+ </dd>
1039
+ </dl>
1040
+
1041
+ <dl>
1042
+ <dd>
1043
+
1014
1044
  **requestOptions:** `SourceConnections.RequestOptions`
1015
1045
 
1016
1046
  </dd>
@@ -1022,7 +1052,7 @@ await client.sourceConnections.get("550e8400-e29b-41d4-a716-446655440000");
1022
1052
  </dl>
1023
1053
  </details>
1024
1054
 
1025
- <details><summary><code>client.sourceConnections.<a href="/src/api/resources/sourceConnections/client/Client.ts">delete</a>(sourceConnectionId) -> AirweaveSDK.SourceConnection</code></summary>
1055
+ <details><summary><code>client.sourceConnections.<a href="/src/api/resources/sourceConnections/client/Client.ts">cancelJob</a>(sourceConnectionId, jobId) -> AirweaveSDK.SourceConnectionJob</code></summary>
1026
1056
  <dl>
1027
1057
  <dd>
1028
1058
 
@@ -1034,23 +1064,21 @@ await client.sourceConnections.get("550e8400-e29b-41d4-a716-446655440000");
1034
1064
  <dl>
1035
1065
  <dd>
1036
1066
 
1037
- Permanently delete a source connection and all its synced data.
1067
+ Request cancellation of a running sync job.
1038
1068
 
1039
- **What happens when you delete:**
1069
+ **State lifecycle**: `PENDING` / `RUNNING` → `CANCELLING` → `CANCELLED`
1040
1070
 
1041
- 1. Any running sync is cancelled and the API waits (up to 15 s) for the
1042
- worker to stop writing.
1043
- 2. The source connection, sync configuration, job history, and entity
1044
- metadata are cascade-deleted from the database.
1045
- 3. A background cleanup workflow is scheduled to remove data from the
1046
- vector database (Vespa) and raw data storage (ARF). This may take
1047
- several minutes for large datasets but does **not** block the response.
1071
+ 1. The API immediately marks the job as **CANCELLING** in the database.
1072
+ 2. A cancellation signal is sent to the Temporal workflow.
1073
+ 3. The worker receives the signal, gracefully stops the sync pipeline
1074
+ (cancels worker pool, source stream), and marks the job as **CANCELLED**.
1048
1075
 
1049
- The API returns immediately after step 2. Vector database cleanup happens
1050
- asynchronously -- the data becomes unsearchable as soon as the database
1051
- records are deleted.
1076
+ Already-processed entities are retained in the vector database.
1077
+ If the worker is unresponsive, a background cleanup job will force the
1078
+ transition to CANCELLED after 3 minutes.
1052
1079
 
1053
- **Warning**: This action cannot be undone.
1080
+ **Note**: Only jobs in `PENDING` or `RUNNING` state can be cancelled.
1081
+ Attempting to cancel a `COMPLETED`, `FAILED`, or `CANCELLED` job returns 400.
1054
1082
 
1055
1083
  </dd>
1056
1084
  </dl>
@@ -1066,7 +1094,10 @@ records are deleted.
1066
1094
  <dd>
1067
1095
 
1068
1096
  ```typescript
1069
- await client.sourceConnections.delete("550e8400-e29b-41d4-a716-446655440000");
1097
+ await client.sourceConnections.cancelJob(
1098
+ "550e8400-e29b-41d4-a716-446655440000",
1099
+ "660e8400-e29b-41d4-a716-446655440001",
1100
+ );
1070
1101
  ```
1071
1102
 
1072
1103
  </dd>
@@ -1082,7 +1113,15 @@ await client.sourceConnections.delete("550e8400-e29b-41d4-a716-446655440000");
1082
1113
  <dl>
1083
1114
  <dd>
1084
1115
 
1085
- **sourceConnectionId:** `string` — Unique identifier of the source connection to delete (UUID)
1116
+ **sourceConnectionId:** `string` — Unique identifier of the source connection (UUID)
1117
+
1118
+ </dd>
1119
+ </dl>
1120
+
1121
+ <dl>
1122
+ <dd>
1123
+
1124
+ **jobId:** `string` — Unique identifier of the sync job to cancel (UUID)
1086
1125
 
1087
1126
  </dd>
1088
1127
  </dl>
@@ -1101,7 +1140,9 @@ await client.sourceConnections.delete("550e8400-e29b-41d4-a716-446655440000");
1101
1140
  </dl>
1102
1141
  </details>
1103
1142
 
1104
- <details><summary><code>client.sourceConnections.<a href="/src/api/resources/sourceConnections/client/Client.ts">update</a>(sourceConnectionId, { ...params }) -> AirweaveSDK.SourceConnection</code></summary>
1143
+ ## webhooks
1144
+
1145
+ <details><summary><code>client.webhooks.<a href="/src/api/resources/webhooks/client/Client.ts">getMessages</a>({ ...params }) -> AirweaveSDK.WebhookMessage[]</code></summary>
1105
1146
  <dl>
1106
1147
  <dd>
1107
1148
 
@@ -1113,16 +1154,14 @@ await client.sourceConnections.delete("550e8400-e29b-41d4-a716-446655440000");
1113
1154
  <dl>
1114
1155
  <dd>
1115
1156
 
1116
- Update an existing source connection's configuration.
1117
-
1118
- You can modify:
1157
+ Retrieve all webhook messages for your organization.
1119
1158
 
1120
- - **Name and description**: Display information
1121
- - **Configuration**: Source-specific settings (e.g., repository name, filters)
1122
- - **Schedule**: Cron expression for automatic syncs
1123
- - **Authentication**: Update credentials (direct auth only)
1159
+ Webhook messages represent payloads that were sent (or attempted to be sent)
1160
+ to your subscribed endpoints. Each message contains the event type, payload data,
1161
+ and delivery status information.
1124
1162
 
1125
- Only include the fields you want to change; omitted fields retain their current values.
1163
+ Use the `event_types` query parameter to filter messages by specific event types,
1164
+ such as `sync.completed` or `sync.failed`.
1126
1165
 
1127
1166
  </dd>
1128
1167
  </dl>
@@ -1138,7 +1177,7 @@ Only include the fields you want to change; omitted fields retain their current
1138
1177
  <dd>
1139
1178
 
1140
1179
  ```typescript
1141
- await client.sourceConnections.update("550e8400-e29b-41d4-a716-446655440000");
1180
+ await client.webhooks.getMessages();
1142
1181
  ```
1143
1182
 
1144
1183
  </dd>
@@ -1154,15 +1193,7 @@ await client.sourceConnections.update("550e8400-e29b-41d4-a716-446655440000");
1154
1193
  <dl>
1155
1194
  <dd>
1156
1195
 
1157
- **sourceConnectionId:** `string` — Unique identifier of the source connection to update (UUID)
1158
-
1159
- </dd>
1160
- </dl>
1161
-
1162
- <dl>
1163
- <dd>
1164
-
1165
- **request:** `AirweaveSDK.SourceConnectionUpdate`
1196
+ **request:** `AirweaveSDK.GetMessagesWebhooksMessagesGetRequest`
1166
1197
 
1167
1198
  </dd>
1168
1199
  </dl>
@@ -1170,7 +1201,7 @@ await client.sourceConnections.update("550e8400-e29b-41d4-a716-446655440000");
1170
1201
  <dl>
1171
1202
  <dd>
1172
1203
 
1173
- **requestOptions:** `SourceConnections.RequestOptions`
1204
+ **requestOptions:** `Webhooks.RequestOptions`
1174
1205
 
1175
1206
  </dd>
1176
1207
  </dl>
@@ -1181,7 +1212,7 @@ await client.sourceConnections.update("550e8400-e29b-41d4-a716-446655440000");
1181
1212
  </dl>
1182
1213
  </details>
1183
1214
 
1184
- <details><summary><code>client.sourceConnections.<a href="/src/api/resources/sourceConnections/client/Client.ts">run</a>(sourceConnectionId, { ...params }) -> AirweaveSDK.SourceConnectionJob</code></summary>
1215
+ <details><summary><code>client.webhooks.<a href="/src/api/resources/webhooks/client/Client.ts">getMessage</a>(messageId, { ...params }) -> AirweaveSDK.WebhookMessageWithAttempts</code></summary>
1185
1216
  <dl>
1186
1217
  <dd>
1187
1218
 
@@ -1193,14 +1224,15 @@ await client.sourceConnections.update("550e8400-e29b-41d4-a716-446655440000");
1193
1224
  <dl>
1194
1225
  <dd>
1195
1226
 
1196
- Trigger a data synchronization job for a source connection.
1227
+ Retrieve a specific webhook message by its ID.
1197
1228
 
1198
- Starts an asynchronous sync job that pulls the latest data from the connected
1199
- source. The job runs in the background and you can monitor its progress using
1200
- the jobs endpoint.
1229
+ Returns the full message details including the event type, payload data,
1230
+ timestamp, and delivery channel information. Use this to inspect the
1231
+ exact payload that was sent to your webhook endpoints.
1201
1232
 
1202
- For continuous sync connections, this performs an incremental sync by default.
1203
- Use `force_full_sync=true` to perform a complete re-sync of all data.
1233
+ Use `include_attempts=true` to also retrieve delivery attempts for this message,
1234
+ which include HTTP response codes, response bodies, and timestamps for debugging
1235
+ delivery failures.
1204
1236
 
1205
1237
  </dd>
1206
1238
  </dl>
@@ -1216,8 +1248,8 @@ Use `force_full_sync=true` to perform a complete re-sync of all data.
1216
1248
  <dd>
1217
1249
 
1218
1250
  ```typescript
1219
- await client.sourceConnections.run("550e8400-e29b-41d4-a716-446655440000", {
1220
- force_full_sync: false,
1251
+ await client.webhooks.getMessage("550e8400-e29b-41d4-a716-446655440000", {
1252
+ include_attempts: true,
1221
1253
  });
1222
1254
  ```
1223
1255
 
@@ -1234,7 +1266,7 @@ await client.sourceConnections.run("550e8400-e29b-41d4-a716-446655440000", {
1234
1266
  <dl>
1235
1267
  <dd>
1236
1268
 
1237
- **sourceConnectionId:** `string` — Unique identifier of the source connection to sync (UUID)
1269
+ **messageId:** `string` — The unique identifier of the message to retrieve (UUID).
1238
1270
 
1239
1271
  </dd>
1240
1272
  </dl>
@@ -1242,7 +1274,7 @@ await client.sourceConnections.run("550e8400-e29b-41d4-a716-446655440000", {
1242
1274
  <dl>
1243
1275
  <dd>
1244
1276
 
1245
- **request:** `AirweaveSDK.RunSourceConnectionsSourceConnectionIdRunPostRequest`
1277
+ **request:** `AirweaveSDK.GetMessageWebhooksMessagesMessageIdGetRequest`
1246
1278
 
1247
1279
  </dd>
1248
1280
  </dl>
@@ -1250,7 +1282,7 @@ await client.sourceConnections.run("550e8400-e29b-41d4-a716-446655440000", {
1250
1282
  <dl>
1251
1283
  <dd>
1252
1284
 
1253
- **requestOptions:** `SourceConnections.RequestOptions`
1285
+ **requestOptions:** `Webhooks.RequestOptions`
1254
1286
 
1255
1287
  </dd>
1256
1288
  </dl>
@@ -1261,7 +1293,7 @@ await client.sourceConnections.run("550e8400-e29b-41d4-a716-446655440000", {
1261
1293
  </dl>
1262
1294
  </details>
1263
1295
 
1264
- <details><summary><code>client.sourceConnections.<a href="/src/api/resources/sourceConnections/client/Client.ts">getSourceConnectionJobs</a>(sourceConnectionId, { ...params }) -> AirweaveSDK.SourceConnectionJob[]</code></summary>
1296
+ <details><summary><code>client.webhooks.<a href="/src/api/resources/webhooks/client/Client.ts">getSubscriptions</a>() -> AirweaveSDK.WebhookSubscription[]</code></summary>
1265
1297
  <dl>
1266
1298
  <dd>
1267
1299
 
@@ -1273,25 +1305,16 @@ await client.sourceConnections.run("550e8400-e29b-41d4-a716-446655440000", {
1273
1305
  <dl>
1274
1306
  <dd>
1275
1307
 
1276
- Retrieve the sync job history for a source connection.
1277
-
1278
- Returns a list of sync jobs ordered by creation time (newest first). Each job
1279
- includes status, timing information, and entity counts.
1308
+ List all webhook subscriptions for your organization.
1280
1309
 
1281
- Job statuses:
1310
+ Returns all configured webhook endpoints, including their URLs, subscribed
1311
+ event types, and current status (enabled/disabled). Use this to audit
1312
+ your webhook configuration or find a specific subscription.
1282
1313
 
1283
- - **PENDING**: Job is queued, waiting for the worker to pick it up
1284
- - **RUNNING**: Sync is actively pulling and processing data
1285
- - **COMPLETED**: Sync finished successfully
1286
- - **FAILED**: Sync encountered an unrecoverable error
1287
- - **CANCELLING**: Cancellation has been requested. The worker is
1288
- gracefully stopping the pipeline and cleaning up destination data.
1289
- - **CANCELLED**: Sync was cancelled. The worker has fully stopped
1290
- and destination data cleanup has been scheduled.
1291
- </dd>
1292
- </dl>
1293
- </dd>
1294
- </dl>
1314
+ </dd>
1315
+ </dl>
1316
+ </dd>
1317
+ </dl>
1295
1318
 
1296
1319
  #### 🔌 Usage
1297
1320
 
@@ -1302,9 +1325,7 @@ and destination data cleanup has been scheduled.
1302
1325
  <dd>
1303
1326
 
1304
1327
  ```typescript
1305
- await client.sourceConnections.getSourceConnectionJobs("550e8400-e29b-41d4-a716-446655440000", {
1306
- limit: 100,
1307
- });
1328
+ await client.webhooks.getSubscriptions();
1308
1329
  ```
1309
1330
 
1310
1331
  </dd>
@@ -1320,23 +1341,7 @@ await client.sourceConnections.getSourceConnectionJobs("550e8400-e29b-41d4-a716-
1320
1341
  <dl>
1321
1342
  <dd>
1322
1343
 
1323
- **sourceConnectionId:** `string` — Unique identifier of the source connection (UUID)
1324
-
1325
- </dd>
1326
- </dl>
1327
-
1328
- <dl>
1329
- <dd>
1330
-
1331
- **request:** `AirweaveSDK.GetSourceConnectionJobsSourceConnectionsSourceConnectionIdJobsGetRequest`
1332
-
1333
- </dd>
1334
- </dl>
1335
-
1336
- <dl>
1337
- <dd>
1338
-
1339
- **requestOptions:** `SourceConnections.RequestOptions`
1344
+ **requestOptions:** `Webhooks.RequestOptions`
1340
1345
 
1341
1346
  </dd>
1342
1347
  </dl>
@@ -1347,7 +1352,7 @@ await client.sourceConnections.getSourceConnectionJobs("550e8400-e29b-41d4-a716-
1347
1352
  </dl>
1348
1353
  </details>
1349
1354
 
1350
- <details><summary><code>client.sourceConnections.<a href="/src/api/resources/sourceConnections/client/Client.ts">cancelJob</a>(sourceConnectionId, jobId) -> AirweaveSDK.SourceConnectionJob</code></summary>
1355
+ <details><summary><code>client.webhooks.<a href="/src/api/resources/webhooks/client/Client.ts">createSubscription</a>({ ...params }) -> AirweaveSDK.WebhookSubscription</code></summary>
1351
1356
  <dl>
1352
1357
  <dd>
1353
1358
 
@@ -1359,21 +1364,17 @@ await client.sourceConnections.getSourceConnectionJobs("550e8400-e29b-41d4-a716-
1359
1364
  <dl>
1360
1365
  <dd>
1361
1366
 
1362
- Request cancellation of a running sync job.
1363
-
1364
- **State lifecycle**: `PENDING` / `RUNNING` → `CANCELLING` → `CANCELLED`
1367
+ Create a new webhook subscription.
1365
1368
 
1366
- 1. The API immediately marks the job as **CANCELLING** in the database.
1367
- 2. A cancellation signal is sent to the Temporal workflow.
1368
- 3. The worker receives the signal, gracefully stops the sync pipeline
1369
- (cancels worker pool, source stream), and marks the job as **CANCELLED**.
1369
+ Webhook subscriptions allow you to receive real-time notifications when events
1370
+ occur in Airweave. When you create a subscription, you specify:
1370
1371
 
1371
- Already-processed entities are retained in the vector database.
1372
- If the worker is unresponsive, a background cleanup job will force the
1373
- transition to CANCELLED after 3 minutes.
1372
+ - **URL**: The HTTPS endpoint where events will be delivered
1373
+ - **Event Types**: Which events you want to receive (e.g., `sync.completed`, `sync.failed`)
1374
+ - **Secret** (optional): A custom signing secret for verifying webhook signatures
1374
1375
 
1375
- **Note**: Only jobs in `PENDING` or `RUNNING` state can be cancelled.
1376
- Attempting to cancel a `COMPLETED`, `FAILED`, or `CANCELLED` job returns 400.
1376
+ After creation, Airweave will send HTTP POST requests to your URL whenever
1377
+ matching events occur. Each request includes a signature header for verification.
1377
1378
 
1378
1379
  </dd>
1379
1380
  </dl>
@@ -1389,10 +1390,10 @@ Attempting to cancel a `COMPLETED`, `FAILED`, or `CANCELLED` job returns 400.
1389
1390
  <dd>
1390
1391
 
1391
1392
  ```typescript
1392
- await client.sourceConnections.cancelJob(
1393
- "550e8400-e29b-41d4-a716-446655440000",
1394
- "660e8400-e29b-41d4-a716-446655440001",
1395
- );
1393
+ await client.webhooks.createSubscription({
1394
+ url: "https://api.mycompany.com/webhooks/airweave",
1395
+ event_types: ["sync.completed", "sync.failed"],
1396
+ });
1396
1397
  ```
1397
1398
 
1398
1399
  </dd>
@@ -1408,15 +1409,7 @@ await client.sourceConnections.cancelJob(
1408
1409
  <dl>
1409
1410
  <dd>
1410
1411
 
1411
- **sourceConnectionId:** `string` — Unique identifier of the source connection (UUID)
1412
-
1413
- </dd>
1414
- </dl>
1415
-
1416
- <dl>
1417
- <dd>
1418
-
1419
- **jobId:** `string` — Unique identifier of the sync job to cancel (UUID)
1412
+ **request:** `AirweaveSDK.CreateSubscriptionRequest`
1420
1413
 
1421
1414
  </dd>
1422
1415
  </dl>
@@ -1424,7 +1417,7 @@ await client.sourceConnections.cancelJob(
1424
1417
  <dl>
1425
1418
  <dd>
1426
1419
 
1427
- **requestOptions:** `SourceConnections.RequestOptions`
1420
+ **requestOptions:** `Webhooks.RequestOptions`
1428
1421
 
1429
1422
  </dd>
1430
1423
  </dl>
@@ -1435,9 +1428,7 @@ await client.sourceConnections.cancelJob(
1435
1428
  </dl>
1436
1429
  </details>
1437
1430
 
1438
- ## webhooks
1439
-
1440
- <details><summary><code>client.webhooks.<a href="/src/api/resources/webhooks/client/Client.ts">getMessages</a>({ ...params }) -> AirweaveSDK.WebhookMessage[]</code></summary>
1431
+ <details><summary><code>client.webhooks.<a href="/src/api/resources/webhooks/client/Client.ts">getSubscription</a>(subscriptionId, { ...params }) -> AirweaveSDK.WebhookSubscriptionDetail</code></summary>
1441
1432
  <dl>
1442
1433
  <dd>
1443
1434
 
@@ -1449,14 +1440,14 @@ await client.sourceConnections.cancelJob(
1449
1440
  <dl>
1450
1441
  <dd>
1451
1442
 
1452
- Retrieve all webhook messages for your organization.
1443
+ Retrieve a specific webhook subscription with its recent delivery attempts.
1453
1444
 
1454
- Webhook messages represent payloads that were sent (or attempted to be sent)
1455
- to your subscribed endpoints. Each message contains the event type, payload data,
1456
- and delivery status information.
1445
+ Returns the subscription configuration along with a history of message delivery
1446
+ attempts. This is useful for debugging delivery issues or verifying that your
1447
+ endpoint is correctly receiving events.
1457
1448
 
1458
- Use the `event_types` query parameter to filter messages by specific event types,
1459
- such as `sync.completed` or `sync.failed`.
1449
+ Use `include_secret=true` to also retrieve the signing secret for webhook
1450
+ signature verification. Keep this secret secure.
1460
1451
 
1461
1452
  </dd>
1462
1453
  </dl>
@@ -1472,7 +1463,9 @@ such as `sync.completed` or `sync.failed`.
1472
1463
  <dd>
1473
1464
 
1474
1465
  ```typescript
1475
- await client.webhooks.getMessages();
1466
+ await client.webhooks.getSubscription("550e8400-e29b-41d4-a716-446655440000", {
1467
+ include_secret: true,
1468
+ });
1476
1469
  ```
1477
1470
 
1478
1471
  </dd>
@@ -1488,7 +1481,15 @@ await client.webhooks.getMessages();
1488
1481
  <dl>
1489
1482
  <dd>
1490
1483
 
1491
- **request:** `AirweaveSDK.GetMessagesWebhooksMessagesGetRequest`
1484
+ **subscriptionId:** `string` — The unique identifier of the subscription to retrieve (UUID).
1485
+
1486
+ </dd>
1487
+ </dl>
1488
+
1489
+ <dl>
1490
+ <dd>
1491
+
1492
+ **request:** `AirweaveSDK.GetSubscriptionWebhooksSubscriptionsSubscriptionIdGetRequest`
1492
1493
 
1493
1494
  </dd>
1494
1495
  </dl>
@@ -1507,7 +1508,7 @@ await client.webhooks.getMessages();
1507
1508
  </dl>
1508
1509
  </details>
1509
1510
 
1510
- <details><summary><code>client.webhooks.<a href="/src/api/resources/webhooks/client/Client.ts">getMessage</a>(messageId, { ...params }) -> AirweaveSDK.WebhookMessageWithAttempts</code></summary>
1511
+ <details><summary><code>client.webhooks.<a href="/src/api/resources/webhooks/client/Client.ts">deleteSubscription</a>(subscriptionId) -> AirweaveSDK.WebhookSubscription</code></summary>
1511
1512
  <dl>
1512
1513
  <dd>
1513
1514
 
@@ -1519,15 +1520,13 @@ await client.webhooks.getMessages();
1519
1520
  <dl>
1520
1521
  <dd>
1521
1522
 
1522
- Retrieve a specific webhook message by its ID.
1523
+ Permanently delete a webhook subscription.
1523
1524
 
1524
- Returns the full message details including the event type, payload data,
1525
- timestamp, and delivery channel information. Use this to inspect the
1526
- exact payload that was sent to your webhook endpoints.
1525
+ Once deleted, Airweave will stop sending events to this endpoint immediately.
1526
+ This action cannot be undone. Any pending message deliveries will be cancelled.
1527
1527
 
1528
- Use `include_attempts=true` to also retrieve delivery attempts for this message,
1529
- which include HTTP response codes, response bodies, and timestamps for debugging
1530
- delivery failures.
1528
+ If you want to temporarily stop receiving events, consider disabling the
1529
+ subscription instead using the PATCH endpoint.
1531
1530
 
1532
1531
  </dd>
1533
1532
  </dl>
@@ -1543,9 +1542,7 @@ delivery failures.
1543
1542
  <dd>
1544
1543
 
1545
1544
  ```typescript
1546
- await client.webhooks.getMessage("550e8400-e29b-41d4-a716-446655440000", {
1547
- include_attempts: true,
1548
- });
1545
+ await client.webhooks.deleteSubscription("550e8400-e29b-41d4-a716-446655440000");
1549
1546
  ```
1550
1547
 
1551
1548
  </dd>
@@ -1561,15 +1558,7 @@ await client.webhooks.getMessage("550e8400-e29b-41d4-a716-446655440000", {
1561
1558
  <dl>
1562
1559
  <dd>
1563
1560
 
1564
- **messageId:** `string` — The unique identifier of the message to retrieve (UUID).
1565
-
1566
- </dd>
1567
- </dl>
1568
-
1569
- <dl>
1570
- <dd>
1571
-
1572
- **request:** `AirweaveSDK.GetMessageWebhooksMessagesMessageIdGetRequest`
1561
+ **subscriptionId:** `string` — The unique identifier of the subscription to delete (UUID).
1573
1562
 
1574
1563
  </dd>
1575
1564
  </dl>
@@ -1588,7 +1577,7 @@ await client.webhooks.getMessage("550e8400-e29b-41d4-a716-446655440000", {
1588
1577
  </dl>
1589
1578
  </details>
1590
1579
 
1591
- <details><summary><code>client.webhooks.<a href="/src/api/resources/webhooks/client/Client.ts">getSubscriptions</a>() -> AirweaveSDK.WebhookSubscription[]</code></summary>
1580
+ <details><summary><code>client.webhooks.<a href="/src/api/resources/webhooks/client/Client.ts">patchSubscription</a>(subscriptionId, { ...params }) -> AirweaveSDK.WebhookSubscription</code></summary>
1592
1581
  <dl>
1593
1582
  <dd>
1594
1583
 
@@ -1600,11 +1589,21 @@ await client.webhooks.getMessage("550e8400-e29b-41d4-a716-446655440000", {
1600
1589
  <dl>
1601
1590
  <dd>
1602
1591
 
1603
- List all webhook subscriptions for your organization.
1592
+ Update an existing webhook subscription.
1604
1593
 
1605
- Returns all configured webhook endpoints, including their URLs, subscribed
1606
- event types, and current status (enabled/disabled). Use this to audit
1607
- your webhook configuration or find a specific subscription.
1594
+ Use this endpoint to modify a subscription's configuration. You can:
1595
+
1596
+ - **Change the URL**: Update where events are delivered
1597
+ - **Update event types**: Modify which events trigger notifications
1598
+ - **Enable/disable**: Temporarily pause delivery without deleting the subscription
1599
+ - **Recover messages**: When re-enabling, optionally recover missed messages
1600
+
1601
+ Only include the fields you want to change. Omitted fields will retain their
1602
+ current values.
1603
+
1604
+ When re-enabling a subscription (`disabled: false`), you can optionally provide
1605
+ `recover_since` to automatically retry all messages that were generated while
1606
+ the subscription was disabled.
1608
1607
 
1609
1608
  </dd>
1610
1609
  </dl>
@@ -1620,7 +1619,7 @@ your webhook configuration or find a specific subscription.
1620
1619
  <dd>
1621
1620
 
1622
1621
  ```typescript
1623
- await client.webhooks.getSubscriptions();
1622
+ await client.webhooks.patchSubscription("550e8400-e29b-41d4-a716-446655440000");
1624
1623
  ```
1625
1624
 
1626
1625
  </dd>
@@ -1636,6 +1635,22 @@ await client.webhooks.getSubscriptions();
1636
1635
  <dl>
1637
1636
  <dd>
1638
1637
 
1638
+ **subscriptionId:** `string` — The unique identifier of the subscription to update (UUID).
1639
+
1640
+ </dd>
1641
+ </dl>
1642
+
1643
+ <dl>
1644
+ <dd>
1645
+
1646
+ **request:** `AirweaveSDK.PatchSubscriptionRequest`
1647
+
1648
+ </dd>
1649
+ </dl>
1650
+
1651
+ <dl>
1652
+ <dd>
1653
+
1639
1654
  **requestOptions:** `Webhooks.RequestOptions`
1640
1655
 
1641
1656
  </dd>
@@ -1647,7 +1662,7 @@ await client.webhooks.getSubscriptions();
1647
1662
  </dl>
1648
1663
  </details>
1649
1664
 
1650
- <details><summary><code>client.webhooks.<a href="/src/api/resources/webhooks/client/Client.ts">createSubscription</a>({ ...params }) -> AirweaveSDK.WebhookSubscription</code></summary>
1665
+ <details><summary><code>client.webhooks.<a href="/src/api/resources/webhooks/client/Client.ts">recoverFailedMessages</a>(subscriptionId, { ...params }) -> AirweaveSDK.RecoveryTask</code></summary>
1651
1666
  <dl>
1652
1667
  <dd>
1653
1668
 
@@ -1659,17 +1674,17 @@ await client.webhooks.getSubscriptions();
1659
1674
  <dl>
1660
1675
  <dd>
1661
1676
 
1662
- Create a new webhook subscription.
1677
+ Retry failed message deliveries for a webhook subscription.
1663
1678
 
1664
- Webhook subscriptions allow you to receive real-time notifications when events
1665
- occur in Airweave. When you create a subscription, you specify:
1679
+ Triggers a recovery process that replays all failed messages within the
1680
+ specified time window. This is useful when:
1666
1681
 
1667
- - **URL**: The HTTPS endpoint where events will be delivered
1668
- - **Event Types**: Which events you want to receive (e.g., `sync.completed`, `sync.failed`)
1669
- - **Secret** (optional): A custom signing secret for verifying webhook signatures
1682
+ - Your endpoint was temporarily down and you want to catch up
1683
+ - You've fixed a bug in your webhook handler
1684
+ - You want to reprocess events after re-enabling a disabled subscription
1670
1685
 
1671
- After creation, Airweave will send HTTP POST requests to your URL whenever
1672
- matching events occur. Each request includes a signature header for verification.
1686
+ Messages are retried in chronological order. Successfully delivered messages
1687
+ are skipped; only failed or pending messages are retried.
1673
1688
 
1674
1689
  </dd>
1675
1690
  </dl>
@@ -1685,9 +1700,8 @@ matching events occur. Each request includes a signature header for verification
1685
1700
  <dd>
1686
1701
 
1687
1702
  ```typescript
1688
- await client.webhooks.createSubscription({
1689
- url: "https://api.mycompany.com/webhooks/airweave",
1690
- event_types: ["sync.completed", "sync.failed"],
1703
+ await client.webhooks.recoverFailedMessages("550e8400-e29b-41d4-a716-446655440000", {
1704
+ since: "2024-03-14T00:00:00Z",
1691
1705
  });
1692
1706
  ```
1693
1707
 
@@ -1704,7 +1718,15 @@ await client.webhooks.createSubscription({
1704
1718
  <dl>
1705
1719
  <dd>
1706
1720
 
1707
- **request:** `AirweaveSDK.CreateSubscriptionRequest`
1721
+ **subscriptionId:** `string` — The unique identifier of the subscription to recover messages for (UUID).
1722
+
1723
+ </dd>
1724
+ </dl>
1725
+
1726
+ <dl>
1727
+ <dd>
1728
+
1729
+ **request:** `AirweaveSDK.RecoverMessagesRequest`
1708
1730
 
1709
1731
  </dd>
1710
1732
  </dl>
@@ -1723,7 +1745,9 @@ await client.webhooks.createSubscription({
1723
1745
  </dl>
1724
1746
  </details>
1725
1747
 
1726
- <details><summary><code>client.webhooks.<a href="/src/api/resources/webhooks/client/Client.ts">getSubscription</a>(subscriptionId, { ...params }) -> AirweaveSDK.WebhookSubscriptionDetail</code></summary>
1748
+ ## Collections Search
1749
+
1750
+ <details><summary><code>client.collections.search.<a href="/src/api/resources/collections/resources/search/client/Client.ts">instant</a>(readableId, { ...params }) -> AirweaveSDK.SearchV2Response</code></summary>
1727
1751
  <dl>
1728
1752
  <dd>
1729
1753
 
@@ -1735,14 +1759,7 @@ await client.webhooks.createSubscription({
1735
1759
  <dl>
1736
1760
  <dd>
1737
1761
 
1738
- Retrieve a specific webhook subscription with its recent delivery attempts.
1739
-
1740
- Returns the subscription configuration along with a history of message delivery
1741
- attempts. This is useful for debugging delivery issues or verifying that your
1742
- endpoint is correctly receiving events.
1743
-
1744
- Use `include_secret=true` to also retrieve the signing secret for webhook
1745
- signature verification. Keep this secret secure.
1762
+ Direct vector search.
1746
1763
 
1747
1764
  </dd>
1748
1765
  </dl>
@@ -1758,8 +1775,10 @@ signature verification. Keep this secret secure.
1758
1775
  <dd>
1759
1776
 
1760
1777
  ```typescript
1761
- await client.webhooks.getSubscription("550e8400-e29b-41d4-a716-446655440000", {
1762
- include_secret: true,
1778
+ await client.collections.search.instant("customer-support-tickets-x7k9m", {
1779
+ query: "How do I reset my password?",
1780
+ retrieval_strategy: "hybrid",
1781
+ limit: 10,
1763
1782
  });
1764
1783
  ```
1765
1784
 
@@ -1776,7 +1795,7 @@ await client.webhooks.getSubscription("550e8400-e29b-41d4-a716-446655440000", {
1776
1795
  <dl>
1777
1796
  <dd>
1778
1797
 
1779
- **subscriptionId:** `string` — The unique identifier of the subscription to retrieve (UUID).
1798
+ **readableId:** `string`
1780
1799
 
1781
1800
  </dd>
1782
1801
  </dl>
@@ -1784,7 +1803,7 @@ await client.webhooks.getSubscription("550e8400-e29b-41d4-a716-446655440000", {
1784
1803
  <dl>
1785
1804
  <dd>
1786
1805
 
1787
- **request:** `AirweaveSDK.GetSubscriptionWebhooksSubscriptionsSubscriptionIdGetRequest`
1806
+ **request:** `AirweaveSDK.collections.InstantSearchRequest`
1788
1807
 
1789
1808
  </dd>
1790
1809
  </dl>
@@ -1792,7 +1811,7 @@ await client.webhooks.getSubscription("550e8400-e29b-41d4-a716-446655440000", {
1792
1811
  <dl>
1793
1812
  <dd>
1794
1813
 
1795
- **requestOptions:** `Webhooks.RequestOptions`
1814
+ **requestOptions:** `Search.RequestOptions`
1796
1815
 
1797
1816
  </dd>
1798
1817
  </dl>
@@ -1803,7 +1822,7 @@ await client.webhooks.getSubscription("550e8400-e29b-41d4-a716-446655440000", {
1803
1822
  </dl>
1804
1823
  </details>
1805
1824
 
1806
- <details><summary><code>client.webhooks.<a href="/src/api/resources/webhooks/client/Client.ts">deleteSubscription</a>(subscriptionId) -> AirweaveSDK.WebhookSubscription</code></summary>
1825
+ <details><summary><code>client.collections.search.<a href="/src/api/resources/collections/resources/search/client/Client.ts">classic</a>(readableId, { ...params }) -> AirweaveSDK.SearchV2Response</code></summary>
1807
1826
  <dl>
1808
1827
  <dd>
1809
1828
 
@@ -1815,13 +1834,7 @@ await client.webhooks.getSubscription("550e8400-e29b-41d4-a716-446655440000", {
1815
1834
  <dl>
1816
1835
  <dd>
1817
1836
 
1818
- Permanently delete a webhook subscription.
1819
-
1820
- Once deleted, Airweave will stop sending events to this endpoint immediately.
1821
- This action cannot be undone. Any pending message deliveries will be cancelled.
1822
-
1823
- If you want to temporarily stop receiving events, consider disabling the
1824
- subscription instead using the PATCH endpoint.
1837
+ AI-optimized search.
1825
1838
 
1826
1839
  </dd>
1827
1840
  </dl>
@@ -1837,7 +1850,10 @@ subscription instead using the PATCH endpoint.
1837
1850
  <dd>
1838
1851
 
1839
1852
  ```typescript
1840
- await client.webhooks.deleteSubscription("550e8400-e29b-41d4-a716-446655440000");
1853
+ await client.collections.search.classic("customer-support-tickets-x7k9m", {
1854
+ query: "quarterly revenue report",
1855
+ limit: 10,
1856
+ });
1841
1857
  ```
1842
1858
 
1843
1859
  </dd>
@@ -1853,7 +1869,7 @@ await client.webhooks.deleteSubscription("550e8400-e29b-41d4-a716-446655440000")
1853
1869
  <dl>
1854
1870
  <dd>
1855
1871
 
1856
- **subscriptionId:** `string` — The unique identifier of the subscription to delete (UUID).
1872
+ **readableId:** `string`
1857
1873
 
1858
1874
  </dd>
1859
1875
  </dl>
@@ -1861,7 +1877,15 @@ await client.webhooks.deleteSubscription("550e8400-e29b-41d4-a716-446655440000")
1861
1877
  <dl>
1862
1878
  <dd>
1863
1879
 
1864
- **requestOptions:** `Webhooks.RequestOptions`
1880
+ **request:** `AirweaveSDK.collections.ClassicSearchRequest`
1881
+
1882
+ </dd>
1883
+ </dl>
1884
+
1885
+ <dl>
1886
+ <dd>
1887
+
1888
+ **requestOptions:** `Search.RequestOptions`
1865
1889
 
1866
1890
  </dd>
1867
1891
  </dl>
@@ -1872,7 +1896,7 @@ await client.webhooks.deleteSubscription("550e8400-e29b-41d4-a716-446655440000")
1872
1896
  </dl>
1873
1897
  </details>
1874
1898
 
1875
- <details><summary><code>client.webhooks.<a href="/src/api/resources/webhooks/client/Client.ts">patchSubscription</a>(subscriptionId, { ...params }) -> AirweaveSDK.WebhookSubscription</code></summary>
1899
+ <details><summary><code>client.collections.search.<a href="/src/api/resources/collections/resources/search/client/Client.ts">agentic</a>(readableId, { ...params }) -> AirweaveSDK.SearchV2Response</code></summary>
1876
1900
  <dl>
1877
1901
  <dd>
1878
1902
 
@@ -1884,21 +1908,7 @@ await client.webhooks.deleteSubscription("550e8400-e29b-41d4-a716-446655440000")
1884
1908
  <dl>
1885
1909
  <dd>
1886
1910
 
1887
- Update an existing webhook subscription.
1888
-
1889
- Use this endpoint to modify a subscription's configuration. You can:
1890
-
1891
- - **Change the URL**: Update where events are delivered
1892
- - **Update event types**: Modify which events trigger notifications
1893
- - **Enable/disable**: Temporarily pause delivery without deleting the subscription
1894
- - **Recover messages**: When re-enabling, optionally recover missed messages
1895
-
1896
- Only include the fields you want to change. Omitted fields will retain their
1897
- current values.
1898
-
1899
- When re-enabling a subscription (`disabled: false`), you can optionally provide
1900
- `recover_since` to automatically retry all messages that were generated while
1901
- the subscription was disabled.
1911
+ Agent that iteratively searches, reads, navigates hierarchies, and collects results.
1902
1912
 
1903
1913
  </dd>
1904
1914
  </dl>
@@ -1914,7 +1924,10 @@ the subscription was disabled.
1914
1924
  <dd>
1915
1925
 
1916
1926
  ```typescript
1917
- await client.webhooks.patchSubscription("550e8400-e29b-41d4-a716-446655440000");
1927
+ await client.collections.search.agentic("customer-support-tickets-x7k9m", {
1928
+ query: "find all deployment-related docs from last month",
1929
+ thinking: true,
1930
+ });
1918
1931
  ```
1919
1932
 
1920
1933
  </dd>
@@ -1930,7 +1943,7 @@ await client.webhooks.patchSubscription("550e8400-e29b-41d4-a716-446655440000");
1930
1943
  <dl>
1931
1944
  <dd>
1932
1945
 
1933
- **subscriptionId:** `string` — The unique identifier of the subscription to update (UUID).
1946
+ **readableId:** `string`
1934
1947
 
1935
1948
  </dd>
1936
1949
  </dl>
@@ -1938,7 +1951,7 @@ await client.webhooks.patchSubscription("550e8400-e29b-41d4-a716-446655440000");
1938
1951
  <dl>
1939
1952
  <dd>
1940
1953
 
1941
- **request:** `AirweaveSDK.PatchSubscriptionRequest`
1954
+ **request:** `AirweaveSDK.AgenticSearchRequest`
1942
1955
 
1943
1956
  </dd>
1944
1957
  </dl>
@@ -1946,7 +1959,7 @@ await client.webhooks.patchSubscription("550e8400-e29b-41d4-a716-446655440000");
1946
1959
  <dl>
1947
1960
  <dd>
1948
1961
 
1949
- **requestOptions:** `Webhooks.RequestOptions`
1962
+ **requestOptions:** `Search.RequestOptions`
1950
1963
 
1951
1964
  </dd>
1952
1965
  </dl>
@@ -1957,7 +1970,7 @@ await client.webhooks.patchSubscription("550e8400-e29b-41d4-a716-446655440000");
1957
1970
  </dl>
1958
1971
  </details>
1959
1972
 
1960
- <details><summary><code>client.webhooks.<a href="/src/api/resources/webhooks/client/Client.ts">recoverFailedMessages</a>(subscriptionId, { ...params }) -> AirweaveSDK.RecoveryTask</code></summary>
1973
+ <details><summary><code>client.collections.search.<a href="/src/api/resources/collections/resources/search/client/Client.ts">streamAgentic</a>(readableId, { ...params }) -> core.Stream&lt;AirweaveSDK.AgenticSearchEvent&gt;</code></summary>
1961
1974
  <dl>
1962
1975
  <dd>
1963
1976
 
@@ -1969,17 +1982,7 @@ await client.webhooks.patchSubscription("550e8400-e29b-41d4-a716-446655440000");
1969
1982
  <dl>
1970
1983
  <dd>
1971
1984
 
1972
- Retry failed message deliveries for a webhook subscription.
1973
-
1974
- Triggers a recovery process that replays all failed messages within the
1975
- specified time window. This is useful when:
1976
-
1977
- - Your endpoint was temporarily down and you want to catch up
1978
- - You've fixed a bug in your webhook handler
1979
- - You want to reprocess events after re-enabling a disabled subscription
1980
-
1981
- Messages are retried in chronological order. Successfully delivered messages
1982
- are skipped; only failed or pending messages are retried.
1985
+ Streaming agentic search via Server-Sent Events. Returns real-time events as the agent searches.
1983
1986
 
1984
1987
  </dd>
1985
1988
  </dl>
@@ -1995,9 +1998,12 @@ are skipped; only failed or pending messages are retried.
1995
1998
  <dd>
1996
1999
 
1997
2000
  ```typescript
1998
- await client.webhooks.recoverFailedMessages("550e8400-e29b-41d4-a716-446655440000", {
1999
- since: "2024-03-14T00:00:00Z",
2001
+ const response = await client.collections.search.streamAgentic("readable_id", {
2002
+ query: "query",
2000
2003
  });
2004
+ for await (const item of response) {
2005
+ console.log(item);
2006
+ }
2001
2007
  ```
2002
2008
 
2003
2009
  </dd>
@@ -2013,7 +2019,7 @@ await client.webhooks.recoverFailedMessages("550e8400-e29b-41d4-a716-44665544000
2013
2019
  <dl>
2014
2020
  <dd>
2015
2021
 
2016
- **subscriptionId:** `string` — The unique identifier of the subscription to recover messages for (UUID).
2022
+ **readableId:** `string`
2017
2023
 
2018
2024
  </dd>
2019
2025
  </dl>
@@ -2021,7 +2027,7 @@ await client.webhooks.recoverFailedMessages("550e8400-e29b-41d4-a716-44665544000
2021
2027
  <dl>
2022
2028
  <dd>
2023
2029
 
2024
- **request:** `AirweaveSDK.RecoverMessagesRequest`
2030
+ **request:** `AirweaveSDK.AgenticSearchRequest`
2025
2031
 
2026
2032
  </dd>
2027
2033
  </dl>
@@ -2029,7 +2035,7 @@ await client.webhooks.recoverFailedMessages("550e8400-e29b-41d4-a716-44665544000
2029
2035
  <dl>
2030
2036
  <dd>
2031
2037
 
2032
- **requestOptions:** `Webhooks.RequestOptions`
2038
+ **requestOptions:** `Search.RequestOptions`
2033
2039
 
2034
2040
  </dd>
2035
2041
  </dl>