# UniGateway LLM + Agent Guide

UniGateway is an OpenAI-compatible unified AI gateway.
Single endpoint, multiple providers/models.
Brand positioning: unified AI gateway, OpenAI-compatible multi-provider gateway.

Base API URL: https://api.unigateway.ai/v1
Docs Home: https://unigateway.ai/docs
Models: https://unigateway.ai/models
Model pricing: https://unigateway.ai/models
LLM Full Context: https://unigateway.ai/llms-full.txt

## Published docs index
- [概览](https://unigateway.ai/docs/overview)
- [快速开始](https://unigateway.ai/docs/quickstart)
- [账户与 API Keys](https://unigateway.ai/docs/account-and-api-keys)
- [管理 API Key](https://unigateway.ai/docs/management-key)
- [UniGateway 组织用户与子用户](https://unigateway.ai/docs/organization-users)
- [UniGateway 多因素验证（MFA）](https://unigateway.ai/docs/mfa)
- [UniGateway 组织安全与额度通知](https://unigateway.ai/docs/organization-security-notifications)
- [套餐与定价](https://unigateway.ai/docs/usage-plans-and-pricing)
- [Authentication](https://unigateway.ai/docs/authentication)
- [OpenAI 兼容 API](https://unigateway.ai/docs/openai-compatible-api)
- [Chat Completions](https://unigateway.ai/docs/chat-completions)
- [OpenAI Responses API](https://unigateway.ai/docs/openai-responses-api)
- [Embeddings](https://unigateway.ai/docs/embeddings)
- [Models](https://unigateway.ai/docs/models)
- [Audio](https://unigateway.ai/docs/audio)
- [UniGateway Kimi K3 模型支持](https://unigateway.ai/docs/kimi-k3)
- [Anthropic 兼容 API](https://unigateway.ai/docs/anthropic-compatible-api)
- [Anthropic Messages API](https://unigateway.ai/docs/anthropic-messages-api)
- [Gemini 原生 API](https://unigateway.ai/docs/gemini-native-api)
- [Gemini generateContent API](https://unigateway.ai/docs/gemini-generate-content)
- [模型选择与回退](https://unigateway.ai/docs/model-selection-and-fallback)
- [错误处理与重试](https://unigateway.ai/docs/error-handling-and-retries)
- [Claude Prompt Caching](https://unigateway.ai/docs/prompt-caching)
- [Streaming](https://unigateway.ai/docs/streaming)
- [图像生成概览](https://unigateway.ai/docs/images-overview)
- [Image Generation and Editing](https://unigateway.ai/docs/image-generation)
- [OpenAI Images API](https://unigateway.ai/docs/openai-images-api)
- [Gemini Images API](https://unigateway.ai/docs/gemini-images-api)
- [视频生成概览](https://unigateway.ai/docs/video-generation-landing)
- [Sora Video Generation](https://unigateway.ai/docs/sora-overview)
- [Seedance 概览](https://unigateway.ai/docs/seedance-overview)
- [Seedance 创建任务](https://unigateway.ai/docs/seedance-create-task)
- [Seedance 查询任务](https://unigateway.ai/docs/seedance-task-query)
- [Seedance 素材库](https://unigateway.ai/docs/seedance-asset-libraries)
- [OpenAI SDK 接入](https://unigateway.ai/docs/openai-sdk)
- [Dify 接入](https://unigateway.ai/docs/dify)
- [OpenWebUI 接入](https://unigateway.ai/docs/openwebui)
- [AI 编程工具](https://unigateway.ai/docs/coding-tools-and-agents)
- [Codex CLI 接入](https://unigateway.ai/docs/codex-cli)
- [Codex 桌面版接入](https://unigateway.ai/docs/codex-desktop)
- [OpenCode 接入](https://unigateway.ai/docs/opencode)
- [GitHub Copilot 接入](https://unigateway.ai/docs/copilot)
- [WorkBuddy 接入](https://unigateway.ai/docs/workbuddy)
- [pi-dev 接入](https://unigateway.ai/docs/pi)
- [CC-Switch 接入](https://unigateway.ai/docs/cc-switch)
- [OpenClaw 接入](https://unigateway.ai/docs/openclaw)
- [Claude Code 接入](https://unigateway.ai/docs/claude-code)
- [LobeChat 接入](https://unigateway.ai/docs/lobechat)
- [Claude Desktop 接入](https://unigateway.ai/docs/claude-desktop)
- [Hermes Agent 接入](https://unigateway.ai/docs/hermes-agent)
- [n8n 接入](https://unigateway.ai/docs/n8n)
- [LangChain 接入](https://unigateway.ai/docs/langchain)
- [Cherry Studio 接入](https://unigateway.ai/docs/cherry-studio)
- [Flowise 接入](https://unigateway.ai/docs/flowise)
- [Continue 接入](https://unigateway.ai/docs/continue)
- [Cline 接入](https://unigateway.ai/docs/cline)
- [API Key 用量查询](https://unigateway.ai/docs/usage-analytics)
- [API Key 额度与限制查询](https://unigateway.ai/docs/api-key-quotas-and-restrictions)
- [账户管理 API](https://unigateway.ai/docs/account-management-api)
- [UniGateway 账户用量与计费 API](https://unigateway.ai/docs/account-usage-billing-api)
- [API 兼容性矩阵](https://unigateway.ai/docs/endpoint-compatibility)
- [错误码参考](https://unigateway.ai/docs/error-codes-reference)

## LLM-friendly markdown endpoints
- Canonical docs URL: https://unigateway.ai/docs/{slug}
- Markdown mirror URL: https://unigateway.ai/docs/{slug}.md

## Agent maintenance protocol (JWT)
Use Admin JWT for create/update/delete operations.

### 1) Login and get JWT
POST /api/auth/login
Content-Type: application/json

{
  "email": "<admin_email>",
  "password": "<admin_password>"
}

Read token from response field `token`.
Then use header: Authorization: Bearer <token>

### 2) Read documentation
- GET /api/docs
- GET /api/docs/{slug}

### 3) Manage categories (Admin JWT required)
- GET /api/admin/doc-categories
- POST /api/admin/doc-categories
- PUT /api/admin/doc-categories/{id}
- DELETE /api/admin/doc-categories/{id}

### 4) Manage docs (Admin JWT required)
- POST /api/docs
- PUT /api/docs/{slug}
- DELETE /api/docs/{slug}

### 5) Update this llms.txt through API (Admin JWT required)
- GET /api/admin/llms-txt
- PUT /api/admin/llms-txt

PUT payload:
{
  "content": "# UniGateway LLM + Agent Guide ..."
}

## Authoring conventions for agents
1) Slug: lowercase + hyphen only (`^[a-z0-9-]+$`).
2) Keep both EN/ZH content synchronized.
3) Keep code examples runnable and OpenAI-compatible.
4) Prefer additive updates; avoid deleting existing docs unless explicitly requested.
5) Keep the first 160 chars concise for metadata extraction.