use-cases/api-integration-migrations.md +82 −0 added
1# Upgrade your API integration | Codex use cases
2
3[← All use cases](https://developers.openai.com/codex/use-cases)
4
5Use Codex to update your existing OpenAI API integration to the latest recommended models and API features, while checking for regressions before you ship.
6
7Intermediate
8
91h
10
11Related links
12
13[Latest model guide](https://developers.openai.com/api/docs/guides/latest-model) [Prompt guidance](https://developers.openai.com/api/docs/guides/prompt-guidance) [OpenAI Docs MCP](/learn/docs-mcp) [Evals guide](https://developers.openai.com/api/docs/guides/evals)
14
15## Best for
16
17 - Teams upgrading from older models or API surfaces
18 - Repos that need behavior-preserving migrations with explicit validation
19
20## Skills & Plugins
21
22- [OpenAI Docs](https://github.com/openai/skills/tree/main/skills/.curated/openai-docs)
23
24 Pull the current model, migration, and API guidance before Codex makes edits to your implementation.
25
26## Starter prompt
27
28Use $openai-docs to upgrade this OpenAI integration to the latest recommended model and API features.
29Specifically, look for the latest model and prompt guidance for this specific model.
30 Requirements:
31- Start by inventorying the current models, endpoints, and tool assumptions in the repo.
32- Identify the smallest migration plan that gets us onto the latest supported path.
33 - Preserve behavior unless a change is required by the new API or model.
34 - Update prompts using the latest model prompt guidance.
35- Call out any prompt, tool, or response-shape changes we need to review manually.
36
37## Introduction
38
39As we release new models and API features, we recommend upgrading your integration to benefit from the latest improvements.
40Changing from one model to another is often not as simple as just updating the model name.
41
42There might be changes to the API–for example, for the GPT-5.4 model, we added a new `phase` parameter to the assistant message that is important to include in your integration–but most importantly, model behavior can be different and require changes to your existing prompts.
43
44When migrating to a new model, you should make sure to not only make the necessary code changes, but also evaluate the impact on your workflows.
45
46## Leverage the OpenAI Docs skill
47
48All the specifics about the new API features and model behavior are documented in our docs, in the [latest model](https://developers.openai.com/api/docs/guides/latest-model) and [prompt guidance](https://developers.openai.com/api/docs/guides/prompt-guidance) guides.
49
50The OpenAI Docs skill also includes [specific guidance](https://github.com/openai/codex/blob/6323f0104d17d211029faab149231ba787f7da37/codex-rs/skills/src/assets/samples/openai-docs/references/upgrading-to-gpt-5p4.md) as reference, codifying how to upgrade to the latest model–currently [GPT-5.4](https://developers.openai.com/api/docs/models/gpt-5.4).
51
52Codex now automatically comes with the OpenAI Docs skill, so make sure to mention it in your prompt to access all the latest documentation and guidance when building with the OpenAI API.
53
54## Build a robust evals pipeline
55
56Codex can automatically update your prompts based on the latest prompt guidance, but you should have a way to automate verifying your integration is working as expected.
57
58Make sure to build an evals pipeline that you can run every time you make changes to your integration, to verify there is no regression in behavior.
59
60This [cookbook guide](https://developers.openai.com/cookbook/examples/evaluation/building_resilient_prompts_using_an_evaluation_flywheel) covers in detail how to do this using our [Evals API](https://developers.openai.com/api/docs/guides/evals).
61
62## Related use cases
63
64[
65
66### Create browser-based games
67
68Use Codex to turn a game brief into first a well-defined plan, and then a real browser-based...
69
70Engineering Code](https://developers.openai.com/codex/use-cases/browser-games)[
71
72### Bring your app to ChatGPT
73
74Build one narrow ChatGPT app outcome end to end: define the tools, scaffold the MCP server...
75
76Integrations Code](https://developers.openai.com/codex/use-cases/chatgpt-apps)[
77
78### Build for iOS and macOS
79
80Use Codex to scaffold SwiftUI projects, keep the build loop CLI-first with `xcodebuild` or...
81
82Mobile Code](https://developers.openai.com/codex/use-cases/native-ios-macos-apps)