API docs

CodexIn v1 supports Codex CLI-compatible traffic, Hermes Responses calls, verified image analysis, and Desktop-backed audio transcription. File routes are documented below with their current upstream limit.

Codex CLI config

model = "gpt-5.5"
openai_base_url = "https://api.codexin.lol/v1"

Supported v1 surface

Public compatibility target: /v1/models, /v1/responses, streaming responses, /v1/chat/completions, image analysis, and audio transcription. Advanced file upload routes are implemented but currently upstream-limited.

Hermes base

Use Responses as the primary route. Chat Completions is available for older clients.

Environment

export CODEXIN_BASE_URL="https://api.codexin.lol/v1"
export CODEXIN_API_KEY="ci_..."

Authorization: Bearer $CODEXIN_API_KEY

Text request

curl "$CODEXIN_BASE_URL/responses" \
  -H "Authorization: Bearer $CODEXIN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "gpt-5.5",
    "input": "Reply with a short Hermes status."
  }'

Image analysis

Send screenshots as base64 data URLs. Non-streaming and streaming work on both Responses and Chat Completions.

Responses input_image

curl "$CODEXIN_BASE_URL/responses" \
  -H "Authorization: Bearer $CODEXIN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "gpt-5.5",
    "input": [{
      "role": "user",
      "content": [
        { "type": "input_text", "text": "Describe this screenshot." },
        { "type": "input_image", "image_url": "data:image/png;base64,<base64>" }
      ]
    }]
  }'

Chat image_url

curl "$CODEXIN_BASE_URL/chat/completions" \
  -H "Authorization: Bearer $CODEXIN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "gpt-5.5",
    "messages": [{
      "role": "user",
      "content": [
        { "type": "text", "text": "Describe this screenshot." },
        { "type": "image_url", "image_url": { "url": "data:image/png;base64,<base64>" } }
      ]
    }]
  }'

Explicit helper

curl "$CODEXIN_BASE_URL/codex/image-analysis" \
  -H "Authorization: Bearer $CODEXIN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "prompt": "What is in this screenshot?",
    "image_url": "data:image/png;base64,<base64>"
  }'

Desktop asset pointers from /v1/codex/images are for upload bookkeeping. For analysis, send input_image or image_url data URLs.

Route matrix

Advanced routes are available only for users with advanced route access enabled.

Method	Path	Status	Use
GET	/v1/models	Live	List active CodexIn models.
POST	/v1/responses	Live	Main Hermes route for text, streaming, tools, and image analysis.
POST	/v1/chat/completions	Live	Compatibility route. Image messages are rewritten to Responses input_image.
POST	/v1/codex/image-analysis	Live	Explicit image-analysis helper for base64 data URLs.
POST	/v1/codex/images	Upstream-limited	Implemented, but current public probe receives ChatGPT file-upload 429 throttling.
POST	/v1/files	Upstream-limited	Implemented, but current public upload probe receives ChatGPT file-upload 429 throttling.
GET	/v1/files/{file_id}/content	Upstream-limited	Implemented; requires a successful upstream file upload first.
POST	/v1/audio/transcriptions	Advanced	Desktop-backed audio transcription. Public WebM probe returned HTTP 200.
POST	/v1/codex/image-generation	Unavailable	Returns 501 in desktop mode; native image generation is not wired yet.