Repository navigation
Expose x-request-id in SSE streaming responses for Java SDK聽#593
Description
Description
We need access to the x-request-id header to debug API requests with the OpenAI team, as described in the official docs:
馃憠 https://platform.openai.com/docs/api-reference/debugging-requests
Although x-request-id can be obtained when using:
OpenAIClientAsync.withRawResponse()We are using SSE streaming in our project, below is example code:
OpenAIClientAsync currentClient = OpenAIOkHttpClientAsync.builder().build();
currentClient.responses().createStreaming(params)
.subscribe(event -> {
// business logic
})
.onCompleteFuture()
.thenAccept(result -> {
// handle completion
})
.exceptionally(ex -> {
// handle error
return null;
});Feature request
Please provide a way to access the x-request-id header in SSE streaming responses (e.g., via callback, metadata, or event property).
This would make debugging and support much easier without requiring a full switch to withRawResponse().
Activity
bhawnapannu2701 commentedon Sep 3, 2025
Hi! I鈥檇 like to pick this up.
Plan: capture the initial OkHttp Response during SSE start, expose
x-request-idvia a new optional accessor on the stream/event surface, and add MockWebServer tests (header present/absent). This will be an additive, non-breaking change.If this scope/layer is acceptable, I鈥檒l open a PR with tests and docs.
TomerAberbach commentedon Sep 3, 2025
I think you won't want to start at the OkHttp layer. We expose the method for this here so you should be able to grab it from that.
I think it'd probably make sense to include the
requestIdmethod on theStreamResponseandAsyncStreamResponseinterfaces (the event object seems wrong because the request ID is associated with the response, not each event)So then people could do this:
If that all sounds good, then feel free to work on!