Skip to content

Conversation

@imcfadyen-cf
Copy link
Contributor

Summary

Originally reported by a user on the Discord (https://discord.com/channels/595317990191398933/1154819662161395742/1379844865202065631).

The OpenAI SDK automatically adds /chat/completions to the end of the URL, and adding it yourself (so it's duplicated) causes the SDK to throw an internal error.

This PR just removes /chat/completions from the SDK example in the docs (it's kept for cURL because it's still required) and adds a comment explaining why the user shouldn't add it themselves.

Documentation checklist

@imcfadyen-cf imcfadyen-cf requested review from a team, kathayl, kodster28 and mchenco as code owners June 4, 2025 15:58
Copy link
Contributor

@windsurf-bot windsurf-bot bot left a comment

Choose a reason for hiding this comment

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

Looks good to me 🤙

💡 To request another review, post a new comment with "/windsurf-review".

@hyperlint-ai
Copy link
Contributor

hyperlint-ai bot commented Jun 4, 2025

Howdy and thanks for contributing to our repo. The Cloudflare team reviews new, external PRs within two (2) weeks. If it's been two weeks or longer without any movement, please tag the PR Assignees in a comment.

We review internal PRs within 1 week. If it's something urgent or has been sitting without a comment, start a thread in the Developer Docs space internally.


PR Change Summary

Fixed the OpenAI SDK example in the documentation to prevent internal errors caused by URL duplication.

  • Removed duplicate '/chat/completions' from the OpenAI SDK example URL in the docs.
  • Added a comment explaining the automatic addition of '/chat/completions' by the SDK.

Modified Files

  • src/content/docs/ai-gateway/chat-completion.mdx

How can I customize these reviews?

Check out the Hyperlint AI Reviewer docs for more information on how to customize the review.

If you just want to ignore it on this PR, you can add the hyperlint-ignore label to the PR. Future changes won't trigger a Hyperlint review.

Note specifically for link checks, we only check the first 30 links in a file and we cache the results for several hours (for instance, if you just added a page, you might experience this). Our recommendation is to add hyperlint-ignore to the PR to ignore the link check for this PR.

@github-actions github-actions bot added the product:ai-gateway AI Gateway: https://developers.cloudflare.com/ai-gateway/ label Jun 4, 2025
@kodster28 kodster28 merged commit dbe3958 into cloudflare:production Jun 4, 2025
6 checks passed
@workers-devprod workers-devprod added the contribution [Holopin] Recognizes a docs contribution, big or small label Jun 4, 2025
@holopin-bot
Copy link

holopin-bot bot commented Jun 4, 2025

Congratulations @imcfadyen-cf, the maintainer of this repository has issued you a holobyte! Here it is: https://holopin.io/holobyte/cmbi7h108257707kwys4dac94

This badge can only be claimed by you, so make sure that your GitHub account is linked to your Holopin account. You can manage those preferences here: https://holopin.io/account.
Or if you're new to Holopin, you can simply sign up with GitHub, which will do the trick!

sdnts pushed a commit to sdnts/cloudflare-docs that referenced this pull request Jul 24, 2025
* Update chat-completion.mdx

* Fix typo
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

contribution [Holopin] Recognizes a docs contribution, big or small product:ai-gateway AI Gateway: https://developers.cloudflare.com/ai-gateway/ size/xs

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants