🤖 Auto-generate SDK v0.81.1

Author: github-actions[bot]

.openapi-generator/FILES

@@ -9,6 +9,8 @@ Name | Type | Description | Notes
 **key_id** | **str** | Public identifier for the API key. | [optional] 
 **key_hash** | **str** | SHA-256 hash of the plaintext key. | 
 **key_prefix** | **str** | Visible prefix of the API key for user identification (e.g., 'sk_abc123...'). Shows the first 10 characters of the plaintext key to help users identify which key is which in lists, without exposing the full secret. This follows industry best practices from GitHub, Stripe, and AWS. Generated automatically for new keys. Older keys may not have this field. | [optional] 
+**key_type** | [**APIKeyType**](APIKeyType.md) | Type of API key. STANDARD for regular organization keys, MARKETPLACE_SUBSCRIPTION for marketplace subscription access tokens. | [optional] 
+**subscription_id** | **str** | Marketplace subscription ID if this is a marketplace subscription key. Only set when key_type is MARKETPLACE_SUBSCRIPTION. | [optional] 
 **internal_id** | **str** | Organization internal identifier. | 
 **organization_id** | **str** | Organization public identifier (denormalized). | [optional] 
 **user_id** | **str** | Identifier of the user who owns the key. | 
@@ -24,6 +26,7 @@ Name | Type | Description | Notes
 **created_by** | **str** | User identifier that created the key. | [optional] 
 **revoked_at** | **datetime** | UTC timestamp when the key was revoked (if applicable). | [optional] 
 **revoked_by** | **str** | User identifier that revoked the key (if applicable). | [optional] 
+**allowed_origins** | **List[str]** | Optional list of allowed HTTP origins for this API key. When set, requests must include an Origin header matching one of these values. Supports exact matches (e.g., 'https://docs.example.com') and wildcard subdomains (e.g., 'https://*.example.com'). Only enforced for browser requests (defense-in-depth, not a security boundary). Null means no origin restriction. | [optional] 
 **key** | **str** |  | 
 
 ## Example

README.md

@@ -9,6 +9,8 @@ Name | Type | Description | Notes
 **key_id** | **str** | Public identifier for the API key. | [optional] 
 **key_hash** | **str** | SHA-256 hash of the plaintext key. | 
 **key_prefix** | **str** | Visible prefix of the API key for user identification (e.g., 'sk_abc123...'). Shows the first 10 characters of the plaintext key to help users identify which key is which in lists, without exposing the full secret. This follows industry best practices from GitHub, Stripe, and AWS. Generated automatically for new keys. Older keys may not have this field. | [optional] 
+**key_type** | [**APIKeyType**](APIKeyType.md) | Type of API key. STANDARD for regular organization keys, MARKETPLACE_SUBSCRIPTION for marketplace subscription access tokens. | [optional] 
+**subscription_id** | **str** | Marketplace subscription ID if this is a marketplace subscription key. Only set when key_type is MARKETPLACE_SUBSCRIPTION. | [optional] 
 **internal_id** | **str** | Organization internal identifier. | 
 **organization_id** | **str** | Organization public identifier (denormalized). | [optional] 
 **user_id** | **str** | Identifier of the user who owns the key. | 
@@ -24,6 +26,7 @@ Name | Type | Description | Notes
 **created_by** | **str** | User identifier that created the key. | [optional] 
 **revoked_at** | **datetime** | UTC timestamp when the key was revoked (if applicable). | [optional] 
 **revoked_by** | **str** | User identifier that revoked the key (if applicable). | [optional] 
+**allowed_origins** | **List[str]** | Optional list of allowed HTTP origins for this API key. When set, requests must include an Origin header matching one of these values. Supports exact matches (e.g., 'https://docs.example.com') and wildcard subdomains (e.g., 'https://*.example.com'). Only enforced for browser requests (defense-in-depth, not a security boundary). Null means no origin restriction. | [optional] 
 
 ## Example
 

docs/APIKeyCreateResponse.md

@@ -0,0 +1,15 @@
+# APIKeyType
+
+Type of API key determining its purpose and scope.  - STANDARD: Regular organization API key with standard permissions. - MARKETPLACE_SUBSCRIPTION: Special key generated for marketplace subscriptions,   allowing cross-org access to specific marketplace retrievers. - RETRIEVER: Per-retriever API key scoped to execute a specific retriever.   Only the retriever owner can create these keys. Prefix: ret_sk_
+
+## Enum
+
+* `STANDARD` (value: `'standard'`)
+
+* `MARKETPLACE_SUBSCRIPTION` (value: `'marketplace_subscription'`)
+
+* `RETRIEVER` (value: `'retriever'`)
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

docs/APIKeyModel.md

@@ -9,7 +9,7 @@ Name | Type | Description | Notes
 **collection_identifiers** | **List[str]** | Collection identifiers (names or IDs) to query. Can be collection names or IDs. Names are automatically resolved. Can be empty for query-only inference mode (e.g., LLM query analysis without documents). | [optional] 
 **input_schema** | [**Dict[str, RetrieverInputSchemaFieldInput]**](RetrieverInputSchemaFieldInput.md) | REQUIRED. Input schema defining expected inputs. Each key is an input name, value is a RetrieverInputSchemaField. | 
 **stages** | [**List[StageConfig]**](StageConfig.md) | REQUIRED. Ordered list of stage configurations. At least one stage is required for execution. | 
-**inputs** | **object** | REQUIRED. Input values matching the input_schema. These values are passed to stages for parameterization. | 
+**inputs** | **Dict[str, object]** | REQUIRED. Input values matching the input_schema. These values are passed to stages for parameterization. | 
 **budget_limits** | [**BudgetLimits**](BudgetLimits.md) | OPTIONAL. Budget limits for execution. | [optional] 
 **stream** | **bool** | Enable streaming execution to receive real-time stage updates via Server-Sent Events (SSE). NOT REQUIRED - defaults to False for standard execution.   When stream=True: - Response Content-Type: text/event-stream - Events emitted: stage_start, stage_complete, stage_error, execution_complete, execution_error - Each event is formatted as: data: {json}\\n\\n - StreamStageEvent contains: event_type, execution_id, stage_name, stage_index, total_stages, documents (intermediate), statistics, budget_used   When to use streaming: - Progress tracking for multi-stage pipelines - Displaying intermediate results as stages complete - Real-time budget and performance monitoring - Debugging pipeline execution   When to skip streaming: - Single-stage or fast pipelines (<100ms) - No need for intermediate results - Minimizing overhead is critical | [optional] [default to False]
 

docs/APIKeyType.md

@@ -10,7 +10,7 @@ Method | HTTP request | Description
 
 
 # **execute_adhoc_retriever**
-> object execute_adhoc_retriever(adhoc_execute_request, return_presigned_urls=return_presigned_urls, return_vectors=return_vectors, authorization=authorization, x_namespace=x_namespace)
+> object execute_adhoc_retriever(adhoc_execute_request, return_presigned_urls=return_presigned_urls, return_vectors=return_vectors, authorization=authorization, authorization2=authorization2, x_namespace=x_namespace)
 
 Execute Adhoc Retriever
 
@@ -79,11 +79,12 @@ with mixpeek.ApiClient(configuration) as api_client:
     return_presigned_urls = False # bool |  (optional) (default to False)
     return_vectors = False # bool |  (optional) (default to False)
     authorization = 'authorization_example' # str | REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. (optional)
+    authorization2 = 'authorization_example' # str |  (optional)
     x_namespace = 'x_namespace_example' # str | REQUIRED: Namespace identifier for scoping this request. All resources (collections, buckets, taxonomies, etc.) are scoped to a namespace. You can provide either the namespace name or namespace ID. Format: ns_xxxxxxxxxxxxx (ID) or a custom name like 'my-namespace' (optional)
 
     try:
         # Execute Adhoc Retriever
-        api_response = api_instance.execute_adhoc_retriever(adhoc_execute_request, return_presigned_urls=return_presigned_urls, return_vectors=return_vectors, authorization=authorization, x_namespace=x_namespace)
+        api_response = api_instance.execute_adhoc_retriever(adhoc_execute_request, return_presigned_urls=return_presigned_urls, return_vectors=return_vectors, authorization=authorization, authorization2=authorization2, x_namespace=x_namespace)
         print("The response of AdhocRetrieversApi->execute_adhoc_retriever:\n")
         pprint(api_response)
     except Exception as e:
@@ -101,6 +102,7 @@ Name | Type | Description  | Notes
  **return_presigned_urls** | **bool**|  | [optional] [default to False]
  **return_vectors** | **bool**|  | [optional] [default to False]
  **authorization** | **str**| REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. | [optional] 
+ **authorization2** | **str**|  | [optional] 
  **x_namespace** | **str**| REQUIRED: Namespace identifier for scoping this request. All resources (collections, buckets, taxonomies, etc.) are scoped to a namespace. You can provide either the namespace name or namespace ID. Format: ns_xxxxxxxxxxxxx (ID) or a custom name like 'my-namespace' | [optional] 
 
 ### Return type
@@ -125,13 +127,13 @@ No authorization required
 **401** | Unauthorized |  -  |
 **403** | Forbidden |  -  |
 **404** | Not Found |  -  |
-**500** | Internal Server Error |  -  |
 **422** | Validation Error |  -  |
+**500** | Internal Server Error |  -  |
 
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
 
 # **get_adhoc_execution_retrievers**
-> AdhocExecutionDetail get_adhoc_execution_retrievers(execution_id, authorization=authorization, x_namespace=x_namespace)
+> AdhocExecutionDetail get_adhoc_execution_retrievers(execution_id, authorization=authorization, authorization2=authorization2, x_namespace=x_namespace)
 
 Get Adhoc Execution
 
@@ -175,11 +177,12 @@ with mixpeek.ApiClient(configuration) as api_client:
     api_instance = mixpeek.AdhocRetrieversApi(api_client)
     execution_id = 'execution_id_example' # str | Execution identifier.
     authorization = 'authorization_example' # str | REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. (optional)
+    authorization2 = 'authorization_example' # str |  (optional)
     x_namespace = 'x_namespace_example' # str | REQUIRED: Namespace identifier for scoping this request. All resources (collections, buckets, taxonomies, etc.) are scoped to a namespace. You can provide either the namespace name or namespace ID. Format: ns_xxxxxxxxxxxxx (ID) or a custom name like 'my-namespace' (optional)
 
     try:
         # Get Adhoc Execution
-        api_response = api_instance.get_adhoc_execution_retrievers(execution_id, authorization=authorization, x_namespace=x_namespace)
+        api_response = api_instance.get_adhoc_execution_retrievers(execution_id, authorization=authorization, authorization2=authorization2, x_namespace=x_namespace)
         print("The response of AdhocRetrieversApi->get_adhoc_execution_retrievers:\n")
         pprint(api_response)
     except Exception as e:
@@ -195,6 +198,7 @@ Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **execution_id** | **str**| Execution identifier. | 
  **authorization** | **str**| REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. | [optional] 
+ **authorization2** | **str**|  | [optional] 
  **x_namespace** | **str**| REQUIRED: Namespace identifier for scoping this request. All resources (collections, buckets, taxonomies, etc.) are scoped to a namespace. You can provide either the namespace name or namespace ID. Format: ns_xxxxxxxxxxxxx (ID) or a custom name like 'my-namespace' | [optional] 
 
 ### Return type
@@ -219,13 +223,13 @@ No authorization required
 **401** | Unauthorized |  -  |
 **403** | Forbidden |  -  |
 **404** | Not Found |  -  |
-**500** | Internal Server Error |  -  |
 **422** | Validation Error |  -  |
+**500** | Internal Server Error |  -  |
 
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
 
 # **list_adhoc_executions_retrievers**
-> ListAdhocExecutionsResponse list_adhoc_executions_retrievers(limit=limit, offset=offset, cursor=cursor, include_total=include_total, authorization=authorization, x_namespace=x_namespace, list_adhoc_executions_request=list_adhoc_executions_request)
+> ListAdhocExecutionsResponse list_adhoc_executions_retrievers(limit=limit, offset=offset, cursor=cursor, include_total=include_total, authorization=authorization, authorization2=authorization2, x_namespace=x_namespace, list_adhoc_executions_request=list_adhoc_executions_request)
 
 List Adhoc Executions
 
@@ -275,12 +279,13 @@ with mixpeek.ApiClient(configuration) as api_client:
     cursor = 'cursor_example' # str |  (optional)
     include_total = False # bool |  (optional) (default to False)
     authorization = 'authorization_example' # str | REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. (optional)
+    authorization2 = 'authorization_example' # str |  (optional)
     x_namespace = 'x_namespace_example' # str | REQUIRED: Namespace identifier for scoping this request. All resources (collections, buckets, taxonomies, etc.) are scoped to a namespace. You can provide either the namespace name or namespace ID. Format: ns_xxxxxxxxxxxxx (ID) or a custom name like 'my-namespace' (optional)
     list_adhoc_executions_request = mixpeek.ListAdhocExecutionsRequest() # ListAdhocExecutionsRequest |  (optional)
 
     try:
         # List Adhoc Executions
-        api_response = api_instance.list_adhoc_executions_retrievers(limit=limit, offset=offset, cursor=cursor, include_total=include_total, authorization=authorization, x_namespace=x_namespace, list_adhoc_executions_request=list_adhoc_executions_request)
+        api_response = api_instance.list_adhoc_executions_retrievers(limit=limit, offset=offset, cursor=cursor, include_total=include_total, authorization=authorization, authorization2=authorization2, x_namespace=x_namespace, list_adhoc_executions_request=list_adhoc_executions_request)
         print("The response of AdhocRetrieversApi->list_adhoc_executions_retrievers:\n")
         pprint(api_response)
     except Exception as e:
@@ -299,6 +304,7 @@ Name | Type | Description  | Notes
  **cursor** | **str**|  | [optional] 
  **include_total** | **bool**|  | [optional] [default to False]
  **authorization** | **str**| REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. | [optional] 
+ **authorization2** | **str**|  | [optional] 
  **x_namespace** | **str**| REQUIRED: Namespace identifier for scoping this request. All resources (collections, buckets, taxonomies, etc.) are scoped to a namespace. You can provide either the namespace name or namespace ID. Format: ns_xxxxxxxxxxxxx (ID) or a custom name like 'my-namespace' | [optional] 
  **list_adhoc_executions_request** | [**ListAdhocExecutionsRequest**](ListAdhocExecutionsRequest.md)|  | [optional] 
 
@@ -324,8 +330,8 @@ No authorization required
 **401** | Unauthorized |  -  |
 **403** | Forbidden |  -  |
 **404** | Not Found |  -  |
-**500** | Internal Server Error |  -  |
 **422** | Validation Error |  -  |
+**500** | Internal Server Error |  -  |
 
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
 

docs/AdhocExecuteRequest.md

@@ -1,12 +1,12 @@
 # AgentConfig
 
-Agent configuration for session.  This config is immutable after session creation (similar to RetrieverConfig). To change agent config, create a new session.  Attributes:     model: LLM model identifier. Supported models:         - gemini-2.0-flash (fastest, cheapest)         - gemini-2.5-pro (better quality)         - gpt-4o-mini, gpt-4o     temperature: Sampling temperature for LLM responses (0.0-2.0)         - 0.0-0.3: More deterministic, focused responses         - 0.5-0.7: Balanced creativity and coherence         - 0.8-2.0: More creative, varied responses     max_tokens: Maximum tokens per response (1-100000)     system_prompt: System prompt that defines agent behavior and persona     available_tools: List of tools the agent can call (see AvailableTool enum)  Example:     ```python     config = AgentConfig(         model=\"gemini-2.0-flash\",         temperature=0.7,         max_tokens=4096,         system_prompt=\"You are a helpful video search assistant.\",         available_tools=[             \"smart_search\",             \"execute_retriever\",             \"list_collections\"         ]     )     ```
+Agent configuration for session.  This config is immutable after session creation (similar to RetrieverConfig). To change agent config, create a new session.  Attributes:     model: LLM model identifier. Supported models:         - gemini-2.5-flash (fastest, cheapest)         - gemini-2.5-pro (better quality)         - gpt-4o-mini, gpt-4o     temperature: Sampling temperature for LLM responses (0.0-2.0)         - 0.0-0.3: More deterministic, focused responses         - 0.5-0.7: Balanced creativity and coherence         - 0.8-2.0: More creative, varied responses     max_tokens: Maximum tokens per response (1-100000)     system_prompt: System prompt that defines agent behavior and persona     available_tools: List of tools the agent can call (see AvailableTool enum)  Example:     ```python     config = AgentConfig(         model=\"gemini-2.5-flash\",         temperature=0.7,         max_tokens=4096,         system_prompt=\"You are a helpful video search assistant.\",         available_tools=[             \"smart_search\",             \"execute_retriever\",             \"list_collections\"         ]     )     ```
 
 ## Properties
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**model** | **str** | LLM model identifier. Options: 'gemini-2.0-flash' (fastest, cheapest), 'gemini-2.5-pro' (better quality), 'gpt-4o-mini', 'gpt-4o' | [optional] [default to 'gemini-2.0-flash']
+**model** | **str** | LLM model identifier. Options: 'gemini-2.5-flash' (fastest, cheapest), 'gemini-2.5-pro' (better quality), 'gpt-4o-mini', 'gpt-4o' | [optional] [default to 'gemini-2.5-flash']
 **temperature** | **float** | Sampling temperature for LLM responses (0.0-2.0). Lower values (0.0-0.3) are more deterministic. Higher values (0.8-2.0) are more creative. | [optional] [default to 0.7]
 **max_tokens** | **int** | Maximum tokens per response | [optional] [default to 4096]
 **system_prompt** | **str** | System prompt that defines agent behavior and persona | [optional] [default to 'You are a helpful AI assistant with access to Mixpeek\'s data infrastructure.']