Skip to content

docs: [ENG-3371] codex with ai gateway#5114

Merged
connortbot merged 2 commits intomainfrom
connor/eng-3371
Oct 23, 2025
Merged

docs: [ENG-3371] codex with ai gateway#5114
connortbot merged 2 commits intomainfrom
connor/eng-3371

Conversation

@connortbot
Copy link
Collaborator

No description provided.

@vercel
Copy link

vercel bot commented Oct 23, 2025

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Preview Comments Updated (UTC)
helicone Ready Ready Preview Comment Oct 23, 2025 10:36pm
helicone-bifrost Ready Ready Preview Comment Oct 23, 2025 10:36pm
helicone-eu Ready Ready Preview Comment Oct 23, 2025 10:36pm

@claude
Copy link
Contributor

claude bot commented Oct 23, 2025

Claude finished @connortbot's task —— View job


Code Review Complete

Score: 6/10 - Documentation looks good with some important verification concerns

Todo List:

  • Read and analyze changed files
  • Review documentation content for accuracy
  • Check for security, performance, and quality issues
  • Provide actionable feedback with confidence score

Issues Found

Critical Concerns (Blocking):

  1. Unverified Package Reference (docs/gateway/integrations/codex.mdx:74):

    • The documentation references @openai/codex-sdk package, but this doesn't appear to be an official OpenAI package
    • No evidence in the codebase or common npm registries suggests this package exists
    • This could mislead users trying to follow the integration guide
  2. Unverified CLI Configuration (docs/gateway/integrations/codex.mdx:29-37):

    • The config.toml format and field names need verification
    • model_provider, base_url, env_key, and wire_api fields should be confirmed against actual Codex CLI documentation

Minor Issues:

  1. Inconsistent Model Reference (docs/gateway/integrations/codex.mdx:90):
    • Uses gpt-5 model which may not be widely available
    • Consider using a more common model like gpt-4 or gpt-3.5-turbo for examples

Suggestions Summary:

  • URGENT: Verify that @openai/codex-sdk is a real, installable package
  • URGENT: Confirm the Codex CLI configuration format matches actual CLI expectations
  • Recommended: Update example to use a more accessible model
  • Nice-to-have: Add error handling examples for common integration issues

Positive Aspects:

Good Documentation Structure: Follows established patterns from other integration docs
Proper Use of Reusable Components: Uses strings from snippets for consistency
Clear Step-by-step Instructions: Well-organized integration steps
Helpful Context: Includes limitations and related documentation links
Navigation Integration: Properly added to docs.json navigation structure

Recommendations:

  1. Verify package existence before merging - check if @openai/codex-sdk actually exists on npm
  2. Confirm CLI configuration format with official Codex documentation
  3. Test the integration with actual Codex tools if available
  4. Consider adding a disclaimer if this is experimental/unofficial integration

The documentation follows good practices and structure, but the unverified external dependencies are concerning for user experience.

Copy link
Contributor

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Greptile Overview

Greptile Summary

Added comprehensive documentation for integrating OpenAI Codex CLI and SDK with Helicone AI Gateway. The documentation follows the established integration pattern and includes setup instructions for both CLI and SDK users.

Key additions:

  • CLI integration using config.toml file with Helicone provider configuration
  • SDK integration using @openai/codex-sdk with AI Gateway base URL
  • Clear note about Responses API limitations for SDK users
  • Consistent use of reusable string components from snippets
  • Related documentation cards linking to AI Gateway features

Confidence Score: 4/5

  • This PR is safe to merge with minor documentation verification recommended
  • The PR adds new documentation following established patterns from other integration docs (LangChain, Semantic Kernel). The structure is consistent and uses proper reusable components. Score is 4/5 rather than 5/5 because the Codex SDK package @openai/codex-sdk and CLI configuration format should be verified to ensure accuracy, as there's limited evidence of this being an official OpenAI product.
  • Verify that @openai/codex-sdk is the correct package name and the config.toml format matches actual Codex CLI expectations

Important Files Changed

File Analysis

Filename Score Overview
docs/docs.json 5/5 Added codex entry to the integrations list under gateway documentation navigation
docs/gateway/integrations/codex.mdx 4/5 New documentation for OpenAI Codex CLI and SDK integration with AI Gateway; includes CLI config, SDK setup, and related features

Sequence Diagram

sequenceDiagram
    participant User as Developer
    participant Codex as Codex CLI/SDK
    participant Gateway as Helicone AI Gateway
    participant Provider as LLM Provider

    User->>Codex: Configure with Helicone base URL
    Note over User,Codex: config.toml or SDK initialization

    User->>Codex: Run command/API call
    Codex->>Gateway: POST /v1/chat/completions
    Note over Codex,Gateway: HELICONE_API_KEY for auth

    Gateway->>Gateway: Log request metadata
    Gateway->>Gateway: Apply observability features
    Gateway->>Provider: Forward request to LLM
    Provider->>Gateway: Return LLM response
    Gateway->>Gateway: Track costs & metrics
    Gateway->>Codex: Return response
    Codex->>User: Display result

    User->>Gateway: View logs in dashboard
    Gateway->>User: Show request/response data
Loading

2 files reviewed, no comments

Edit Code Review Agent Settings | Greptile

@H2Shami
Copy link
Collaborator

H2Shami commented Oct 23, 2025

is it possible to change the model that CLI Codex actually uses? Like maybe switch it from gpt-5-codex to claude-4.5-sonnet?

@connortbot
Copy link
Collaborator Author

is it possible to change the model that CLI Codex actually uses? Like maybe switch it from gpt-5-codex to claude-4.5-sonnet?

yup just updated for this

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants