exa-js 1.5.12 → 1.6.13

package/dist/index.d.ts

@@ -1,3 +1,1384 @@
+/**
+ * Base client for Websets API
+ */
+
+/**
+ * Type for API query parameters
+ */
+type QueryParams = Record<string, string | number | boolean | string[] | undefined>;
+/**
+ * Type for API request body
+ */
+interface RequestBody {
+    [key: string]: unknown;
+}
+/**
+ * Common pagination parameters
+ */
+interface PaginationParams {
+    /**
+     * Cursor for pagination
+     */
+    cursor?: string;
+    /**
+     * Maximum number of items per page
+     */
+    limit?: number;
+}
+/**
+ * Base client class for all Websets-related API clients
+ */
+declare class WebsetsBaseClient {
+    protected client: Exa;
+    /**
+     * Initialize a new Websets base client
+     * @param client The Exa client instance
+     */
+    constructor(client: Exa);
+    /**
+     * Make a request to the Websets API
+     * @param endpoint The endpoint path
+     * @param method The HTTP method
+     * @param data Optional request body data
+     * @param params Optional query parameters
+     * @returns The response JSON
+     * @throws ExaError with API error details if the request fails
+     */
+    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;
+}
+
+interface components {
+    schemas: {
+        CreateCriterionParameters: {
+            /** @description The description of the criterion */
+            description: string;
+        };
+        CreateEnrichmentParameters: {
+            /** @description Provide a description of the enrichment task you want to perform to each Webset Item. */
+            description: string;
+            /**
+             * @description Format of the enrichment response.
+             *
+             *     We automatically select the best format based on the description. If you want to explicitly specify the format, you can do so here.
+             * @enum {string}
+             */
+            format?: CreateEnrichmentParametersFormat;
+            /** @description Set of key-value pairs you want to associate with this object. */
+            metadata?: {
+                [key: string]: string;
+            };
+            /** @description When the format is options, the different options for the enrichment agent to choose from. */
+            options?: {
+                /** @description The label of the option */
+                label: string;
+            }[];
+        };
+        CreateWebhookParameters: {
+            /** @description The events to trigger the webhook */
+            events: components["schemas"]["EventType"][];
+            /** @description Set of key-value pairs you want to associate with this object. */
+            metadata?: {
+                [key: string]: string;
+            };
+            /**
+             * Format: uri
+             * @description The URL to send the webhook to
+             */
+            url: string;
+        };
+        CreateWebsetParameters: {
+            /** @description Add Enrichments for the Webset. */
+            enrichments?: components["schemas"]["CreateEnrichmentParameters"][];
+            /** @description The external identifier for the webset.
+             *
+             *     You can use this to reference the Webset by your own internal identifiers. */
+            externalId?: string;
+            /** @description Set of key-value pairs you want to associate with this object. */
+            metadata?: {
+                [key: string]: string;
+            };
+            /** @description Create initial search for the Webset. */
+            search: {
+                /**
+                 * @description Number of Items the Webset will attempt to find.
+                 *
+                 *     The actual number of Items found may be less than this number depending on the search complexity.
+                 * @default 10
+                 */
+                count: number;
+                /** @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"][];
+                /** @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"];
+                /** @description Your search query.
+                 *
+                 *     Use this to describe what you are looking for.
+                 *
+                 *     Any URL provided will be crawled and used as context for the search. */
+                query: string;
+            };
+        };
+        CreateWebsetSearchParameters: {
+            /**
+             * WebsetSearchBehaviour
+             * @description The behaviour 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.
+             * @default override
+             * @enum {string}
+             */
+            behaviour: CreateWebsetSearchParametersBehaviour;
+            /** @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. */
+            count: number;
+            /** @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"][];
+            /** @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"];
+            /** @description Set of key-value pairs you want to associate with this object. */
+            metadata?: {
+                [key: string]: string;
+            };
+            /** @description Query describing what you are looking for.
+             *
+             *     Any URL provided will be crawled and used as context for the search. */
+            query: string;
+        };
+        EnrichmentResult: {
+            /** @description The id of the Enrichment that generated the result */
+            enrichmentId: string;
+            format: components["schemas"]["WebsetEnrichmentFormat"];
+            /**
+             * @default enrichment_result
+             * @constant
+             */
+            object: "enrichment_result";
+            /** @description The reasoning for the result when an Agent is used. */
+            reasoning: string | null;
+            /** @description The references used to generate the result. */
+            references: {
+                /** @description The relevant snippet of the reference content */
+                snippet: string | null;
+                /** @description The title of the reference */
+                title: string | null;
+                /** @description The URL of the reference */
+                url: string;
+            }[];
+            /** @description The result of the enrichment. */
+            result: string[] | null;
+        };
+        /** Event */
+        Event: {
+            /**
+             * Format: date-time
+             * @description The date and time the event was created
+             */
+            createdAt: string;
+            data: components["schemas"]["Webset"];
+            /** @description The unique identifier for the event */
+            id: string;
+            /**
+             * @default event
+             * @constant
+             */
+            object: "event";
+            /**
+             * @default webset.created
+             * @constant
+             */
+            type: "webset.created";
+        } | {
+            /**
+             * Format: date-time
+             * @description The date and time the event was created
+             */
+            createdAt: string;
+            data: components["schemas"]["Webset"];
+            /** @description The unique identifier for the event */
+            id: string;
+            /**
+             * @default event
+             * @constant
+             */
+            object: "event";
+            /**
+             * @default webset.deleted
+             * @constant
+             */
+            type: "webset.deleted";
+        } | {
+            /**
+             * Format: date-time
+             * @description The date and time the event was created
+             */
+            createdAt: string;
+            data: components["schemas"]["Webset"];
+            /** @description The unique identifier for the event */
+            id: string;
+            /**
+             * @default event
+             * @constant
+             */
+            object: "event";
+            /**
+             * @default webset.idle
+             * @constant
+             */
+            type: "webset.idle";
+        } | {
+            /**
+             * Format: date-time
+             * @description The date and time the event was created
+             */
+            createdAt: string;
+            data: components["schemas"]["Webset"];
+            /** @description The unique identifier for the event */
+            id: string;
+            /**
+             * @default event
+             * @constant
+             */
+            object: "event";
+            /**
+             * @default webset.paused
+             * @constant
+             */
+            type: "webset.paused";
+        } | {
+            /**
+             * Format: date-time
+             * @description The date and time the event was created
+             */
+            createdAt: string;
+            data: components["schemas"]["WebsetItem"];
+            /** @description The unique identifier for the event */
+            id: string;
+            /**
+             * @default event
+             * @constant
+             */
+            object: "event";
+            /**
+             * @default webset.item.created
+             * @constant
+             */
+            type: "webset.item.created";
+        } | {
+            /**
+             * Format: date-time
+             * @description The date and time the event was created
+             */
+            createdAt: string;
+            data: components["schemas"]["WebsetItem"];
+            /** @description The unique identifier for the event */
+            id: string;
+            /**
+             * @default event
+             * @constant
+             */
+            object: "event";
+            /**
+             * @default webset.item.enriched
+             * @constant
+             */
+            type: "webset.item.enriched";
+        } | {
+            /**
+             * Format: date-time
+             * @description The date and time the event was created
+             */
+            createdAt: string;
+            data: components["schemas"]["WebsetSearch"];
+            /** @description The unique identifier for the event */
+            id: string;
+            /**
+             * @default event
+             * @constant
+             */
+            object: "event";
+            /**
+             * @default webset.search.created
+             * @constant
+             */
+            type: "webset.search.created";
+        } | {
+            /**
+             * Format: date-time
+             * @description The date and time the event was created
+             */
+            createdAt: string;
+            data: components["schemas"]["WebsetSearch"];
+            /** @description The unique identifier for the event */
+            id: string;
+            /**
+             * @default event
+             * @constant
+             */
+            object: "event";
+            /**
+             * @default webset.search.updated
+             * @constant
+             */
+            type: "webset.search.updated";
+        } | {
+            /**
+             * Format: date-time
+             * @description The date and time the event was created
+             */
+            createdAt: string;
+            data: components["schemas"]["WebsetSearch"];
+            /** @description The unique identifier for the event */
+            id: string;
+            /**
+             * @default event
+             * @constant
+             */
+            object: "event";
+            /**
+             * @default webset.search.canceled
+             * @constant
+             */
+            type: "webset.search.canceled";
+        } | {
+            /**
+             * Format: date-time
+             * @description The date and time the event was created
+             */
+            createdAt: string;
+            data: components["schemas"]["WebsetSearch"];
+            /** @description The unique identifier for the event */
+            id: string;
+            /**
+             * @default event
+             * @constant
+             */
+            object: "event";
+            /**
+             * @default webset.search.completed
+             * @constant
+             */
+            type: "webset.search.completed";
+        };
+        /** @enum {string} */
+        EventType: EventType;
+        GetWebsetResponse: components["schemas"]["Webset"] & {
+            /** @description When expand query parameter contains `items`, this will contain the items in the webset */
+            items?: components["schemas"]["WebsetItem"][];
+        };
+        ListEventsResponse: {
+            /** @description The list of events */
+            data: components["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;
+        };
+        ListWebhookAttemptsResponse: {
+            /** @description The list of webhook attempts */
+            data: components["schemas"]["WebhookAttempt"][];
+            /** @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;
+        };
+        ListWebhooksResponse: {
+            /** @description The list of webhooks */
+            data: components["schemas"]["Webhook"][];
+            /** @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;
+        };
+        ListWebsetItemResponse: {
+            /** @description The list of webset items */
+            data: components["schemas"]["WebsetItem"][];
+            /** @description Whether there are more Items to paginate through */
+            hasMore: boolean;
+            /** @description The cursor to paginate through the next set of Items */
+            nextCursor: string | null;
+        };
+        ListWebsetsResponse: {
+            /** @description The list of websets */
+            data: components["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;
+        };
+        UpdateWebhookParameters: {
+            /** @description The events to trigger the webhook */
+            events?: components["schemas"]["EventType"][];
+            /** @description Set of key-value pairs you want to associate with this object. */
+            metadata?: {
+                [key: string]: string;
+            };
+            /**
+             * Format: uri
+             * @description The URL to send the webhook to
+             */
+            url?: string;
+        };
+        UpdateWebsetRequest: {
+            /** @description Set of key-value pairs you want to associate with this object. */
+            metadata?: {
+                [key: string]: string;
+            } | null;
+        };
+        Webhook: {
+            /**
+             * Format: date-time
+             * @description The date and time the webhook was created
+             */
+            createdAt: string;
+            /** @description The events to trigger the webhook */
+            events: components["schemas"]["EventType"][];
+            /** @description The unique identifier for the webhook */
+            id: string;
+            /**
+             * @description The metadata of the webhook
+             * @default {}
+             */
+            metadata: {
+                [key: string]: string;
+            };
+            /**
+             * @default webhook
+             * @constant
+             */
+            object: "webhook";
+            /** @description The secret to verify the webhook signature. Only returned on Webhook creation. */
+            secret: string | null;
+            /**
+             * WebhookStatus
+             * @description The status of the webhook
+             * @enum {string}
+             */
+            status: WebhookStatus;
+            /**
+             * Format: date-time
+             * @description The date and time the webhook was last updated
+             */
+            updatedAt: string;
+            /**
+             * Format: uri
+             * @description The URL to send the webhook to
+             */
+            url: string;
+        };
+        WebhookAttempt: {
+            /** @description The attempt number of the webhook */
+            attempt: number;
+            /**
+             * Format: date-time
+             * @description The date and time the webhook attempt was made
+             */
+            attemptedAt: string;
+            /** @description The unique identifier for the event */
+            eventId: string;
+            /**
+             * @description The type of event
+             * @enum {string}
+             */
+            eventType: EventType;
+            /** @description The unique identifier for the webhook attempt */
+            id: string;
+            /**
+             * @default webhook_attempt
+             * @constant
+             */
+            object: "webhook_attempt";
+            /** @description The body of the response */
+            responseBody: string | null;
+            /** @description The headers of the response */
+            responseHeaders: {
+                [key: string]: string;
+            };
+            /** @description The status code of the response */
+            responseStatusCode: number;
+            /** @description Whether the attempt was successful */
+            successful: boolean;
+            /** @description The URL that was used during the attempt */
+            url: string;
+            /** @description The unique identifier for the webhook */
+            webhookId: string;
+        };
+        Webset: {
+            /**
+             * Format: date-time
+             * @description The date and time the webset was created
+             */
+            createdAt: string;
+            /** @description The Enrichments to apply to the Webset Items. */
+            enrichments: components["schemas"]["WebsetEnrichment"][];
+            /** @description The external identifier for the webset */
+            externalId: string | null;
+            /** @description The unique identifier for the webset */
+            id: string;
+            /**
+             * @description Set of key-value pairs you want to associate with this object.
+             * @default {}
+             */
+            metadata: {
+                [key: string]: string;
+            };
+            /**
+             * @default webset
+             * @constant
+             */
+            object: "webset";
+            /** @description The searches that have been performed on the webset. */
+            searches: components["schemas"]["WebsetSearch"][];
+            /**
+             * WebsetStatus
+             * @description The status of the webset
+             * @enum {string}
+             */
+            status: WebsetStatus;
+            /**
+             * Format: date-time
+             * @description The date and time the webset was updated
+             */
+            updatedAt: string;
+        };
+        WebsetArticleEntity: {
+            /**
+             * @default article
+             * @constant
+             */
+            type: "article";
+        };
+        WebsetCompanyEntity: {
+            /**
+             * @default company
+             * @constant
+             */
+            type: "company";
+        };
+        WebsetCustomEntity: {
+            /** @description When you decide to use a custom entity, this is the description of the entity.
+             *
+             *     The entity represents what type of results the Webset will return. For example, if you want results to be Job Postings, you might use "Job Postings" as the entity description. */
+            description: string;
+            /**
+             * @default custom
+             * @constant
+             */
+            type: "custom";
+        };
+        WebsetEnrichment: {
+            /**
+             * Format: date-time
+             * @description The date and time the enrichment was created
+             */
+            createdAt: string;
+            /** @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"];
+            /** @description The unique identifier for the enrichment */
+            id: string;
+            /** @description The instructions for the enrichment Agent.
+             *
+             *     This will be automatically generated based on the description and format. */
+            instructions: string | null;
+            /**
+             * @description The metadata of the enrichment
+             * @default {}
+             */
+            metadata: {
+                [key: string]: string;
+            };
+            /**
+             * @default webset_enrichment
+             * @constant
+             */
+            object: "webset_enrichment";
+            /**
+             * WebsetEnrichmentOptions
+             * @description When the format is options, the different options for the enrichment agent to choose from.
+             */
+            options: {
+                /** @description The label of the option */
+                label: string;
+            }[] | null;
+            /**
+             * WebsetEnrichmentStatus
+             * @description The status of the enrichment
+             * @enum {string}
+             */
+            status: WebsetEnrichmentStatus;
+            /** @description The title of the enrichment.
+             *
+             *     This will be automatically generated based on the description and format. */
+            title: string | null;
+            /**
+             * Format: date-time
+             * @description The date and time the enrichment was updated
+             */
+            updatedAt: string;
+            /** @description The unique identifier for the Webset this enrichment belongs to. */
+            websetId: string;
+        };
+        /** @enum {string} */
+        WebsetEnrichmentFormat: WebsetEnrichmentFormat;
+        WebsetEntity: components["schemas"]["WebsetCompanyEntity"] | components["schemas"]["WebsetPersonEntity"] | components["schemas"]["WebsetArticleEntity"] | components["schemas"]["WebsetResearchPaperEntity"] | components["schemas"]["WebsetCustomEntity"];
+        WebsetItem: {
+            /**
+             * Format: date-time
+             * @description The date and time the item was created
+             */
+            createdAt: string;
+            /** @description The enrichments results of the Webset item */
+            enrichments: components["schemas"]["EnrichmentResult"][] | null;
+            /** @description The criteria evaluations of the item */
+            evaluations: components["schemas"]["WebsetItemEvaluation"][];
+            /** @description The unique identifier for the Webset Item */
+            id: string;
+            /**
+             * @default webset_item
+             * @constant
+             */
+            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"];
+            /**
+             * @description The source of the Item
+             * @enum {string}
+             */
+            source: WebsetItemSource;
+            /** @description The unique identifier for the source */
+            sourceId: string;
+            /**
+             * Format: date-time
+             * @description The date and time the item was last updated
+             */
+            updatedAt: string;
+            /** @description The unique identifier for the Webset this Item belongs to. */
+            websetId: string;
+        };
+        WebsetItemArticleProperties: {
+            /** WebsetItemArticlePropertiesFields */
+            article: {
+                /** @description The author(s) of the article */
+                author: string | null;
+                /** @description The date and time the article was published */
+                publishedAt: string | null;
+            };
+            /** @description The text content for the article */
+            content: string | null;
+            /** @description Short description of the relevance of the article */
+            description: string;
+            /**
+             * @default article
+             * @constant
+             */
+            type: "article";
+            /**
+             * Format: uri
+             * @description The URL of the article
+             */
+            url: string;
+        };
+        WebsetItemCompanyProperties: {
+            /** WebsetItemCompanyPropertiesFields */
+            company: {
+                /** @description A short description of the company */
+                about: string | null;
+                /** @description The number of employees of the company */
+                employees: number | null;
+                /** @description The industry of the company */
+                industry: string | null;
+                /** @description The main location of the company */
+                location: string | null;
+                /**
+                 * Format: uri
+                 * @description The logo URL of the company
+                 */
+                logoUrl: string | null;
+                /** @description The name of the company */
+                name: string;
+            };
+            /** @description The text content of the company website */
+            content: string | null;
+            /** @description Short description of the relevance of the company */
+            description: string;
+            /**
+             * @default company
+             * @constant
+             */
+            type: "company";
+            /**
+             * Format: uri
+             * @description The URL of the company website
+             */
+            url: string;
+        };
+        WebsetItemCustomProperties: {
+            /** @description The text content of the Item */
+            content: string | null;
+            /** WebsetItemCustomPropertiesFields */
+            custom: {
+                /** @description The author(s) of the website */
+                author: string | null;
+                /** @description The date and time the website was published */
+                publishedAt: string | null;
+            };
+            /** @description Short description of the Item */
+            description: string;
+            /**
+             * @default custom
+             * @constant
+             */
+            type: "custom";
+            /**
+             * Format: uri
+             * @description The URL of the Item
+             */
+            url: string;
+        };
+        WebsetItemEvaluation: {
+            /** @description The description of the criterion */
+            criterion: string;
+            /** @description The reasoning for the result of the evaluation */
+            reasoning: string;
+            /**
+             * @description The references used to generate the result.
+             * @default []
+             */
+            references: {
+                /** @description The relevant snippet of the reference content */
+                snippet: string | null;
+                /** @description The title of the reference */
+                title: string | null;
+                /** @description The URL of the reference */
+                url: string;
+            }[];
+            /**
+             * @description The satisfaction of the criterion
+             * @enum {string}
+             */
+            satisfied: WebsetItemEvaluationSatisfied;
+        };
+        WebsetItemPersonProperties: {
+            /** @description Short description of the relevance of the person */
+            description: string;
+            /** WebsetItemPersonPropertiesFields */
+            person: {
+                /** @description The location of the person */
+                location: string | null;
+                /** @description The name of the person */
+                name: string;
+                /**
+                 * Format: uri
+                 * @description The image URL of the person
+                 */
+                pictureUrl: string | null;
+                /** @description The current work position of the person */
+                position: string | null;
+            };
+            /**
+             * @default person
+             * @constant
+             */
+            type: "person";
+            /**
+             * Format: uri
+             * @description The URL of the person profile
+             */
+            url: string;
+        };
+        WebsetItemResearchPaperProperties: {
+            /** @description The text content of the research paper */
+            content: string | null;
+            /** @description Short description of the relevance of the research paper */
+            description: string;
+            /** WebsetItemResearchPaperPropertiesFields */
+            researchPaper: {
+                /** @description The author(s) of the research paper */
+                author: string | null;
+                /** @description The date and time the research paper was published */
+                publishedAt: string | null;
+            };
+            /**
+             * @default research_paper
+             * @constant
+             */
+            type: "research_paper";
+            /**
+             * Format: uri
+             * @description The URL of the research paper
+             */
+            url: string;
+        };
+        WebsetPersonEntity: {
+            /**
+             * @default person
+             * @constant
+             */
+            type: "person";
+        };
+        WebsetResearchPaperEntity: {
+            /**
+             * @default research_paper
+             * @constant
+             */
+            type: "research_paper";
+        };
+        WebsetSearch: {
+            /**
+             * 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 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;
+            /**
+             * Format: date-time
+             * @description The date and time the search was created
+             */
+            createdAt: string;
+            /** @description The criteria the search will use to evaluate the results. If not provided, we will automatically generate them for you. */
+            criteria: {
+                /** @description The description of the criterion */
+                description: string;
+                /** @description Value between 0 and 100 representing the percentage of results that meet the criterion. */
+                successRate: number;
+            }[];
+            /** @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"];
+            /** @description The unique identifier for the search */
+            id: string;
+            /**
+             * @description Set of key-value pairs you want to associate with this object.
+             * @default {}
+             */
+            metadata: {
+                [key: string]: string;
+            };
+            /**
+             * @default webset_search
+             * @constant
+             */
+            object: "webset_search";
+            /** @description The progress of the search */
+            progress: {
+                /** @description The completion percentage of the search */
+                completion: number;
+                /** @description The number of results found so far */
+                found: number;
+            };
+            /** @description The query used to create the search. */
+            query: string;
+            /**
+             * WebsetSearchStatus
+             * @description The status of the search
+             * @enum {string}
+             */
+            status: WebsetSearchStatus;
+            /**
+             * Format: date-time
+             * @description The date and time the search was updated
+             */
+            updatedAt: string;
+        };
+    };
+    responses: never;
+    parameters: never;
+    requestBodies: never;
+    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"];
+declare enum CreateEnrichmentParametersFormat {
+    text = "text",
+    date = "date",
+    number = "number",
+    options = "options",
+    email = "email",
+    phone = "phone"
+}
+declare enum CreateWebsetSearchParametersBehaviour {
+    override = "override"
+}
+declare enum EventType {
+    webset_created = "webset.created",
+    webset_deleted = "webset.deleted",
+    webset_paused = "webset.paused",
+    webset_idle = "webset.idle",
+    webset_search_created = "webset.search.created",
+    webset_search_canceled = "webset.search.canceled",
+    webset_search_completed = "webset.search.completed",
+    webset_search_updated = "webset.search.updated",
+    webset_export_created = "webset.export.created",
+    webset_export_completed = "webset.export.completed",
+    webset_item_created = "webset.item.created",
+    webset_item_enriched = "webset.item.enriched"
+}
+declare enum WebhookStatus {
+    active = "active",
+    inactive = "inactive"
+}
+declare enum WebsetStatus {
+    idle = "idle",
+    running = "running",
+    paused = "paused"
+}
+declare enum WebsetEnrichmentStatus {
+    pending = "pending",
+    canceled = "canceled",
+    completed = "completed"
+}
+declare enum WebsetEnrichmentFormat {
+    text = "text",
+    date = "date",
+    number = "number",
+    options = "options",
+    email = "email",
+    phone = "phone"
+}
+declare enum WebsetItemSource {
+    search = "search"
+}
+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"
+}
+
+/**
+ * Client for managing Webset Enrichments
+ */
+
+/**
+ * Client for managing Webset Enrichments
+ */
+declare class WebsetEnrichmentsClient extends WebsetsBaseClient {
+    /**
+     * Create an Enrichment for a Webset
+     * @param websetId The ID of the Webset
+     * @param params The enrichment parameters
+     * @returns The created Webset Enrichment
+     */
+    create(websetId: string, params: CreateEnrichmentParameters): Promise<WebsetEnrichment>;
+    /**
+     * Get an Enrichment by ID
+     * @param websetId The ID of the Webset
+     * @param id The ID of the Enrichment
+     * @returns The Webset Enrichment
+     */
+    get(websetId: string, id: string): Promise<WebsetEnrichment>;
+    /**
+     * Delete an Enrichment
+     * @param websetId The ID of the Webset
+     * @param id The ID of the Enrichment
+     * @returns The deleted Webset Enrichment
+     */
+    delete(websetId: string, id: string): Promise<WebsetEnrichment>;
+    /**
+     * Cancel a running Enrichment
+     * @param websetId The ID of the Webset
+     * @param id The ID of the Enrichment
+     * @returns The canceled Webset Enrichment
+     */
+    cancel(websetId: string, id: string): Promise<WebsetEnrichment>;
+}
+
+/**
+ * Options for listing Events
+ */
+interface ListEventsOptions {
+    /**
+     * The cursor to paginate through the results
+     */
+    cursor?: string;
+    /**
+     * The number of results to return
+     */
+    limit?: number;
+    /**
+     * The types of events to filter by
+     */
+    types?: EventType[];
+}
+/**
+ * Client for managing Events
+ */
+declare class EventsClient extends WebsetsBaseClient {
+    /**
+     * Initialize a new Events client
+     * @param client The Exa client instance
+     */
+    constructor(client: Exa);
+    /**
+     * List all Events
+     * @param options Optional filtering and pagination options
+     * @returns The list of Events
+     */
+    list(options?: ListEventsOptions): Promise<ListEventsResponse>;
+    /**
+     * Get an Event by ID
+     * @param id The ID of the Event
+     * @returns The Event
+     */
+    get(id: string): Promise<Event>;
+}
+
+/**
+ * Client for managing Webset Items
+ */
+
+/**
+ * Client for managing Webset Items
+ */
+declare class WebsetItemsClient extends WebsetsBaseClient {
+    /**
+     * List all Items for a Webset
+     * @param websetId The ID of the Webset
+     * @param params - Optional pagination parameters
+     * @returns A promise that resolves with the list of Items
+     */
+    list(websetId: string, params?: PaginationParams): 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>;
+    /**
+     * 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[]>;
+    /**
+     * Get an Item by ID
+     * @param websetId The ID of the Webset
+     * @param id The ID of the Item
+     * @returns The Webset Item
+     */
+    get(websetId: string, id: string): Promise<WebsetItem>;
+    /**
+     * Delete an Item
+     * @param websetId The ID of the Webset
+     * @param id The ID of the Item
+     * @returns The deleted Webset Item
+     */
+    delete(websetId: string, id: string): Promise<WebsetItem>;
+}
+
+/**
+ * Client for managing Webset Searches
+ */
+
+/**
+ * Client for managing Webset Searches
+ */
+declare class WebsetSearchesClient extends WebsetsBaseClient {
+    /**
+     * Create a new Search for the Webset
+     * @param websetId The ID of the Webset
+     * @param params The search parameters
+     * @returns The created Webset Search
+     */
+    create(websetId: string, params: CreateWebsetSearchParameters): Promise<WebsetSearch>;
+    /**
+     * Get a Search by ID
+     * @param websetId The ID of the Webset
+     * @param id The ID of the Search
+     * @returns The Webset Search
+     */
+    get(websetId: string, id: string): Promise<WebsetSearch>;
+    /**
+     * Cancel a running Search
+     * @param websetId The ID of the Webset
+     * @param id The ID of the Search
+     * @returns The canceled Webset Search
+     */
+    cancel(websetId: string, id: string): Promise<WebsetSearch>;
+}
+
+/**
+ * Client for managing Webset Webhooks
+ */
+
+/**
+ * Options for listing webhooks (only pagination is supported by API)
+ */
+interface ListWebhooksOptions extends PaginationParams {
+}
+/**
+ * Options for listing webhook attempts
+ */
+interface ListWebhookAttemptsOptions extends PaginationParams {
+    /**
+     * The type of event to filter by
+     */
+    eventType?: EventType;
+}
+/**
+ * Client for managing Webset Webhooks
+ */
+declare class WebsetWebhooksClient extends WebsetsBaseClient {
+    /**
+     * Create a Webhook
+     * @param params The webhook parameters
+     * @returns The created Webhook
+     */
+    create(params: CreateWebhookParameters): Promise<Webhook>;
+    /**
+     * Get a Webhook by ID
+     * @param id The ID of the Webhook
+     * @returns The Webhook
+     */
+    get(id: string): Promise<Webhook>;
+    /**
+     * List all Webhooks
+     * @param options Pagination options
+     * @returns The list of Webhooks
+     */
+    list(options?: ListWebhooksOptions): Promise<ListWebhooksResponse>;
+    /**
+     * Iterate through all Webhooks, handling pagination automatically
+     * @param options Pagination options
+     * @returns Async generator of Webhooks
+     */
+    listAll(options?: ListWebhooksOptions): AsyncGenerator<Webhook>;
+    /**
+     * Collect all Webhooks into an array
+     * @param options Pagination options
+     * @returns Promise resolving to an array of all Webhooks
+     */
+    getAll(options?: ListWebhooksOptions): Promise<Webhook[]>;
+    /**
+     * Update a Webhook
+     * @param id The ID of the Webhook
+     * @param params The webhook update parameters (events, metadata, url)
+     * @returns The updated Webhook
+     */
+    update(id: string, params: UpdateWebhookParameters): Promise<Webhook>;
+    /**
+     * Delete a Webhook
+     * @param id The ID of the Webhook
+     * @returns The deleted Webhook
+     */
+    delete(id: string): Promise<Webhook>;
+    /**
+     * List all attempts for a Webhook
+     * @param id The ID of the Webhook
+     * @param options Pagination and filtering options
+     * @returns The list of Webhook attempts
+     */
+    listAttempts(id: string, options?: ListWebhookAttemptsOptions): Promise<ListWebhookAttemptsResponse>;
+    /**
+     * Iterate through all attempts for a Webhook, handling pagination automatically
+     * @param id The ID of the Webhook
+     * @param options Pagination and filtering options
+     * @returns Async generator of Webhook attempts
+     */
+    listAllAttempts(id: string, options?: ListWebhookAttemptsOptions): AsyncGenerator<WebhookAttempt>;
+    /**
+     * Collect all attempts for a Webhook into an array
+     * @param id The ID of the Webhook
+     * @param options Pagination and filtering options
+     * @returns Promise resolving to an array of all Webhook attempts
+     */
+    getAllAttempts(id: string, options?: ListWebhookAttemptsOptions): Promise<WebhookAttempt[]>;
+}
+
+/**
+ * Main client for Websets API
+ */
+
+/**
+ * Options for listing Websets (API only supports pagination)
+ */
+interface ListWebsetsOptions extends PaginationParams {
+}
+/**
+ * Client for managing Websets
+ */
+declare class WebsetsClient extends WebsetsBaseClient {
+    /**
+     * Client for managing Events
+     */
+    events: EventsClient;
+    /**
+     * Client for managing Webset Items
+     */
+    items: WebsetItemsClient;
+    /**
+     * Client for managing Webset Searches
+     */
+    searches: WebsetSearchesClient;
+    /**
+     * Client for managing Webset Enrichments
+     */
+    enrichments: WebsetEnrichmentsClient;
+    /**
+     * Client for managing Webset Webhooks
+     */
+    webhooks: WebsetWebhooksClient;
+    /**
+     * Initialize a new Websets client
+     * @param client The Exa client instance
+     */
+    constructor(client: Exa);
+    /**
+     * Create a new Webset
+     * @param params The Webset creation parameters
+     * @returns The created Webset
+     */
+    create(params: CreateWebsetParameters): Promise<Webset>;
+    /**
+     * Get a Webset by ID
+     * @param id The ID of the Webset
+     * @param expand Optional array of relations to expand
+     * @returns The Webset
+     */
+    get(id: string, expand?: Array<"items">): Promise<GetWebsetResponse>;
+    /**
+     * List all Websets
+     * @param options Pagination options (filtering by status is not supported by API)
+     * @returns The list of Websets
+     */
+    list(options?: ListWebsetsOptions): Promise<ListWebsetsResponse>;
+    /**
+     * Iterate through all Websets, handling pagination automatically
+     * @param options Pagination options
+     * @returns Async generator of Websets
+     */
+    listAll(options?: ListWebsetsOptions): AsyncGenerator<Webset>;
+    /**
+     * Collect all Websets into an array
+     * @param options Pagination options
+     * @returns Promise resolving to an array of all Websets
+     */
+    getAll(options?: ListWebsetsOptions): Promise<Webset[]>;
+    /**
+     * Update a Webset
+     * @param id The ID of the Webset
+     * @param params The Webset update parameters
+     * @returns The updated Webset
+     */
+    update(id: string, params: UpdateWebsetRequest): Promise<Webset>;
+    /**
+     * Delete a Webset
+     * @param id The ID of the Webset
+     * @returns The deleted Webset
+     */
+    delete(id: string): Promise<Webset>;
+    /**
+     * Cancel a running Webset
+     * @param id The ID or external ID of the Webset
+     * @returns The canceled Webset (as returned by the API)
+     */
+    cancel(id: string): Promise<Webset>;
+    /**
+     * Wait until a Webset is idle
+     * @param id The ID of the Webset
+     * @param options Configuration options for timeout and polling
+     * @returns The Webset once it becomes idle
+     * @throws Error if the Webset does not become idle within the timeout
+     */
+    waitUntilIdle(id: string, options?: {
+        timeout?: number;
+        pollInterval?: number;
+        onPoll?: (status: WebsetStatus) => void;
+    } | number): Promise<Webset>;
+}
+
+/**
+ * HTTP status codes
+ */
+declare enum HttpStatusCode {
+    BadRequest = 400,
+    NotFound = 404,
+    Unauthorized = 401,
+    Forbidden = 403,
+    TooManyRequests = 429,
+    RequestTimeout = 408,
+    InternalServerError = 500,
+    ServiceUnavailable = 503
+}
+/**
+ * Base error class for all Exa API errors
+ */
+declare class ExaError extends Error {
+    /**
+     * HTTP status code
+     */
+    statusCode: number;
+    /**
+     * ISO timestamp from API
+     */
+    timestamp?: string;
+    /**
+     * Path that caused the error (may be undefined for client-side errors)
+     */
+    path?: string;
+    /**
+     * Create a new ExaError
+     * @param message Error message
+     * @param statusCode HTTP status code
+     * @param timestamp ISO timestamp from API
+     * @param path Path that caused the error
+     */
+    constructor(message: string, statusCode: number, timestamp?: string, path?: string);
+}
+
 declare const isBeta = false;
 /**
  * Search options for performing a search query.
@@ -262,11 +1643,13 @@ type SearchResponse<T extends ContentsOptions> = {
  * @property {boolean} [stream] - Whether to stream the response. Default false.
  * @property {boolean} [text] - Whether to include text in the source results. Default false.
  * @property {"exa" | "exa-pro"} [model] - The model to use for generating the answer. Default "exa".
+ * @property {string} [systemPrompt] - A system prompt to guide the LLM's behavior when generating the answer.
  */
 type AnswerOptions = {
     stream?: boolean;
     text?: boolean;
     model?: "exa" | "exa-pro";
+    systemPrompt?: string;
 };
 /**
  * Represents an answer response object from the /answer endpoint.
@@ -307,12 +1690,17 @@ type AnswerStreamResponse = {
     answer?: string;
     citations?: SearchResult<{}>[];
 };
+
 /**
  * The Exa class encapsulates the API's endpoints.
  */
 declare class Exa {
     private baseURL;
     private headers;
+    /**
+     * Websets API client
+     */
+    websets: WebsetsClient;
     /**
      * Helper method to separate out the contents-specific options from the rest.
      */
@@ -328,9 +1716,11 @@ declare class Exa {
      * @param {string} endpoint - The API endpoint to call.
      * @param {string} method - The HTTP method to use.
      * @param {any} [body] - The request body for POST requests.
+     * @param {Record<string, any>} [params] - The query parameters.
      * @returns {Promise<any>} The response from the API.
+     * @throws {ExaError} When any API request fails with structured error information
      */
-    private request;
+    request<T = unknown>(endpoint: string, method: string, body?: any, params?: Record<string, any>): Promise<T>;
     /**
      * Performs a search with an Exa prompt-engineered query.
      *
@@ -374,6 +1764,15 @@ declare class Exa {
      * @param {AnswerOptions} [options] - Additional options for answer generation.
      * @returns {Promise<AnswerResponse>} The generated answer and source references.
      *
+     * Example with systemPrompt:
+     * ```ts
+     * const answer = await exa.answer("What is quantum computing?", {
+     *   text: true,
+     *   model: "exa-pro",
+     *   systemPrompt: "Answer in a technical manner suitable for experts."
+     * });
+     * ```
+     *
      * Note: For streaming responses, use the `streamAnswer` method:
      * ```ts
      * for await (const chunk of exa.streamAnswer(query)) {
@@ -390,7 +1789,10 @@ declare class Exa {
      *
      * Example usage:
      * ```ts
-     * for await (const chunk of exa.streamAnswer("What is quantum computing?", { text: false })) {
+     * for await (const chunk of exa.streamAnswer("What is quantum computing?", {
+     *   text: false,
+     *   systemPrompt: "Answer in a concise manner suitable for beginners."
+     * })) {
      *   if (chunk.content) process.stdout.write(chunk.content);
      *   if (chunk.citations) {
      *     console.log("\nCitations: ", chunk.citations);
@@ -401,8 +1803,9 @@ declare class Exa {
     streamAnswer(query: string, options?: {
         text?: boolean;
         model?: "exa" | "exa-pro";
+        systemPrompt?: string;
     }): AsyncGenerator<AnswerStreamChunk>;
     private processChunk;
 }
 
-export { AnswerOptions, AnswerResponse, AnswerStreamChunk, AnswerStreamResponse, BaseSearchOptions, ContentsOptions, ContentsResultComponent, CostDollars, CostDollarsContents, CostDollarsSeearch, Default, ExtrasOptions, ExtrasResponse, FindSimilarOptions, HighlightsContentsOptions, HighlightsResponse, JSONSchema, LivecrawlOptions, RegularSearchOptions, SearchResponse, SearchResult, SubpagesResponse, SummaryContentsOptions, SummaryResponse, TextContentsOptions, TextResponse, Exa as default };
+export { AnswerOptions, AnswerResponse, AnswerStreamChunk, AnswerStreamResponse, BaseSearchOptions, ContentsOptions, ContentsResultComponent, CostDollars, CostDollarsContents, CostDollarsSeearch, CreateEnrichmentParameters, CreateEnrichmentParametersFormat, CreateWebhookParameters, CreateWebsetParameters, CreateWebsetSearchParameters, CreateWebsetSearchParametersBehaviour, Default, EnrichmentResult, Event, EventType, Exa, ExaError, ExtrasOptions, ExtrasResponse, FindSimilarOptions, GetWebsetResponse, HighlightsContentsOptions, HighlightsResponse, HttpStatusCode, JSONSchema, ListEventsResponse, ListWebhooksOptions, ListWebhooksResponse, ListWebsetItemResponse, ListWebsetsOptions, ListWebsetsResponse, LivecrawlOptions, RegularSearchOptions, SearchResponse, SearchResult, SubpagesResponse, SummaryContentsOptions, SummaryResponse, TextContentsOptions, TextResponse, UpdateWebhookParameters, UpdateWebsetRequest, Webhook, WebhookStatus, Webset, WebsetEnrichment, WebsetEnrichmentFormat, WebsetEnrichmentStatus, WebsetEnrichmentsClient, WebsetItem, WebsetItemEvaluationSatisfied, WebsetItemSource, WebsetItemsClient, WebsetSearch, WebsetSearchCanceledReason, WebsetSearchStatus, WebsetSearchesClient, WebsetStatus, WebsetWebhooksClient, WebsetsClient, Exa as default };