-
Notifications
You must be signed in to change notification settings - Fork 14.9k
Add Codex AI Gateway integration docs #31308
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
elithrar
wants to merge
1
commit into
production
Choose a base branch
from
docs/openai-codex-ai-gateway
base: production
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+27
−0
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| @@ -0,0 +1,27 @@ | ||||||||||
| --- | ||||||||||
| title: OpenAI Codex | ||||||||||
| description: Configure OpenAI Codex to send model requests through Cloudflare AI Gateway. | ||||||||||
| pcx_content_type: configuration | ||||||||||
| sidebar: | ||||||||||
| order: 4 | ||||||||||
| products: | ||||||||||
| - ai-gateway | ||||||||||
| --- | ||||||||||
|
|
||||||||||
| [OpenAI Codex](https://developers.openai.com/codex/) supports [custom model providers](https://developers.openai.com/codex/config-advanced#custom-model-providers) in its local configuration file. | ||||||||||
|
|
||||||||||
| Add the provider configuration to your user config at `~/.codex/config.toml`. Codex can also load project-scoped files from `.codex/config.toml`, but provider settings such as `model_provider` and `model_providers` must be configured in the user-level config. Refer to the Codex docs for [config and state locations](https://developers.openai.com/codex/config-advanced#config-and-state-locations). | ||||||||||
|
|
||||||||||
| You need your Cloudflare Account ID and AI Gateway ID from the [AI Gateway dashboard](https://dash.cloudflare.com/?to=/:account/ai/ai-gateway), plus a [Cloudflare API token](/fundamentals/api/get-started/create-token/) with access to AI Gateway. | ||||||||||
|
|
||||||||||
| ```toml | ||||||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Add a heading before the code block for structure.
Suggested change
|
||||||||||
| model = "openai/gpt-5.5" | ||||||||||
| model_provider = "cloudflare-ai-gateway" | ||||||||||
|
|
||||||||||
| [model_providers.cloudflare-ai-gateway] | ||||||||||
| name = "Cloudflare AI Gateway" | ||||||||||
| base_url = "https://api.cloudflare.com/client/v4/accounts/<account_id>/ai/v1" | ||||||||||
| wire_api = "responses" | ||||||||||
| env_key = "CLOUDFLARE_API_TOKEN" | ||||||||||
| http_headers = { "cf-aig-gateway-id" = "<gateway_id>" } | ||||||||||
| ``` | ||||||||||
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This
orderconflicts withaig-workers-ai-binding.mdx(alsoorder: 4).