codex-sdk-python 0.87.0__tar.gz → 0.88.0__tar.gz

{codex_sdk_python-0.87.0 → codex_sdk_python-0.88.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: codex-sdk-python
-Version: 0.87.0
+Version: 0.88.0
 Summary: Python SDK for the Codex CLI agent with async threads, streaming events, and structured outputs
 Keywords: codex,sdk,python,api,cli,agent,async,streaming
 Author: Vectorfy Co
@@ -244,6 +244,9 @@ ThreadOptions(
     working_directory="/path/to/project",
     skip_git_repo_check=True,
     model_reasoning_effort="high",
+    model_instructions_file="/path/to/instructions.md",
+    model_personality="friendly",
+    max_threads=4,
     network_access_enabled=True,
     web_search_mode="cached",
     shell_snapshot_enabled=True,
@@ -251,6 +254,8 @@ ThreadOptions(
     apply_patch_freeform_enabled=False,
     exec_policy_enabled=True,
     remote_models_enabled=False,
+    collaboration_modes_enabled=True,
+    responses_websockets_enabled=True,
     request_compression_enabled=True,
     approval_policy="on-request",
     additional_directories=["../shared"],
@@ -264,6 +269,9 @@ Important mappings to the Codex CLI:
 - `additional_directories` maps to repeated `--add-dir`.
 - `skip_git_repo_check` maps to `--skip-git-repo-check`.
 - `model_reasoning_effort` maps to `--config model_reasoning_effort=...`.
+- `model_instructions_file` maps to `--config model_instructions_file=...`.
+- `model_personality` maps to `--config model_personality=...`.
+- `max_threads` maps to `--config agents.max_threads=...`.
 - `network_access_enabled` maps to `--config sandbox_workspace_write.network_access=...`.
 - `web_search_mode` maps to `--config web_search="disabled|cached|live"`.
 - `web_search_enabled`/`web_search_cached_enabled` map to `--config web_search=...` for legacy
@@ -273,12 +281,16 @@ Important mappings to the Codex CLI:
 - `apply_patch_freeform_enabled` maps to `--config features.apply_patch_freeform=...`.
 - `exec_policy_enabled` maps to `--config features.exec_policy=...`.
 - `remote_models_enabled` maps to `--config features.remote_models=...`.
+- `collaboration_modes_enabled` maps to `--config features.collaboration_modes=...`.
+- `responses_websockets_enabled` maps to `--config features.responses_websockets=...`.
 - `request_compression_enabled` maps to `--config features.enable_request_compression=...`.
 - `feature_overrides` maps to `--config features.<key>=...` (explicit options take precedence).
 - `approval_policy` maps to `--config approval_policy=...`.
 - `config_overrides` maps to repeated `--config key=value` entries.
 
 Note: `skills_enabled` is deprecated in Codex 0.80+ (skills are always enabled).
+Note: Codex 0.88.0+ ignores `experimental_instructions_file`; use
+`model_instructions_file` instead.
 
 Feature overrides example:
 
@@ -336,6 +348,7 @@ The SDK also exposes helpers for most app-server endpoints:
 - Skills: `skills_list`
 - Turns/review: `turn_start`, `turn_interrupt`, `review_start`, `turn_session`
 - Models: `model_list`
+- Collaboration modes: `collaboration_mode_list`
 - One-off commands: `command_exec`
 - MCP auth/status: `mcp_server_oauth_login`, `mcp_server_refresh`, `mcp_server_status_list`
 - Account: `account_login_start`, `account_login_cancel`, `account_logout`,

{codex_sdk_python-0.87.0 → codex_sdk_python-0.88.0}/README.md

@@ -208,6 +208,9 @@ ThreadOptions(
     working_directory="/path/to/project",
     skip_git_repo_check=True,
     model_reasoning_effort="high",
+    model_instructions_file="/path/to/instructions.md",
+    model_personality="friendly",
+    max_threads=4,
     network_access_enabled=True,
     web_search_mode="cached",
     shell_snapshot_enabled=True,
@@ -215,6 +218,8 @@ ThreadOptions(
     apply_patch_freeform_enabled=False,
     exec_policy_enabled=True,
     remote_models_enabled=False,
+    collaboration_modes_enabled=True,
+    responses_websockets_enabled=True,
     request_compression_enabled=True,
     approval_policy="on-request",
     additional_directories=["../shared"],
@@ -228,6 +233,9 @@ Important mappings to the Codex CLI:
 - `additional_directories` maps to repeated `--add-dir`.
 - `skip_git_repo_check` maps to `--skip-git-repo-check`.
 - `model_reasoning_effort` maps to `--config model_reasoning_effort=...`.
+- `model_instructions_file` maps to `--config model_instructions_file=...`.
+- `model_personality` maps to `--config model_personality=...`.
+- `max_threads` maps to `--config agents.max_threads=...`.
 - `network_access_enabled` maps to `--config sandbox_workspace_write.network_access=...`.
 - `web_search_mode` maps to `--config web_search="disabled|cached|live"`.
 - `web_search_enabled`/`web_search_cached_enabled` map to `--config web_search=...` for legacy
@@ -237,12 +245,16 @@ Important mappings to the Codex CLI:
 - `apply_patch_freeform_enabled` maps to `--config features.apply_patch_freeform=...`.
 - `exec_policy_enabled` maps to `--config features.exec_policy=...`.
 - `remote_models_enabled` maps to `--config features.remote_models=...`.
+- `collaboration_modes_enabled` maps to `--config features.collaboration_modes=...`.
+- `responses_websockets_enabled` maps to `--config features.responses_websockets=...`.
 - `request_compression_enabled` maps to `--config features.enable_request_compression=...`.
 - `feature_overrides` maps to `--config features.<key>=...` (explicit options take precedence).
 - `approval_policy` maps to `--config approval_policy=...`.
 - `config_overrides` maps to repeated `--config key=value` entries.
 
 Note: `skills_enabled` is deprecated in Codex 0.80+ (skills are always enabled).
+Note: Codex 0.88.0+ ignores `experimental_instructions_file`; use
+`model_instructions_file` instead.
 
 Feature overrides example:
 
@@ -300,6 +312,7 @@ The SDK also exposes helpers for most app-server endpoints:
 - Skills: `skills_list`
 - Turns/review: `turn_start`, `turn_interrupt`, `review_start`, `turn_session`
 - Models: `model_list`
+- Collaboration modes: `collaboration_mode_list`
 - One-off commands: `command_exec`
 - MCP auth/status: `mcp_server_oauth_login`, `mcp_server_refresh`, `mcp_server_status_list`
 - Account: `account_login_start`, `account_login_cancel`, `account_logout`,

{codex_sdk_python-0.87.0 → codex_sdk_python-0.88.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "uv_build"
 
 [project]
 name = "codex-sdk-python"
-version = "0.87.0"
+version = "0.88.0"
 description = "Python SDK for the Codex CLI agent with async threads, streaming events, and structured outputs"
 readme = "README.md"
 license = {text = "Apache-2.0"}

{codex_sdk_python-0.87.0 → codex_sdk_python-0.88.0}/src/codex_sdk/__init__.py

@@ -60,6 +60,7 @@ from .items import (
 from .options import (
     ApprovalMode,
     CodexOptions,
+    ModelPersonality,
     ModelReasoningEffort,
     SandboxMode,
     ThreadOptions,
@@ -76,7 +77,7 @@ from .thread import (
     Turn,
 )
 
-__version__ = "0.87.0"
+__version__ = "0.88.0"
 
 __all__ = [
     "AbortController",
@@ -132,6 +133,7 @@ __all__ = [
     "ApprovalMode",
     "SandboxMode",
     "ModelReasoningEffort",
+    "ModelPersonality",
     "WebSearchMode",
     "CodexError",
     "CodexAbortError",

{codex_sdk_python-0.87.0 → codex_sdk_python-0.88.0}/src/codex_sdk/app_server.py

@@ -614,6 +614,9 @@ class AppServerClient:
             params["limit"] = limit
         return await self._request_dict("model/list", params or None)
 
+    async def collaboration_mode_list(self) -> Dict[str, Any]:
+        return await self._request_dict("collaborationMode/list", {})
+
     async def command_exec(
         self,
         *,

{codex_sdk_python-0.87.0 → codex_sdk_python-0.88.0}/src/codex_sdk/exec.py

@@ -27,7 +27,13 @@ from typing import (
 from .abort import AbortSignal
 from .config_overrides import encode_config_overrides
 from .exceptions import CodexAbortError, CodexCLIError, CodexError
-from .options import ApprovalMode, ModelReasoningEffort, SandboxMode, WebSearchMode
+from .options import (
+    ApprovalMode,
+    ModelPersonality,
+    ModelReasoningEffort,
+    SandboxMode,
+    WebSearchMode,
+)
 from .telemetry import span
 
 INTERNAL_ORIGINATOR_ENV = "CODEX_INTERNAL_ORIGINATOR_OVERRIDE"
@@ -51,6 +57,9 @@ class CodexExecArgs:
     skip_git_repo_check: Optional[bool] = None
     output_schema_file: Optional[str] = None
     model_reasoning_effort: Optional[ModelReasoningEffort] = None
+    model_instructions_file: Optional[Union[str, Path]] = None
+    model_personality: Optional[ModelPersonality] = None
+    max_threads: Optional[int] = None
     network_access_enabled: Optional[bool] = None
     web_search_mode: Optional[WebSearchMode] = None
     web_search_enabled: Optional[bool] = None
@@ -61,6 +70,8 @@ class CodexExecArgs:
     apply_patch_freeform_enabled: Optional[bool] = None
     exec_policy_enabled: Optional[bool] = None
     remote_models_enabled: Optional[bool] = None
+    collaboration_modes_enabled: Optional[bool] = None
+    responses_websockets_enabled: Optional[bool] = None
     request_compression_enabled: Optional[bool] = None
     feature_overrides: Optional[Mapping[str, bool]] = None
     approval_policy: Optional[ApprovalMode] = None
@@ -199,6 +210,23 @@ class CodexExec:
                 ["--config", f'model_reasoning_effort="{args.model_reasoning_effort}"']
             )
 
+        if args.model_instructions_file:
+            instructions_path = str(args.model_instructions_file)
+            command_args.extend(
+                [
+                    "--config",
+                    f"model_instructions_file={json.dumps(instructions_path)}",
+                ]
+            )
+
+        if args.model_personality:
+            command_args.extend(
+                ["--config", f'model_personality="{args.model_personality}"']
+            )
+
+        if args.max_threads is not None:
+            command_args.extend(["--config", f"agents.max_threads={args.max_threads}"])
+
         if args.feature_overrides:
             for key in sorted(args.feature_overrides):
                 enabled = args.feature_overrides[key]
@@ -254,6 +282,18 @@ class CodexExec:
             enabled_str = "true" if args.remote_models_enabled else "false"
             command_args.extend(["--config", f"features.remote_models={enabled_str}"])
 
+        if args.collaboration_modes_enabled is not None:
+            enabled_str = "true" if args.collaboration_modes_enabled else "false"
+            command_args.extend(
+                ["--config", f"features.collaboration_modes={enabled_str}"]
+            )
+
+        if args.responses_websockets_enabled is not None:
+            enabled_str = "true" if args.responses_websockets_enabled else "false"
+            command_args.extend(
+                ["--config", f"features.responses_websockets={enabled_str}"]
+            )
+
         if args.request_compression_enabled is not None:
             enabled_str = "true" if args.request_compression_enabled else "false"
             command_args.extend(

{codex_sdk_python-0.87.0 → codex_sdk_python-0.88.0}/src/codex_sdk/options.py

@@ -3,7 +3,8 @@
 from __future__ import annotations
 
 from dataclasses import dataclass
-from typing import Any, List, Literal, Mapping, Optional
+from pathlib import Path
+from typing import Any, List, Literal, Mapping, Optional, Union
 
 from .abort import AbortSignal
 
@@ -13,6 +14,7 @@ SandboxMode = Literal["read-only", "workspace-write", "danger-full-access"]
 
 ModelReasoningEffort = Literal["minimal", "low", "medium", "high", "xhigh"]
 WebSearchMode = Literal["disabled", "cached", "live"]
+ModelPersonality = Literal["friendly", "pragmatic"]
 
 
 @dataclass
@@ -55,6 +57,9 @@ class ThreadOptions:
         working_directory: Working directory for the thread.
         skip_git_repo_check: Skip Git repository safety check.
         model_reasoning_effort: Model reasoning effort preset.
+        model_instructions_file: Optional path to a file containing model instructions.
+        model_personality: Optional personality preset for the model.
+        max_threads: Maximum number of concurrent threads allowed by the agent.
         network_access_enabled: Enable/disable network access in workspace-write sandbox.
         web_search_mode: Web search mode ("disabled", "cached", or "live").
         web_search_enabled: Enable/disable web search feature.
@@ -65,6 +70,8 @@ class ThreadOptions:
         apply_patch_freeform_enabled: Enable/disable freeform apply_patch tool.
         exec_policy_enabled: Enable/disable exec policy enforcement.
         remote_models_enabled: Enable/disable remote model list refresh.
+        collaboration_modes_enabled: Enable/disable collaboration mode tooling.
+        responses_websockets_enabled: Enable/disable responses websocket transport.
         request_compression_enabled: Enable/disable request body compression.
         feature_overrides: Arbitrary feature flag overrides (key -> bool).
         approval_policy: Approval policy for tool execution.
@@ -88,6 +95,15 @@ class ThreadOptions:
     # Model reasoning effort preset
     model_reasoning_effort: Optional[ModelReasoningEffort] = None
 
+    # Optional path to a file containing model instructions
+    model_instructions_file: Optional[Union[str, Path]] = None
+
+    # Optional personality preset for the model
+    model_personality: Optional[ModelPersonality] = None
+
+    # Maximum number of concurrent threads allowed by the agent
+    max_threads: Optional[int] = None
+
     # Enable/disable network access in workspace-write sandbox
     network_access_enabled: Optional[bool] = None
 
@@ -118,6 +134,12 @@ class ThreadOptions:
     # Enable/disable remote model list refresh
     remote_models_enabled: Optional[bool] = None
 
+    # Enable/disable collaboration mode tooling
+    collaboration_modes_enabled: Optional[bool] = None
+
+    # Enable/disable responses websocket transport
+    responses_websockets_enabled: Optional[bool] = None
+
     # Enable/disable request body compression
     request_compression_enabled: Optional[bool] = None
 

{codex_sdk_python-0.87.0 → codex_sdk_python-0.88.0}/src/codex_sdk/thread.py

@@ -276,6 +276,9 @@ class Thread:
                     skip_git_repo_check=self._thread_options.skip_git_repo_check,
                     output_schema_file=schema_path,
                     model_reasoning_effort=self._thread_options.model_reasoning_effort,
+                    model_instructions_file=self._thread_options.model_instructions_file,
+                    model_personality=self._thread_options.model_personality,
+                    max_threads=self._thread_options.max_threads,
                     network_access_enabled=self._thread_options.network_access_enabled,
                     web_search_mode=self._thread_options.web_search_mode,
                     web_search_enabled=self._thread_options.web_search_enabled,
@@ -286,6 +289,8 @@ class Thread:
                     apply_patch_freeform_enabled=self._thread_options.apply_patch_freeform_enabled,
                     exec_policy_enabled=self._thread_options.exec_policy_enabled,
                     remote_models_enabled=self._thread_options.remote_models_enabled,
+                    collaboration_modes_enabled=self._thread_options.collaboration_modes_enabled,
+                    responses_websockets_enabled=self._thread_options.responses_websockets_enabled,
                     request_compression_enabled=self._thread_options.request_compression_enabled,
                     feature_overrides=self._thread_options.feature_overrides,
                     approval_policy=self._thread_options.approval_policy,