diff --git a/sources/platform/integrations/ai/codex/_category_.yml b/sources/platform/integrations/ai/codex/_category_.yml new file mode 100644 index 0000000000..379cd5da64 --- /dev/null +++ b/sources/platform/integrations/ai/codex/_category_.yml @@ -0,0 +1 @@ +label: 'Codex' diff --git a/sources/platform/integrations/ai/codex/codex-app.md b/sources/platform/integrations/ai/codex/codex-app.md new file mode 100644 index 0000000000..f4198fbbab --- /dev/null +++ b/sources/platform/integrations/ai/codex/codex-app.md @@ -0,0 +1,143 @@ +--- +title: Codex App integration +sidebar_label: Codex App +description: Learn how to install the Apify plugin for Codex to discover, run, and build Actors with the Apify MCP server and bundled skills for common workflows. +slug: /integrations/codex-app +--- + +import ThirdPartyDisclaimer from '@site/sources/_partials/_third-party-integration.mdx'; + +[Codex](https://developers.openai.com/codex/) is OpenAI's agentic coding tool. It reads and edits your codebase, runs commands, and completes multi-step development tasks. + +The [Apify plugin for Codex](https://github.com/apify/apify-codex-plugin) connects Codex to Apify's library of [Actors](https://apify.com/store) and bundles: + +- The [Apify MCP server](/integrations/mcp) for searching Apify Store, running Actors, and retrieving datasets through the [Model Context Protocol (MCP)](https://modelcontextprotocol.io/docs/getting-started/intro). +- Five built-in skills for common workflows (see [Bundled skills](#bundled-skills) below). + +This guide covers installation in the Codex app. + + + +## Prerequisites + +- [An Apify account](https://console.apify.com/sign-up) - sign up for free if you don't have one. +- [Codex](https://developers.openai.com/codex/) - installed. + +## Install the plugin + +1. In Codex, open the sidebar and select **Plugins**. + + ![Codex sidebar with the Plugins entry selected](../images/codex/00-plugins.webp) + +1. On the **Plugins** screen, select the dropdown next to **+** and choose **Add marketplace**. + + ![Plugins screen with the add menu open and Add marketplace available](../images/codex/01-add-marketplace.webp) + +1. In the **Add plugin marketplace** dialog, enter the Apify plugin repository in the **Source** field: + + ```text + apify/apify-codex-plugin + ``` + + ![Add plugin marketplace dialog with the Apify repository in the Source field](../images/codex/02-marketplace-form.webp) + +1. Select **Add marketplace**. + +1. On the **Plugins** screen, open the **Personal** tab. The **Apify** plugin appears under **Apify Plugin**. + + ![Plugins screen Personal tab showing the Apify plugin card](../images/codex/03-add-plugin.webp) + +1. Select **Add** next to **Apify**. + + ![Apify plugin card with the Add button and Install plugin tooltip](../images/codex/04-install-plugin.webp) + +1. In the dialog, select **Add to Codex**. + +1. Select **Install Apify** to start the Apify MCP server setup. + +## Authenticate to Apify + +The plugin bundles the Apify MCP server. Read-only tools like searching Apify Store and fetching Actor details work without signing in, but you need to authenticate to run Actors and access your account data. + +1. After you select **Install Apify**, Codex starts the Apify MCP server setup and opens a browser tab for the Apify OAuth flow. + +1. Review the permissions and click **Allow access**. + +1. Back in Codex, the `apify` MCP server connects and is ready to use. + +:::tip Session persistence + +The connection stays authenticated for future sessions. You can revoke access at any time in [Apify Console > Settings > Integrations](https://console.apify.com/settings/integrations). + +::: + +## Run your first prompt + +Describe what you want in natural language. Because this bundle exposes the MCP tools and skills directly, be explicit about the workflow you want. + +> Use Apify to find a good Actor for scraping Google Maps places. Show me the best option, its input requirements, pricing model, and what kind of dataset output it returns. Do not run the Actor yet. + +Codex searches Apify Store, fetches the top Actor's details through the `apify` MCP server, and summarizes its inputs, pricing, and output - all without running the Actor. + +![Codex session calling the Apify MCP server and returning Google Maps Actor details](../images/codex/05-test-plugin.webp) + +## Bundled skills + +| Skill | Description | +| --- | --- | +| `apify-ultimate-scraper` | CLI-driven extraction using existing Actors for multi-step scraping and lead-generation workflows. | +| `apify-actor-development` | Full Actor lifecycle - template selection, development, local testing, and deployment with `apify push`. | +| `apify-actorization` | Converts existing JavaScript, TypeScript, Python, or CLI projects into Apify Actors. | +| `apify-generate-output-schema` | Generates dataset and key-value store schemas for existing Actors. | +| `apify-sdk-integration` | Integrates Actor execution into applications using the `apify-client` package. | + +Example prompts that route to specific skills: + +_Ultimate scraper:_ + +> Find 10 highly rated coffee shops in Seattle with name, address, rating, phone, and website. + +_Actor development:_ + +> Create an Apify Actor that accepts a `startUrl` and `maxPages` input, crawls the site, and stores each page title and URL. + +_SDK integration:_ + +> Add Apify to this project. The Node.js API route should run an Actor and return dataset items as JSON. + +## Troubleshooting + +### The Apify plugin does not appear in the list + +Open the **Plugins** screen, switch to the **Personal** tab, and confirm the Apify marketplace was added. If the **Apify** plugin still doesn't appear, re-add the marketplace using the repository `apify/apify-codex-plugin`. + +### The Plugins screen does not appear + +Plugins require a local installation of Codex with plugin support enabled. Install or update Codex, then reopen the **Plugins** screen. + +### Browser doesn't open, or OAuth fails + +If the browser doesn't open automatically, copy the OAuth URL shown by Codex and paste it into your browser manually. + +If you're running Codex in a headless environment (SSH, remote container) or the OAuth flow still fails, authenticate with an API token instead. Copy your token from [Apify Console > Settings > Integrations](https://console.apify.com/settings/integrations) and set it before starting Codex: + +```bash +export APIFY_TOKEN= +``` + +## Limitations + +- Long-running Actors may exceed the time a single tool call waits for completion. Reduce the scope or split the work across multiple prompts. +- Each Actor run consumes Apify platform usage from your plan in addition to any Codex usage. See [Billing](/account/billing) for details. +- Skills that edit files in your project (Actor development, actorization, SDK integration) make local changes - review them before deploying or committing. + +## Related integrations + +- [MCP server integration](/integrations/mcp) - Use the Apify MCP server with other clients +- [ChatGPT integration](/integrations/chatgpt) - Connect the Apify MCP server to ChatGPT + +## Resources + +- [Apify plugin for Codex](https://github.com/apify/apify-codex-plugin) - Source repository and full README with advanced setup notes (Apify CLI install, all auth paths, available MCP tools) +- [Codex documentation](https://developers.openai.com/codex/) - Official Codex docs +- [Apify Store](https://apify.com/store) - Browse Actors you can run from Codex diff --git a/sources/platform/integrations/ai/codex/codex-cli.md b/sources/platform/integrations/ai/codex/codex-cli.md new file mode 100644 index 0000000000..d22552b3da --- /dev/null +++ b/sources/platform/integrations/ai/codex/codex-cli.md @@ -0,0 +1,141 @@ +--- +title: Codex CLI integration +sidebar_label: Codex CLI +description: Learn how to install the Apify plugin for Codex CLI to discover, run, and build Actors with the Apify MCP server and bundled skills for common workflows. +slug: /integrations/codex-cli +--- + +import ThirdPartyDisclaimer from '@site/sources/_partials/_third-party-integration.mdx'; + +[Codex](https://developers.openai.com/codex/) is OpenAI's agentic coding tool. The Codex CLI runs in your terminal, reads and edits your codebase, runs commands, and completes multi-step development tasks. + +The [Apify plugin for Codex](https://github.com/apify/apify-codex-plugin) connects Codex to Apify's library of [Actors](https://apify.com/store) and bundles: + +- The [Apify MCP server](/integrations/mcp) for searching Apify Store, running Actors, and retrieving datasets through the [Model Context Protocol (MCP)](https://modelcontextprotocol.io/docs/getting-started/intro). +- Five built-in skills for common workflows (see [Bundled skills](#bundled-skills) below). + +This guide covers installation in the Codex CLI. + + + +## Prerequisites + +- [An Apify account](https://console.apify.com/sign-up) - sign up for free if you don't have one. +- [Codex CLI](https://developers.openai.com/codex/) - installed and authenticated locally. + +## Install the plugin + +1. In the Codex CLI, run the `/plugins` command. + + ![Codex CLI prompt with the /plugins command typed in](../images/codex-cli/00-plugins-command.webp) + +1. Use the arrow keys to select the **Add Marketplace** tab, then press Enter. + + ![Codex CLI plugins menu with the Add Marketplace tab selected](../images/codex-cli/01-add-marketplace-tab.webp) + +1. Type the Apify plugin repository and press Enter to confirm: + + ```text + apify/apify-codex-plugin + ``` + + ![Codex CLI add marketplace prompt with the Apify repository entered](../images/codex-cli/02-marketplace-repo.webp) + +1. Open the **Apify Plugin** tab, select **Apify**, and press Enter to view the plugin details. + + ![Codex CLI plugins menu showing the Apify plugin as available](../images/codex-cli/03-plugin-detail.webp) + +1. Select **Install plugin** and press Enter to install. + + ![Codex CLI Apify plugin detail with the Install plugin option selected](../images/codex-cli/04-plugin-install.webp) + +## Authenticate to Apify + +The plugin bundles the Apify MCP server. Read-only tools like searching Apify Store and fetching Actor details work without signing in, but you need to authenticate to run Actors and access your account data. + +1. The first time Codex calls a tool that requires authentication, such as running an Actor, it opens a browser tab for the Apify OAuth flow. + +1. Review the permissions and click **Allow access**. + +1. Back in the terminal, the `apify` MCP server is connected and ready to use in any new chat. + +:::tip Session persistence + +The connection stays authenticated for future sessions. You can revoke access at any time in [Apify Console > Settings > Integrations](https://console.apify.com/settings/integrations). + +::: + +## Run your first prompt + +In any new Codex CLI chat, describe what you want in natural language. Because this bundle exposes the MCP tools and skills directly, be explicit about the workflow you want. + +> Use Apify to find a good Actor for scraping Google Maps places. Show me the best option, its input requirements, pricing model, and what kind of dataset output it returns. Do not run the Actor yet. + +Codex searches Apify Store and fetches the top Actor's details through the `apify` MCP server. + +![Codex CLI calling the Apify MCP server search-actors tool](../images/codex-cli/05-test-prompt-input.webp) + +It then summarizes the Actor's inputs, pricing, and output - all without running the Actor. + +![Codex CLI response summarizing the Google Maps Actor inputs and pricing](../images/codex-cli/06-test-prompt-output.webp) + +## Bundled skills + +| Skill | Description | +| --- | --- | +| `apify-ultimate-scraper` | CLI-driven extraction using existing Actors for multi-step scraping and lead-generation workflows. | +| `apify-actor-development` | Full Actor lifecycle - template selection, development, local testing, and deployment with `apify push`. | +| `apify-actorization` | Converts existing JavaScript, TypeScript, Python, or CLI projects into Apify Actors. | +| `apify-generate-output-schema` | Generates dataset and key-value store schemas for existing Actors. | +| `apify-sdk-integration` | Integrates Actor execution into applications using the `apify-client` package. | + +Example prompts that route to specific skills: + +_Ultimate scraper:_ + +> Find 10 highly rated coffee shops in Seattle with name, address, rating, phone, and website. + +_Actor development:_ + +> Create an Apify Actor that accepts a `startUrl` and `maxPages` input, crawls the site, and stores each page title and URL. + +_SDK integration:_ + +> Add Apify to this project. The Node.js API route should run an Actor and return dataset items as JSON. + +## Troubleshooting + +### The `/plugins` command does not appear + +Plugins require a local installation of the Codex CLI with plugin support enabled. Install or update the Codex CLI locally, then run `/plugins` again. + +### The Apify plugin does not appear in the list + +Reopen `/plugins`, move to the **Apify Plugin** tab, and confirm the marketplace was added. If the **Apify** plugin still doesn't appear, re-add the marketplace using the repository `apify/apify-codex-plugin`. + +### Browser doesn't open, or OAuth fails + +If the browser doesn't open automatically, copy the OAuth URL shown in the terminal and paste it into your browser manually. + +If you're running the Codex CLI in a headless environment (SSH, remote container) or the OAuth flow still fails, authenticate with an API token instead. Copy your token from [Apify Console > Settings > Integrations](https://console.apify.com/settings/integrations) and set it before starting Codex: + +```bash +export APIFY_TOKEN= +``` + +## Limitations + +- Long-running Actors may exceed the time a single tool call waits for completion. Reduce the scope or split the work across multiple prompts. +- Each Actor run consumes Apify platform usage from your plan in addition to any Codex usage. See [Billing](/account/billing) for details. +- Skills that edit files in your project (Actor development, actorization, SDK integration) make local changes - review them before deploying or committing. + +## Related integrations + +- [MCP server integration](/integrations/mcp) - Use the Apify MCP server with other clients +- [ChatGPT integration](/integrations/chatgpt) - Connect the Apify MCP server to ChatGPT + +## Resources + +- [Apify plugin for Codex](https://github.com/apify/apify-codex-plugin) - Source repository and full README with advanced setup notes (Apify CLI install, all auth paths, available MCP tools) +- [Codex documentation](https://developers.openai.com/codex/) - Official Codex docs +- [Apify Store](https://apify.com/store) - Browse Actors you can run from Codex diff --git a/sources/platform/integrations/ai/codex/index.mdx b/sources/platform/integrations/ai/codex/index.mdx new file mode 100644 index 0000000000..10868546b4 --- /dev/null +++ b/sources/platform/integrations/ai/codex/index.mdx @@ -0,0 +1,32 @@ +--- +title: Codex +description: Use Apify Actors with OpenAI Codex - install the Apify plugin in the Codex app or the Codex CLI to discover, run, and build Actors with the MCP server. +sidebar_label: Codex +slug: /integrations/codex +--- + +import Card from '@site/src/components/Card'; +import CardGrid from '@site/src/components/CardGrid'; + +[Codex](https://developers.openai.com/codex/) is OpenAI's agentic coding tool. The [Apify plugin for Codex](https://github.com/apify/apify-codex-plugin) connects Codex to Apify's library of [Actors](https://apify.com/store) through the [Apify MCP server](/integrations/mcp) and five bundled skills for common workflows. + +The plugin installs in two places. Pick the one that matches how you use Codex. + +## Choose your setup + + + + + diff --git a/sources/platform/integrations/ai/images/codex-cli/00-plugins-command.webp b/sources/platform/integrations/ai/images/codex-cli/00-plugins-command.webp new file mode 100644 index 0000000000..e37455982b Binary files /dev/null and b/sources/platform/integrations/ai/images/codex-cli/00-plugins-command.webp differ diff --git a/sources/platform/integrations/ai/images/codex-cli/01-add-marketplace-tab.webp b/sources/platform/integrations/ai/images/codex-cli/01-add-marketplace-tab.webp new file mode 100644 index 0000000000..c2ac6c291a Binary files /dev/null and b/sources/platform/integrations/ai/images/codex-cli/01-add-marketplace-tab.webp differ diff --git a/sources/platform/integrations/ai/images/codex-cli/02-marketplace-repo.webp b/sources/platform/integrations/ai/images/codex-cli/02-marketplace-repo.webp new file mode 100644 index 0000000000..7027a0213a Binary files /dev/null and b/sources/platform/integrations/ai/images/codex-cli/02-marketplace-repo.webp differ diff --git a/sources/platform/integrations/ai/images/codex-cli/03-plugin-detail.webp b/sources/platform/integrations/ai/images/codex-cli/03-plugin-detail.webp new file mode 100644 index 0000000000..0c21099579 Binary files /dev/null and b/sources/platform/integrations/ai/images/codex-cli/03-plugin-detail.webp differ diff --git a/sources/platform/integrations/ai/images/codex-cli/04-plugin-install.webp b/sources/platform/integrations/ai/images/codex-cli/04-plugin-install.webp new file mode 100644 index 0000000000..f919671a9b Binary files /dev/null and b/sources/platform/integrations/ai/images/codex-cli/04-plugin-install.webp differ diff --git a/sources/platform/integrations/ai/images/codex-cli/05-test-prompt-input.webp b/sources/platform/integrations/ai/images/codex-cli/05-test-prompt-input.webp new file mode 100644 index 0000000000..0e6ea20bf4 Binary files /dev/null and b/sources/platform/integrations/ai/images/codex-cli/05-test-prompt-input.webp differ diff --git a/sources/platform/integrations/ai/images/codex-cli/06-test-prompt-output.webp b/sources/platform/integrations/ai/images/codex-cli/06-test-prompt-output.webp new file mode 100644 index 0000000000..d029caa0f4 Binary files /dev/null and b/sources/platform/integrations/ai/images/codex-cli/06-test-prompt-output.webp differ diff --git a/sources/platform/integrations/ai/images/codex/00-plugins.webp b/sources/platform/integrations/ai/images/codex/00-plugins.webp new file mode 100644 index 0000000000..9c7097ccec Binary files /dev/null and b/sources/platform/integrations/ai/images/codex/00-plugins.webp differ diff --git a/sources/platform/integrations/ai/images/codex/01-add-marketplace.webp b/sources/platform/integrations/ai/images/codex/01-add-marketplace.webp new file mode 100644 index 0000000000..deca1b89f0 Binary files /dev/null and b/sources/platform/integrations/ai/images/codex/01-add-marketplace.webp differ diff --git a/sources/platform/integrations/ai/images/codex/02-marketplace-form.webp b/sources/platform/integrations/ai/images/codex/02-marketplace-form.webp new file mode 100644 index 0000000000..ddb5807615 Binary files /dev/null and b/sources/platform/integrations/ai/images/codex/02-marketplace-form.webp differ diff --git a/sources/platform/integrations/ai/images/codex/03-add-plugin.webp b/sources/platform/integrations/ai/images/codex/03-add-plugin.webp new file mode 100644 index 0000000000..9fdfb9bb60 Binary files /dev/null and b/sources/platform/integrations/ai/images/codex/03-add-plugin.webp differ diff --git a/sources/platform/integrations/ai/images/codex/04-install-plugin.webp b/sources/platform/integrations/ai/images/codex/04-install-plugin.webp new file mode 100644 index 0000000000..68dbb80fe2 Binary files /dev/null and b/sources/platform/integrations/ai/images/codex/04-install-plugin.webp differ diff --git a/sources/platform/integrations/ai/images/codex/05-test-plugin.webp b/sources/platform/integrations/ai/images/codex/05-test-plugin.webp new file mode 100644 index 0000000000..5ceb42d2cf Binary files /dev/null and b/sources/platform/integrations/ai/images/codex/05-test-plugin.webp differ diff --git a/sources/platform/integrations/ai/index.mdx b/sources/platform/integrations/ai/index.mdx index ee4696263c..93b2cd3726 100644 --- a/sources/platform/integrations/ai/index.mdx +++ b/sources/platform/integrations/ai/index.mdx @@ -88,6 +88,14 @@ Plug Apify Actors into the AI stack - chat clients like Claude and ChatGPT via t imageUrl="/img/platform/integrations/emoji-x402.svg" smallImage /> + + \ No newline at end of file diff --git a/static/img/platform/integrations/codex.svg b/static/img/platform/integrations/codex.svg new file mode 100644 index 0000000000..34b19941be --- /dev/null +++ b/static/img/platform/integrations/codex.svg @@ -0,0 +1 @@ + \ No newline at end of file