Skip to content

sdk(python): add support for client_request_id -> X-Client-Request-Id #2738

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

sdk(python): add support for client_request_id -> X-Client-Request-Id #2738

wants to merge 1 commit into from
+54 −2

Conversation

@arvindg-openai
Copy link

@arvindg-openai arvindg-openai commented Nov 7, 2025

Changes being requested

  • Forward any provided client_request_id as the X-Client-Request-Id header in _build_headers.
  • Allow FinalRequestOptions/RequestOptions to carry the optional ID and thread it through make_request_options.
  • Add unit coverage in tests/test_client.py for presence/absence of the header.
  • Document usage in the README and bump the package version to 2.7.2.

Additional context & links

Testing

  • pytest -o addopts='' tests/test_client.py -k client_request_id
@arvindg-openai arvindg-openai requested a review from a team as a code owner November 7, 2025 15:46
@arvindg-openai
Copy link
Author

arvindg-openai commented Nov 7, 2025

Looks like the examples GitHub Action tried to run examples/demo.py, but on forked repos that workflow doesn’t get the OPENAI_API_KEY secret. Without that key, the script sends an unauthenticated request and immediately hits a 401 (openai.AuthenticationError: "You didn't provide an API key"), so the job exits with code 1.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

1 participant

@arvindg-openai