Model integration, explained clearly

Quick start

1. Create an API Key

1. Sign in to the console.
2. Open API Key management and create a new key.
3. Confirm the account has available balance or enterprise quota.

2. Choose a model

Browse Models and pick by provider, context length, input/output price and capability tags. Prefer explicit model IDs at the beginning.

3. Verify connectivity

export APIEX_API_KEY="sk-xxxxxxxx"

curl -s -o /dev/null -w "%{http_code}\n" \
  -H "Authorization: Bearer $APIEX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"model":"openai/gpt-5.2","messages":[{"role":"user","content":"hi"}]}' \
  https://apiex.cc/gateway/v1/chat/completions

Standard integration & config

The apiex gateway is OpenAI-compatible. Any SDK, CLI or Agent tool needs only the three fields below — defined once here, and tool sections only cover their differences.

import os
from openai import OpenAI

client = OpenAI(
    api_key=os.environ["APIEX_API_KEY"],
    base_url="https://apiex.cc/gateway/v1",
)

completion = client.chat.completions.create(
    model="openai/gpt-5.2",
    messages=[
        {"role": "system", "content": "You are a helpful assistant."},
        {"role": "user", "content": "how are you?"}
    ],
)

print(completion.choices[0].message.content)

IDE & CLI integration

All tools below build on the three fields in Standard integration & config; this group only lists per-tool differences.

Claude Code

Anthropic-compatible tools: set the Base URL to https://apiex.cc/gateway (no /v1) — the CLI appends /v1/messages itself.

Persistent config (recommended)

mkdir -p ~/.claude

cat > ~/.claude/settings.json <<'EOF'
{
  "env": {
    "ANTHROPIC_BASE_URL": "https://apiex.cc/gateway",
    "ANTHROPIC_API_KEY": "sk-xxxxxxxx",
    "ANTHROPIC_MODEL": "anthropic/claude-sonnet-4.6"
  },
  "includeCoAuthoredBy": false
}
EOF

claude /logout 2>/dev/null || true
unset ANTHROPIC_AUTH_TOKEN

Temporary access (environment variables)

export ANTHROPIC_BASE_URL="https://apiex.cc/gateway"
export ANTHROPIC_API_KEY="sk-xxxxxxxx"

claude

Codex CLI

Difference: uses the Responses API (wire_api = "responses"), with config in the user-level ~/.codex/config.toml.

mkdir -p ~/.codex

cat > ~/.codex/config.toml <<'EOF'
model_provider = "apiex"
model = "openai/gpt-5.2"

[model_providers.apiex]
name = "apiex"
base_url = "https://apiex.cc/gateway/v1"
env_key = "APIEX_API_KEY"
wire_api = "responses"
requires_openai_auth = false
EOF

export APIEX_API_KEY="sk-xxxxxxxx"
codex

Cursor

1. Open Cursor settings and go to Models.
2. Add a custom model; use the provider/model-name format from Models for the model ID.
3. Enable the OpenAI API Key switch and fill in your apiex key.
4. Set the Base URL per the common config (https://apiex.cc/gateway/v1; use https://apiex.cc/gateway if the tool appends /v1 itself).
5. After saving, select the model in Chat, Composer or Agent.

Claude Desktop

Difference: desktop clients usually connect through a local MCP or tool proxy. Keep the apiex key in local environment variables and let the tool config read it.

export APIEX_API_KEY="sk-xxxxxxxx"
export APIEX_BASE_URL="https://apiex.cc/gateway/v1"

Hermes / QClaw / AutoClaw

Difference: these Agent tools support OpenAI-compatible config directly — no dedicated config file. Fill the three common fields into the tool settings:

API reference

All endpoints are mounted under https://apiex.cc/gateway/v1.

Multimodal endpoints

Image, video and reference-image generation open up progressively by model capability. Different models may bill by tokens, image count, resolution, video duration or task spec — prices as labeled in Models.

Responses & reconciliation

apiex stands for auditable billing: every response carries a usage field, invoices are settled by it, and you can verify call by call.

{
  "id": "chatcmpl-...",
  "model": "openai/gpt-5.2",
  "usage": {
    "prompt_tokens": 18,
    "completion_tokens": 42,
    "total_tokens": 60
  }
}

Troubleshooting

Each row follows a cause-then-fix order; with an error code, match the status badge first to locate the category.