1- # codex-app-server-client
1+ # codex-app-server-sdk
22
33High-level async Python client for ` codex app-server ` .
44
@@ -47,7 +47,7 @@ uv pip install codex-app-server-sdk
4747
4848``` python
4949import asyncio
50- from codex_app_server_client import CodexClient
50+ from codex_app_server_sdk import CodexClient
5151
5252
5353async def main () -> None :
@@ -70,7 +70,7 @@ You can override via:
7070
7171``` python
7272import asyncio
73- from codex_app_server_client import CodexClient
73+ from codex_app_server_sdk import CodexClient
7474
7575
7676async def main () -> None :
@@ -92,7 +92,7 @@ Both high-level APIs support resuming the same running turn.
9292
9393``` python
9494import asyncio
95- from codex_app_server_client import CodexClient, CodexTurnInactiveError
95+ from codex_app_server_sdk import CodexClient, CodexTurnInactiveError
9696
9797
9898async def main () -> None :
@@ -128,7 +128,7 @@ Use explicit thread handles when you need thread-scoped configuration.
128128
129129``` python
130130import asyncio
131- from codex_app_server_client import CodexClient, ThreadConfig, TurnOverrides
131+ from codex_app_server_sdk import CodexClient, ThreadConfig, TurnOverrides
132132
133133
134134async def main () -> None :
@@ -176,7 +176,7 @@ asyncio.run(main())
176176Example:
177177
178178``` python
179- from codex_app_server_client import ThreadConfig, UNSET
179+ from codex_app_server_sdk import ThreadConfig, UNSET
180180
181181cfg = ThreadConfig(
182182 model = UNSET , # omit key
@@ -376,7 +376,7 @@ uv run python examples/chat_session_websocket.py
376376
377377## API reference (quick)
378378
379- ### ` CodexClient ` (` src/codex_app_server_client /client.py ` )
379+ ### ` CodexClient ` (` src/codex_app_server_sdk /client.py ` )
380380
381381- ` connect_stdio(...) ` : create a stdio-configured client (unstarted).
382382- ` connect_websocket(...) ` : create a websocket-configured client (unstarted).
@@ -404,13 +404,13 @@ uv run python examples/chat_session_websocket.py
404404- ` interrupt_turn(turn_id, timeout=None) ` : low-level turn interruption request.
405405- ` close() ` : cancel receive loop and close transport.
406406
407- ### ` Transport ` and implementations (` src/codex_app_server_client /transport.py ` )
407+ ### ` Transport ` and implementations (` src/codex_app_server_sdk /transport.py ` )
408408
409409- ` Transport.connect/send/recv/close ` : abstract interface.
410410- ` StdioTransport ` : line-delimited JSON over subprocess stdin/stdout.
411411- ` WebSocketTransport ` : JSON messages over websocket frames.
412412
413- ### Data models (` src/codex_app_server_client /models.py ` )
413+ ### Data models (` src/codex_app_server_sdk /models.py ` )
414414
415415- ` InitializeResult ` : parsed initialize response (` protocol_version ` , ` server_info ` , ` capabilities ` , ` raw ` ).
416416- ` ConversationStep ` : completed step from ` chat(...) ` (` step_type ` , ` item_type ` , ` text ` , ` item_id ` , ` thread_id ` , ` turn_id ` , ` data ` ).
@@ -422,7 +422,7 @@ uv run python examples/chat_session_websocket.py
422422- ` UNSET ` : sentinel for “omit this field from request payload.”
423423- ` ApprovalPolicy ` : literal type for approval policy values (` untrusted ` , ` on-failure ` , ` on-request ` , ` never ` ).
424424
425- ### ` ThreadHandle ` (` src/codex_app_server_client /client.py ` )
425+ ### ` ThreadHandle ` (` src/codex_app_server_sdk /client.py ` )
426426
427427- ` thread_id ` : bound thread id.
428428- ` defaults ` : local thread config snapshot.
@@ -434,7 +434,7 @@ uv run python examples/chat_session_websocket.py
434434- ` set_name(name) ` , ` archive() ` , ` unarchive() ` , ` rollback(num_turns) ` , ` compact() ` : thread lifecycle/history helpers.
435435- ` start_review(target, delivery=None) ` : thread-bound review API.
436436
437- ### Exceptions (` src/codex_app_server_client /errors.py ` )
437+ ### Exceptions (` src/codex_app_server_sdk /errors.py ` )
438438
439439- ` CodexError ` : base exception.
440440- ` CodexTransportError ` : transport/connectivity problems.
@@ -475,7 +475,7 @@ When `params=None`, the client sends:
475475{
476476 "protocolVersion" : " 1" ,
477477 "clientInfo" : {
478- "name" : " codex-app-server-client " ,
478+ "name" : " codex-app-server-sdk " ,
479479 "version" : " 0.1.0"
480480 },
481481 "capabilities" : {
@@ -520,7 +520,7 @@ Merge rules:
520520
521521``` python
522522import asyncio
523- from codex_app_server_client import CodexClient
523+ from codex_app_server_sdk import CodexClient
524524
525525
526526async def main () -> None :
0 commit comments