WOX API Documentation

Guides for connecting to the WOX AI API, calling models, and configuring popular clients

WOX provides a unified AI API gateway for the text, image, audio, embedding, reranking, and other model capabilities currently available on the platform. Model availability, supported parameters, and pricing are determined by the current information on the Models and Pricing page and by API responses.

Get Started

Sign in to WOX and create a key on the API Keys page.
Select an available model ID on the Models and Pricing page.
Select an available API route and send a request with Authorization: Bearer YOUR_API_KEY.
Handle timeouts, upstream errors, 429 responses, and retries in production.

API Keys are sensitive credentials. Do not commit them to a repository, write them to public logs, or expose them in untrusted clients such as browser applications.

API Endpoints

All of the following endpoints use the OpenAI-compatible /v1 path:

Route	Base URL
Default	`https://api.wox.lol/v1`
CN2	`https://api.cn2.wox.lol/v1`
GIA	`https://api.gia.wox.lol/v1`

Route availability and details may change. Refer to the current information on the WOX platform. The examples in this documentation use https://api.wox.lol/v1 by default.

Example Request

curl https://api.wox.lol/v1/chat/completions \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "YOUR_MODEL_ID",
    "messages": [
      {"role": "user", "content": "Hello"}
    ]
  }'

Replace YOUR_API_KEY and YOUR_MODEL_ID with the values from your account. Different models may use different endpoints or parameters; do not assume that every model supports the same capabilities.

Documentation Guide

Quickstart: make your first API request
API Reference: explore the OpenAPI specification
Token Plan FAQ: understand subscription quotas and billing preferences
Popular integrations: configure OpenClaw, HermesAgents, CC Switch, WorkBuddy, Cherry Studio, OpenCode, and Codex++
Frequently Asked Questions and Error Codes: troubleshoot integration issues

Usage Requirements

When calling the WOX API, you must follow the User Agreement, the Privacy Policy, the applicable policies of the selected upstream provider, and local laws. Model output may be inaccurate or incomplete; validate it before using it in production.