Skip to content

[Docs] Document the Use Responses API option for OpenAI Compatible providers - #72

Draft
zoomote2[bot] wants to merge 1 commit into
mainfrom
fix/openai-compatible-responses-api-1ybm193i5siuq
Draft

zoomote2[bot] wants to merge 1 commit into
mainfrom
fix/openai-compatible-responses-api-1ybm193i5siuq

Conversation

@zoomote2

@zoomote2 zoomote2 Bot commented Nov 18, 2026

Copy link
Copy Markdown

​Opened on behalf of @taltas. Follow up by mentioning @roomote, in the web UI, or in Discord.

What changed

The OpenAI Compatible provider page gains a Responses API section. It explains the new Use Responses API setting: requests go to <Base URL>/responses instead of /chat/completions, the configured reasoning effort is sent as reasoning: { effort: ... }, and reasoning works together with native tool calling. The troubleshooting section gains an entry for the 400 "Function tools with reasoning_effort are not supported" error that points to the new section.

Why this change was made

The main Zoo Code repository adds the Use Responses API setting in a paired PR. Endpoints such as Azure OpenAI deployments of GPT-6.1 Terra behind a corporate gateway require the Responses API to combine reasoning with tool use. Users need documentation for when and why to enable the option.

Impact

Documentation-only change. Readers of the OpenAI Compatible provider page can now discover the setting and self-serve the fix for the 400 error. No product behavior changes.

Screenshots

The setting this page documents (from the paired Zoo Code PR):

New "Use Responses API" checkbox in the OpenAI Compatible provider settings

Related PRs

Validated with pnpm run check-types in this repository.

…patible

Explain when to enable the option (endpoints that require /v1/responses
to combine reasoning with tool use, such as Azure OpenAI deployments of
GPT-6.1 Terra) and add a troubleshooting entry for the 400
reasoning_effort error.
@zoomote2

zoomote2 Bot commented Nov 18, 2026 •

Copy link
Copy Markdown
Author

2 documentation accuracy issues outstanding. See session

  • docs/providers/openai-compatible.md:133 — Qualify the setting as applying to task/conversation requests; single completions still use Chat Completions. Review comment
  • docs/providers/openai-compatible.md:142 — Reconcile the Responses API section with the page's Extra Body guarantee; the paired implementation does not apply Extra Body in this mode. Review comment

Reviewed 6843e25


## Responses API

By default, the OpenAI Compatible provider sends requests to the Chat Completions endpoint (`/chat/completions`). Enable **Use Responses API** in the provider settings to send requests to the Responses endpoint (`/responses`) instead.

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This overstates the setting's scope. The paired implementation only routes createMessage() through Responses; completePrompt() still calls Chat Completions for prompt enhancement and task-title generation. Please qualify this as task/conversation requests rather than all provider requests.

To use function tools, use /v1/responses or set reasoning_effort to 'none'.
```

With **Use Responses API** enabled:

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This mode also needs an Extra Body caveat or corresponding implementation support. The paired handleResponsesApiMessage() never applies withExtraBody(), but this page says Extra Body fields are added to streaming requests. Users whose gateway requires those fields would otherwise expect them to be sent with Responses API requests.

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant