Documentation renewed! For old docs, visit doc.newapi.pro
New APINew API
User GuideInstallationAPI ReferenceAI ApplicationsSkillsHelp & SupportBusiness Cooperation

newapi

newapi is the official New API user-level Skill for Claude Code, Codex, and OpenClaw. Query models, manage tokens, view groups, check balance, and ask New API usage questions directly inside your AI coding workflow.

What is newapi-skills?

newapi-skills is the official AI editor Skill plugin from New API. Skills are a lightweight extension protocol that enables AI coding assistants — such as Claude Code, Codex, OpenClaw, Cursor, Windsurf, and Cline — to call New API endpoints directly from within the editor, performing model queries, token management, balance checks, and answering New API deployment, configuration, and API usage questions without ever leaving your coding environment.

It now also works inside OpenClaw, so you can run /newapi commands for models, tokens, groups, and balance, and ask New API usage questions without leaving your agent workflow.

Why Use Skills

During everyday AI development, developers frequently switch between their editor and the New API management dashboard — checking available models, creating API tokens, inspecting balance, adjusting group quotas. These context switches disrupt coding flow.

What newapi-skills solves:

  • Zero context-switching: Issue natural language commands directly in Claude Code, Codex, OpenClaw, or other AI IDEs — no browser or admin panel needed
  • Built-in help: Ask about New API deployment, configuration, groups, and API call formats directly from your coding workflow
  • Security-first design: Keys are never shown in plain text; token copy and injection use secure channels (sk- prefixed keys never appear in terminal output or logs)
  • Instant setup: A single npx command handles installation; runtime auto-detection (Bun / Node.js / Deno)
  • Cross-editor compatibility: Works with any AI editor or coding assistant that implements the Skills protocol

Supported AI Editors

newapi-skills works with the following AI coding tools:

AI Editor / Coding AssistantTypeNotes
Claude CodeTerminal AI programming assistantOfficial Anthropic CLI
OpenClawSelf-hosted AI assistant platformSupports Skills-based /newapi command workflows
CursorAI-native code editorVS Code based
WindsurfAI code editorBy Codeium
ClineVS Code AI extensionOpen-source AI coding agent
Codex CLITerminal AI programming assistantOfficial OpenAI CLI

Any tool that supports the Skills protocol can use newapi-skills.

Commands Reference

Below is the complete list of commands provided by newapi-skills. These commands interact with the New API REST API to query and manage resources on your New API instance.

Query Commands

CommandDescriptionUse Case
/newapi modelsList available AI modelsView all models configured on your New API instance (OpenAI, Claude, Gemini, etc.)
/newapi groupsList user groupsView your account's groups with quota and rate multiplier settings
/newapi balanceShow account balanceReal-time query of current user's balance and usage

Token Management Commands

CommandDescriptionUse Case
/newapi tokensList API tokensView all created tokens (keys shown masked, e.g. sk-reHR**********OspA)
/newapi create-token <name> [--group=xxx]Create new API tokenGenerate independent API keys for different apps or projects
/newapi switch-group <token_id> <group>Change token's groupModify token group to adjust model access permissions and rate multipliers
/newapi copy-token <token_id>Copy key to clipboardSecurely copy the real key to system clipboard (key never displayed in terminal)
/newapi apply-token <token_id> <file>Inject key into config fileSecurely write token key into project config files (e.g. .env) via placeholder replacement

Help Command

CommandDescriptionUse Case
/newapi help <question>Ask about New APIGet help on New API deployment, configuration, API call formats, and more

Installation & Configuration

Install newapi-skills

One-line installation via npx:

npx skills add https://github.com/QuantumNous/skills --skill newapi

This pulls the latest Skill definition from the GitHub repository and installs it into your editor environment.

Set Environment Variables

newapi-skills requires three environment variables to connect to your New API instance. Add them to your shell profile:

# ~/.bashrc or ~/.zshrc
export NEWAPI_BASE_URL=https://your-newapi-instance.com
export NEWAPI_ACCESS_TOKEN=your-access-token
export NEWAPI_USER_ID=1
VariableDescriptionExample
NEWAPI_BASE_URLNew API service URLhttps://api.example.com
NEWAPI_ACCESS_TOKENAdmin or user access tokenFrom "Personal Settings → Account → Security → System Access Token"
NEWAPI_USER_IDUser ID1 (admin default is 1)

You can also create a .env file in your project root. Make sure .env is listed in .gitignore to prevent key leaks.

Start Using

Once installed, type /newapi commands in any Skills-compatible AI editor. For example:

  • Type /newapi models to list available models
  • Type /newapi balance to check your current balance
  • Type /newapi create-token my-app to create a new token named my-app
  • Type /newapi help how do I configure groups and tokens? to ask New API usage questions directly
  • In OpenClaw, you can also run /newapi models, /newapi balance, and token commands directly in your agent workflow

Runtime Requirements

newapi-skills requires one of the following JavaScript runtimes (auto-detected at startup):

RuntimeVersionRecommendation
BunLatestRecommended (fastest)
Node.js>= 18Widely supported
DenoLatestOptional

Security

newapi-skills has multiple layers of security built in to protect your API keys:

  • Token listings only show masked keys (e.g. sk-reHR**********OspA) — real keys never appear in terminal output
  • copy-token copies the key to the system clipboard only, never displaying it in any output
  • apply-token uses placeholder replacement to inject keys, never exposing raw key content
  • All sk- prefixed key values are strictly protected throughout the entire execution flow

Learn More

newapi-skills is under active development — commands and features may change with updates. Refer to the repository README for the latest information and changelog:

How is this guide?

Last updated on