[Docs] Explain OpenAI-compatible custom request fields - #46
Open
zoomote[bot] wants to merge 2 commits into
Open
Conversation
edelauna
marked this pull request as ready for review
August 28, 2026 01:14
edelauna
requested review from
JamesRobert20,
edelauna,
hannesrudolph,
navedmerchant and
taltas
as code owners
August 28, 2026 01:14
Author
|
1 documentation mismatch outstanding.
Reviewed ee6316e |
![zoomote[bot]](https://avatars.githubusercontent.com/u/278826416?s=60&v=4){kind=small}
|
|
||
| Zoo Code validates the JSON before saving the provider profile and adds the fields to streaming, non-streaming, and single-completion requests. The top-level value must be an object. | ||
|
|
||
| Extra Body cannot override fields managed by Zoo Code, including the model, messages, streaming mode, tools, reasoning settings, temperature, and token limits. Use the corresponding Zoo Code setting for those fields. Do not put API keys or other secrets in Extra Body because provider profiles can be exported. |
Author
There was a problem hiding this comment.
PR #1350 now also protects response_format, but this list omits it and the next sentence implies every protected field has a corresponding Zoo Code setting. Please include response format and qualify the guidance (for example, use Zoo Code’s normal controls where available), since no direct setting exists for every reserved field.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What changed
The OpenAI-compatible provider guide now documents the Extra Body setting, includes a Sail Research
metadata.completion_windowexample, explains protected fields and profile-export security, and shows the complete unclipped VS Code settings control.Why this change was made
Users need a concrete, provider-focused example for configuring custom request-body fields without relying on a proxy or mistaking them for HTTP headers.
Impact
OpenAI-compatible provider users can follow a complete setup example for custom request metadata and understand the validation and security boundaries before saving a profile.
Related PRs