Codex + Raims
OpenAI's coding agent for building and reviewing your Raims integration in the terminal, editor, or cloud.
Quick start
Install Codex
With Node.js and npm available, install the CLI:
Shellnpm install -g @openai/codexThe official CLI guide also covers Windows, macOS, and Linux installers. To use the desktop app, editor, or cloud, follow OpenAI's quickstart.
Open your application folder
From the root of the project you want to integrate with Raims, run:
ShellcodexComplete the authentication requested by Codex. Your agent account and Raims API key serve different purposes.
Provide Raims context
Ask Codex to read the documentation index and find the authentication and charges guides. The consolidated documentation is also available as a reference.
Try a prompt
Read https://docs.raims.com/llms.txt and the authentication and charges guides. Inspect this application's backend and propose a plan to retrieve an existing Sandbox charge with GET /v1/charges/{id}. Prepare an example that loads the key from protected server configuration. Do not send requests or use real credentials. Show your sources and the files you intend to change before editing.
Project context
Add these instructions to AGENTS.md at your application's root, preserving
any existing guidance. Codex reads AGENTS.md files when starting a session
and also considers more specific directory instructions.
# Raims integration
- Read https://docs.raims.com/llms.txt before choosing endpoints and fields.
- Use https://docs.raims.com/llms-full.txt for the complete documentation.
- API base URL: https://api.raims.com.
- In Raims product installation examples, select the latest stable version
through the package manager (`latest` where supported).
- Prepare Sandbox examples with Bearer authentication on the backend.
- Keep the key in protected server configuration. Do not put secrets in code,
prompts, logs, or browser applications.
- Explain the plan and request approval before sending API requests.After saving, start a new project session to load the instructions.
Check the setup
Ask Codex to summarize the active instructions, list the guides it read, and explain where the application will load the key. Review the plan and code before approving a test.
Reading the documentation does not authenticate your application. Requests use a Raims API key for the intended company and environment, stored in the private part of your system.
Common issues
Check that the session was opened in the correct folder, save AGENTS.md,
and start another session. Ask Codex which instructions it loaded.
Check the agent's network permissions. You can also provide the public guide excerpt as context and ask Codex to identify any missing information.
Ask for an authentication review. Your application uses the Raims key in the Bearer header; the credentials used to access Codex do not replace it.