DataEyesAI
Official SiteConsoleDocs Home
Getting StartedDeveloper ToolsAI Models API
Official SiteConsoleDocs Home
Getting StartedDeveloper ToolsAI Models API
  1. Developer Tool Integration
  • Getting Started
    • Overview
    • Console (Getting Started)
    • API Key
    • Base URL
  • Developer Tool Integration
    • OpenClaw
    • Claude Code
    • Codex
    • Gemini CLI
    • Grok CLI
    • Other Tools
  • AI Models API
    • OpenAI format (supports major original models)
      • Chat (Response)
        • Create Network Search
        • Create Model Response GPT-5 Enable Thinking
        • Create Function Call
        • Create Model Response
        • Create Model Response (Streaming Return)
        • Create Model Response (Control Thinking Length)
      • ChatGPT Interface
        • Audio
          • Audio to text gpt-4o-transcribe
          • GPT-4o-audio
          • Audio to text whisper-1
          • Audio to text gpt-4o-transcribe
          • Create voice gpt-4o-mini-tts
        • Chat
          • Create chat-based image recognition (non-streaming)
          • Create chat-based image recognition (streaming)
          • Create chat-based image recognition (streaming) best64
          • Official N test
          • Create structured output
          • Control the effort level of the inference model
          • Create chat function call
          • deepseek-ocr recognition
          • Create chat completion (non-stream)
        • Completions
          • ChatGPT automatic completion
          • Create completion
      • Image
        • Edit image
        • Create chat completion (streaming)
        • Create chat completion (qwen-mt-turbo)
        • Create chat completion with deepseek v3.1 level of reasoning (streaming)
      • Audio
        • Speech recognition
        • Speech synthesis
        • Official Function Calling invocation
        • Create chat-generated images (non-streaming)
      • Embedding
        • Text embeddings
    • Anthropic format
      • Chat
      • Chat(prompt cache)
      • Streaming response
      • Chat (deep reasoning)
      • Tool invocation (function call)
      • Analyze image
    • Google Gemini interface
      • Native format
        • Text-to-image + control over aspect ratio + clarity
        • Generate image
        • Text generation
        • Text generation - stream
        • Text generation + reasoning - stream
        • Image generation
        • Formatted output
        • Function call
        • Document understanding
        • URL context [native format]
        • Code execution
        • Video understanding
        • URL context
        • Video understanding - url [native format]
        • Imagen 4
        • Audio understanding
        • Embeddings
        • Chat
        • Edit image
      • Image-to-image Base64 request method
        • Multi-image fusion slice generation with gemini-3-pro-image-preview, controlling aspect ratio and clarity
        • Image editing
        • Single image gemini-3-pro-image-preview, controlling aspect ratio and clarity.
        • Image generation( gemini-2.5-flash-image)
        • Image generation gemini-2.5-flash-image, controlling aspect ratio.
        • Image understanding
      • Image-to-image URL request returns URL request format OpenAI
        • Single image generation with gemini-3-pro-image-preview, controlling aspect ratio and clarity.
        • Multi-image fusion slice generation with gemini-3-pro-image-preview, controlling aspect ratio and clarity.
        • Image understanding
    • NanoBanana
      • OpenAI request
        • Edit image
        • OpenAI image format
      • Gemini request
        • Generate image
        • Edit image
    • Midjourney format
      • Midjourney API Reference
      • Task query interface
      • Upload image
      • Get seed (Seed)
      • Submit Imagine task
      • Query tasks based on ID list
      • FaceSwap
      • Execute Action operation
      • /mj/submit/blend
      • Submit Describe task
      • Submit Modal
      • Refresh link
      • Edit image
      • Query task status by task ID
      • Get the seed of the task image
    • Doubao - Painting
      • doubao-seededit-3-0-i2i-250628
      • doubao-seedream-4-0-250828 - text-to-image
      • doubao-seedream-4-0-250828 - image-to-image
      • doubao-seedream-4-0-250828 - multi-image generation
    • Rerank Reordering Model
      • Rerank
    • Video Model
      • Grok Video Generation
        • 00-Overview
        • 01-Text-to-Video
        • 02-Image-to-Video
        • 03-Reference-to-Video
        • 04-Video-Editing
        • 05-Video-Extension
      • Seedance Video Generation
        • 00-Overview
        • 01-Create-Video-Generation-Task
        • 02-Query-Video-Generation-Task
        • 03-Query-Video-Generation-Task-List
        • 04-Cancel-or-Delete-Task
        • Seedance Private Asset Library API Documentation
      • MiniMax-H3 Video Generation
        • 00-Overview
        • 01-Create-Video-Generation
        • 02-Create-Video-Regeneration
        • 03-Create-H3-Context-IR
        • 04-Query-Task
        • 05-List-Tasks
        • 06-Cancel-or-Delete-Task
      • Hailuo Video Generation
        • 00-Overview
        • 01-Text-to-Video-T2V
        • 02-Image-to-Video-I2V
        • 03-First-Last-Frame-FL2V
        • 04-Subject-Reference-S2V
        • 05-Query-Task-Status
        • 06-Video-Download
        • 99-Appendix-Camera-Movement-and-Webhooks
      • Jimeng Video Generation
        • 00-Overview
        • 01-3.0-Pro-Video-Generation
        • 02-720P-Text-to-Video
        • 03-720P-Image-to-Video-First-Frame
        • 04-720P-Image-to-Video-Start-End-Frame
        • 05-720P-Image-to-Video-Camera
        • 06-1080P-Text-to-Video
        • 07-1080P-Image-to-Video-First-Frame
        • 08-1080P-Image-to-Video-Start-End-Frame
        • 09-Error-Codes
      • Kling AI Video Generation
        • 00-Overview
        • 01-Text-to-Video
        • 02-Image-to-Video
        • 03-Omni-Video
        • 04-Multi-Image-to-Video
        • 05-Motion-Control
        • 06-Multi-Elements
        • 07-Video-Extension
        • 08-Lip-Sync
        • 09-Avatar
        • 10-Text-to-Audio
        • 11-Video-to-Audio
        • 12-TTS
        • 13-Custom-Voices
        • 14-Image-Recognition
        • 15-Element-Management
        • 16-Video-Effects
      • Vidu Video Generation
        • 00-Overview
        • 01-Text-to-Video
        • 02-Image-to-Video
        • 03-Reference-to-Video
        • 04-Start-End-Frame
        • 05-Multi-Frame
        • 06-Scene-Template
        • 07-Template-Story
        • 08-Query-Tasks
      • HappyHorse
        • HappyHorse Text-to-Video
        • HappyHorse Image-to-Video (First Frame)
        • HappyHorse Reference-to-Video
        • HappyHorse Video Editing
      • Wan Video Generation
        • 00-Overview.md
        • 01-Text-to-Video
        • 02-Image-to-Video
        • 03-Reference-to-Video
        • 04-Video-Editing
        • 05-First-Last-Frame-to-Video
        • 06-Motion-Transfer-and-Character-Swap
        • 07-Digital-Human-Video
        • 08-VACE-Video-Editing
        • 09-Query-Task
    • Audio API
      • Audio API
      • Gemini TTS API
      • Google DeepMind Lyria API
      • Elevenlabs Speech to Text API Reference
      • Text-to-Music Suno
        • Task Submission
          • Generate Song (Inspiration Mode)
          • Generate Song (Custom Mode)
          • Generate Song (Continuation Mode)
          • Generate Song (Singer Style)
          • Generate Song (Secondary Creation from Uploaded Song)
          • Generate Song (Song Stitching)
          • Generate Lyrics
          • Song Stitching
        • Query Interface
          • Batch Retrieve Tasks
          • Query Single Task
  • Search / Reader Product
    • Web Reader API​​
      • Web Reader API
      • Web Reader API(HK)
    • Web Search API​​
      • Modal Card API
        • Weather
          • All City ID
          • Weather Query API
      • Web Search API
      • Video Search api
      • Trending Search API
    • Document OCR Parsing API
      • fiel upload
      • URL Parsing
  • Advanced & System API
    • Data Updates
    • System interface
      • API Key & Quota Query API
      • API Key Management API
    • API Reference​​
      • Error Codes
      • HTTP Notes
    • List models
      • Models
  1. Developer Tool Integration

Codex

Codex Integration with DataEyesAI#

Codex is a powerful coding Agent tool that can read, modify, and run project code directly from the terminal (CLI) or within VS Code.
This guide will walk you through switching Codex's underlying model to DataEyes using a custom Provider configuration with the OpenAI Responses wire API.

1. Prerequisites (3 Core Parameters)#

Before starting, have the following 3 parameters ready — you will use them throughout the configuration:
ParameterValueNotes
API Keysk-xxxxxxxxxxxxxxxxEnter the raw key directly
Base URLhttps://platform.dataeyes.ai/v1Must include /v1.
Model Namee.g. gpt-5 or claude-sonnet-4-6Must be a model supported by DataEyesAI that your account has permission to call.

2. Quick Setup Guide#

Step 1: Install Codex CLI#

Make sure Node.js is installed on your machine.
If Node.js is not available, click here to download it
Open a terminal and run the following command to install globally:

Step 2: Create the Configuration File (config.toml)#

Codex officially recommends defining custom Providers via a config.toml file.
1.
Find or create the configuration directory:
Windows: C:\Users\YourUsername\.codex
macOS / Linux: ~/.codex
2.
Create a new file named config.toml in that directory.
3.
Paste the following content into the file and save:
# Basic configuration
model_provider = "dataeyes"
model = "Replace with the actual model name supported by DataEyesAI"
preferred_auth_method = "apikey"
disable_response_storage = true

# DataEyesAI custom Provider configuration
[model_providers.dataeyes]
name = "DataEyes"
base_url = "https://platform.dataeyes.ai/v1"
env_key = "DATAEYES_API_KEY"
wire_api = "responses"
Parameter notes: This configuration directly specifies the API endpoint (base_url) and instructs Codex to retrieve the API key from the DATAEYES_API_KEY environment variable.

Step 3: Set the API Key Environment Variable#

For security, do not write your API Key directly into the configuration file. Run the following commands in your terminal based on your operating system:
Windows PowerShell (temporary — current session only):
$env:DATAEYES_API_KEY="sk-your-dataeyes-key"
Windows PowerShell (permanent — write to user variables, requires terminal restart):
[System.Environment]::SetEnvironmentVariable("DATAEYES_API_KEY", "sk-your-dataeyes-key", "User")
macOS / Linux:

Step 4: Launch and Test#

After completing the configuration, navigate to any project code directory in your terminal and run:
Once launched, try a simple read-only analysis command, for example: Summarize the main module structure of the current repository. If Codex responds normally with output, congratulations — DataEyesAI is fully connected!

3. Using the VS Code Extension#

The Codex CLI and the VS Code extension share the same underlying configuration.
Once you have completed the config.toml and environment variable setup above, simply search for and install the Codex extension from the VS Code Extension Marketplace — it will work out of the box with no additional configuration needed inside VS Code.

4. FAQ#

Q1: Authentication Failed after launching?
Verify that the DATAEYES_API_KEY environment variable is actually set in your terminal. If you used the Windows permanent write command, you must fully close and reopen the terminal for the change to take effect.
Check that the key you entered does not accidentally include a Bearer prefix.
Q2: Model not found after launching?
The model field in config.toml must be filled in precisely. Cross-reference the available model list in the DataEyesAI console and enter the exact full name, character for character.
Q3: The connection works, but it is unstable and errors occur intermittently?
Codex depends heavily on the responses wire API format. If instability occurs under high concurrency or unusual network conditions, ensure that wire_api = "responses" in config.toml has no typos, and verify that the selected model is fully compatible with the OpenAI Responses specification.
Previous
Claude Code
Next
Gemini CLI