Sync with Documentation

Author: z64

README.md

@@ -39,7 +39,7 @@ Join our [Discord](https://kagi.com/discord)! Good for quick questions or chatti
 
 This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
-- API version: v1 (Preview)
+- API version: 1
 - Package version: 1.0.0
 - Generator version: 7.22.0-SNAPSHOT
 - Build package: org.openapitools.codegen.languages.PythonClientCodegen

docs/ErrorDetail.md

@@ -7,7 +7,7 @@ API error response for Extract operations
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **code** | **str** | Namespaced error code | 
-**url** | **str** | URL to error documentation | 
+**url** | **str** | URL to error documentation.  **NOTE:** These URLs are still a work in progress and will currently return a 404 error. These will be updated to real URLs as the preview period continues.  | 
 **message** | **str** | Human-readable error message | [optional] 
 **location** | **str** | Field location where the error occurred | [optional] 
 

docs/Meta.md

@@ -7,7 +7,6 @@ This object is subject to change as it is provided for debugging purposes. Field
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **trace** | **str** | Trace ID that can be used to debug individual API requests. Provide this, if needed, when contacting Kagi support. | [optional] 
-**id** | **str** |  | [optional] 
 **node** | **str** | The hostname of the node that fulfilled the request. | [optional] 
 **ms** | **int** | how long the request took to fulfill, excluding round trip to the client. | [optional] 
 

docs/SearchRequest.md

@@ -13,7 +13,7 @@ Name | Type | Description | Notes
 **lens** | [**SearchRequestLens**](SearchRequestLens.md) |  | [optional] 
 **timeout** | **float** | Number of seconds to allow for collecting search results. Lower values will return results more quickly, but may be lower quality or inconsistent between calls. If omitted, will use the latest recommended value by Kagi. | [optional] 
 **page** | **int** | Page number for paginated results. Must be between 1 and 10. | [optional] 
-**limit** | **int** | Maximum number of results to return. Must be between 1 and 1024. | [optional] 
+**limit** | **int** | Maximum number of results to return. Must be between 1 and 1024.  **NOTE:** This does not change the amount of results requested, it only limits the maximum amount returned. If omitted, the API always gives you the most results we can get in a single pass.  | [optional] 
 **filters** | [**SearchRequestFilters**](SearchRequestFilters.md) |  | [optional] 
 **extract** | [**SearchRequestExtract**](SearchRequestExtract.md) |  | [optional] 
 **safe_search** | **bool** | Whether safe search is enabled, omitting potentially NSFW content. | [optional] [default to True]

docs/SearchRequestExtract.md

@@ -1,13 +1,13 @@
 # SearchRequestExtract
 
-Configuration for extracting page content from search results. When provided, the API will fetch and extract the content from the specified number of result pages.  **NOTE: Use of this option incurs additional cost, billed at your account's rate for the Extract API**.  The resulting page markdown will update the value of the `snippet` field on the respective result item. 
+Configuration for extracting page content from search results. When provided, the API will fetch and extract the content from the specified number of result pages.  The resulting page markdown will update the value of the `snippet` field on the respective result item.  **NOTE:** Use of this option incurs additional cost, billed at your account's rate for the Extract API based on the number of units requested. You will not be charged if there were no results to extract. 
 
 ## Properties
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **count** | **int** | Number of search results to extract content from. Must be between 1 and 10. | [optional] 
-**timeout** | **float** | Timeout in seconds for extraction of each page. If omitted, uses the default timeout. | [optional] 
+**timeout** | **float** | Timeout in seconds for extraction of each page. If omitted, uses the default timeout. This time budget is in addition to the allocated top-level search timeout, so that you can control both independently. | [optional] 
 
 ## Example
 

docs/SearchRequestFilters.md

@@ -1,6 +1,6 @@
 # SearchRequestFilters
 
-Filters to apply to search results for more targeted queries.
+Filters to apply to search results for more targeted queries.  **NOTE:** Any parameter here that overlaps with lenses will take priority over the lens. 
 
 ## Properties
 

openapi_client/__init__.py

@@ -7,7 +7,7 @@
 
     The Kagi API provides programmatic access to data that powers our search results & more.   Get started on the [API Dashboard](https://kagi.com/api) to set up billing, manage API keys, and more.  ### Official Client Libraries  We offer the following libraries you can use to interact with the Kagi API. These are generated from an OpenAPI spec. If you have a language you would like to use and it's not in the list, send us a message and we will add it to the list if it is supported. Or you can use the [spec](https://kagi.redocly.app/_spec/openapi.yaml?download) to build your own custom library.  - [Golang](https://github.com/kagisearch/kagi-openapi-golang) - [Python](https://github.com/kagisearch/kagi-openapi-python) - [TypeScript](https://github.com/kagisearch/kagi-openapi-typescript) - [Rust](https://github.com/kagisearch/kagi-openapi-rust)  ### API Status  **The v1 API is currently in preview to early access testers.**  Our existing API, the \"v0\" beta API, is being replaced with a new version that will be available publicly soon. As changes are made, we will be updating the documentation below when the new features become available.  See the [Support and Community](https://help.kagi.com/kagi/support-and-community/) section for details.  ### Pricing  See our [API Pricing](https://kagi.com/api/pricing) page for standard rates.  ### GitHub Discussions  This is the preferred venue for bug reports and feature requests.  - [Bug Reports](https://github.com/kagisearch/kagi-docs/issues/new/choose) - [Q&A Forum](https://github.com/kagisearch/kagi-docs/discussions/categories/q-a?discussions_q=category%3AQ%26A+label%3Aproduct%3Akagi_search_api) - [API Feature Requests](https://github.com/kagisearch/kagi-docs/discussions/categories/kagi-search-api-feature-requests-ideas)  ### Discord  Join our [Discord](https://kagi.com/discord)! Good for quick questions or chatting about things you've made with our APIs! 
 
-    The version of the OpenAPI document: v1 (Preview)
+    The version of the OpenAPI document: 1
     Contact: support@kagi.com
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 

openapi_client/api/extract_api.py

@@ -3,7 +3,7 @@
 
     The Kagi API provides programmatic access to data that powers our search results & more.   Get started on the [API Dashboard](https://kagi.com/api) to set up billing, manage API keys, and more.  ### Official Client Libraries  We offer the following libraries you can use to interact with the Kagi API. These are generated from an OpenAPI spec. If you have a language you would like to use and it's not in the list, send us a message and we will add it to the list if it is supported. Or you can use the [spec](https://kagi.redocly.app/_spec/openapi.yaml?download) to build your own custom library.  - [Golang](https://github.com/kagisearch/kagi-openapi-golang) - [Python](https://github.com/kagisearch/kagi-openapi-python) - [TypeScript](https://github.com/kagisearch/kagi-openapi-typescript) - [Rust](https://github.com/kagisearch/kagi-openapi-rust)  ### API Status  **The v1 API is currently in preview to early access testers.**  Our existing API, the \"v0\" beta API, is being replaced with a new version that will be available publicly soon. As changes are made, we will be updating the documentation below when the new features become available.  See the [Support and Community](https://help.kagi.com/kagi/support-and-community/) section for details.  ### Pricing  See our [API Pricing](https://kagi.com/api/pricing) page for standard rates.  ### GitHub Discussions  This is the preferred venue for bug reports and feature requests.  - [Bug Reports](https://github.com/kagisearch/kagi-docs/issues/new/choose) - [Q&A Forum](https://github.com/kagisearch/kagi-docs/discussions/categories/q-a?discussions_q=category%3AQ%26A+label%3Aproduct%3Akagi_search_api) - [API Feature Requests](https://github.com/kagisearch/kagi-docs/discussions/categories/kagi-search-api-feature-requests-ideas)  ### Discord  Join our [Discord](https://kagi.com/discord)! Good for quick questions or chatting about things you've made with our APIs! 
 
-    The version of the OpenAPI document: v1 (Preview)
+    The version of the OpenAPI document: 1
     Contact: support@kagi.com
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 

openapi_client/api/search_api.py

@@ -3,7 +3,7 @@
 
     The Kagi API provides programmatic access to data that powers our search results & more.   Get started on the [API Dashboard](https://kagi.com/api) to set up billing, manage API keys, and more.  ### Official Client Libraries  We offer the following libraries you can use to interact with the Kagi API. These are generated from an OpenAPI spec. If you have a language you would like to use and it's not in the list, send us a message and we will add it to the list if it is supported. Or you can use the [spec](https://kagi.redocly.app/_spec/openapi.yaml?download) to build your own custom library.  - [Golang](https://github.com/kagisearch/kagi-openapi-golang) - [Python](https://github.com/kagisearch/kagi-openapi-python) - [TypeScript](https://github.com/kagisearch/kagi-openapi-typescript) - [Rust](https://github.com/kagisearch/kagi-openapi-rust)  ### API Status  **The v1 API is currently in preview to early access testers.**  Our existing API, the \"v0\" beta API, is being replaced with a new version that will be available publicly soon. As changes are made, we will be updating the documentation below when the new features become available.  See the [Support and Community](https://help.kagi.com/kagi/support-and-community/) section for details.  ### Pricing  See our [API Pricing](https://kagi.com/api/pricing) page for standard rates.  ### GitHub Discussions  This is the preferred venue for bug reports and feature requests.  - [Bug Reports](https://github.com/kagisearch/kagi-docs/issues/new/choose) - [Q&A Forum](https://github.com/kagisearch/kagi-docs/discussions/categories/q-a?discussions_q=category%3AQ%26A+label%3Aproduct%3Akagi_search_api) - [API Feature Requests](https://github.com/kagisearch/kagi-docs/discussions/categories/kagi-search-api-feature-requests-ideas)  ### Discord  Join our [Discord](https://kagi.com/discord)! Good for quick questions or chatting about things you've made with our APIs! 
 
-    The version of the OpenAPI document: v1 (Preview)
+    The version of the OpenAPI document: 1
     Contact: support@kagi.com
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 

openapi_client/api_client.py

@@ -3,7 +3,7 @@
 
     The Kagi API provides programmatic access to data that powers our search results & more.   Get started on the [API Dashboard](https://kagi.com/api) to set up billing, manage API keys, and more.  ### Official Client Libraries  We offer the following libraries you can use to interact with the Kagi API. These are generated from an OpenAPI spec. If you have a language you would like to use and it's not in the list, send us a message and we will add it to the list if it is supported. Or you can use the [spec](https://kagi.redocly.app/_spec/openapi.yaml?download) to build your own custom library.  - [Golang](https://github.com/kagisearch/kagi-openapi-golang) - [Python](https://github.com/kagisearch/kagi-openapi-python) - [TypeScript](https://github.com/kagisearch/kagi-openapi-typescript) - [Rust](https://github.com/kagisearch/kagi-openapi-rust)  ### API Status  **The v1 API is currently in preview to early access testers.**  Our existing API, the \"v0\" beta API, is being replaced with a new version that will be available publicly soon. As changes are made, we will be updating the documentation below when the new features become available.  See the [Support and Community](https://help.kagi.com/kagi/support-and-community/) section for details.  ### Pricing  See our [API Pricing](https://kagi.com/api/pricing) page for standard rates.  ### GitHub Discussions  This is the preferred venue for bug reports and feature requests.  - [Bug Reports](https://github.com/kagisearch/kagi-docs/issues/new/choose) - [Q&A Forum](https://github.com/kagisearch/kagi-docs/discussions/categories/q-a?discussions_q=category%3AQ%26A+label%3Aproduct%3Akagi_search_api) - [API Feature Requests](https://github.com/kagisearch/kagi-docs/discussions/categories/kagi-search-api-feature-requests-ideas)  ### Discord  Join our [Discord](https://kagi.com/discord)! Good for quick questions or chatting about things you've made with our APIs! 
 
-    The version of the OpenAPI document: v1 (Preview)
+    The version of the OpenAPI document: 1
     Contact: support@kagi.com
     Generated by OpenAPI Generator (https://openapi-generator.tech)