exa-js 1.7.3 → 1.8.0

package/dist/index.d.ts

@@ -15,7 +15,7 @@ interface RequestBody$1 {
 /**
  * Common pagination parameters
  */
-interface PaginationParams {
+interface PaginationParams$1 {
     /**
      * Cursor for pagination
      */
@@ -50,10 +50,10 @@ declare class WebsetsBaseClient {
      * @param pagination The pagination parameters
      * @returns QueryParams object with pagination parameters
      */
-    protected buildPaginationParams(pagination?: PaginationParams): QueryParams$1;
+    protected buildPaginationParams(pagination?: PaginationParams$1): QueryParams$1;
 }
 
-interface components {
+interface components$1 {
     schemas: {
         CreateCriterionParameters: {
             /** @description The description of the criterion */
@@ -79,9 +79,28 @@ interface components {
                 label: string;
             }[];
         };
+        CreateStreamParameters: {
+            /** @description Behavior to perform when stream runs */
+            behavior: components$1["schemas"]["StreamBehaviorSearch"] | components$1["schemas"]["StreamBehaviorRefresh"];
+            /** @description How often the stream will run */
+            cadence: {
+                /** @description Cron expression for stream cadence (must be a valid Unix cron with 5 fields). The schedule must trigger at most once per day. */
+                cron: string;
+                /**
+                 * @description IANA timezone (e.g., "America/New_York")
+                 * @default Etc/UTC
+                 */
+                timezone: string;
+            };
+            metadata?: {
+                [key: string]: string;
+            };
+            /** @description The id of the Webset */
+            websetId: string;
+        };
         CreateWebhookParameters: {
             /** @description The events to trigger the webhook */
-            events: components["schemas"]["EventType"][];
+            events: components$1["schemas"]["EventType"][];
             /** @description Set of key-value pairs you want to associate with this object. */
             metadata?: {
                 [key: string]: string;
@@ -94,7 +113,7 @@ interface components {
         };
         CreateWebsetParameters: {
             /** @description Add Enrichments for the Webset. */
-            enrichments?: components["schemas"]["CreateEnrichmentParameters"][];
+            enrichments?: components$1["schemas"]["CreateEnrichmentParameters"][];
             /** @description The external identifier for the webset.
              *
              *     You can use this to reference the Webset by your own internal identifiers. */
@@ -115,11 +134,11 @@ interface components {
                 /** @description Criteria every item is evaluated against.
                  *
                  *     It's not required to provide your own criteria, we automatically detect the criteria from all the information provided in the query. Only use this when you need more fine control. */
-                criteria?: components["schemas"]["CreateCriterionParameters"][];
+                criteria?: components$1["schemas"]["CreateCriterionParameters"][];
                 /** @description Entity the Webset will return results for.
                  *
                  *     It is not required to provide it, we automatically detect the entity from all the information provided in the query. Only use this when you need more fine control. */
-                entity?: components["schemas"]["WebsetEntity"];
+                entity?: components$1["schemas"]["WebsetEntity"];
                 /** @description Your search query.
                  *
                  *     Use this to describe what you are looking for.
@@ -130,14 +149,13 @@ interface components {
         };
         CreateWebsetSearchParameters: {
             /**
-             * WebsetSearchBehaviour
-             * @description The behaviour of the Search when it is added to a Webset.
+             * @description The behavior of the Search when it is added to a Webset.
              *
-             *     - `override`: the search will reuse the existing Items found in the Webset and evaluate them against the new criteria. Any Items that don't match the new criteria will be discarded.
+             *     - `override`: the search will replace the existing Items found in the Webset and evaluate them against the new criteria. Any Items that don't match the new criteria will be discarded.
+             *     - `append`: the search will add the new Items found to the existing Webset. Any Items that don't match the new criteria will be discarded.
              * @default override
-             * @enum {string}
              */
-            behaviour: CreateWebsetSearchParametersBehaviour;
+            behavior: WebsetSearchBehavior;
             /** @description Number of Items the Search will attempt to find.
              *
              *     The actual number of Items found may be less than this number depending on the query complexity. */
@@ -145,11 +163,11 @@ interface components {
             /** @description Criteria every item is evaluated against.
              *
              *     It's not required to provide your own criteria, we automatically detect the criteria from all the information provided in the query. */
-            criteria?: components["schemas"]["CreateCriterionParameters"][];
+            criteria?: components$1["schemas"]["CreateCriterionParameters"][];
             /** @description Entity the Webset will return results for.
              *
              *     It is not required to provide it, we automatically detect the entity from all the information provided in the query. */
-            entity?: components["schemas"]["WebsetEntity"];
+            entity?: components$1["schemas"]["WebsetEntity"];
             /** @description Set of key-value pairs you want to associate with this object. */
             metadata?: {
                 [key: string]: string;
@@ -162,7 +180,7 @@ interface components {
         EnrichmentResult: {
             /** @description The id of the Enrichment that generated the result */
             enrichmentId: string;
-            format: components["schemas"]["WebsetEnrichmentFormat"];
+            format: WebsetEnrichmentFormat;
             /**
              * @default enrichment_result
              * @constant
@@ -189,7 +207,7 @@ interface components {
              * @description The date and time the event was created
              */
             createdAt: string;
-            data: components["schemas"]["Webset"];
+            data: components$1["schemas"]["Webset"];
             /** @description The unique identifier for the event */
             id: string;
             /**
@@ -208,7 +226,7 @@ interface components {
              * @description The date and time the event was created
              */
             createdAt: string;
-            data: components["schemas"]["Webset"];
+            data: components$1["schemas"]["Webset"];
             /** @description The unique identifier for the event */
             id: string;
             /**
@@ -227,7 +245,7 @@ interface components {
              * @description The date and time the event was created
              */
             createdAt: string;
-            data: components["schemas"]["Webset"];
+            data: components$1["schemas"]["Webset"];
             /** @description The unique identifier for the event */
             id: string;
             /**
@@ -246,7 +264,7 @@ interface components {
              * @description The date and time the event was created
              */
             createdAt: string;
-            data: components["schemas"]["Webset"];
+            data: components$1["schemas"]["Webset"];
             /** @description The unique identifier for the event */
             id: string;
             /**
@@ -265,7 +283,7 @@ interface components {
              * @description The date and time the event was created
              */
             createdAt: string;
-            data: components["schemas"]["WebsetItem"];
+            data: components$1["schemas"]["WebsetItem"];
             /** @description The unique identifier for the event */
             id: string;
             /**
@@ -284,7 +302,7 @@ interface components {
              * @description The date and time the event was created
              */
             createdAt: string;
-            data: components["schemas"]["WebsetItem"];
+            data: components$1["schemas"]["WebsetItem"];
             /** @description The unique identifier for the event */
             id: string;
             /**
@@ -303,7 +321,7 @@ interface components {
              * @description The date and time the event was created
              */
             createdAt: string;
-            data: components["schemas"]["WebsetSearch"];
+            data: components$1["schemas"]["WebsetSearch"];
             /** @description The unique identifier for the event */
             id: string;
             /**
@@ -322,7 +340,7 @@ interface components {
              * @description The date and time the event was created
              */
             createdAt: string;
-            data: components["schemas"]["WebsetSearch"];
+            data: components$1["schemas"]["WebsetSearch"];
             /** @description The unique identifier for the event */
             id: string;
             /**
@@ -341,7 +359,7 @@ interface components {
              * @description The date and time the event was created
              */
             createdAt: string;
-            data: components["schemas"]["WebsetSearch"];
+            data: components$1["schemas"]["WebsetSearch"];
             /** @description The unique identifier for the event */
             id: string;
             /**
@@ -360,7 +378,7 @@ interface components {
              * @description The date and time the event was created
              */
             createdAt: string;
-            data: components["schemas"]["WebsetSearch"];
+            data: components$1["schemas"]["WebsetSearch"];
             /** @description The unique identifier for the event */
             id: string;
             /**
@@ -376,13 +394,29 @@ interface components {
         };
         /** @enum {string} */
         EventType: EventType;
-        GetWebsetResponse: components["schemas"]["Webset"] & {
+        GetWebsetResponse: components$1["schemas"]["Webset"] & {
             /** @description When expand query parameter contains `items`, this will contain the items in the webset */
-            items?: components["schemas"]["WebsetItem"][];
+            items?: components$1["schemas"]["WebsetItem"][];
         };
         ListEventsResponse: {
             /** @description The list of events */
-            data: components["schemas"]["Event"][];
+            data: components$1["schemas"]["Event"][];
+            /** @description Whether there are more results to paginate through */
+            hasMore: boolean;
+            /** @description The cursor to paginate through the next set of results */
+            nextCursor: string | null;
+        };
+        ListStreamRunsResponse: {
+            /** @description The list of stream runs */
+            data: components$1["schemas"]["StreamRun"][];
+            /** @description Whether there are more results to paginate through */
+            hasMore: boolean;
+            /** @description The cursor to paginate through the next set of results */
+            nextCursor: string | null;
+        };
+        ListStreamsResponse: {
+            /** @description The list of streams */
+            data: components$1["schemas"]["Stream"][];
             /** @description Whether there are more results to paginate through */
             hasMore: boolean;
             /** @description The cursor to paginate through the next set of results */
@@ -390,7 +424,7 @@ interface components {
         };
         ListWebhookAttemptsResponse: {
             /** @description The list of webhook attempts */
-            data: components["schemas"]["WebhookAttempt"][];
+            data: components$1["schemas"]["WebhookAttempt"][];
             /** @description Whether there are more results to paginate through */
             hasMore: boolean;
             /** @description The cursor to paginate through the next set of results */
@@ -398,7 +432,7 @@ interface components {
         };
         ListWebhooksResponse: {
             /** @description The list of webhooks */
-            data: components["schemas"]["Webhook"][];
+            data: components$1["schemas"]["Webhook"][];
             /** @description Whether there are more results to paginate through */
             hasMore: boolean;
             /** @description The cursor to paginate through the next set of results */
@@ -406,7 +440,7 @@ interface components {
         };
         ListWebsetItemResponse: {
             /** @description The list of webset items */
-            data: components["schemas"]["WebsetItem"][];
+            data: components$1["schemas"]["WebsetItem"][];
             /** @description Whether there are more Items to paginate through */
             hasMore: boolean;
             /** @description The cursor to paginate through the next set of Items */
@@ -414,15 +448,181 @@ interface components {
         };
         ListWebsetsResponse: {
             /** @description The list of websets */
-            data: components["schemas"]["Webset"][];
+            data: components$1["schemas"]["Webset"][];
             /** @description Whether there are more results to paginate through */
             hasMore: boolean;
             /** @description The cursor to paginate through the next set of results */
             nextCursor: string | null;
         };
+        Stream: {
+            /** @description Behavior to perform when stream runs */
+            behavior: components$1["schemas"]["StreamBehaviorSearch"] | components$1["schemas"]["StreamBehaviorRefresh"];
+            /** @description How often the stream will run */
+            cadence: {
+                /** @description Cron expression for stream cadence (must be a valid Unix cron with 5 fields). The schedule must trigger at most once per day. */
+                cron: string;
+                /**
+                 * @description IANA timezone (e.g., "America/New_York")
+                 * @default Etc/UTC
+                 */
+                timezone: string;
+            };
+            /**
+             * Format: date-time
+             * @description When the stream was created
+             */
+            createdAt: string;
+            /** @description The unique identifier for the Stream */
+            id: string;
+            /**
+             * StreamRun
+             * @description The last run of the stream
+             */
+            lastRun: components$1["schemas"]["StreamRun"];
+            /** @description Set of key-value pairs you want to associate with this object. */
+            metadata: {
+                [key: string]: string;
+            };
+            /**
+             * Format: date-time
+             * @description When the next run will occur
+             */
+            nextRunAt: string | null;
+            /**
+             * @description The type of object
+             * @enum {string}
+             */
+            object: StreamObject;
+            /**
+             * @description The status of the Stream
+             * @enum {string}
+             */
+            status: StreamStatus;
+            /**
+             * Format: date-time
+             * @description When the stream was last updated
+             */
+            updatedAt: string;
+            /** @description The id of the Webset the Stream belongs to */
+            websetId: string;
+        };
+        StreamBehaviorRefresh: {
+            /** @description Specify the target of the refresh */
+            config: components$1["schemas"]["StreamRefreshBehaviorEnrichmentsConfig"] | components$1["schemas"]["StreamRefreshBehaviorContentsConfig"];
+            /**
+             * @default refresh
+             * @constant
+             */
+            type: "refresh";
+        };
+        StreamBehaviorSearch: {
+            config: {
+                /**
+                 * @description The behaviour of the Search when it is added to a Webset.
+                 * @default append
+                 */
+                behavior?: WebsetSearchBehavior;
+                /** @description The maximum number of results to find */
+                count: number;
+                criteria: {
+                    description: string;
+                }[];
+                /** WebsetEntity */
+                entity: components$1["schemas"]["WebsetEntity"];
+                query: string;
+            };
+            /**
+             * @default search
+             * @constant
+             */
+            type: "search";
+        };
+        StreamCadence: {
+            /** @description Cron expression for stream cadence (must be a valid Unix cron with 5 fields). The schedule must trigger at most once per day. */
+            cron: string;
+            /**
+             * @description IANA timezone (e.g., "America/New_York")
+             * @default Etc/UTC
+             */
+            timezone: string;
+        };
+        StreamRefreshBehaviorContentsConfig: {
+            /**
+             * @default contents
+             * @constant
+             */
+            target: "contents";
+        };
+        StreamRefreshBehaviorEnrichmentsConfig: {
+            /** @description Only refresh specific enrichments */
+            enrichments?: {
+                ids?: string[];
+            };
+            /**
+             * @default enrichments
+             * @constant
+             */
+            target: "enrichments";
+        };
+        StreamRun: {
+            /**
+             * Format: date-time
+             * @description When the run was canceled
+             */
+            canceledAt: string | null;
+            /**
+             * Format: date-time
+             * @description When the run completed
+             */
+            completedAt: string | null;
+            /**
+             * Format: date-time
+             * @description When the run was created
+             */
+            createdAt: string;
+            /**
+             * Format: date-time
+             * @description When the run failed
+             */
+            failedAt: string | null;
+            /** @description The unique identifier for the Stream Run */
+            id: string;
+            /**
+             * @description The type of object
+             * @enum {string}
+             */
+            object: StreamRunObject;
+            /**
+             * @description The status of the Stream Run
+             * @enum {string}
+             */
+            status: StreamRunStatus;
+            /** @description The stream that the run is associated with */
+            streamId: string;
+            /**
+             * @description The type of the Stream Run
+             * @enum {string}
+             */
+            type: StreamRunType;
+            /**
+             * Format: date-time
+             * @description When the run was last updated
+             */
+            updatedAt: string;
+        };
+        UpdateStream: {
+            metadata?: {
+                [key: string]: string;
+            };
+            /**
+             * @description The status of the stream.
+             * @enum {string}
+             */
+            status?: UpdateStreamStatus;
+        };
         UpdateWebhookParameters: {
             /** @description The events to trigger the webhook */
-            events?: components["schemas"]["EventType"][];
+            events?: components$1["schemas"]["EventType"][];
             /** @description Set of key-value pairs you want to associate with this object. */
             metadata?: {
                 [key: string]: string;
@@ -446,7 +646,7 @@ interface components {
              */
             createdAt: string;
             /** @description The events to trigger the webhook */
-            events: components["schemas"]["EventType"][];
+            events: components$1["schemas"]["EventType"][];
             /** @description The unique identifier for the webhook */
             id: string;
             /**
@@ -524,7 +724,7 @@ interface components {
              */
             createdAt: string;
             /** @description The Enrichments to apply to the Webset Items. */
-            enrichments: components["schemas"]["WebsetEnrichment"][];
+            enrichments: components$1["schemas"]["WebsetEnrichment"][];
             /** @description The external identifier for the webset */
             externalId: string | null;
             /** @description The unique identifier for the webset */
@@ -542,13 +742,15 @@ interface components {
              */
             object: "webset";
             /** @description The searches that have been performed on the webset. */
-            searches: components["schemas"]["WebsetSearch"][];
+            searches: components$1["schemas"]["WebsetSearch"][];
             /**
              * WebsetStatus
              * @description The status of the webset
              * @enum {string}
              */
             status: WebsetStatus;
+            /** @description The Streams for the Webset. */
+            streams: components$1["schemas"]["Stream"][];
             /**
              * Format: date-time
              * @description The date and time the webset was updated
@@ -589,7 +791,7 @@ interface components {
             /** @description The description of the enrichment task provided during the creation of the enrichment. */
             description: string;
             /** @description The format of the enrichment response. */
-            format: components["schemas"]["WebsetEnrichmentFormat"];
+            format: WebsetEnrichmentFormat;
             /** @description The unique identifier for the enrichment */
             id: string;
             /** @description The instructions for the enrichment Agent.
@@ -635,8 +837,7 @@ interface components {
             websetId: string;
         };
         /** @enum {string} */
-        WebsetEnrichmentFormat: WebsetEnrichmentFormat;
-        WebsetEntity: components["schemas"]["WebsetCompanyEntity"] | components["schemas"]["WebsetPersonEntity"] | components["schemas"]["WebsetArticleEntity"] | components["schemas"]["WebsetResearchPaperEntity"] | components["schemas"]["WebsetCustomEntity"];
+        WebsetEntity: components$1["schemas"]["WebsetCompanyEntity"] | components$1["schemas"]["WebsetPersonEntity"] | components$1["schemas"]["WebsetArticleEntity"] | components$1["schemas"]["WebsetResearchPaperEntity"] | components$1["schemas"]["WebsetCustomEntity"];
         WebsetItem: {
             /**
              * Format: date-time
@@ -644,9 +845,9 @@ interface components {
              */
             createdAt: string;
             /** @description The enrichments results of the Webset item */
-            enrichments: components["schemas"]["EnrichmentResult"][] | null;
+            enrichments: components$1["schemas"]["EnrichmentResult"][] | null;
             /** @description The criteria evaluations of the item */
-            evaluations: components["schemas"]["WebsetItemEvaluation"][];
+            evaluations: components$1["schemas"]["WebsetItemEvaluation"][];
             /** @description The unique identifier for the Webset Item */
             id: string;
             /**
@@ -655,7 +856,7 @@ interface components {
              */
             object: "webset_item";
             /** @description The properties of the Item */
-            properties: components["schemas"]["WebsetItemPersonProperties"] | components["schemas"]["WebsetItemCompanyProperties"] | components["schemas"]["WebsetItemArticleProperties"] | components["schemas"]["WebsetItemResearchPaperProperties"] | components["schemas"]["WebsetItemCustomProperties"];
+            properties: components$1["schemas"]["WebsetItemPersonProperties"] | components$1["schemas"]["WebsetItemCompanyProperties"] | components$1["schemas"]["WebsetItemArticleProperties"] | components$1["schemas"]["WebsetItemResearchPaperProperties"] | components$1["schemas"]["WebsetItemCustomProperties"];
             /**
              * @description The source of the Item
              * @enum {string}
@@ -840,16 +1041,21 @@ interface components {
             type: "research_paper";
         };
         WebsetSearch: {
+            /**
+             * @description The behavior of the search when it is added to a Webset.
+             *
+             *     - `override`: the search will replace the existing Items found in the Webset and evaluate them against the new criteria. Any Items that don't match the new criteria will be discarded.
+             *     - `append`: the search will add the new Items found to the existing Webset. Any Items that don't match the new criteria will be discarded.
+             * @default override
+             */
+            behavior: WebsetSearchBehavior;
             /**
              * Format: date-time
              * @description The date and time the search was canceled
              */
             canceledAt: string | null;
-            /**
-             * @description The reason the search was canceled
-             * @enum {string|null}
-             */
-            canceledReason: WebsetSearchCanceledReason;
+            /** @description The reason the search was canceled */
+            canceledReason: WebsetSearchCanceledReason | null;
             /** @description The number of results the search will attempt to find. The actual number of results may be less than this number depending on the search complexity. */
             count: number;
             /**
@@ -867,7 +1073,7 @@ interface components {
             /** @description The entity the search will return results for.
              *
              *     When no entity is provided during creation, we will automatically select the best entity based on the query. */
-            entity: components["schemas"]["WebsetEntity"];
+            entity: components$1["schemas"]["WebsetEntity"];
             /** @description The unique identifier for the search */
             id: string;
             /**
@@ -910,26 +1116,32 @@ interface components {
     headers: never;
     pathItems: never;
 }
-type CreateEnrichmentParameters = components["schemas"]["CreateEnrichmentParameters"];
-type CreateWebhookParameters = components["schemas"]["CreateWebhookParameters"];
-type CreateWebsetParameters = components["schemas"]["CreateWebsetParameters"];
-type CreateWebsetSearchParameters = components["schemas"]["CreateWebsetSearchParameters"];
-type EnrichmentResult = components["schemas"]["EnrichmentResult"];
-type Event = components["schemas"]["Event"];
-type GetWebsetResponse = components["schemas"]["GetWebsetResponse"];
-type ListEventsResponse = components["schemas"]["ListEventsResponse"];
-type ListWebhookAttemptsResponse = components["schemas"]["ListWebhookAttemptsResponse"];
-type ListWebhooksResponse = components["schemas"]["ListWebhooksResponse"];
-type ListWebsetItemResponse = components["schemas"]["ListWebsetItemResponse"];
-type ListWebsetsResponse = components["schemas"]["ListWebsetsResponse"];
-type UpdateWebhookParameters = components["schemas"]["UpdateWebhookParameters"];
-type UpdateWebsetRequest = components["schemas"]["UpdateWebsetRequest"];
-type Webhook = components["schemas"]["Webhook"];
-type WebhookAttempt = components["schemas"]["WebhookAttempt"];
-type Webset = components["schemas"]["Webset"];
-type WebsetEnrichment = components["schemas"]["WebsetEnrichment"];
-type WebsetItem = components["schemas"]["WebsetItem"];
-type WebsetSearch = components["schemas"]["WebsetSearch"];
+type CreateEnrichmentParameters = components$1["schemas"]["CreateEnrichmentParameters"];
+type CreateStreamParameters = components$1["schemas"]["CreateStreamParameters"];
+type CreateWebhookParameters = components$1["schemas"]["CreateWebhookParameters"];
+type CreateWebsetParameters = components$1["schemas"]["CreateWebsetParameters"];
+type CreateWebsetSearchParameters = components$1["schemas"]["CreateWebsetSearchParameters"];
+type EnrichmentResult = components$1["schemas"]["EnrichmentResult"];
+type Event = components$1["schemas"]["Event"];
+type GetWebsetResponse = components$1["schemas"]["GetWebsetResponse"];
+type ListEventsResponse = components$1["schemas"]["ListEventsResponse"];
+type ListStreamRunsResponse = components$1["schemas"]["ListStreamRunsResponse"];
+type ListStreamsResponse = components$1["schemas"]["ListStreamsResponse"];
+type ListWebhookAttemptsResponse = components$1["schemas"]["ListWebhookAttemptsResponse"];
+type ListWebhooksResponse = components$1["schemas"]["ListWebhooksResponse"];
+type ListWebsetItemResponse = components$1["schemas"]["ListWebsetItemResponse"];
+type ListWebsetsResponse = components$1["schemas"]["ListWebsetsResponse"];
+type Stream = components$1["schemas"]["Stream"];
+type StreamRun = components$1["schemas"]["StreamRun"];
+type UpdateStream = components$1["schemas"]["UpdateStream"];
+type UpdateWebhookParameters = components$1["schemas"]["UpdateWebhookParameters"];
+type UpdateWebsetRequest = components$1["schemas"]["UpdateWebsetRequest"];
+type Webhook = components$1["schemas"]["Webhook"];
+type WebhookAttempt = components$1["schemas"]["WebhookAttempt"];
+type Webset = components$1["schemas"]["Webset"];
+type WebsetEnrichment = components$1["schemas"]["WebsetEnrichment"];
+type WebsetItem = components$1["schemas"]["WebsetItem"];
+type WebsetSearch = components$1["schemas"]["WebsetSearch"];
 declare enum CreateEnrichmentParametersFormat {
     text = "text",
     date = "date",
@@ -938,9 +1150,6 @@ declare enum CreateEnrichmentParametersFormat {
     email = "email",
     phone = "phone"
 }
-declare enum CreateWebsetSearchParametersBehaviour {
-    override = "override"
-}
 declare enum EventType {
     webset_created = "webset.created",
     webset_deleted = "webset.deleted",
@@ -955,6 +1164,30 @@ declare enum EventType {
     webset_item_created = "webset.item.created",
     webset_item_enriched = "webset.item.enriched"
 }
+declare enum StreamObject {
+    stream = "stream"
+}
+declare enum StreamStatus {
+    open = "open",
+    closed = "closed"
+}
+declare enum StreamRunObject {
+    stream_run = "stream_run"
+}
+declare enum StreamRunStatus {
+    created = "created",
+    running = "running",
+    completed = "completed",
+    canceled = "canceled"
+}
+declare enum StreamRunType {
+    search = "search",
+    refresh = "refresh"
+}
+declare enum UpdateStreamStatus {
+    open = "open",
+    closed = "closed"
+}
 declare enum WebhookStatus {
     active = "active",
     inactive = "inactive"
@@ -978,23 +1211,28 @@ declare enum WebsetEnrichmentFormat {
     phone = "phone"
 }
 declare enum WebsetItemSource {
-    search = "search"
+    search = "search",
+    import = "import"
 }
 declare enum WebsetItemEvaluationSatisfied {
     yes = "yes",
     no = "no",
     unclear = "unclear"
 }
-declare enum WebsetSearchCanceledReason {
-    webset_deleted = "webset_deleted",
-    webset_canceled = "webset_canceled"
-}
 declare enum WebsetSearchStatus {
     created = "created",
     running = "running",
     completed = "completed",
     canceled = "canceled"
 }
+declare enum WebsetSearchBehavior {
+    override = "override",
+    append = "append"
+}
+declare enum WebsetSearchCanceledReason {
+    webset_deleted = "webset_deleted",
+    webset_canceled = "webset_canceled"
+}
 
 /**
  * Client for managing Webset Enrichments
@@ -1088,21 +1326,21 @@ declare class WebsetItemsClient extends WebsetsBaseClient {
      * @param params - Optional pagination parameters
      * @returns A promise that resolves with the list of Items
      */
-    list(websetId: string, params?: PaginationParams): Promise<ListWebsetItemResponse>;
+    list(websetId: string, params?: PaginationParams$1): Promise<ListWebsetItemResponse>;
     /**
      * Iterate through all Items in a Webset, handling pagination automatically
      * @param websetId The ID of the Webset
      * @param options Pagination options
      * @returns Async generator of Webset Items
      */
-    listAll(websetId: string, options?: PaginationParams): AsyncGenerator<WebsetItem>;
+    listAll(websetId: string, options?: PaginationParams$1): AsyncGenerator<WebsetItem>;
     /**
      * Collect all items from a Webset into an array
      * @param websetId The ID of the Webset
      * @param options Pagination options
      * @returns Promise resolving to an array of all Webset Items
      */
-    getAll(websetId: string, options?: PaginationParams): Promise<WebsetItem[]>;
+    getAll(websetId: string, options?: PaginationParams$1): Promise<WebsetItem[]>;
     /**
      * Get an Item by ID
      * @param websetId The ID of the Webset
@@ -1150,6 +1388,80 @@ declare class WebsetSearchesClient extends WebsetsBaseClient {
     cancel(websetId: string, id: string): Promise<WebsetSearch>;
 }
 
+/**
+ * Client for managing Webset Streams
+ */
+
+/**
+ * Options for listing streams
+ */
+interface ListStreamsOptions extends PaginationParams$1 {
+    /**
+     * The id of the Webset to list streams for
+     */
+    websetId?: string;
+}
+/**
+ * Client for managing Stream Runs
+ */
+declare class WebsetStreamRunsClient extends WebsetsBaseClient {
+    /**
+     * List all runs for a Stream
+     * @param streamId The ID of the Stream
+     * @param options Pagination options
+     * @returns The list of Stream runs
+     */
+    list(streamId: string, options?: PaginationParams$1): Promise<ListStreamRunsResponse>;
+    /**
+     * Get a specific Stream run
+     * @param streamId The ID of the Stream
+     * @param runId The ID of the Stream run
+     * @returns The Stream run
+     */
+    get(streamId: string, runId: string): Promise<StreamRun>;
+}
+/**
+ * Client for managing Webset Streams
+ */
+declare class WebsetStreamsClient extends WebsetsBaseClient {
+    /**
+     * Client for managing Stream Runs
+     */
+    runs: WebsetStreamRunsClient;
+    constructor(client: Exa);
+    /**
+     * Create a Stream
+     * @param params The stream parameters
+     * @returns The created Stream
+     */
+    create(params: CreateStreamParameters): Promise<Stream>;
+    /**
+     * Get a Stream by ID
+     * @param id The ID of the Stream
+     * @returns The Stream
+     */
+    get(id: string): Promise<Stream>;
+    /**
+     * List all Streams
+     * @param options Pagination and filtering options
+     * @returns The list of Streams
+     */
+    list(options?: ListStreamsOptions): Promise<ListStreamsResponse>;
+    /**
+     * Update a Stream
+     * @param id The ID of the Stream
+     * @param params The stream update parameters (status, metadata)
+     * @returns The updated Stream
+     */
+    update(id: string, params: UpdateStream): Promise<Stream>;
+    /**
+     * Delete a Stream
+     * @param id The ID of the Stream
+     * @returns The deleted Stream
+     */
+    delete(id: string): Promise<Stream>;
+}
+
 /**
  * Client for managing Webset Webhooks
  */
@@ -1157,12 +1469,12 @@ declare class WebsetSearchesClient extends WebsetsBaseClient {
 /**
  * Options for listing webhooks (only pagination is supported by API)
  */
-interface ListWebhooksOptions extends PaginationParams {
+interface ListWebhooksOptions extends PaginationParams$1 {
 }
 /**
  * Options for listing webhook attempts
  */
-interface ListWebhookAttemptsOptions extends PaginationParams {
+interface ListWebhookAttemptsOptions extends PaginationParams$1 {
     /**
      * The type of event to filter by
      */
@@ -1245,7 +1557,7 @@ declare class WebsetWebhooksClient extends WebsetsBaseClient {
 /**
  * Options for listing Websets (API only supports pagination)
  */
-interface ListWebsetsOptions extends PaginationParams {
+interface ListWebsetsOptions extends PaginationParams$1 {
 }
 /**
  * Client for managing Websets
@@ -1267,6 +1579,10 @@ declare class WebsetsClient extends WebsetsBaseClient {
      * Client for managing Webset Enrichments
      */
     enrichments: WebsetEnrichmentsClient;
+    /**
+     * Client for managing Webset Streams
+     */
+    streams: WebsetStreamsClient;
     /**
      * Client for managing Webset Webhooks
      */
@@ -1340,6 +1656,101 @@ declare class WebsetsClient extends WebsetsBaseClient {
     } | number): Promise<Webset>;
 }
 
+interface components {
+    schemas: {
+        ListResearchTasksRequestDto: {
+            /** @description The cursor to paginate through the results */
+            cursor?: string;
+            /**
+             * @description The number of results to return
+             * @default 25
+             */
+            limit: number;
+        };
+        ListResearchTasksResponseDto: {
+            /** @description The list of research tasks */
+            data: components["schemas"]["ResearchTaskDto"][];
+            /** @description Whether there are more results to paginate through */
+            hasMore: boolean;
+            /** @description The cursor to paginate through the next set of results */
+            nextCursor: string | null;
+        };
+        ResearchCreateTaskRequestDto: {
+            /** @description Instructions for what the research task should accomplish */
+            instructions: string;
+            /**
+             * @default exa-research
+             * @enum {string}
+             */
+            model: ResearchCreateTaskRequestDtoModel;
+            output?: {
+                /** @description A JsonSchema specification of the desired output. See https://json-schema.org/draft-07. */
+                schema?: unknown;
+            };
+        };
+        ResearchCreateTaskResponseDto: {
+            /** @description The unique identifier for the research task */
+            id: string;
+        };
+        ResearchTaskDto: {
+            /** @description Citations grouped by the root field they were used in */
+            citations?: {
+                [key: string]: {
+                    id: string;
+                    snippet: string;
+                    title?: string;
+                    url: string;
+                }[];
+            };
+            /** @description The research results data conforming to the specified schema */
+            data?: {
+                [key: string]: unknown;
+            };
+            /** @description The unique identifier for the research task */
+            id: string;
+            /** @description The instructions or query for the research task */
+            instructions: string;
+            /** @description The JSON schema specification for the expected output format */
+            schema?: {
+                [key: string]: unknown;
+            };
+            /**
+             * @description The current status of the research task
+             * @enum {string}
+             */
+            status: ResearchTaskDtoStatus;
+        };
+    };
+    responses: never;
+    parameters: never;
+    requestBodies: never;
+    headers: never;
+    pathItems: never;
+}
+type SchemaListResearchTasksResponseDto = components["schemas"]["ListResearchTasksResponseDto"];
+type SchemaResearchCreateTaskResponseDto = components["schemas"]["ResearchCreateTaskResponseDto"];
+type SchemaResearchTaskDto = components["schemas"]["ResearchTaskDto"];
+declare enum ResearchCreateTaskRequestDtoModel {
+    exa_research = "exa-research",
+    exa_ultra = "exa-ultra"
+}
+declare enum ResearchTaskDtoStatus {
+    running = "running",
+    completed = "completed",
+    failed = "failed"
+}
+
+interface PaginationParams {
+    /** Cursor for pagination */
+    cursor?: string;
+    /** Maximum number of items per page */
+    limit?: number;
+}
+/**
+ * Options for listing research tasks (API only supports pagination)
+ */
+type ListResearchTasksOptions = PaginationParams;
+
 type QueryParams = Record<string, string | number | boolean | string[] | undefined>;
 interface RequestBody {
     [key: string]: unknown;
@@ -1363,6 +1774,12 @@ declare class ResearchBaseClient {
      * @returns The parsed JSON response
      */
     protected request<T = unknown>(endpoint: string, method?: string, data?: RequestBody, params?: QueryParams): Promise<T>;
+    /**
+     * Helper to build pagination parameters.
+     * @param pagination The pagination parameters
+     * @returns QueryParams object with pagination parameters
+     */
+    protected buildPaginationParams(pagination?: PaginationParams): QueryParams;
 }
 
 /**
@@ -1371,71 +1788,39 @@ declare class ResearchBaseClient {
 declare class ResearchClient extends ResearchBaseClient {
     constructor(client: Exa);
     /**
-     * Create a research task.
+     * Create a new research task.
      *
-     * Both parameters are required and have fixed shapes:
-     * 1. `input`
-     *      `{ instructions: string }`
-     *     • `instructions` – High-level guidance that tells the research agent what to do.
-     * 2. `output`
-     *    defines the exact structure you expect back, and guides the research conducted by the agent.
-     *      `{ schema: JSONSchema }`.
-     *    The agent's response will be validated against this schema.
+     * @param params Object containing:
+     *   - model: The research model to use (e.g., ResearchModel.ExaResearch).
+     *   - instructions: High-level guidance for the research agent.
+     *   - output: An object with a `schema` property (JSONSchema) that defines the expected output structure.
      *
-     * @param input  Object containing high-level research instructions.
-     * @param output Object containing the expected output schema.
-     * @returns The ResearchTaskResponse returned by the API.
+     * @returns An object containing the unique ID of the created research task.
      */
-    createTask(input: {
+    createTask(params: {
         instructions: string;
-    }, output: {
-        schema: JSONSchema;
-    }): Promise<{
-        id: string;
-    }>;
+        model?: ResearchCreateTaskRequestDtoModel;
+        output: {
+            schema: JSONSchema;
+        };
+    }): Promise<SchemaResearchCreateTaskResponseDto>;
     /**
      * Retrieve a research task by ID.
      */
-    getTask(id: string): Promise<ResearchTask>;
+    getTask(id: string): Promise<SchemaResearchTaskDto>;
     /**
      * Poll a research task until completion or failure.
      * Polls every 1 second with a maximum timeout of 10 minutes.
+     * Resilient to up to 10 consecutive polling failures.
      */
-    pollTask(id: string): Promise<ResearchTask>;
-}
-
-/**
- * Enum representing the status of a research task.
- */
-declare enum ResearchStatus {
-    /** The research task is still in progress. */
-    in_progress = "in_progress",
-    /** The research request has finished successfully. */
-    completed = "completed",
-    /** The research task request failed. */
-    failed = "failed"
+    pollTask(id: string): Promise<SchemaResearchTaskDto>;
+    /**
+     * List research tasks
+     * @param options Pagination options
+     * @returns The paginated list of research tasks
+     */
+    listTasks(options?: ListResearchTasksOptions): Promise<SchemaListResearchTasksResponseDto>;
 }
-/**
- * Response object returned from the research API.
- */
-type ResearchTask = {
-    /** Unique identifier for the task. */
-    id: string;
-    /** Current status. */
-    status: ResearchStatus;
-    /** The original instructions provided along with the task. */
-    instructions: string;
-    /** The original schema defining the task */
-    schema: Record<string, any>;
-    /** Structured output that follows the user-provided schema (null while running or if failed). */
-    data: Record<string, any> | null;
-    /**
-     * Citations collected while deriving each top-level field in `output`.
-     * The key is the field name, the value is the list of `SearchResult`s that
-     * were used to compute that field.
-     */
-    citations: Record<string, SearchResult<{}>[]>;
-};
 
 /**
  * HTTP status codes
@@ -1914,4 +2299,4 @@ declare class Exa {
     private parseSSEStream;
 }
 
-export { type AnswerOptions, type AnswerResponse, type AnswerStreamChunk, type AnswerStreamResponse, type BaseSearchOptions, type ContentsOptions, type ContentsResultComponent, type CostDollars, type CostDollarsContents, type CostDollarsSeearch, type CreateEnrichmentParameters, CreateEnrichmentParametersFormat, type CreateWebhookParameters, type CreateWebsetParameters, type CreateWebsetSearchParameters, CreateWebsetSearchParametersBehaviour, type Default, type EnrichmentResult, type Event, EventType, Exa, ExaError, type ExtrasOptions, type ExtrasResponse, type FindSimilarOptions, type GetWebsetResponse, type HighlightsContentsOptions, type HighlightsResponse, HttpStatusCode, type JSONSchema, type ListEventsResponse, type ListWebhooksOptions, type ListWebhooksResponse, type ListWebsetItemResponse, type ListWebsetsOptions, type ListWebsetsResponse, type LivecrawlOptions, type RegularSearchOptions, ResearchClient, ResearchStatus, type ResearchTask, type SearchResponse, type SearchResult, type SubpagesResponse, type SummaryContentsOptions, type SummaryResponse, type TextContentsOptions, type TextResponse, type UpdateWebhookParameters, type UpdateWebsetRequest, type Webhook, WebhookStatus, type Webset, type WebsetEnrichment, WebsetEnrichmentFormat, WebsetEnrichmentStatus, WebsetEnrichmentsClient, type WebsetItem, WebsetItemEvaluationSatisfied, WebsetItemSource, WebsetItemsClient, type WebsetSearch, WebsetSearchCanceledReason, WebsetSearchStatus, WebsetSearchesClient, WebsetStatus, WebsetWebhooksClient, WebsetsClient, Exa as default };
+export { type AnswerOptions, type AnswerResponse, type AnswerStreamChunk, type AnswerStreamResponse, type BaseSearchOptions, type ContentsOptions, type ContentsResultComponent, type CostDollars, type CostDollarsContents, type CostDollarsSeearch, type CreateEnrichmentParameters, CreateEnrichmentParametersFormat, type CreateStreamParameters, type CreateWebhookParameters, type CreateWebsetParameters, type CreateWebsetSearchParameters, type Default, type EnrichmentResult, type Event, EventType, Exa, ExaError, type ExtrasOptions, type ExtrasResponse, type FindSimilarOptions, type GetWebsetResponse, type HighlightsContentsOptions, type HighlightsResponse, HttpStatusCode, type JSONSchema, type ListEventsResponse, type ListResearchTasksOptions, type SchemaListResearchTasksResponseDto as ListResearchTasksResponse, type ListStreamRunsResponse, type ListStreamsOptions, type ListStreamsResponse, type ListWebhooksOptions, type ListWebhooksResponse, type ListWebsetItemResponse, type ListWebsetsOptions, type ListWebsetsResponse, type LivecrawlOptions, type RegularSearchOptions, ResearchClient, ResearchCreateTaskRequestDtoModel as ResearchModel, ResearchTaskDtoStatus as ResearchStatus, type SchemaResearchTaskDto as ResearchTask, type SearchResponse, type SearchResult, type Stream, type StreamRun, type SubpagesResponse, type SummaryContentsOptions, type SummaryResponse, type TextContentsOptions, type TextResponse, type UpdateStream, UpdateStreamStatus, type UpdateWebhookParameters, type UpdateWebsetRequest, type Webhook, WebhookStatus, type Webset, type WebsetEnrichment, WebsetEnrichmentFormat, WebsetEnrichmentStatus, WebsetEnrichmentsClient, type WebsetItem, WebsetItemEvaluationSatisfied, WebsetItemSource, WebsetItemsClient, type WebsetSearch, WebsetSearchBehavior, WebsetSearchCanceledReason, WebsetSearchStatus, WebsetSearchesClient, WebsetStatus, WebsetStreamsClient, WebsetWebhooksClient, WebsetsClient, Exa as default };