use-cases/api-integration-migrations.md Codex Docs, 2026-04-15 06:44 UTC → 2026-05-07 20:02 UTC

1# Upgrade your API integration | Codex use cases1---

2 2name: Upgrade your API integration

3[← All use cases](https://developers.openai.com/codex/use-cases)3tagline: Upgrade your app to the latest OpenAI API models.

4 4summary: Use Codex to update your existing OpenAI API integration to the latest

5Copy page [Export as PDF](https://developers.openai.com/codex/use-cases/api-integration-migrations/?export=pdf)5 recommended models and API features, while checking for regressions before you

6 6 ship.

7Use Codex to update your existing OpenAI API integration to the latest recommended models and API features, while checking for regressions before you ship.7skills:

8 8 - token: $openai-docs

9Intermediate9 url: https://github.com/openai/skills/tree/main/skills/.curated/openai-docs

10 10 description: Pull the current model, migration, and API guidance before Codex

111h11 makes edits to your implementation.

12 12bestFor:

13Related links

14 

15[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)

16 

17## Best for

18 

19 - Teams upgrading from older models or API surfaces13 - Teams upgrading from older models or API surfaces

20 - Repos that need behavior-preserving migrations with explicit validation14 - Repos that need behavior-preserving migrations with explicit validation

15starterPrompt:

16 title: Upgrade the Integration Safely

17 body: >-

18 Use $openai-docs to upgrade this OpenAI integration to the latest

19 recommended model and API features.

21 20 

22## Skills & Plugins

23 21 

24- [OpenAI Docs](https://github.com/openai/skills/tree/main/skills/.curated/openai-docs)22 Specifically, look for the latest model and prompt guidance for this

23 specific model.

25 24 

26 Pull the current model, migration, and API guidance before Codex makes edits to your implementation.

27 25 

28| Skill | Why use it |26 Requirements:

29| --- | --- |

30| [OpenAI Docs](https://github.com/openai/skills/tree/main/skills/.curated/openai-docs) | Pull the current model, migration, and API guidance before Codex makes edits to your implementation. |

31 27 

32## Starter prompt28 - Start by inventorying the current models, endpoints, and tool assumptions

29 in the repo.

33 30 

34Use $openai-docs to upgrade this OpenAI integration to the latest recommended model and API features.31 - Identify the smallest migration plan that gets us onto the latest

35Specifically, look for the latest model and prompt guidance for this specific model.32 supported path.

36 Requirements:

37- Start by inventorying the current models, endpoints, and tool assumptions in the repo.

38- Identify the smallest migration plan that gets us onto the latest supported path.

39 - Preserve behavior unless a change is required by the new API or model.

40 - Update prompts using the latest model prompt guidance.

41- Call out any prompt, tool, or response-shape changes we need to review manually.

42 33 

43Use $openai-docs to upgrade this OpenAI integration to the latest recommended model and API features.

44Specifically, look for the latest model and prompt guidance for this specific model.

45 Requirements:

46- Start by inventorying the current models, endpoints, and tool assumptions in the repo.

47- Identify the smallest migration plan that gets us onto the latest supported path.

48 - Preserve behavior unless a change is required by the new API or model.34 - Preserve behavior unless a change is required by the new API or model.

35 

49 - Update prompts using the latest model prompt guidance. 36 - Update prompts using the latest model prompt guidance.

50- Call out any prompt, tool, or response-shape changes we need to review manually.37 

38 - Call out any prompt, tool, or response-shape changes we need to review

39 manually.

40relatedLinks:

41 - label: Latest model guide

42 url: /api/docs/guides/latest-model

43 - label: Prompt guidance

44 url: /api/docs/guides/prompt-guidance

45 - label: OpenAI Docs MCP

46 url: /learn/docs-mcp

47 - label: Evals guide

48 url: /api/docs/guides/evals

49---

51 50 

52## Introduction51## Introduction

53 52 

73Make 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.72Make 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.

74 73 

75This [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).74This [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).

76 

77## Related use cases

78 

79[![](/images/codex/codex-wallpaper-2.webp)

80 

81### Add Mac telemetry

82 

83Use Codex and the Build macOS Apps plugin to add a few high-signal `Logger` events around...

84 

85macOS Code](https://developers.openai.com/codex/use-cases/macos-telemetry-logs)[![](/images/codex/codex-wallpaper-2.webp)

86 

87### Create a CLI Codex can use

88 

89Ask Codex to create a composable CLI it can run from any folder, combine with repo scripts...

90 

91Engineering Code](https://developers.openai.com/codex/use-cases/agent-friendly-clis)[![](/images/codex/codex-wallpaper-1.webp)

92 

93### Create browser-based games

94 

95Use Codex to turn a game brief into first a well-defined plan, and then a real browser-based...

96 

97Engineering Code](https://developers.openai.com/codex/use-cases/browser-games)