Skip to content

docs: surface venice_parameters on the Chat Completions page#302

Open
sabrinaaquino wants to merge 1 commit into
mainfrom
docs/highlight-venice-parameters
Open

docs: surface venice_parameters on the Chat Completions page#302
sabrinaaquino wants to merge 1 commit into
mainfrom
docs/highlight-venice-parameters

Conversation

@sabrinaaquino

Copy link
Copy Markdown
Contributor

Summary

Addresses feedback that integrators building on Venice often don't realize the API supports Venice-specific parameters (venice_parameters) — they assume it's purely OpenAI-style and walk away missing features like web search, character personas, and system-prompt control.

Adds a prominent callout at the top of the Chat Completions API reference page that:

  • Calls out that venice_parameters is Venice-only and easy to miss
  • Lists the key features it unlocks (web search & citations, character personas, system prompt control, reasoning controls, E2EE)
  • Links to the venice_parameters section on the page

This keeps the OpenAPI spec untouched and simply surfaces the section above the auto-generated body params.

Test plan

  • Open the Chat Completions page on the preview; confirm the callout renders at the top with a distinct background
  • Confirm the venice_parameters links scroll to the section
  • Confirm no MDX/build errors

Integrators frequently miss the Venice-specific venice_parameters object
because it renders as one collapsed item among the OpenAI-compatible body
params. Add a prominent callout at the top of the Chat Completions page that
highlights the key Venice-only features (web search, character personas,
system prompt control, reasoning controls, E2EE) and links to the section.
@mintlify

mintlify Bot commented Jun 23, 2026

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
veniceai 🟢 Ready View Preview Jun 23, 2026, 7:50 PM

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