API Documentation

NovAI provides an OpenAI-compatible REST API. If you've used OpenAI's API before, you already know how to use NovAI — just change the base URL and API key.

Overview

NovAI is an AI API gateway based in Hong Kong, offering low-latency access to Chinese AI models through a unified, OpenAI-compatible interface.

NovAI supports both the Chat Completions API (/v1/chat/completions) and the new Responses API (/v1/responses). We are the only platform offering Responses API access to Chinese AI models.

Authentication

All API requests require an API key passed via the Authorization header:

Authorization: Bearer nvai-your-api-key-here

Get your API key by signing up at aiapi-pro.com. Registration requires only an email address.

Base URL

https://aiapi-pro.com/v1

Replace https://api.openai.com/v1 with the URL above in any existing OpenAI integration.

Available Models

Free model available! Start building immediately with GLM-4.6V-Flash — no credit card required. Click model ID to copy.

Chat Models

Model ID (click to copy)ProviderInputOutputContextNotes
glm-4.6v-flashZhipu AIFreeFree128KFree multimodal FREE
glm-5Zhipu AI$0.60/1M$1.92/1M128KMultimodal flagship
glm-5.1Zhipu AI$1.05/1M$3.96/1M128K8-hour autonomous coding
glm-5.2Zhipu AI$1.19/1M$3.74/1M1M1M context flagship NEW
glm-5.3Zhipu AI$1.25/1M$4.00/1M1MNewest flagship, coding & agents NEW
glm-5v-turboZhipu AI$1.08/1M$3.69/1M128KVision + coding multimodal NEW
minimax-text-01MiniMax$0.14/1M$1.10/1M1M1M context window
glm-4.6vZhipu AI$0.30/1M$0.90/1M128KMultimodal vision

Quick Start Example

curl https://aiapi-pro.com/v1/chat/completions \
  -H "Authorization: Bearer nvai-your-key" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "glm-4.6v-flash",
    "messages": [{"role": "user", "content": "Hello!"}]
  }'

API Playground TRY FREE — NO SIGNUP

Test the API right here in your browser. Uses the free GLM-4.6V-Flash model — no API key required.

Model Free model works without API key. Paid models require free signup + your key.
API Key
Prompt
Click "Send Request" to test the API...
Want to use all 15+ models? Sign up free and get $2.00 credit — try DeepSeek, Qwen, Kimi, and more.
Start Free →

Chat Completions

POST /v1/chat/completions

Creates a model response for the given conversation.

Request Body

ParameterTypeRequiredDescription
modelstringRequiredModel ID to use (see table above)
messagesarrayRequiredList of messages in the conversation
temperaturefloatOptionalSampling temperature (0-2). Default: 1.0
max_tokensintegerOptionalMaximum tokens to generate
streambooleanOptionalEnable streaming responses. Default: false
top_pfloatOptionalNucleus sampling parameter. Default: 1.0

Message Object

FieldTypeDescription
rolestringsystem, user, or assistant
contentstringThe message content

Example Request

curl https://aiapi-pro.com/v1/chat/completions \
  -H "Authorization: Bearer nvai-your-key" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "glm-5",
    "messages": [
      {"role": "system", "content": "You are a helpful assistant."},
      {"role": "user", "content": "Hello!"}
    ],
    "temperature": 0.7,
    "max_tokens": 500
  }'

Example Response

{
  "id": "chatcmpl-abc123",
  "object": "chat.completion",
  "created": 1709942400,
  "model": "glm-5",
  "choices": [
    {
      "index": 0,
      "message": {
        "role": "assistant",
        "content": "Hello! How can I help you today?"
      },
      "finish_reason": "stop"
    }
  ],
  "usage": {
    "prompt_tokens": 20,
    "completion_tokens": 9,
    "total_tokens": 29
  }
}

Responses API NEW — EXCLUSIVE

POST /v1/responses

NovAI is the first and only API platform supporting OpenAI's new Responses API for Chinese AI models. This enables tools like Open Cowork, OpenAI Agents SDK, and any Responses API-based application to use GLM-5, MiniMax, and more China-exclusive models.

Why this matters: Chinese AI providers (Zhipu, MiniMax) only support the legacy /v1/chat/completions endpoint. NovAI automatically translates Responses API format to Chat Completions format, making Chinese models accessible to all modern agent tools.

Request Body

ParameterTypeRequiredDescription
modelstringRequiredModel ID to use
inputstring | arrayRequiredText prompt or message array
instructionsstringOptionalSystem instructions for the model
streambooleanOptionalEnable SSE streaming. Default: false
temperaturefloatOptionalSampling temperature (0-2). Default: 0.7
max_output_tokensintegerOptionalMaximum tokens to generate
toolsarrayOptionalFunction/tool definitions
tool_choicestringOptionalauto, required, or none

Example: Simple Request

curl https://aiapi-pro.com/v1/responses \
  -H "Authorization: Bearer nvai-your-key" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "glm-5",
    "input": "Explain quantum computing simply.",
    "stream": false
  }'

Example: Conversation with Instructions

curl https://aiapi-pro.com/v1/responses \
  -H "Authorization: Bearer nvai-your-key" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "glm-5",
    "instructions": "You are a senior code reviewer.",
    "input": [
      {"role": "user", "content": "Review: def add(a,b): return a+b"}
    ],
    "stream": true
  }'

Example Response

{
  "id": "resp_abc123...",
  "object": "response",
  "status": "completed",
  "model": "glm-5",
  "output": [
    {
      "type": "message",
      "role": "assistant",
      "content": [
        {"type": "output_text", "text": "Quantum computing uses..."}
      ]
    }
  ],
  "usage": {
    "input_tokens": 12,
    "output_tokens": 150,
    "total_tokens": 162
  }
}

Compatible Tools

The following tools work out of the box with NovAI's Responses API endpoint:

  • Open Cowork — Set Base URL to https://aiapi-pro.com/v1
  • OpenAI Agents SDK — Pass NovAI client to Runner
  • OpenAI Python SDK (responses mode) — Set base_url
  • Any custom application using POST /v1/responses

Read the full guide: Responses API for Chinese Models →

Streaming

Set "stream": true to receive responses as Server-Sent Events (SSE):

curl https://aiapi-pro.com/v1/chat/completions \
  -H "Authorization: Bearer nvai-your-key" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "glm-5",
    "messages": [{"role": "user", "content": "Hello"}],
    "stream": true
  }'

Each SSE event contains a JSON chunk with delta.content for the new token. The stream ends with [DONE].

List Models

GET /v1/models

Returns a list of all available models.

curl https://aiapi-pro.com/v1/models \
  -H "Authorization: Bearer nvai-your-key"

Error Codes

HTTP CodeMeaningDescription
400Bad RequestInvalid request body or missing required fields
401UnauthorizedInvalid or missing API key
402Insufficient BalanceAccount balance too low (does not apply to free models)
404Not FoundInvalid model ID
429Rate LimitedToo many requests, please slow down
500Server ErrorInternal error, please retry

Rate Limits

Current rate limits per API key:

  • Free models (glm-4.6v-flash): 30 requests/minute
  • Paid models: 60 requests/minute
Rate limits may be adjusted. If you need higher limits, contact us.

SDKs & Libraries

NovAI works with any OpenAI-compatible SDK. Just set the base URL:

Python

pip install openai

from openai import OpenAI
client = OpenAI(api_key="nvai-...", base_url="https://aiapi-pro.com/v1")

Node.js

npm install openai

import OpenAI from 'openai';
const client = new OpenAI({ apiKey: 'nvai-...', baseURL: 'https://aiapi-pro.com/v1' });

LangChain

from langchain_openai import ChatOpenAI
llm = ChatOpenAI(model="glm-5", openai_api_key="nvai-...", openai_api_base="https://aiapi-pro.com/v1")

Cursor IDE / Continue

Set base URL to https://aiapi-pro.com/v1 in your IDE settings. See our Cursor setup guide.

More examples: GitHub Repository | Blog & Tutorials

Supported Email Providers

Due to bot attacks targeting our free welcome credit, NovAI restricts new account registration to major email providers. This policy applies to new registrations only — all existing accounts are fully unaffected.

If your email provider is not listed below, please contact [email protected] for manual approval.

Provider Accepted Domains Notes
Googlegmail.com, googlemail.comRecommended
Microsoftoutlook.com, hotmail.com, live.com, msn.comRecommended
Yahooyahoo.com, yahoo.co.jp, yahoo.co.uk
Appleicloud.com, me.com, mac.com
Protonprotonmail.com, proton.mePrivacy-focused
Tutanotatutanota.comPrivacy-focused
Zohozoho.comBusiness / developer
GMXgmx.com, gmx.netEurope popular
AOLaol.com
Mail.commail.com
Yandexyandex.com
Navernaver.comKorea
Daum / Kakaodaum.netKorea
Web.deweb.de, t-online.deGermany
Mail.rumail.ruRussia

Note: Custom domain emails, dynamic DNS addresses, and temporary/disposable email services are not accepted. This restriction was introduced on June 24, 2026 to combat bot abuse. All 3,000+ users registered before this date are fully unaffected.

App Tutorials

Connect NovAI to your favorite tools in 60 seconds. Just change the Base URL and paste your API Key.

🎧
Cherry Studio
Desktop AI client for Mac / Windows / Linux.
Settings → Model Provider → OpenAI
Base URL: https://aiapi-pro.com/v1
API Key: your novai key
💬
ChatBox
Cross-platform AI assistant app.
Settings → AI Model Provider → Custom
API Host: https://aiapi-pro.com
API Path: /v1/chat/completions
Cursor
AI-native code editor.
Cursor Settings → Models
Override OpenAI Base URL
https://aiapi-pro.com/v1
💻
NextChat
One-click deployable web UI.
Settings → OpenAI Endpoint
https://aiapi-pro.com
Select any NovAI model
🌐
Immersive Translate
Bilingual web page translation.
AI Service → OpenAI
Custom API URL: /v1/chat/completions
Host: aiapi-pro.com
🤖
LobeChat
Modern AI chat framework.
App Settings → Language Model
OpenAI Proxy URL: https://aiapi-pro.com/v1
🧱
Dify
LLMOps workflow & agent platform.
Model Provider → OpenAI-API-compatible
API endpoint: https://aiapi-pro.com/v1
🌐
Open WebUI
Self-hosted ChatGPT-style web UI.
Admin Panel → Connections
OpenAI API Base URL: https://aiapi-pro.com/v1

Frequently Asked Questions

Quick answers to common questions. Can't find yours? Contact support.

Is NovAI really OpenAI-compatible?
Yes. Our API mirrors OpenAI's /v1/chat/completions and /v1/responses endpoints. Any SDK or tool built for OpenAI works with NovAI — just change the base URL to https://aiapi-pro.com/v1.
How is pricing calculated?
We pass through the raw provider price with 0% platform fee. You see the exact per-1M-token rates on the Models page. Credits never expire.
What payment methods are supported?
Credit card (Visa/Mastercard/UnionPay) and TRC20-USDT - both live now with instant top-up. No geographic restrictions. Top up from as little as $1 on the Pricing FAQ page.
What is the rate limit?
Free playground: 10 requests per 10 minutes per IP. Authenticated API: no hard cap on paid accounts; we apply burst protection only to prevent abuse. See Rate Limits for details.
Do you store my prompts or responses?
We only log request metadata (timestamp, model, token counts) for billing and abuse detection. Prompt and response bodies are not persisted and are encrypted in transit.
How do I get a refund?
Unused credits are refundable within 7 days of purchase. See the Refund Policy page or contact support.
Can I use NovAI for commercial products?
Yes. Commercial use is permitted under our Terms of Service. You retain full ownership of your prompts, responses, and any derivative content.
How does the affiliate program work?
Share your referral link, earn commission on every paid top-up by your referrals. See the Affiliate page to get your link.
Zhipu AI Ecosystem Partner Volcano Engine Ecosystem Partner Tencent Cloud Ecosystem Partner