Client guides

This section is for connecting an existing client to AIXHUB and proving that its requests use the intended route. For application or service code, start with API authentication instead.

Choose a client

Choose the tool that matches your workflow and protocol. Open its dedicated guide before changing any settings because Base URL, credential storage, model selection, and restore steps differ by client.

Command-line clients

Desktop clients

Generic fallback

If another GUI or CLI supports a custom OpenAI-compatible provider and custom Base URL, use the generic OpenAI-compatible guide. Do not use the generic values for a client that has a dedicated guide; its URL composition or credential format may differ.

Values you need

Prepare these values before opening a client:

Field meaning matters. A Base URL or API Base usually receives the versioned base, while a Host or Origin may receive the root when the client appends /v1 itself. A Full endpoint receives the complete request path. Do not place a full endpoint in a Base URL field, and never produce /v1/v1.

Claude Code uses the Anthropic-compatible root Base URL. Codex CLI, OpenCode, OpenClaw, and generic OpenAI-compatible clients follow the exact value and API mode documented in their own guides. Copy those values rather than transferring settings from another tool.

First successful request

Use this sequence for every client:

1. Create a separate AIXHUB API key for this tool. Do not reuse a key from another client or from application code.

2. Copy the complete compatible model ID from Model routes; do not type a model name from memory.

3. Open the dedicated guide above, or the generic fallback only when no dedicated guide applies.

4. Back up the current settings and record the original provider, Base URL, model, API mode, and credential location.

5. Configure AIXHUB, save the settings, fully restart the client, and confirm the active provider and model.

6. Send a bounded read-only or tool-free request that can only return OK:

   Do not use tools or change any data. Reply with OK only.

7. Open AIXHUB Usage and match the request time, model, and successful status. If Usage displays an API mode or protocol, compare it too; do not assume that field is always present.

Do not enable tools, approve write access, or begin a large task until the small request and Usage record agree.

Common mistakes

• Using an official login: An AIXHUB key is not an official OpenAI, Anthropic, or other vendor account credential. Use the custom provider or API flow described by the client guide.
• Reusing one key everywhere: Create one key per tool and another key for code. This keeps rotation, revocation, and Usage investigation isolated.
• Typing a model name: Copy the exact model ID from the panel. Display names and IDs are not interchangeable.
• Mixing root, base, and full endpoint fields: Read the field label and the dedicated guide. A root URL, versioned Base URL, and full endpoint are different values.
• Skipping restart or Usage verification: A running client may retain old settings or silently use another provider. Fully restart and match the small request in Usage.
• Exposing the key: Never paste it into a prompt, commit it, print it, or include it in screenshots and support logs. Rotate it immediately after exposure.

For request failures, continue with Troubleshooting and the error code reference.

API or client?

Choose a client

Choose a client when you want to use an existing coding, agent, chat, desktop, or profile-management tool. Follow that tool's guide so its provider, URL, credential, model, verification, and restore behavior remain explicit.

Choose the API

Choose API integration when you are building application or service code. Create another dedicated AIXHUB key used only by that code; do not reuse any client key. Then continue with:

• API authentication
• OpenAI Responses
• Anthropic Messages
• OpenAI SDK
• Anthropic SDK
• Troubleshooting
• Error code reference

Last verified: 2026-07-14