mixpeek 0.81.1

package/dist/api/public-retriever-apiapi.d.ts

@@ -0,0 +1,483 @@
+/**
+ * Mixpeek API
+ * This is the Mixpeek API, providing access to various endpoints for data processing and retrieval.
+ *
+ * The version of the OpenAPI document: 0.81.1
+ * Contact: info@mixpeek.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { Configuration } from '../configuration';
+import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
+import { type RequestArgs, BaseAPI } from '../base';
+import type { ListPublicRetrieversResponse } from '../models';
+import type { PublicInteractionBatchRequest } from '../models';
+import type { PublicInteractionRequest } from '../models';
+import type { PublicRetrieverConfigResponse } from '../models';
+import type { PublicRetrieverTemplateResponse } from '../models';
+import type { RetrieverExecutionRequest } from '../models';
+import type { VerifyPasswordRequest } from '../models';
+import type { VerifyPasswordResponse } from '../models';
+/**
+ * PublicRetrieverAPIApi - axios parameter creator
+ * @export
+ */
+export declare const PublicRetrieverAPIApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * Execute a published retriever (public endpoint).  **Authentication:** - API key is OPTIONAL for public retrievers - Supports: no key, prk_ keys (deprecated), or ret_sk_ keys - If password-protected, requires `X-Retriever-Password` header  **Rate Limiting:** - Subject to per-retriever rate limits (per minute/hour/day) - May also have IP-based rate limits  **Response:** - Only returns fields specified in `exposed_fields` configuration - Internal metadata is stripped from results - Includes `execution_id` for interaction tracking - Presigned URLs returned by default (return_presigned_urls=true) for media rendering  **Example (no API key - recommended for public access):** ```bash curl -X POST \"https://api.mixpeek.com/v1/public/retrievers/video-search/execute\" \\   -H \"Content-Type: application/json\" \\   -d \'{     \"inputs\": {\"query\": \"red car\"},     \"pagination\": {\"method\": \"offset\", \"page_number\": 1, \"page_size\": 10}   }\' ```  **Example with ret_sk_ key (for SDK/programmatic access):** ```bash curl -X POST \"https://api.mixpeek.com/v1/public/retrievers/video-search/execute\" \\   -H \"X-Public-API-Key: ret_sk_abc123...\" \\   -H \"Content-Type: application/json\" \\   -d \'{     \"inputs\": {\"query\": \"red car\"},     \"pagination\": {\"method\": \"offset\", \"page_number\": 1, \"page_size\": 10}   }\' ```
+     * @summary Execute Public Retriever
+     * @param {string} publicName Public name of the published retriever
+     * @param {RetrieverExecutionRequest} retrieverExecutionRequest
+     * @param {boolean} [returnPresignedUrls] Generate fresh presigned download URLs for all blobs with S3 storage. Default: True for public retrievers to enable media rendering. Set to False if you only need metadata without URLs.
+     * @param {string} [xPublicAPIKey]
+     * @param {string} [xRetrieverPassword]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    executeRetrieverName: (publicName: string, retrieverExecutionRequest: RetrieverExecutionRequest, returnPresignedUrls?: boolean, xPublicAPIKey?: string, xRetrieverPassword?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Get display configuration for public page rendering.  ⚠️ **DEPRECATED**: Use `/v1/marketplace/catalog/{public_name}/config` instead. This endpoint is maintained for backwards compatibility but may be removed in the future.  Returns the UI configuration needed to render the public search interface. Used by the frontend app at mxp.co to dynamically build the UI.  **Authentication:** - NO authentication required - this endpoint is public - Anyone can access the config if they know the public_name - The config includes the public_api_key needed for execute/interact endpoints  **Response includes:** - Display config (logo, theme, components, field rendering) - Title and description - Password protection status - Public API key for subsequent authenticated requests  **Example (deprecated):** ```bash curl -X GET \"https://api.mixpeek.com/v1/public/retrievers/video-search/config\" ```  **Example (recommended):** ```bash curl -X GET \"https://api.mixpeek.com/v1/marketplace/catalog/video-search/config\" ```
+     * @summary Get Public Retriever Config
+     * @param {string} publicName Public name of the published retriever
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getRetrieverConfigName: (publicName: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Get retriever configuration as a reusable template.  Returns the published retriever\'s configuration in a format that can be directly used to create your own retriever. This is perfect for discovering patterns and adapting them to your own data.  **Authentication:** - NO authentication required - this endpoint is completely public - Anyone can get the template if they know the public_name  **Use Case:** 1. Browse public retrievers to find patterns you like 2. GET this endpoint to get the full configuration 3. Copy the config and modify for your needs (especially `collection_identifiers`) 4. POST to `/v1/retrievers` to create your own retriever 5. Optionally publish it with the same display_config  **What\'s included:** - Retriever configuration (stages, input_schema, budget_limits) - Display configuration (for publishing with similar UI) - Original metadata for reference  **What you need to change:** - `collection_identifiers`: Replace with your own collection IDs - `retriever_name`: Give it a unique name - Optionally modify stages, inputs, display_config as needed  **Example:** ```bash # 1. Get the template curl -X GET \"https://api.mixpeek.com/v1/public/retrievers/video-search/template\"  # 2. Modify the response and create your own retriever curl -X POST \"https://api.mixpeek.com/v1/retrievers\" \\   -H \"Authorization: Bearer YOUR_API_KEY\" \\   -H \"Content-Type: application/json\" \\   -d \'{     \"retriever_name\": \"my_video_search\",     \"collection_identifiers\": [\"my_videos\"],     \"stages\": [...],  # From template     \"input_schema\": {...},  # From template     \"budget_limits\": {...},  # From template     \"display_config\": {...}  # From template (optional)   }\' ```  **Response includes:** - All retriever configuration fields - Display config for publishing (optional to use) - Source reference (where this template came from)
+     * @summary Get Public Retriever Template
+     * @param {string} publicName Public name of the published retriever
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getRetrieverTemplateName: (publicName: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * List all public retrievers with pagination and search.  This endpoint allows browsing and discovering all published retrievers across all organizations. No authentication required.  **Authentication:** - NO authentication required - completely public endpoint - Discover retrievers created by all Mixpeek users  **Pagination:** - Default: page=1, page_size=20 - Maximum page_size: 100 - Returns total count and total pages  **Search:** - Search across retriever titles and descriptions - Case-insensitive regex matching - Combine with pagination  **Filtering:** - By default, only active retrievers are shown - Set `include_inactive=true` to see all retrievers  **Response includes:** - List of public retrievers with basic info - Pagination details (page, page_size, total_count, total_pages) - Aggregate statistics (total active, password protected, open)  **What\'s NOT exposed:** - API keys (except in individual config endpoint) - Internal IDs or organization details - Full retriever configuration (use template endpoint for that) - Password values (only password_protected: true/false)  **Example:** ```bash # List all public retrievers (first page) curl -X GET \"https://api.mixpeek.com/v1/public/retrievers/\"  # Search for video-related retrievers curl -X GET \"https://api.mixpeek.com/v1/public/retrievers/?search=video&page_size=50\"  # Get page 2 with custom page size curl -X GET \"https://api.mixpeek.com/v1/public/retrievers/?page=2&page_size=50\" ```  **Use Cases:** - Browse available public retrievers - Discover search patterns and implementations - Find retrievers to use as templates - Explore what others have built
+     * @summary List Public Retrievers
+     * @param {number} [page] Page number (1-indexed)
+     * @param {number} [pageSize] Results per page
+     * @param {boolean} [includeInactive] Include inactive retrievers in results
+     * @param {string} [search] Search query for filtering by title or description
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listRetrievers: (page?: number, pageSize?: number, includeInactive?: boolean, search?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Track multiple interactions in a single request (batching).  More efficient than sending individual interaction requests. Use this for batching viewport visibility, bulk actions, etc.  **Authentication:** - API key is OPTIONAL (same as execute endpoint) - Password NOT required (tracking should work even without auth)  **Recommended Headers:** - `X-Session-ID`: Applied to all interactions in the batch  **Limits:** - Maximum 100 interactions per batch  **Example:** ```bash curl -X POST \"https://api.mixpeek.com/v1/public/retrievers/video-search/interactions/batch\" \\   -H \"X-Session-ID: sess_xyz...\" \\   -H \"Content-Type: application/json\" \\   -d \'{     \"interactions\": [       {         \"document_id\": \"doc_123\",         \"interaction_type\": [\"VIEW\"],         \"position\": 0,         \"execution_id\": \"exec_abc\"       },       {         \"document_id\": \"doc_456\",         \"interaction_type\": [\"VIEW\"],         \"position\": 1,         \"execution_id\": \"exec_abc\"       }     ]   }\' ```
+     * @summary Track Interaction Batch
+     * @param {string} publicName Public name of the published retriever
+     * @param {PublicInteractionBatchRequest} publicInteractionBatchRequest
+     * @param {string} [xSessionID]
+     * @param {string} [xPublicAPIKey]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    trackInteractionBatchRetrieversName: (publicName: string, publicInteractionBatchRequest: PublicInteractionBatchRequest, xSessionID?: string, xPublicAPIKey?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Track user interaction with search results.  Records user engagement (clicks, views, etc.) for analytics and potential search optimization (Learning to Rank).  **Authentication:** - API key is OPTIONAL (same as execute endpoint) - Password NOT required (tracking should work even without auth)  **Recommended Headers:** - `X-Session-ID`: Session identifier for tracking user journey  **Interaction Types:** - `VIEW`: Result was visible in viewport - `CLICK`: User clicked on result - `POSITIVE_FEEDBACK`: User explicitly liked result - `NEGATIVE_FEEDBACK`: User explicitly disliked result - `PURCHASE`: User purchased/converted - `ADD_TO_CART`: User added to cart - `WISHLIST`: User added to wishlist - `LONG_VIEW`: User spent significant time viewing - `SHARE`: User shared result - `BOOKMARK`: User bookmarked result  **Example:** ```bash curl -X POST \"https://api.mixpeek.com/v1/public/retrievers/video-search/interactions\" \\   -H \"X-Session-ID: sess_xyz...\" \\   -H \"Content-Type: application/json\" \\   -d \'{     \"document_id\": \"doc_123\",     \"interaction_type\": [\"CLICK\"],     \"position\": 2,     \"execution_id\": \"exec_abc\",     \"query_snapshot\": {\"query\": \"red car\"}   }\' ```
+     * @summary Track Interaction
+     * @param {string} publicName Public name of the published retriever
+     * @param {PublicInteractionRequest} publicInteractionRequest
+     * @param {string} [xSessionID]
+     * @param {string} [xPublicAPIKey]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    trackInteractionRetrieversName: (publicName: string, publicInteractionRequest: PublicInteractionRequest, xSessionID?: string, xPublicAPIKey?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Verify password for a password-protected retriever.  Allows the frontend to check if a password is valid before attempting to execute a password-protected retriever. Returns the public API key if the password is valid.  **Authentication:** - NO authentication required - this endpoint is public - The password is verified against the retriever\'s configured password  **Use Case:** 1. Frontend detects that a retriever is password-protected (from /config endpoint) 2. User enters password in the UI 3. Frontend calls this endpoint to verify the password 4. If valid, frontend receives the public_api_key to use for subsequent requests  **Response:** - `valid`: Whether the password is correct - `public_api_key`: The API key to use for execute/interact endpoints (only if valid)  **Example:** ```bash curl -X POST \"https://api.mixpeek.com/v1/public/retrievers/private-search/verify\" \\   -H \"Content-Type: application/json\" \\   -d \'{\"password\": \"secret123\"}\' ```  **Response if valid:** ```json {   \"valid\": true,   \"public_api_key\": \"prk_abc123...\" } ```  **Response if invalid:** ```json {   \"valid\": false,   \"public_api_key\": null } ```
+     * @summary Verify Password
+     * @param {string} publicName Public name of the published retriever
+     * @param {VerifyPasswordRequest} verifyPasswordRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    verifyPasswordRetrieversName: (publicName: string, verifyPasswordRequest: VerifyPasswordRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * PublicRetrieverAPIApi - functional programming interface
+ * @export
+ */
+export declare const PublicRetrieverAPIApiFp: (configuration?: Configuration) => {
+    /**
+     * Execute a published retriever (public endpoint).  **Authentication:** - API key is OPTIONAL for public retrievers - Supports: no key, prk_ keys (deprecated), or ret_sk_ keys - If password-protected, requires `X-Retriever-Password` header  **Rate Limiting:** - Subject to per-retriever rate limits (per minute/hour/day) - May also have IP-based rate limits  **Response:** - Only returns fields specified in `exposed_fields` configuration - Internal metadata is stripped from results - Includes `execution_id` for interaction tracking - Presigned URLs returned by default (return_presigned_urls=true) for media rendering  **Example (no API key - recommended for public access):** ```bash curl -X POST \"https://api.mixpeek.com/v1/public/retrievers/video-search/execute\" \\   -H \"Content-Type: application/json\" \\   -d \'{     \"inputs\": {\"query\": \"red car\"},     \"pagination\": {\"method\": \"offset\", \"page_number\": 1, \"page_size\": 10}   }\' ```  **Example with ret_sk_ key (for SDK/programmatic access):** ```bash curl -X POST \"https://api.mixpeek.com/v1/public/retrievers/video-search/execute\" \\   -H \"X-Public-API-Key: ret_sk_abc123...\" \\   -H \"Content-Type: application/json\" \\   -d \'{     \"inputs\": {\"query\": \"red car\"},     \"pagination\": {\"method\": \"offset\", \"page_number\": 1, \"page_size\": 10}   }\' ```
+     * @summary Execute Public Retriever
+     * @param {string} publicName Public name of the published retriever
+     * @param {RetrieverExecutionRequest} retrieverExecutionRequest
+     * @param {boolean} [returnPresignedUrls] Generate fresh presigned download URLs for all blobs with S3 storage. Default: True for public retrievers to enable media rendering. Set to False if you only need metadata without URLs.
+     * @param {string} [xPublicAPIKey]
+     * @param {string} [xRetrieverPassword]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    executeRetrieverName(publicName: string, retrieverExecutionRequest: RetrieverExecutionRequest, returnPresignedUrls?: boolean, xPublicAPIKey?: string, xRetrieverPassword?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
+    /**
+     * Get display configuration for public page rendering.  ⚠️ **DEPRECATED**: Use `/v1/marketplace/catalog/{public_name}/config` instead. This endpoint is maintained for backwards compatibility but may be removed in the future.  Returns the UI configuration needed to render the public search interface. Used by the frontend app at mxp.co to dynamically build the UI.  **Authentication:** - NO authentication required - this endpoint is public - Anyone can access the config if they know the public_name - The config includes the public_api_key needed for execute/interact endpoints  **Response includes:** - Display config (logo, theme, components, field rendering) - Title and description - Password protection status - Public API key for subsequent authenticated requests  **Example (deprecated):** ```bash curl -X GET \"https://api.mixpeek.com/v1/public/retrievers/video-search/config\" ```  **Example (recommended):** ```bash curl -X GET \"https://api.mixpeek.com/v1/marketplace/catalog/video-search/config\" ```
+     * @summary Get Public Retriever Config
+     * @param {string} publicName Public name of the published retriever
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getRetrieverConfigName(publicName: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PublicRetrieverConfigResponse>>;
+    /**
+     * Get retriever configuration as a reusable template.  Returns the published retriever\'s configuration in a format that can be directly used to create your own retriever. This is perfect for discovering patterns and adapting them to your own data.  **Authentication:** - NO authentication required - this endpoint is completely public - Anyone can get the template if they know the public_name  **Use Case:** 1. Browse public retrievers to find patterns you like 2. GET this endpoint to get the full configuration 3. Copy the config and modify for your needs (especially `collection_identifiers`) 4. POST to `/v1/retrievers` to create your own retriever 5. Optionally publish it with the same display_config  **What\'s included:** - Retriever configuration (stages, input_schema, budget_limits) - Display configuration (for publishing with similar UI) - Original metadata for reference  **What you need to change:** - `collection_identifiers`: Replace with your own collection IDs - `retriever_name`: Give it a unique name - Optionally modify stages, inputs, display_config as needed  **Example:** ```bash # 1. Get the template curl -X GET \"https://api.mixpeek.com/v1/public/retrievers/video-search/template\"  # 2. Modify the response and create your own retriever curl -X POST \"https://api.mixpeek.com/v1/retrievers\" \\   -H \"Authorization: Bearer YOUR_API_KEY\" \\   -H \"Content-Type: application/json\" \\   -d \'{     \"retriever_name\": \"my_video_search\",     \"collection_identifiers\": [\"my_videos\"],     \"stages\": [...],  # From template     \"input_schema\": {...},  # From template     \"budget_limits\": {...},  # From template     \"display_config\": {...}  # From template (optional)   }\' ```  **Response includes:** - All retriever configuration fields - Display config for publishing (optional to use) - Source reference (where this template came from)
+     * @summary Get Public Retriever Template
+     * @param {string} publicName Public name of the published retriever
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getRetrieverTemplateName(publicName: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PublicRetrieverTemplateResponse>>;
+    /**
+     * List all public retrievers with pagination and search.  This endpoint allows browsing and discovering all published retrievers across all organizations. No authentication required.  **Authentication:** - NO authentication required - completely public endpoint - Discover retrievers created by all Mixpeek users  **Pagination:** - Default: page=1, page_size=20 - Maximum page_size: 100 - Returns total count and total pages  **Search:** - Search across retriever titles and descriptions - Case-insensitive regex matching - Combine with pagination  **Filtering:** - By default, only active retrievers are shown - Set `include_inactive=true` to see all retrievers  **Response includes:** - List of public retrievers with basic info - Pagination details (page, page_size, total_count, total_pages) - Aggregate statistics (total active, password protected, open)  **What\'s NOT exposed:** - API keys (except in individual config endpoint) - Internal IDs or organization details - Full retriever configuration (use template endpoint for that) - Password values (only password_protected: true/false)  **Example:** ```bash # List all public retrievers (first page) curl -X GET \"https://api.mixpeek.com/v1/public/retrievers/\"  # Search for video-related retrievers curl -X GET \"https://api.mixpeek.com/v1/public/retrievers/?search=video&page_size=50\"  # Get page 2 with custom page size curl -X GET \"https://api.mixpeek.com/v1/public/retrievers/?page=2&page_size=50\" ```  **Use Cases:** - Browse available public retrievers - Discover search patterns and implementations - Find retrievers to use as templates - Explore what others have built
+     * @summary List Public Retrievers
+     * @param {number} [page] Page number (1-indexed)
+     * @param {number} [pageSize] Results per page
+     * @param {boolean} [includeInactive] Include inactive retrievers in results
+     * @param {string} [search] Search query for filtering by title or description
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listRetrievers(page?: number, pageSize?: number, includeInactive?: boolean, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListPublicRetrieversResponse>>;
+    /**
+     * Track multiple interactions in a single request (batching).  More efficient than sending individual interaction requests. Use this for batching viewport visibility, bulk actions, etc.  **Authentication:** - API key is OPTIONAL (same as execute endpoint) - Password NOT required (tracking should work even without auth)  **Recommended Headers:** - `X-Session-ID`: Applied to all interactions in the batch  **Limits:** - Maximum 100 interactions per batch  **Example:** ```bash curl -X POST \"https://api.mixpeek.com/v1/public/retrievers/video-search/interactions/batch\" \\   -H \"X-Session-ID: sess_xyz...\" \\   -H \"Content-Type: application/json\" \\   -d \'{     \"interactions\": [       {         \"document_id\": \"doc_123\",         \"interaction_type\": [\"VIEW\"],         \"position\": 0,         \"execution_id\": \"exec_abc\"       },       {         \"document_id\": \"doc_456\",         \"interaction_type\": [\"VIEW\"],         \"position\": 1,         \"execution_id\": \"exec_abc\"       }     ]   }\' ```
+     * @summary Track Interaction Batch
+     * @param {string} publicName Public name of the published retriever
+     * @param {PublicInteractionBatchRequest} publicInteractionBatchRequest
+     * @param {string} [xSessionID]
+     * @param {string} [xPublicAPIKey]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    trackInteractionBatchRetrieversName(publicName: string, publicInteractionBatchRequest: PublicInteractionBatchRequest, xSessionID?: string, xPublicAPIKey?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
+    /**
+     * Track user interaction with search results.  Records user engagement (clicks, views, etc.) for analytics and potential search optimization (Learning to Rank).  **Authentication:** - API key is OPTIONAL (same as execute endpoint) - Password NOT required (tracking should work even without auth)  **Recommended Headers:** - `X-Session-ID`: Session identifier for tracking user journey  **Interaction Types:** - `VIEW`: Result was visible in viewport - `CLICK`: User clicked on result - `POSITIVE_FEEDBACK`: User explicitly liked result - `NEGATIVE_FEEDBACK`: User explicitly disliked result - `PURCHASE`: User purchased/converted - `ADD_TO_CART`: User added to cart - `WISHLIST`: User added to wishlist - `LONG_VIEW`: User spent significant time viewing - `SHARE`: User shared result - `BOOKMARK`: User bookmarked result  **Example:** ```bash curl -X POST \"https://api.mixpeek.com/v1/public/retrievers/video-search/interactions\" \\   -H \"X-Session-ID: sess_xyz...\" \\   -H \"Content-Type: application/json\" \\   -d \'{     \"document_id\": \"doc_123\",     \"interaction_type\": [\"CLICK\"],     \"position\": 2,     \"execution_id\": \"exec_abc\",     \"query_snapshot\": {\"query\": \"red car\"}   }\' ```
+     * @summary Track Interaction
+     * @param {string} publicName Public name of the published retriever
+     * @param {PublicInteractionRequest} publicInteractionRequest
+     * @param {string} [xSessionID]
+     * @param {string} [xPublicAPIKey]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    trackInteractionRetrieversName(publicName: string, publicInteractionRequest: PublicInteractionRequest, xSessionID?: string, xPublicAPIKey?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
+    /**
+     * Verify password for a password-protected retriever.  Allows the frontend to check if a password is valid before attempting to execute a password-protected retriever. Returns the public API key if the password is valid.  **Authentication:** - NO authentication required - this endpoint is public - The password is verified against the retriever\'s configured password  **Use Case:** 1. Frontend detects that a retriever is password-protected (from /config endpoint) 2. User enters password in the UI 3. Frontend calls this endpoint to verify the password 4. If valid, frontend receives the public_api_key to use for subsequent requests  **Response:** - `valid`: Whether the password is correct - `public_api_key`: The API key to use for execute/interact endpoints (only if valid)  **Example:** ```bash curl -X POST \"https://api.mixpeek.com/v1/public/retrievers/private-search/verify\" \\   -H \"Content-Type: application/json\" \\   -d \'{\"password\": \"secret123\"}\' ```  **Response if valid:** ```json {   \"valid\": true,   \"public_api_key\": \"prk_abc123...\" } ```  **Response if invalid:** ```json {   \"valid\": false,   \"public_api_key\": null } ```
+     * @summary Verify Password
+     * @param {string} publicName Public name of the published retriever
+     * @param {VerifyPasswordRequest} verifyPasswordRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    verifyPasswordRetrieversName(publicName: string, verifyPasswordRequest: VerifyPasswordRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VerifyPasswordResponse>>;
+};
+/**
+ * PublicRetrieverAPIApi - factory interface
+ * @export
+ */
+export declare const PublicRetrieverAPIApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * Execute a published retriever (public endpoint).  **Authentication:** - API key is OPTIONAL for public retrievers - Supports: no key, prk_ keys (deprecated), or ret_sk_ keys - If password-protected, requires `X-Retriever-Password` header  **Rate Limiting:** - Subject to per-retriever rate limits (per minute/hour/day) - May also have IP-based rate limits  **Response:** - Only returns fields specified in `exposed_fields` configuration - Internal metadata is stripped from results - Includes `execution_id` for interaction tracking - Presigned URLs returned by default (return_presigned_urls=true) for media rendering  **Example (no API key - recommended for public access):** ```bash curl -X POST \"https://api.mixpeek.com/v1/public/retrievers/video-search/execute\" \\   -H \"Content-Type: application/json\" \\   -d \'{     \"inputs\": {\"query\": \"red car\"},     \"pagination\": {\"method\": \"offset\", \"page_number\": 1, \"page_size\": 10}   }\' ```  **Example with ret_sk_ key (for SDK/programmatic access):** ```bash curl -X POST \"https://api.mixpeek.com/v1/public/retrievers/video-search/execute\" \\   -H \"X-Public-API-Key: ret_sk_abc123...\" \\   -H \"Content-Type: application/json\" \\   -d \'{     \"inputs\": {\"query\": \"red car\"},     \"pagination\": {\"method\": \"offset\", \"page_number\": 1, \"page_size\": 10}   }\' ```
+     * @summary Execute Public Retriever
+     * @param {PublicRetrieverAPIApiExecuteRetrieverNameRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    executeRetrieverName(requestParameters: PublicRetrieverAPIApiExecuteRetrieverNameRequest, options?: RawAxiosRequestConfig): AxiosPromise<any>;
+    /**
+     * Get display configuration for public page rendering.  ⚠️ **DEPRECATED**: Use `/v1/marketplace/catalog/{public_name}/config` instead. This endpoint is maintained for backwards compatibility but may be removed in the future.  Returns the UI configuration needed to render the public search interface. Used by the frontend app at mxp.co to dynamically build the UI.  **Authentication:** - NO authentication required - this endpoint is public - Anyone can access the config if they know the public_name - The config includes the public_api_key needed for execute/interact endpoints  **Response includes:** - Display config (logo, theme, components, field rendering) - Title and description - Password protection status - Public API key for subsequent authenticated requests  **Example (deprecated):** ```bash curl -X GET \"https://api.mixpeek.com/v1/public/retrievers/video-search/config\" ```  **Example (recommended):** ```bash curl -X GET \"https://api.mixpeek.com/v1/marketplace/catalog/video-search/config\" ```
+     * @summary Get Public Retriever Config
+     * @param {PublicRetrieverAPIApiGetRetrieverConfigNameRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getRetrieverConfigName(requestParameters: PublicRetrieverAPIApiGetRetrieverConfigNameRequest, options?: RawAxiosRequestConfig): AxiosPromise<PublicRetrieverConfigResponse>;
+    /**
+     * Get retriever configuration as a reusable template.  Returns the published retriever\'s configuration in a format that can be directly used to create your own retriever. This is perfect for discovering patterns and adapting them to your own data.  **Authentication:** - NO authentication required - this endpoint is completely public - Anyone can get the template if they know the public_name  **Use Case:** 1. Browse public retrievers to find patterns you like 2. GET this endpoint to get the full configuration 3. Copy the config and modify for your needs (especially `collection_identifiers`) 4. POST to `/v1/retrievers` to create your own retriever 5. Optionally publish it with the same display_config  **What\'s included:** - Retriever configuration (stages, input_schema, budget_limits) - Display configuration (for publishing with similar UI) - Original metadata for reference  **What you need to change:** - `collection_identifiers`: Replace with your own collection IDs - `retriever_name`: Give it a unique name - Optionally modify stages, inputs, display_config as needed  **Example:** ```bash # 1. Get the template curl -X GET \"https://api.mixpeek.com/v1/public/retrievers/video-search/template\"  # 2. Modify the response and create your own retriever curl -X POST \"https://api.mixpeek.com/v1/retrievers\" \\   -H \"Authorization: Bearer YOUR_API_KEY\" \\   -H \"Content-Type: application/json\" \\   -d \'{     \"retriever_name\": \"my_video_search\",     \"collection_identifiers\": [\"my_videos\"],     \"stages\": [...],  # From template     \"input_schema\": {...},  # From template     \"budget_limits\": {...},  # From template     \"display_config\": {...}  # From template (optional)   }\' ```  **Response includes:** - All retriever configuration fields - Display config for publishing (optional to use) - Source reference (where this template came from)
+     * @summary Get Public Retriever Template
+     * @param {PublicRetrieverAPIApiGetRetrieverTemplateNameRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getRetrieverTemplateName(requestParameters: PublicRetrieverAPIApiGetRetrieverTemplateNameRequest, options?: RawAxiosRequestConfig): AxiosPromise<PublicRetrieverTemplateResponse>;
+    /**
+     * List all public retrievers with pagination and search.  This endpoint allows browsing and discovering all published retrievers across all organizations. No authentication required.  **Authentication:** - NO authentication required - completely public endpoint - Discover retrievers created by all Mixpeek users  **Pagination:** - Default: page=1, page_size=20 - Maximum page_size: 100 - Returns total count and total pages  **Search:** - Search across retriever titles and descriptions - Case-insensitive regex matching - Combine with pagination  **Filtering:** - By default, only active retrievers are shown - Set `include_inactive=true` to see all retrievers  **Response includes:** - List of public retrievers with basic info - Pagination details (page, page_size, total_count, total_pages) - Aggregate statistics (total active, password protected, open)  **What\'s NOT exposed:** - API keys (except in individual config endpoint) - Internal IDs or organization details - Full retriever configuration (use template endpoint for that) - Password values (only password_protected: true/false)  **Example:** ```bash # List all public retrievers (first page) curl -X GET \"https://api.mixpeek.com/v1/public/retrievers/\"  # Search for video-related retrievers curl -X GET \"https://api.mixpeek.com/v1/public/retrievers/?search=video&page_size=50\"  # Get page 2 with custom page size curl -X GET \"https://api.mixpeek.com/v1/public/retrievers/?page=2&page_size=50\" ```  **Use Cases:** - Browse available public retrievers - Discover search patterns and implementations - Find retrievers to use as templates - Explore what others have built
+     * @summary List Public Retrievers
+     * @param {PublicRetrieverAPIApiListRetrieversRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listRetrievers(requestParameters?: PublicRetrieverAPIApiListRetrieversRequest, options?: RawAxiosRequestConfig): AxiosPromise<ListPublicRetrieversResponse>;
+    /**
+     * Track multiple interactions in a single request (batching).  More efficient than sending individual interaction requests. Use this for batching viewport visibility, bulk actions, etc.  **Authentication:** - API key is OPTIONAL (same as execute endpoint) - Password NOT required (tracking should work even without auth)  **Recommended Headers:** - `X-Session-ID`: Applied to all interactions in the batch  **Limits:** - Maximum 100 interactions per batch  **Example:** ```bash curl -X POST \"https://api.mixpeek.com/v1/public/retrievers/video-search/interactions/batch\" \\   -H \"X-Session-ID: sess_xyz...\" \\   -H \"Content-Type: application/json\" \\   -d \'{     \"interactions\": [       {         \"document_id\": \"doc_123\",         \"interaction_type\": [\"VIEW\"],         \"position\": 0,         \"execution_id\": \"exec_abc\"       },       {         \"document_id\": \"doc_456\",         \"interaction_type\": [\"VIEW\"],         \"position\": 1,         \"execution_id\": \"exec_abc\"       }     ]   }\' ```
+     * @summary Track Interaction Batch
+     * @param {PublicRetrieverAPIApiTrackInteractionBatchRetrieversNameRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    trackInteractionBatchRetrieversName(requestParameters: PublicRetrieverAPIApiTrackInteractionBatchRetrieversNameRequest, options?: RawAxiosRequestConfig): AxiosPromise<any>;
+    /**
+     * Track user interaction with search results.  Records user engagement (clicks, views, etc.) for analytics and potential search optimization (Learning to Rank).  **Authentication:** - API key is OPTIONAL (same as execute endpoint) - Password NOT required (tracking should work even without auth)  **Recommended Headers:** - `X-Session-ID`: Session identifier for tracking user journey  **Interaction Types:** - `VIEW`: Result was visible in viewport - `CLICK`: User clicked on result - `POSITIVE_FEEDBACK`: User explicitly liked result - `NEGATIVE_FEEDBACK`: User explicitly disliked result - `PURCHASE`: User purchased/converted - `ADD_TO_CART`: User added to cart - `WISHLIST`: User added to wishlist - `LONG_VIEW`: User spent significant time viewing - `SHARE`: User shared result - `BOOKMARK`: User bookmarked result  **Example:** ```bash curl -X POST \"https://api.mixpeek.com/v1/public/retrievers/video-search/interactions\" \\   -H \"X-Session-ID: sess_xyz...\" \\   -H \"Content-Type: application/json\" \\   -d \'{     \"document_id\": \"doc_123\",     \"interaction_type\": [\"CLICK\"],     \"position\": 2,     \"execution_id\": \"exec_abc\",     \"query_snapshot\": {\"query\": \"red car\"}   }\' ```
+     * @summary Track Interaction
+     * @param {PublicRetrieverAPIApiTrackInteractionRetrieversNameRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    trackInteractionRetrieversName(requestParameters: PublicRetrieverAPIApiTrackInteractionRetrieversNameRequest, options?: RawAxiosRequestConfig): AxiosPromise<any>;
+    /**
+     * Verify password for a password-protected retriever.  Allows the frontend to check if a password is valid before attempting to execute a password-protected retriever. Returns the public API key if the password is valid.  **Authentication:** - NO authentication required - this endpoint is public - The password is verified against the retriever\'s configured password  **Use Case:** 1. Frontend detects that a retriever is password-protected (from /config endpoint) 2. User enters password in the UI 3. Frontend calls this endpoint to verify the password 4. If valid, frontend receives the public_api_key to use for subsequent requests  **Response:** - `valid`: Whether the password is correct - `public_api_key`: The API key to use for execute/interact endpoints (only if valid)  **Example:** ```bash curl -X POST \"https://api.mixpeek.com/v1/public/retrievers/private-search/verify\" \\   -H \"Content-Type: application/json\" \\   -d \'{\"password\": \"secret123\"}\' ```  **Response if valid:** ```json {   \"valid\": true,   \"public_api_key\": \"prk_abc123...\" } ```  **Response if invalid:** ```json {   \"valid\": false,   \"public_api_key\": null } ```
+     * @summary Verify Password
+     * @param {PublicRetrieverAPIApiVerifyPasswordRetrieversNameRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    verifyPasswordRetrieversName(requestParameters: PublicRetrieverAPIApiVerifyPasswordRetrieversNameRequest, options?: RawAxiosRequestConfig): AxiosPromise<VerifyPasswordResponse>;
+};
+/**
+ * Request parameters for executeRetrieverName operation in PublicRetrieverAPIApi.
+ * @export
+ * @interface PublicRetrieverAPIApiExecuteRetrieverNameRequest
+ */
+export interface PublicRetrieverAPIApiExecuteRetrieverNameRequest {
+    /**
+     * Public name of the published retriever
+     * @type {string}
+     * @memberof PublicRetrieverAPIApiExecuteRetrieverName
+     */
+    readonly publicName: string;
+    /**
+     *
+     * @type {RetrieverExecutionRequest}
+     * @memberof PublicRetrieverAPIApiExecuteRetrieverName
+     */
+    readonly retrieverExecutionRequest: RetrieverExecutionRequest;
+    /**
+     * Generate fresh presigned download URLs for all blobs with S3 storage. Default: True for public retrievers to enable media rendering. Set to False if you only need metadata without URLs.
+     * @type {boolean}
+     * @memberof PublicRetrieverAPIApiExecuteRetrieverName
+     */
+    readonly returnPresignedUrls?: boolean;
+    /**
+     *
+     * @type {string}
+     * @memberof PublicRetrieverAPIApiExecuteRetrieverName
+     */
+    readonly xPublicAPIKey?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof PublicRetrieverAPIApiExecuteRetrieverName
+     */
+    readonly xRetrieverPassword?: string;
+}
+/**
+ * Request parameters for getRetrieverConfigName operation in PublicRetrieverAPIApi.
+ * @export
+ * @interface PublicRetrieverAPIApiGetRetrieverConfigNameRequest
+ */
+export interface PublicRetrieverAPIApiGetRetrieverConfigNameRequest {
+    /**
+     * Public name of the published retriever
+     * @type {string}
+     * @memberof PublicRetrieverAPIApiGetRetrieverConfigName
+     */
+    readonly publicName: string;
+}
+/**
+ * Request parameters for getRetrieverTemplateName operation in PublicRetrieverAPIApi.
+ * @export
+ * @interface PublicRetrieverAPIApiGetRetrieverTemplateNameRequest
+ */
+export interface PublicRetrieverAPIApiGetRetrieverTemplateNameRequest {
+    /**
+     * Public name of the published retriever
+     * @type {string}
+     * @memberof PublicRetrieverAPIApiGetRetrieverTemplateName
+     */
+    readonly publicName: string;
+}
+/**
+ * Request parameters for listRetrievers operation in PublicRetrieverAPIApi.
+ * @export
+ * @interface PublicRetrieverAPIApiListRetrieversRequest
+ */
+export interface PublicRetrieverAPIApiListRetrieversRequest {
+    /**
+     * Page number (1-indexed)
+     * @type {number}
+     * @memberof PublicRetrieverAPIApiListRetrievers
+     */
+    readonly page?: number;
+    /**
+     * Results per page
+     * @type {number}
+     * @memberof PublicRetrieverAPIApiListRetrievers
+     */
+    readonly pageSize?: number;
+    /**
+     * Include inactive retrievers in results
+     * @type {boolean}
+     * @memberof PublicRetrieverAPIApiListRetrievers
+     */
+    readonly includeInactive?: boolean;
+    /**
+     * Search query for filtering by title or description
+     * @type {string}
+     * @memberof PublicRetrieverAPIApiListRetrievers
+     */
+    readonly search?: string;
+}
+/**
+ * Request parameters for trackInteractionBatchRetrieversName operation in PublicRetrieverAPIApi.
+ * @export
+ * @interface PublicRetrieverAPIApiTrackInteractionBatchRetrieversNameRequest
+ */
+export interface PublicRetrieverAPIApiTrackInteractionBatchRetrieversNameRequest {
+    /**
+     * Public name of the published retriever
+     * @type {string}
+     * @memberof PublicRetrieverAPIApiTrackInteractionBatchRetrieversName
+     */
+    readonly publicName: string;
+    /**
+     *
+     * @type {PublicInteractionBatchRequest}
+     * @memberof PublicRetrieverAPIApiTrackInteractionBatchRetrieversName
+     */
+    readonly publicInteractionBatchRequest: PublicInteractionBatchRequest;
+    /**
+     *
+     * @type {string}
+     * @memberof PublicRetrieverAPIApiTrackInteractionBatchRetrieversName
+     */
+    readonly xSessionID?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof PublicRetrieverAPIApiTrackInteractionBatchRetrieversName
+     */
+    readonly xPublicAPIKey?: string;
+}
+/**
+ * Request parameters for trackInteractionRetrieversName operation in PublicRetrieverAPIApi.
+ * @export
+ * @interface PublicRetrieverAPIApiTrackInteractionRetrieversNameRequest
+ */
+export interface PublicRetrieverAPIApiTrackInteractionRetrieversNameRequest {
+    /**
+     * Public name of the published retriever
+     * @type {string}
+     * @memberof PublicRetrieverAPIApiTrackInteractionRetrieversName
+     */
+    readonly publicName: string;
+    /**
+     *
+     * @type {PublicInteractionRequest}
+     * @memberof PublicRetrieverAPIApiTrackInteractionRetrieversName
+     */
+    readonly publicInteractionRequest: PublicInteractionRequest;
+    /**
+     *
+     * @type {string}
+     * @memberof PublicRetrieverAPIApiTrackInteractionRetrieversName
+     */
+    readonly xSessionID?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof PublicRetrieverAPIApiTrackInteractionRetrieversName
+     */
+    readonly xPublicAPIKey?: string;
+}
+/**
+ * Request parameters for verifyPasswordRetrieversName operation in PublicRetrieverAPIApi.
+ * @export
+ * @interface PublicRetrieverAPIApiVerifyPasswordRetrieversNameRequest
+ */
+export interface PublicRetrieverAPIApiVerifyPasswordRetrieversNameRequest {
+    /**
+     * Public name of the published retriever
+     * @type {string}
+     * @memberof PublicRetrieverAPIApiVerifyPasswordRetrieversName
+     */
+    readonly publicName: string;
+    /**
+     *
+     * @type {VerifyPasswordRequest}
+     * @memberof PublicRetrieverAPIApiVerifyPasswordRetrieversName
+     */
+    readonly verifyPasswordRequest: VerifyPasswordRequest;
+}
+/**
+ * PublicRetrieverAPIApi - object-oriented interface
+ * @export
+ * @class PublicRetrieverAPIApi
+ * @extends {BaseAPI}
+ */
+export declare class PublicRetrieverAPIApi extends BaseAPI {
+    /**
+     * Execute a published retriever (public endpoint).  **Authentication:** - API key is OPTIONAL for public retrievers - Supports: no key, prk_ keys (deprecated), or ret_sk_ keys - If password-protected, requires `X-Retriever-Password` header  **Rate Limiting:** - Subject to per-retriever rate limits (per minute/hour/day) - May also have IP-based rate limits  **Response:** - Only returns fields specified in `exposed_fields` configuration - Internal metadata is stripped from results - Includes `execution_id` for interaction tracking - Presigned URLs returned by default (return_presigned_urls=true) for media rendering  **Example (no API key - recommended for public access):** ```bash curl -X POST \"https://api.mixpeek.com/v1/public/retrievers/video-search/execute\" \\   -H \"Content-Type: application/json\" \\   -d \'{     \"inputs\": {\"query\": \"red car\"},     \"pagination\": {\"method\": \"offset\", \"page_number\": 1, \"page_size\": 10}   }\' ```  **Example with ret_sk_ key (for SDK/programmatic access):** ```bash curl -X POST \"https://api.mixpeek.com/v1/public/retrievers/video-search/execute\" \\   -H \"X-Public-API-Key: ret_sk_abc123...\" \\   -H \"Content-Type: application/json\" \\   -d \'{     \"inputs\": {\"query\": \"red car\"},     \"pagination\": {\"method\": \"offset\", \"page_number\": 1, \"page_size\": 10}   }\' ```
+     * @summary Execute Public Retriever
+     * @param {PublicRetrieverAPIApiExecuteRetrieverNameRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PublicRetrieverAPIApi
+     */
+    executeRetrieverName(requestParameters: PublicRetrieverAPIApiExecuteRetrieverNameRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<any, any, {}>>;
+    /**
+     * Get display configuration for public page rendering.  ⚠️ **DEPRECATED**: Use `/v1/marketplace/catalog/{public_name}/config` instead. This endpoint is maintained for backwards compatibility but may be removed in the future.  Returns the UI configuration needed to render the public search interface. Used by the frontend app at mxp.co to dynamically build the UI.  **Authentication:** - NO authentication required - this endpoint is public - Anyone can access the config if they know the public_name - The config includes the public_api_key needed for execute/interact endpoints  **Response includes:** - Display config (logo, theme, components, field rendering) - Title and description - Password protection status - Public API key for subsequent authenticated requests  **Example (deprecated):** ```bash curl -X GET \"https://api.mixpeek.com/v1/public/retrievers/video-search/config\" ```  **Example (recommended):** ```bash curl -X GET \"https://api.mixpeek.com/v1/marketplace/catalog/video-search/config\" ```
+     * @summary Get Public Retriever Config
+     * @param {PublicRetrieverAPIApiGetRetrieverConfigNameRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PublicRetrieverAPIApi
+     */
+    getRetrieverConfigName(requestParameters: PublicRetrieverAPIApiGetRetrieverConfigNameRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PublicRetrieverConfigResponse, any, {}>>;
+    /**
+     * Get retriever configuration as a reusable template.  Returns the published retriever\'s configuration in a format that can be directly used to create your own retriever. This is perfect for discovering patterns and adapting them to your own data.  **Authentication:** - NO authentication required - this endpoint is completely public - Anyone can get the template if they know the public_name  **Use Case:** 1. Browse public retrievers to find patterns you like 2. GET this endpoint to get the full configuration 3. Copy the config and modify for your needs (especially `collection_identifiers`) 4. POST to `/v1/retrievers` to create your own retriever 5. Optionally publish it with the same display_config  **What\'s included:** - Retriever configuration (stages, input_schema, budget_limits) - Display configuration (for publishing with similar UI) - Original metadata for reference  **What you need to change:** - `collection_identifiers`: Replace with your own collection IDs - `retriever_name`: Give it a unique name - Optionally modify stages, inputs, display_config as needed  **Example:** ```bash # 1. Get the template curl -X GET \"https://api.mixpeek.com/v1/public/retrievers/video-search/template\"  # 2. Modify the response and create your own retriever curl -X POST \"https://api.mixpeek.com/v1/retrievers\" \\   -H \"Authorization: Bearer YOUR_API_KEY\" \\   -H \"Content-Type: application/json\" \\   -d \'{     \"retriever_name\": \"my_video_search\",     \"collection_identifiers\": [\"my_videos\"],     \"stages\": [...],  # From template     \"input_schema\": {...},  # From template     \"budget_limits\": {...},  # From template     \"display_config\": {...}  # From template (optional)   }\' ```  **Response includes:** - All retriever configuration fields - Display config for publishing (optional to use) - Source reference (where this template came from)
+     * @summary Get Public Retriever Template
+     * @param {PublicRetrieverAPIApiGetRetrieverTemplateNameRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PublicRetrieverAPIApi
+     */
+    getRetrieverTemplateName(requestParameters: PublicRetrieverAPIApiGetRetrieverTemplateNameRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PublicRetrieverTemplateResponse, any, {}>>;
+    /**
+     * List all public retrievers with pagination and search.  This endpoint allows browsing and discovering all published retrievers across all organizations. No authentication required.  **Authentication:** - NO authentication required - completely public endpoint - Discover retrievers created by all Mixpeek users  **Pagination:** - Default: page=1, page_size=20 - Maximum page_size: 100 - Returns total count and total pages  **Search:** - Search across retriever titles and descriptions - Case-insensitive regex matching - Combine with pagination  **Filtering:** - By default, only active retrievers are shown - Set `include_inactive=true` to see all retrievers  **Response includes:** - List of public retrievers with basic info - Pagination details (page, page_size, total_count, total_pages) - Aggregate statistics (total active, password protected, open)  **What\'s NOT exposed:** - API keys (except in individual config endpoint) - Internal IDs or organization details - Full retriever configuration (use template endpoint for that) - Password values (only password_protected: true/false)  **Example:** ```bash # List all public retrievers (first page) curl -X GET \"https://api.mixpeek.com/v1/public/retrievers/\"  # Search for video-related retrievers curl -X GET \"https://api.mixpeek.com/v1/public/retrievers/?search=video&page_size=50\"  # Get page 2 with custom page size curl -X GET \"https://api.mixpeek.com/v1/public/retrievers/?page=2&page_size=50\" ```  **Use Cases:** - Browse available public retrievers - Discover search patterns and implementations - Find retrievers to use as templates - Explore what others have built
+     * @summary List Public Retrievers
+     * @param {PublicRetrieverAPIApiListRetrieversRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PublicRetrieverAPIApi
+     */
+    listRetrievers(requestParameters?: PublicRetrieverAPIApiListRetrieversRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListPublicRetrieversResponse, any, {}>>;
+    /**
+     * Track multiple interactions in a single request (batching).  More efficient than sending individual interaction requests. Use this for batching viewport visibility, bulk actions, etc.  **Authentication:** - API key is OPTIONAL (same as execute endpoint) - Password NOT required (tracking should work even without auth)  **Recommended Headers:** - `X-Session-ID`: Applied to all interactions in the batch  **Limits:** - Maximum 100 interactions per batch  **Example:** ```bash curl -X POST \"https://api.mixpeek.com/v1/public/retrievers/video-search/interactions/batch\" \\   -H \"X-Session-ID: sess_xyz...\" \\   -H \"Content-Type: application/json\" \\   -d \'{     \"interactions\": [       {         \"document_id\": \"doc_123\",         \"interaction_type\": [\"VIEW\"],         \"position\": 0,         \"execution_id\": \"exec_abc\"       },       {         \"document_id\": \"doc_456\",         \"interaction_type\": [\"VIEW\"],         \"position\": 1,         \"execution_id\": \"exec_abc\"       }     ]   }\' ```
+     * @summary Track Interaction Batch
+     * @param {PublicRetrieverAPIApiTrackInteractionBatchRetrieversNameRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PublicRetrieverAPIApi
+     */
+    trackInteractionBatchRetrieversName(requestParameters: PublicRetrieverAPIApiTrackInteractionBatchRetrieversNameRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<any, any, {}>>;
+    /**
+     * Track user interaction with search results.  Records user engagement (clicks, views, etc.) for analytics and potential search optimization (Learning to Rank).  **Authentication:** - API key is OPTIONAL (same as execute endpoint) - Password NOT required (tracking should work even without auth)  **Recommended Headers:** - `X-Session-ID`: Session identifier for tracking user journey  **Interaction Types:** - `VIEW`: Result was visible in viewport - `CLICK`: User clicked on result - `POSITIVE_FEEDBACK`: User explicitly liked result - `NEGATIVE_FEEDBACK`: User explicitly disliked result - `PURCHASE`: User purchased/converted - `ADD_TO_CART`: User added to cart - `WISHLIST`: User added to wishlist - `LONG_VIEW`: User spent significant time viewing - `SHARE`: User shared result - `BOOKMARK`: User bookmarked result  **Example:** ```bash curl -X POST \"https://api.mixpeek.com/v1/public/retrievers/video-search/interactions\" \\   -H \"X-Session-ID: sess_xyz...\" \\   -H \"Content-Type: application/json\" \\   -d \'{     \"document_id\": \"doc_123\",     \"interaction_type\": [\"CLICK\"],     \"position\": 2,     \"execution_id\": \"exec_abc\",     \"query_snapshot\": {\"query\": \"red car\"}   }\' ```
+     * @summary Track Interaction
+     * @param {PublicRetrieverAPIApiTrackInteractionRetrieversNameRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PublicRetrieverAPIApi
+     */
+    trackInteractionRetrieversName(requestParameters: PublicRetrieverAPIApiTrackInteractionRetrieversNameRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<any, any, {}>>;
+    /**
+     * Verify password for a password-protected retriever.  Allows the frontend to check if a password is valid before attempting to execute a password-protected retriever. Returns the public API key if the password is valid.  **Authentication:** - NO authentication required - this endpoint is public - The password is verified against the retriever\'s configured password  **Use Case:** 1. Frontend detects that a retriever is password-protected (from /config endpoint) 2. User enters password in the UI 3. Frontend calls this endpoint to verify the password 4. If valid, frontend receives the public_api_key to use for subsequent requests  **Response:** - `valid`: Whether the password is correct - `public_api_key`: The API key to use for execute/interact endpoints (only if valid)  **Example:** ```bash curl -X POST \"https://api.mixpeek.com/v1/public/retrievers/private-search/verify\" \\   -H \"Content-Type: application/json\" \\   -d \'{\"password\": \"secret123\"}\' ```  **Response if valid:** ```json {   \"valid\": true,   \"public_api_key\": \"prk_abc123...\" } ```  **Response if invalid:** ```json {   \"valid\": false,   \"public_api_key\": null } ```
+     * @summary Verify Password
+     * @param {PublicRetrieverAPIApiVerifyPasswordRetrieversNameRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PublicRetrieverAPIApi
+     */
+    verifyPasswordRetrieversName(requestParameters: PublicRetrieverAPIApiVerifyPasswordRetrieversNameRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<VerifyPasswordResponse, any, {}>>;
+}
+//# sourceMappingURL=public-retriever-apiapi.d.ts.map

package/dist/api/public-retriever-apiapi.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"public-retriever-apiapi.d.ts","sourceRoot":"","sources":["../../api/public-retriever-apiapi.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;GAUG;AAGH,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AACtD,OAAO,KAAK,EAAE,YAAY,EAAE,aAAa,EAAE,qBAAqB,EAAE,MAAM,OAAO,CAAC;AAMhF,OAAO,EAAiC,KAAK,WAAW,EAAE,OAAO,EAAqC,MAAM,SAAS,CAAC;AAMtH,OAAO,KAAK,EAAE,4BAA4B,EAAE,MAAM,WAAW,CAAC;AAE9D,OAAO,KAAK,EAAE,6BAA6B,EAAE,MAAM,WAAW,CAAC;AAE/D,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,WAAW,CAAC;AAE1D,OAAO,KAAK,EAAE,6BAA6B,EAAE,MAAM,WAAW,CAAC;AAE/D,OAAO,KAAK,EAAE,+BAA+B,EAAE,MAAM,WAAW,CAAC;AAEjE,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,WAAW,CAAC;AAE3D,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,WAAW,CAAC;AAEvD,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,WAAW,CAAC;AACxD;;;GAGG;AACH,eAAO,MAAM,sCAAsC,GAAa,gBAAgB,aAAa;IAErF;;;;;;;;;;OAUG;uCACsC,MAAM,6BAA6B,yBAAyB,wBAAwB,OAAO,kBAAkB,MAAM,uBAAuB,MAAM,YAAW,qBAAqB,KAAQ,OAAO,CAAC,WAAW,CAAC;IA0CrP;;;;;;OAMG;yCACwC,MAAM,YAAW,qBAAqB,KAAQ,OAAO,CAAC,WAAW,CAAC;IA2B7G;;;;;;OAMG;2CAC0C,MAAM,YAAW,qBAAqB,KAAQ,OAAO,CAAC,WAAW,CAAC;IA2B/G;;;;;;;;;OASG;4BAC2B,MAAM,aAAa,MAAM,oBAAoB,OAAO,WAAW,MAAM,YAAW,qBAAqB,KAAQ,OAAO,CAAC,WAAW,CAAC;IAwC/J;;;;;;;;;OASG;sDACqD,MAAM,iCAAiC,6BAA6B,eAAe,MAAM,kBAAkB,MAAM,YAAW,qBAAqB,KAAQ,OAAO,CAAC,WAAW,CAAC;IAsCrO;;;;;;;;;OASG;iDACgD,MAAM,4BAA4B,wBAAwB,eAAe,MAAM,kBAAkB,MAAM,YAAW,qBAAqB,KAAQ,OAAO,CAAC,WAAW,CAAC;IAsCtN;;;;;;;OAOG;+CAC8C,MAAM,yBAAyB,qBAAqB,YAAW,qBAAqB,KAAQ,OAAO,CAAC,WAAW,CAAC;CAiCxK,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,uBAAuB,GAAY,gBAAgB,aAAa;IAGrE;;;;;;;;;;OAUG;qCACoC,MAAM,6BAA6B,yBAAyB,wBAAwB,OAAO,kBAAkB,MAAM,uBAAuB,MAAM,YAAY,qBAAqB,GAAG,OAAO,CAAC,CAAC,KAAK,CAAC,EAAE,aAAa,EAAE,QAAQ,CAAC,EAAE,MAAM,KAAK,YAAY,CAAC,GAAG,CAAC,CAAC;IAMnS;;;;;;OAMG;uCACsC,MAAM,YAAY,qBAAqB,GAAG,OAAO,CAAC,CAAC,KAAK,CAAC,EAAE,aAAa,EAAE,QAAQ,CAAC,EAAE,MAAM,KAAK,YAAY,CAAC,6BAA6B,CAAC,CAAC;IAMrL;;;;;;OAMG;yCACwC,MAAM,YAAY,qBAAqB,GAAG,OAAO,CAAC,CAAC,KAAK,CAAC,EAAE,aAAa,EAAE,QAAQ,CAAC,EAAE,MAAM,KAAK,YAAY,CAAC,+BAA+B,CAAC,CAAC;IAMzL;;;;;;;;;OASG;0BACyB,MAAM,aAAa,MAAM,oBAAoB,OAAO,WAAW,MAAM,YAAY,qBAAqB,GAAG,OAAO,CAAC,CAAC,KAAK,CAAC,EAAE,aAAa,EAAE,QAAQ,CAAC,EAAE,MAAM,KAAK,YAAY,CAAC,4BAA4B,CAAC,CAAC;IAMtO;;;;;;;;;OASG;oDACmD,MAAM,iCAAiC,6BAA6B,eAAe,MAAM,kBAAkB,MAAM,YAAY,qBAAqB,GAAG,OAAO,CAAC,CAAC,KAAK,CAAC,EAAE,aAAa,EAAE,QAAQ,CAAC,EAAE,MAAM,KAAK,YAAY,CAAC,GAAG,CAAC,CAAC;IAMnR;;;;;;;;;OASG;+CAC8C,MAAM,4BAA4B,wBAAwB,eAAe,MAAM,kBAAkB,MAAM,YAAY,qBAAqB,GAAG,OAAO,CAAC,CAAC,KAAK,CAAC,EAAE,aAAa,EAAE,QAAQ,CAAC,EAAE,MAAM,KAAK,YAAY,CAAC,GAAG,CAAC,CAAC;IAMpQ;;;;;;;OAOG;6CAC4C,MAAM,yBAAyB,qBAAqB,YAAY,qBAAqB,GAAG,OAAO,CAAC,CAAC,KAAK,CAAC,EAAE,aAAa,EAAE,QAAQ,CAAC,EAAE,MAAM,KAAK,YAAY,CAAC,sBAAsB,CAAC,CAAC;CAOzO,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,4BAA4B,GAAa,gBAAgB,aAAa,EAAE,WAAW,MAAM,EAAE,QAAQ,aAAa;IAGrH;;;;;;OAMG;4CACqC,gDAAgD,YAAY,qBAAqB,GAAG,YAAY,CAAC,GAAG,CAAC;IAG7I;;;;;;OAMG;8CACuC,kDAAkD,YAAY,qBAAqB,GAAG,YAAY,CAAC,6BAA6B,CAAC;IAG3K;;;;;;OAMG;gDACyC,oDAAoD,YAAY,qBAAqB,GAAG,YAAY,CAAC,+BAA+B,CAAC;IAGjL;;;;;;OAMG;uCAC+B,0CAA0C,YAAiB,qBAAqB,GAAG,YAAY,CAAC,4BAA4B,CAAC;IAG/J;;;;;;OAMG;2DACoD,+DAA+D,YAAY,qBAAqB,GAAG,YAAY,CAAC,GAAG,CAAC;IAG3K;;;;;;OAMG;sDAC+C,0DAA0D,YAAY,qBAAqB,GAAG,YAAY,CAAC,GAAG,CAAC;IAGjK;;;;;;OAMG;oDAC6C,wDAAwD,YAAY,qBAAqB,GAAG,YAAY,CAAC,sBAAsB,CAAC;CAIvL,CAAC;AAEF;;;;GAIG;AACH,MAAM,WAAW,gDAAgD;IAC7D;;;;OAIG;IACH,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAA;IAE3B;;;;OAIG;IACH,QAAQ,CAAC,yBAAyB,EAAE,yBAAyB,CAAA;IAE7D;;;;OAIG;IACH,QAAQ,CAAC,mBAAmB,CAAC,EAAE,OAAO,CAAA;IAEtC;;;;OAIG;IACH,QAAQ,CAAC,aAAa,CAAC,EAAE,MAAM,CAAA;IAE/B;;;;OAIG;IACH,QAAQ,CAAC,kBAAkB,CAAC,EAAE,MAAM,CAAA;CACvC;AAED;;;;GAIG;AACH,MAAM,WAAW,kDAAkD;IAC/D;;;;OAIG;IACH,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAA;CAC9B;AAED;;;;GAIG;AACH,MAAM,WAAW,oDAAoD;IACjE;;;;OAIG;IACH,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAA;CAC9B;AAED;;;;GAIG;AACH,MAAM,WAAW,0CAA0C;IACvD;;;;OAIG;IACH,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAA;IAEtB;;;;OAIG;IACH,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAA;IAE1B;;;;OAIG;IACH,QAAQ,CAAC,eAAe,CAAC,EAAE,OAAO,CAAA;IAElC;;;;OAIG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAA;CAC3B;AAED;;;;GAIG;AACH,MAAM,WAAW,+DAA+D;IAC5E;;;;OAIG;IACH,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAA;IAE3B;;;;OAIG;IACH,QAAQ,CAAC,6BAA6B,EAAE,6BAA6B,CAAA;IAErE;;;;OAIG;IACH,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAA;IAE5B;;;;OAIG;IACH,QAAQ,CAAC,aAAa,CAAC,EAAE,MAAM,CAAA;CAClC;AAED;;;;GAIG;AACH,MAAM,WAAW,0DAA0D;IACvE;;;;OAIG;IACH,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAA;IAE3B;;;;OAIG;IACH,QAAQ,CAAC,wBAAwB,EAAE,wBAAwB,CAAA;IAE3D;;;;OAIG;IACH,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAA;IAE5B;;;;OAIG;IACH,QAAQ,CAAC,aAAa,CAAC,EAAE,MAAM,CAAA;CAClC;AAED;;;;GAIG;AACH,MAAM,WAAW,wDAAwD;IACrE;;;;OAIG;IACH,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAA;IAE3B;;;;OAIG;IACH,QAAQ,CAAC,qBAAqB,EAAE,qBAAqB,CAAA;CACxD;AAED;;;;;GAKG;AACH,qBAAa,qBAAsB,SAAQ,OAAO;IAC9C;;;;;;;OAOG;IACI,oBAAoB,CAAC,iBAAiB,EAAE,gDAAgD,EAAE,OAAO,CAAC,EAAE,qBAAqB;IAIhI;;;;;;;OAOG;IACI,sBAAsB,CAAC,iBAAiB,EAAE,kDAAkD,EAAE,OAAO,CAAC,EAAE,qBAAqB;IAIpI;;;;;;;OAOG;IACI,wBAAwB,CAAC,iBAAiB,EAAE,oDAAoD,EAAE,OAAO,CAAC,EAAE,qBAAqB;IAIxI;;;;;;;OAOG;IACI,cAAc,CAAC,iBAAiB,GAAE,0CAA+C,EAAE,OAAO,CAAC,EAAE,qBAAqB;IAIzH;;;;;;;OAOG;IACI,mCAAmC,CAAC,iBAAiB,EAAE,+DAA+D,EAAE,OAAO,CAAC,EAAE,qBAAqB;IAI9J;;;;;;;OAOG;IACI,8BAA8B,CAAC,iBAAiB,EAAE,0DAA0D,EAAE,OAAO,CAAC,EAAE,qBAAqB;IAIpJ;;;;;;;OAOG;IACI,4BAA4B,CAAC,iBAAiB,EAAE,wDAAwD,EAAE,OAAO,CAAC,EAAE,qBAAqB;CAGnJ"}