z-node / docs

← Docs index

Codex CLI

Setup guide for using Z-Node with Codex CLI.

Official docs

Start with Codex CLI's official custom model provider and sample config docs. They document the config.toml provider shape, profile overrides, manual model metadata, and WebSocket toggle:

Z-Node example (~/.codex/config.toml)

Copy this into ~/.codex/config.toml. This follows Codex CLI's custom provider shape, defaults to gpt-5.5, and includes profile-scoped metadata for every Z-Node model with verified official limits:

toml
model = "gpt-5.5"
model_provider = "znode"
model_context_window = 1050000
model_max_output_tokens = 128000
model_auto_compact_token_limit = 840000

[model_providers.znode]
name = "Z-Node"
base_url = "https://api.z-node.com/v1"
env_key = "ZNODE_ISSUED_API_KEY"
wire_api = "responses"
supports_websockets = false

[profiles."gpt-5.5"]
model = "gpt-5.5"
model_provider = "znode"
model_context_window = 1050000
model_max_output_tokens = 128000
model_auto_compact_token_limit = 840000

[profiles."gpt-5.4"]
model = "gpt-5.4"
model_provider = "znode"
model_context_window = 1050000
model_max_output_tokens = 128000
model_auto_compact_token_limit = 840000

[profiles."gpt-5.4-mini"]
model = "gpt-5.4-mini"
model_provider = "znode"
model_context_window = 400000
model_max_output_tokens = 128000
model_auto_compact_token_limit = 320000

[profiles."gpt-5.3-codex"]
model = "gpt-5.3-codex"
model_provider = "znode"
model_context_window = 400000
model_max_output_tokens = 128000
model_auto_compact_token_limit = 320000

[profiles."gpt-5.2"]
model = "gpt-5.2"
model_provider = "znode"
model_context_window = 400000
model_max_output_tokens = 128000
model_auto_compact_token_limit = 320000

[profiles."codex-auto-review"]
model = "codex-auto-review"
model_provider = "znode"

Keep supports_websockets = false for this boundary path. The failure shape we observed was a 403/challenge on the websocket path.

Acceptable Z-Node model ids

Smoke test

bash
ZNODE_ISSUED_API_KEY="$ZNODE_ISSUED_API_KEY" codex exec --sandbox read-only --skip-git-repo-check "Reply with exactly: Z-NODE-CODEX-OK"

To use a non-default model, run the same smoke test with --profile gpt-5.4, --profile gpt-5.4-mini, --profile gpt-5.3-codex, --profile gpt-5.2, or --profile codex-auto-review.