From fd09021e497b38dc6537f191b6757e68822bf45c Mon Sep 17 00:00:00 2001 From: Andrey Mishchenko Date: Sun, 19 Apr 2026 17:36:18 -0700 Subject: [PATCH] Add tldr docs for responses-api-proxy (#18604) --- codex-rs/responses-api-proxy/README.md | 28 ++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) diff --git a/codex-rs/responses-api-proxy/README.md b/codex-rs/responses-api-proxy/README.md index 4b6f4da01..610559244 100644 --- a/codex-rs/responses-api-proxy/README.md +++ b/codex-rs/responses-api-proxy/README.md @@ -1,5 +1,33 @@ # codex-responses-api-proxy +#### tl;dr: + +``` +# Launch the proxy, dump request/response pairs to /tmp/proxy +cd path/to/codex/codex-rs +cargo build +echo $OPENAI_API_KEY | ./target/debug/codex-responses-api-proxy \ + --port 60001 \ + --dump-dir /tmp/proxy + + +# Add this to ~/.codex/config.toml: + +[model_providers.codex-responses-api-proxy] +name = 'codex-responses-api-proxy' +base_url = 'http://127.0.0.1:60001/v1' +wire_api='responses' + +[profiles.proxy] +model_provider = "codex-responses-api-proxy" + + +# Use it +codex -p proxy +``` + +# Detailed docs + A strict HTTP proxy that only forwards `POST` requests to `/v1/responses` to the OpenAI API (`https://api.openai.com`), injecting the `Authorization: Bearer $OPENAI_API_KEY` header. Everything else is rejected with `403 Forbidden`. ## Expected Usage