Use Craft’s API to Build With Codex CLI

Use Craft's API to build apps on Codex CLI. Fetch your documents, sync content, and create custom tools powered by your Craft data.

Enabling the API for Documents

First, you have to enable the API in order for Craft to setup an API endpoint for your documents. Then, you use the API endpoint URL to connect to the server from Codex CLI.

Step 1

Open the “Imagine” tab

Step 2

Click “Add Your First API Connection”

Step 3

Configure your API connection with a name.

Step 4

Click “Add Document” to select which documents this API connection has access to.

Step 5

The API URL that will be used to interact with your document is now displayed at the top

Step 6

Click the “Download AI Bundle” button. This will download a folder containing the API documentation and the content of your doc.

Using the API in a Codex CLI Prompt

Once the API is enabled for your Craft docs, you can now focus on writing a prompt that Codex CLI will use to generate your project.

In order for Codex CLI to see how to use the API and understand the structure of your document, you attach the AI bundle to your prompt. This bundle is a markdown document that contains the current content of your Craft doc as well as the API documentation.

Step 1

Open a terminal on your computer. Start OpenAI Codex in a folder which only contains the downloaded “bundle.md” file and nothing else.

Now you can add a prompt to describe the app you want to build. Here is a very general example that can be used for testing:

Please create a website that visualises the content of my connected Craft docs. You find instructions on how to access this data and its structure in the attached file.