# Newapi

> Newapi: OpenAI-compatible AI API gateway for unified access to chat, images, audio, and video generation models.

## Docs

- [Audio: Speech and Transcription API](https://doc.hitopen.com/api-reference/ai/audio.md): POST /v1/audio/speech, /v1/audio/transcriptions, /v1/audio/translations — Convert text to speech, transcribe audio files, and translate spoken audio.
- [Chat Completions API](https://doc.hitopen.com/api-reference/ai/chat.md): POST /v1/chat/completions — Create AI model responses from a conversation history. Supports streaming, tool calls, and reasoning effort control.
- [Text Completions API](https://doc.hitopen.com/api-reference/ai/completions.md): POST /v1/completions — Generate text completions from a prompt using the traditional (non-chat) completions API, compatible with OpenAI's legacy format.
- [Embeddings API](https://doc.hitopen.com/api-reference/ai/embeddings.md): POST /v1/embeddings — Generate text embedding vectors for semantic search, similarity, and classification tasks using any supported embedding model.
- [Image Generation and Editing API](https://doc.hitopen.com/api-reference/ai/images.md): POST /v1/images/generations and /v1/images/edits — Generate and edit images using DALL-E, GPT Image, Gemini, and Qwen models via a unified API.
- [List Available Models](https://doc.hitopen.com/api-reference/ai/models.md): GET /v1/models — Retrieve all AI models available on your Newapi instance. The list reflects configured channels and their enabled model mappings.
- [Content Moderation API](https://doc.hitopen.com/api-reference/ai/moderations.md): POST /v1/moderations — Check whether text content violates usage policies. Returns category scores and flagged categories for safety screening.
- [Rerank API](https://doc.hitopen.com/api-reference/ai/rerank.md): POST /v1/rerank — Reorder a list of documents by relevance to a query. Returns documents sorted by relevance score for RAG and search applications.
- [Video Generation API](https://doc.hitopen.com/api-reference/ai/videos.md): POST /v1/videos — Generate AI videos using Sora, Kling, and Jimeng models. Async API: submit a job, then poll for status and retrieve the result.
- [API Authentication Reference](https://doc.hitopen.com/api-reference/auth.md): How to authenticate Newapi API requests. AI Model APIs use sk- Bearer tokens; Management APIs support Bearer tokens or session cookies.
- [Channel Management API](https://doc.hitopen.com/api-reference/management/channels.md): REST API endpoints for configuring, listing, testing, and deleting upstream AI provider channels in Newapi. Requires Admin permission.
- [Usage Logs API](https://doc.hitopen.com/api-reference/management/logs.md): REST API endpoints for querying API request logs and usage statistics in Newapi. View your own logs or all logs with Admin access.
- [Payment and Top-Up API](https://doc.hitopen.com/api-reference/management/payment.md): REST API endpoints for checking top-up packages, initiating payments via Stripe or other providers, and viewing your transaction history in Newapi.
- [Token Management API](https://doc.hitopen.com/api-reference/management/tokens.md): REST API endpoints for creating, listing, updating, and deleting API tokens in Newapi. Requires User permission and Bearer authentication.
- [User Management API](https://doc.hitopen.com/api-reference/management/users.md): REST API endpoints for viewing and updating user profiles in Newapi. Self-service endpoints use User permission; admin endpoints require Admin.
- [Newapi API Reference Overview](https://doc.hitopen.com/api-reference/overview.md): Newapi exposes AI Model APIs (chat, images, audio, video) and Management APIs (tokens, channels, users). All requests use Bearer token authentication.
- [Connect AionUi to Newapi](https://doc.hitopen.com/apps/aionui.md): Set up AionUi — a free, open-source desktop office agent — to use Newapi as its AI provider for multi-model workflows and agent management.
- [Configure AstrBot with Newapi](https://doc.hitopen.com/apps/astrbot.md): Connect AstrBot — an open-source all-in-one Agent chatbot platform — to Newapi for AI-powered messaging on QQ, Feishu, WeChat Work, and more.
- [Connect Cherry Studio to Newapi](https://doc.hitopen.com/apps/cherry-studio.md): Configure Cherry Studio to use Newapi as its AI provider. Add your API key and base URL to access all models from this powerful desktop client.
- [Use Claude Code with Newapi](https://doc.hitopen.com/apps/claude-code.md): Configure Claude Code to route requests through Newapi on Windows, macOS, and Linux. Set environment variables to connect to your Newapi instance.
- [Use OpenAI Codex CLI with Newapi](https://doc.hitopen.com/apps/codex-cli.md): Install OpenAI Codex CLI and configure it to use Newapi as its AI provider. Step-by-step setup for Windows (WSL2), macOS, and Linux.
- [Connect DeepChat to Newapi](https://doc.hitopen.com/apps/deepchat.md): Configure DeepChat to use Newapi as an AI provider. Import your Newapi configuration with one click using DeepChat's DeepLink feature.
- [Configure LangBot with Newapi](https://doc.hitopen.com/apps/langbot.md): Use Newapi as the AI backend for LangBot — an LLM chatbot framework for Feishu, WeChat, Telegram, Discord, and Slack — with embedding model support.
- [Connect OpenClaw to Newapi](https://doc.hitopen.com/apps/openclaw.md): Set up OpenClaw — a self-hosted AI assistant platform — to use Newapi and deploy AI agents across Feishu, Discord, Slack, and other platforms.
- [AI Applications Compatible with Newapi](https://doc.hitopen.com/apps/overview.md): Connect popular AI applications to Newapi with three simple settings: your API address, API key, and model name. Browse supported apps.
- [Authenticate with Newapi](https://doc.hitopen.com/authentication.md): Create API tokens in the Newapi console, pass them as Bearer headers in every request, and understand the permission levels for Management API endpoints.
- [Channels: Upstream AI Provider Configuration](https://doc.hitopen.com/concepts/channels.md): Channels define the upstream AI providers Newapi routes requests to. Learn how to add, configure, and test channels in the Newapi console.
- [Available Models and Model Configuration](https://doc.hitopen.com/concepts/models.md): Models available in Newapi depend on which channels an admin has configured. Learn to list models via the API, understand naming, and check per-model pricing.
- [Managing API Tokens in Newapi](https://doc.hitopen.com/concepts/tokens.md): API tokens (sk- keys) are the credentials your apps use to call Newapi. Learn how to create, scope with quotas and model limits, and manage tokens.
- [Track Usage, Logs, and Spending in Newapi](https://doc.hitopen.com/concepts/usage-logs.md): Newapi logs every API request with token counts, cost, model, and status. Learn how to view logs in the console and query them programmatically via the API.
- [Newapi: Unified AI API Gateway](https://doc.hitopen.com/introduction.md): Newapi is an OpenAI-compatible AI gateway. Call chat, image, audio, and video models from any provider through a single endpoint with one API key.
- [Quickstart: Your First Newapi Request](https://doc.hitopen.com/quickstart.md): Learn how to create an API token and send your first chat completion request through Newapi in under 5 minutes using cURL, Python, or JavaScript.