docs: add Neon AI Gateway integration guide - #5736
Open
mezotv wants to merge 1 commit into
Open
Conversation
|
@mezotv is attempting to deploy a commit to the Helicone Team on Vercel. A member of the Team first needs to authorize it. |
mezotv
marked this pull request as ready for review
July 26, 2026 18:02
Contributor
There was a problem hiding this comment.
Your trial has ended. Reactivate Greptile to resume code reviews.
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
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.
Ticket
No ticket. Opening this directly as a documentation contribution, per
CONTRIBUTING_GUIDELINES.md(GitHub Flow, all changes via pull request).Component/Service
What part of Helicone does this affect?
Type of Change
Deployment Notes
Context
Neon AI Gateway is an OpenAI-compatible inference endpoint provided by Neon, currently in beta. There is no page in the docs today explaining how to get those requests into Helicone, and the obvious first guess (look for Neon in the AI Gateway model registry) does not work, because Neon is not a registered provider there.
This adds one page that answers the question directly: use the generic Helicone Gateway proxy and name the Neon branch host in
Helicone-Target-Url, which is the mechanismgetting-started/integration-method/gateway.mdxalready documents for any OpenAI-compatible host. The page says up front that the model-registry path is not available, so a reader does not go looking for it.Nothing in the AI Gateway model registry is touched. There are no changes under
packages/cost, no new provider entry, and no claim that Neon is natively supported.Changes
Insertion-only, two files, 131 additions and 0 deletions:
docs/getting-started/integration-method/neon.mdx(new, 130 lines) — Steps walkthrough, cURL / Node.js / Python examples, rate-limit and cost sections.docs/docs.json(+1 line) — one nav entry,"getting-started/integration-method/neon", placed alphabetically betweennebiusandnovita.Every host, key, and token in the examples is an explicit placeholder (
https://<your-neon-branch-host>,<your-helicone-api-key>). No real hostnames or credentials appear anywhere in the diff.Limitations documented on the page
The page states the constraints of this integration rather than only the happy path:
gateway.mdx#approved-domainsand points readers at engineering@helicone.ai / Discord to get a domain approved.GET /v1/models. It makes no tool-calling, structured-output, embeddings, image, or audio claim.Known gap a reviewer may want closed
Neon translates its
gemini-*models into a Gemini request shape that has nostream_optionsfield, so a caller who enables usage reporting in the stream against agemini-model will get a400back from Neon. Helicone is a pass-through proxy here and none of the page's own examples setstream_options, so nothing on the page is wrong as written, butgemini-3-flashdoes appear in the model-ID list. Happy to add a one-line note about it if you would like it called out.Separately, the page does not import
/snippets/legacy-provider-warning.mdx, which 23 of the 33 pages ingetting-started/integration-method/do include. That looked deliberate rather than an oversight: the warning tells readers to switch to the AI Gateway, and the AI Gateway is exactly the path that is not available for Neon. The generic-method pages (gateway,custom, the manual loggers) also omit it. Glad to add it if you would rather every provider page carry it.Checks run
Run locally with the repo's own pinned Mintlify CLI against
docs/:mint validate(strict build validation). Exits 1 with 3 warnings, allCould not find file /snippets/generate-key.mdxfromintegrations/{llama,nvidia,xai}/javascript.mdx. Verified identical on unmodifiedmain, so this branch introduces no new warnings. Neither log mentions the new page.mint broken-linkscannot complete on this repo, before or after this change: it aborts withSyntax error - Unable to parse guides/cookbooks/cost-tracking.mdx - URIError: URI malformed. Reproduced on unmodifiedmain, so it is pre-existing and unrelated. Flagging it since it may be worth a separate fix.gateway.mdx,gateway/overview.mdx,manual-logger-typescript.mdx), and the#approved-domainsanchor exists ingateway.mdx. All 8 external documentation links return200.docs.jsonparses as JSON, and the new nav entry appears exactly once.bashblocks passbash -n, the Python block compiles, MDX frontmatter parses, code fences are even, andNote/Steps/Step/Tabs/Tab/Infoall balance.Helicone-Target-Urlmechanism, and the 24-hour mapper job all come fromgateway.mdx. Neon's absence from the model registry was confirmed againstpackages/cost.Disclosure
The examples on this page have not been executed end to end against a live Neon branch. The Helicone-side behaviour is taken from this repository's own documentation, and the Neon-side details from Neon's published documentation. Everything that could be checked statically is listed above; the request path itself is unverified, so please treat the snippets as needing a maintainer's eye.
Opening as a draft. Happy to adjust placement, wording, or the two open items above.