Getting Started Chat & Sessions Agents Workflow Providers Advanced Shortcuts FAQ
HexClaw Docs

Model Providers

Configure model providers, credentials and availability for your selected HexClaw service.

Providers and Compatible Endpoints

ProviderExample modelsCredentials
OpenAIGPT / o seriesAPI Key
DeepSeekDeepSeek familyAPI Key
AnthropicClaude familyAPI Key
Google GeminiGemini familyAPI Key
Alibaba QwenQwen familyAPI Key
ByteDance ArkDoubao and models available through ArkAPI Key
Zhipu AIGLM familyAPI Key
Kimi (Moonshot)Kimi familyAPI Key
Baidu QianfanERNIE familyAPI Key
Tencent HunyuanHunyuan familyAPI Key
iFlytek SparkSpark familyAPI Key
MiniMaxMiniMax familyAPI Key
OllamaInstalled local modelsNo key for the default local setup
CustomModels exposed by a compatible endpointFollow the selected endpoint requirements

Model names are examples. Select a provider type, then check its current API documentation for the full base URL, API key, and model ID. Native and compatible protocols may use different endpoints; a website domain alone is not a complete API URL. Available models depend on your account, region, and the list returned by the current service.

Ark: the API key is the authentication credential. An ep-... value is an endpoint ID and belongs in the model field; supported model IDs can also be used. The standard base URL is https://ark.cn-beijing.volces.com/api/v3. See the official Ark guide.

Add a Provider

  1. Go to Settings → Model services
  2. Click "Add Provider"
  3. Select a provider type such as OpenAI or DeepSeek
  4. Enter the provider API key; configuration belongs to the currently connected service, as explained below
  5. Optionally override the base URL for a proxy or private deployment
  6. Save the provider
Model provider settings page
Model provider settings: default model, routing policy, and provider list. Click the image to view full size.

Model Capabilities

Capabilities belong to individual models. A provider name does not imply that all its models support the same inputs and outputs:

CapabilityUse
text / codeText chat and code generation; the default chat model requires text capability
visionUnderstand input images, separate from image generation or editing
videoUnderstand input video, separate from video generation
audioSupported audio input and responses; transcription and read-aloud require their respective services
image_generationGenerate images; editing also requires a model and endpoint that support it
video_generationGenerate video and retrieve the resulting artifact through task progress
embeddingProduce vectors for knowledge retrieval, rather than regular chat

Check the configured purpose before selecting a chat or dedicated media model. An unclassified capability list does not mean every operation is supported. Catalog entries, capability declarations, and successful individual calls are separate evidence. Reasoning controls also depend on the exact model.

Local Ollama Setup

After downloading a model, Ollama can run inference locally. Whether the whole task stays offline also depends on web tools, cloud models, and external services it uses.

# Install Ollama
brew install ollama    # macOS
# Or download it from ollama.com

# Start Ollama and pull models
ollama serve
ollama pull llama3.1
ollama pull qwen2.5
ollama pull deepseek-r1

In HexClaw, add Ollama as a provider with base URL http://localhost:11434/v1. No API key is required.

API Key Security

For the local desktop service, the Sidecar saves Provider API keys in ~/.hexclaw/hexclaw.yaml, with directory permissions 0700 and file permissions 0600. Provider keys are not additionally stored in the system keychain or browser storage. A self-hosted cloud connection uses that service's Provider configuration and credentials; local configuration does not automatically sync to the cloud.

Test Connection

Use the provider card's test action to check an actual call with the selected endpoint, credentials, and model. Tests may consume provider quota. Inspect the returned result and error details; a successful test does not validate every model, media operation, or tool capability offered by that provider.

Automatic Model Selection

Automatic selection follows the current service's default model, task capabilities, and routing settings. Dedicated media tasks use the appropriate capability routes. For recoverable model failures, the service can try an eligible fallback provider.

Fallback depends on the failure type, available models, and task state; not every failure is resent. Check the actual model in the execution record. If an external operation has an unknown result, inspect the original task before generating or sending again.


← Workflow Canvas
Advanced Features →

✏️ Edit this page on GitHub