[AIG]Websockets Docs

[daisyfaithauma]

Summary

• New docs for websockets

Screenshots (optional)

Documentation checklist

• The documentation style guide has been adhered to.
• If a larger change - such as adding a new page- an issue has been opened in relation to any incorrect or out of date information that this PR fixes.
• Files which have changed name or location have been allocated redirects.

[hyperlint-ai]

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

Introduced new documentation for the WebSockets API, including both non-realtime and realtime categories.

• Added new documentation for the WebSockets API.
• Renamed the existing non-realtime WebSockets API documentation.
• Introduced a new section for realtime WebSockets API with examples and supported providers.

Added Files

• src/content/docs/ai-gateway/configuration/websockets-api/index.mdx
• src/content/docs/ai-gateway/configuration/websockets-api/realtime-api.mdx

Renamed Files

• src/content/docs/ai-gateway/configuration/websockets-api/non-realtime-api.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.

What is Hyperlint?

Hyperlint is an AI agent that helps you write, edit, and maintain your documentation.

Learn more about the Hyperlint AI reviewer and the checks that we can run on your documentation.

[github-actions]

This PR changes current filenames or deletes current files. Make sure you have redirects set up to cover the following paths:

• /ai-gateway/configuration/websockets-api/

[github-actions]

Preview URL: https://bbc92ce7.preview.developers.cloudflare.com
Preview Branch URL: https://websockets-new.preview.developers.cloudflare.com

Files with changes (up to 15)

Original Link	Updated Link
https://developers.cloudflare.com/ai-gateway/configuration/websockets-api/realtime-api/	https://websockets-new.preview.developers.cloudflare.com/ai-gateway/configuration/websockets-api/realtime-api/
https://developers.cloudflare.com/ai-gateway/configuration/websockets-api/	https://websockets-new.preview.developers.cloudflare.com/ai-gateway/configuration/websockets-api/
https://developers.cloudflare.com/ai-gateway/configuration/websockets-api/non-realtime-api/	https://websockets-new.preview.developers.cloudflare.com/ai-gateway/configuration/websockets-api/non-realtime-api/

[kathayl]

• switch to have realtime before non-realtime
• changelog entry (the one in ai gateway, not changelog next)
• can we keep the "when to use websockets" https://developers.cloudflare.com/ai-gateway/configuration/websockets-api/#when-to-use-websockets and "key benefits" https://developers.cloudflare.com/ai-gateway/configuration/websockets-api/#key-benefits in the overview page
• from the overview page table, in the box that says "Limited to providers offering real-time WebSocket APIs.". Is it possible to link that to the supported providers section of the real-time page?