feat(api): Update OpenAPI spec

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 24
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/parallel-web%2Fparallel-sdk-c4cc922783460c6e65811d13c9abe35807a551c77c126d452806f93caaaf48fb.yml
-openapi_spec_hash: 99c9e48d4dafaca71f058107008d174b
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/parallel-web%2Fparallel-sdk-57e1c56be0942c131ab5f24d8620de166d0721ef7f3423532abc7027e5a989e7.yml
+openapi_spec_hash: e61f831e30d19590eb3138a1b1709d1d
 config_hash: 80e7ee7ad8e3424616aca7189ffd5ae7

src/parallel/_client.py

@@ -247,6 +247,9 @@ def extract(
         """
         Extracts relevant content from specific web URLs.
 
+        The legacy Extract API reference is available
+        [here](https://docs.parallel.ai/api-reference/legacy/extract-beta/extract).
+
         Args:
           urls: URLs to extract content from. Up to 20 URLs.
 
@@ -258,9 +261,7 @@ def extract(
           client_model: The model generating this request and consuming the results. Enables
               optimizations and tailors default settings for the model's capabilities.
 
-          max_chars_total: Upper bound on total characters across excerpts from all extracted results. Does
-              not affect full_content if requested. Default is dynamic based on urls,
-              objective, and client_model.
+          max_chars_total: Upper bound on total characters across excerpts from all extracted results.
 
           objective: As in SearchRequest, a natural-language description of the underlying question
               or goal driving the request. Used together with search_queries to focus excerpts
@@ -269,9 +270,9 @@ def extract(
           search_queries: Optional keyword search queries, as in SearchRequest. Used together with
               objective to focus excerpts on the most relevant content.
 
-          session_id: Session identifier for calls to search and extract made by an agent as part of a
-              larger task. May be a user-generated random string, e.g. a uuid, or a session_id
-              returned by a previous request.
+          session_id: Session identifier to track calls across separate search and extract calls, to
+              be used as part of a larger task. Specifying it may give better contextual
+              results for subsequent API calls.
 
           extra_headers: Send extra headers
 
@@ -308,7 +309,7 @@ def search(
         advanced_settings: Optional[AdvancedSearchSettingsParam] | Omit = omit,
         client_model: Optional[str] | Omit = omit,
         max_chars_total: Optional[int] | Omit = omit,
-        mode: Optional[Literal["basic", "standard"]] | Omit = omit,
+        mode: Optional[Literal["basic", "advanced"]] | Omit = omit,
         objective: Optional[str] | Omit = omit,
         session_id: Optional[str] | Omit = omit,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
@@ -321,6 +322,9 @@ def search(
         """
         Searches the web.
 
+        The legacy Search API reference is available
+        [here](https://docs.parallel.ai/api-reference/legacy/search-beta/search).
+
         Args:
           search_queries: Concise keyword search queries, 3-6 words each. At least one query is required,
               provide 2-3 for best results. Used together with objective to focus results on
@@ -334,22 +338,21 @@ def search(
           client_model: The model generating this request and consuming the results. Enables
               optimizations and tailors default settings for the model's capabilities.
 
-          max_chars_total: Upper bound on total characters across excerpts from all results. Default is
-              dynamic based on search_queries, objective, and client_model.
+          max_chars_total: Upper bound on total characters across excerpts from all results.
 
-          mode: Search mode preset: supported values are basic and standard. Basic mode offers
-              the lowest latency and works best with 2-3 high-quality search_queries. Standard
-              mode provides higher quality with more advanced retrieval and compression.
-              Defaults to standard when omitted.
+          mode: Search mode preset: supported values are `basic` and `advanced`. Basic mode
+              offers the lowest latency and works best with 2-3 high-quality search_queries.
+              Advanced mode provides higher quality with more advanced retrieval and
+              compression. Defaults to `advanced` when omitted.
 
           objective: Natural-language description of the underlying question or goal driving the
               search. Used together with search_queries to focus results on the most relevant
               content. Should be self-contained with enough context to understand the intent
               of the search.
 
-          session_id: Session identifier for calls to search and extract made by an agent as part of a
-              larger task. May be a user-generated random string, e.g. a uuid, or a session_id
-              returned by a previous request.
+          session_id: Session identifier to track calls across separate search and extract calls, to
+              be used as part of a larger task. Specifying it may give better contextual
+              results for subsequent API calls.
 
           extra_headers: Send extra headers
 
@@ -591,6 +594,9 @@ async def extract(
         """
         Extracts relevant content from specific web URLs.
 
+        The legacy Extract API reference is available
+        [here](https://docs.parallel.ai/api-reference/legacy/extract-beta/extract).
+
         Args:
           urls: URLs to extract content from. Up to 20 URLs.
 
@@ -602,9 +608,7 @@ async def extract(
           client_model: The model generating this request and consuming the results. Enables
               optimizations and tailors default settings for the model's capabilities.
 
-          max_chars_total: Upper bound on total characters across excerpts from all extracted results. Does
-              not affect full_content if requested. Default is dynamic based on urls,
-              objective, and client_model.
+          max_chars_total: Upper bound on total characters across excerpts from all extracted results.
 
           objective: As in SearchRequest, a natural-language description of the underlying question
               or goal driving the request. Used together with search_queries to focus excerpts
@@ -613,9 +617,9 @@ async def extract(
           search_queries: Optional keyword search queries, as in SearchRequest. Used together with
               objective to focus excerpts on the most relevant content.
 
-          session_id: Session identifier for calls to search and extract made by an agent as part of a
-              larger task. May be a user-generated random string, e.g. a uuid, or a session_id
-              returned by a previous request.
+          session_id: Session identifier to track calls across separate search and extract calls, to
+              be used as part of a larger task. Specifying it may give better contextual
+              results for subsequent API calls.
 
           extra_headers: Send extra headers
 
@@ -652,7 +656,7 @@ async def search(
         advanced_settings: Optional[AdvancedSearchSettingsParam] | Omit = omit,
         client_model: Optional[str] | Omit = omit,
         max_chars_total: Optional[int] | Omit = omit,
-        mode: Optional[Literal["basic", "standard"]] | Omit = omit,
+        mode: Optional[Literal["basic", "advanced"]] | Omit = omit,
         objective: Optional[str] | Omit = omit,
         session_id: Optional[str] | Omit = omit,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
@@ -665,6 +669,9 @@ async def search(
         """
         Searches the web.
 
+        The legacy Search API reference is available
+        [here](https://docs.parallel.ai/api-reference/legacy/search-beta/search).
+
         Args:
           search_queries: Concise keyword search queries, 3-6 words each. At least one query is required,
               provide 2-3 for best results. Used together with objective to focus results on
@@ -678,22 +685,21 @@ async def search(
           client_model: The model generating this request and consuming the results. Enables
               optimizations and tailors default settings for the model's capabilities.
 
-          max_chars_total: Upper bound on total characters across excerpts from all results. Default is
-              dynamic based on search_queries, objective, and client_model.
+          max_chars_total: Upper bound on total characters across excerpts from all results.
 
-          mode: Search mode preset: supported values are basic and standard. Basic mode offers
-              the lowest latency and works best with 2-3 high-quality search_queries. Standard
-              mode provides higher quality with more advanced retrieval and compression.
-              Defaults to standard when omitted.
+          mode: Search mode preset: supported values are `basic` and `advanced`. Basic mode
+              offers the lowest latency and works best with 2-3 high-quality search_queries.
+              Advanced mode provides higher quality with more advanced retrieval and
+              compression. Defaults to `advanced` when omitted.
 
           objective: Natural-language description of the underlying question or goal driving the
               search. Used together with search_queries to focus results on the most relevant
               content. Should be self-contained with enough context to understand the intent
               of the search.
 
-          session_id: Session identifier for calls to search and extract made by an agent as part of a
-              larger task. May be a user-generated random string, e.g. a uuid, or a session_id
-              returned by a previous request.
+          session_id: Session identifier to track calls across separate search and extract calls, to
+              be used as part of a larger task. Specifying it may give better contextual
+              results for subsequent API calls.
 
           extra_headers: Send extra headers
 

src/parallel/resources/beta/beta.py

@@ -151,9 +151,9 @@ def extract(
 
           search_queries: If provided, focuses extracted content on the specified keyword search queries.
 
-          session_id: Session identifier for calls to search and extract made by an agent as part of a
-              larger task. May be a user-generated random string (e.g. a uuid) or a session_id
-              from a previous request.
+          session_id: Session identifier to track calls across separate search and extract calls, to
+              be used as part of a larger task. Specifying it may give better contextual
+              results for subsequent API calls.
 
           betas: Optional header to specify the beta version(s) to enable.
 
@@ -251,9 +251,9 @@ def search(
               contain search operators. At least one of objective or search_queries must be
               provided.
 
-          session_id: Session identifier for calls to search and extract made by an agent as part of a
-              larger task. May be a user-generated random string (e.g. a uuid) or a session_id
-              from a previous request.
+          session_id: Session identifier to track calls across separate search and extract calls, to
+              be used as part of a larger task. Specifying it may give better contextual
+              results for subsequent API calls.
 
           source_policy: Source policy for web search results.
 
@@ -402,9 +402,9 @@ async def extract(
 
           search_queries: If provided, focuses extracted content on the specified keyword search queries.
 
-          session_id: Session identifier for calls to search and extract made by an agent as part of a
-              larger task. May be a user-generated random string (e.g. a uuid) or a session_id
-              from a previous request.
+          session_id: Session identifier to track calls across separate search and extract calls, to
+              be used as part of a larger task. Specifying it may give better contextual
+              results for subsequent API calls.
 
           betas: Optional header to specify the beta version(s) to enable.
 
@@ -502,9 +502,9 @@ async def search(
               contain search operators. At least one of objective or search_queries must be
               provided.
 
-          session_id: Session identifier for calls to search and extract made by an agent as part of a
-              larger task. May be a user-generated random string (e.g. a uuid) or a session_id
-              from a previous request.
+          session_id: Session identifier to track calls across separate search and extract calls, to
+              be used as part of a larger task. Specifying it may give better contextual
+              results for subsequent API calls.
 
           source_policy: Source policy for web search results.
 

src/parallel/resources/beta/task_run.py

@@ -104,10 +104,10 @@ def create(
 
           enable_events: Controls tracking of task run execution progress. When set to true, progress
               events are recorded and can be accessed via the
-              [Task Run events](https://platform.parallel.ai/api-reference) endpoint. When
-              false, no progress events are tracked. Note that progress tracking cannot be
-              enabled after a run has been created. The flag is set to true by default for
-              premium processors (pro and above).
+              [Task Run events](https://docs.parallel.ai/api-reference) endpoint. When false,
+              no progress events are tracked. Note that progress tracking cannot be enabled
+              after a run has been created. The flag is set to true by default for premium
+              processors (pro and above).
 
           mcp_servers: Optional list of MCP servers to use for the run.
 
@@ -342,10 +342,10 @@ async def create(
 
           enable_events: Controls tracking of task run execution progress. When set to true, progress
               events are recorded and can be accessed via the
-              [Task Run events](https://platform.parallel.ai/api-reference) endpoint. When
-              false, no progress events are tracked. Note that progress tracking cannot be
-              enabled after a run has been created. The flag is set to true by default for
-              premium processors (pro and above).
+              [Task Run events](https://docs.parallel.ai/api-reference) endpoint. When false,
+              no progress events are tracked. Note that progress tracking cannot be enabled
+              after a run has been created. The flag is set to true by default for premium
+              processors (pro and above).
 
           mcp_servers: Optional list of MCP servers to use for the run.
 

src/parallel/resources/task_run.py

@@ -111,10 +111,10 @@ def create(
 
           enable_events: Controls tracking of task run execution progress. When set to true, progress
               events are recorded and can be accessed via the
-              [Task Run events](https://platform.parallel.ai/api-reference) endpoint. When
-              false, no progress events are tracked. Note that progress tracking cannot be
-              enabled after a run has been created. The flag is set to true by default for
-              premium processors (pro and above).
+              [Task Run events](https://docs.parallel.ai/api-reference) endpoint. When false,
+              no progress events are tracked. Note that progress tracking cannot be enabled
+              after a run has been created. The flag is set to true by default for premium
+              processors (pro and above).
 
           mcp_servers: Optional list of MCP servers to use for the run.
 
@@ -494,10 +494,10 @@ async def create(
 
           enable_events: Controls tracking of task run execution progress. When set to true, progress
               events are recorded and can be accessed via the
-              [Task Run events](https://platform.parallel.ai/api-reference) endpoint. When
-              false, no progress events are tracked. Note that progress tracking cannot be
-              enabled after a run has been created. The flag is set to true by default for
-              premium processors (pro and above).
+              [Task Run events](https://docs.parallel.ai/api-reference) endpoint. When false,
+              no progress events are tracked. Note that progress tracking cannot be enabled
+              after a run has been created. The flag is set to true by default for premium
+              processors (pro and above).
 
           mcp_servers: Optional list of MCP servers to use for the run.
 

src/parallel/types/beta/beta_extract_params.py

@@ -42,9 +42,9 @@ class BetaExtractParams(TypedDict, total=False):
 
     session_id: Optional[str]
     """
-    Session identifier for calls to search and extract made by an agent as part of a
-    larger task. May be a user-generated random string (e.g. a uuid) or a session_id
-    from a previous request.
+    Session identifier to track calls across separate search and extract calls, to
+    be used as part of a larger task. Specifying it may give better contextual
+    results for subsequent API calls.
     """
 
     betas: Annotated[List[ParallelBetaParam], PropertyInfo(alias="parallel-beta")]

src/parallel/types/beta/beta_search_params.py

@@ -61,9 +61,9 @@ class BetaSearchParams(TypedDict, total=False):
 
     session_id: Optional[str]
     """
-    Session identifier for calls to search and extract made by an agent as part of a
-    larger task. May be a user-generated random string (e.g. a uuid) or a session_id
-    from a previous request.
+    Session identifier to track calls across separate search and extract calls, to
+    be used as part of a larger task. Specifying it may give better contextual
+    results for subsequent API calls.
     """
 
     source_policy: Optional[SourcePolicy]

src/parallel/types/beta/task_run_create_params.py

@@ -29,10 +29,10 @@ class TaskRunCreateParams(TypedDict, total=False):
     """Controls tracking of task run execution progress.
 
     When set to true, progress events are recorded and can be accessed via the
-    [Task Run events](https://platform.parallel.ai/api-reference) endpoint. When
-    false, no progress events are tracked. Note that progress tracking cannot be
-    enabled after a run has been created. The flag is set to true by default for
-    premium processors (pro and above).
+    [Task Run events](https://docs.parallel.ai/api-reference) endpoint. When false,
+    no progress events are tracked. Note that progress tracking cannot be enabled
+    after a run has been created. The flag is set to true by default for premium
+    processors (pro and above).
     """
 
     mcp_servers: Optional[Iterable[McpServerParam]]

src/parallel/types/client_extract_params.py

@@ -29,11 +29,7 @@ class ClientExtractParams(TypedDict, total=False):
     """
 
     max_chars_total: Optional[int]
-    """Upper bound on total characters across excerpts from all extracted results.
-
-    Does not affect full_content if requested. Default is dynamic based on urls,
-    objective, and client_model.
-    """
+    """Upper bound on total characters across excerpts from all extracted results."""
 
     objective: Optional[str]
     """
@@ -50,7 +46,7 @@ class ClientExtractParams(TypedDict, total=False):
 
     session_id: Optional[str]
     """
-    Session identifier for calls to search and extract made by an agent as part of a
-    larger task. May be a user-generated random string, e.g. a uuid, or a session_id
-    returned by a previous request.
+    Session identifier to track calls across separate search and extract calls, to
+    be used as part of a larger task. Specifying it may give better contextual
+    results for subsequent API calls.
     """