# 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
Pricing: https://unigateway.ai/pricing
LLM Full Context: https://unigateway.ai/llms-full.txt

## Published docs index
- [概览](https://unigateway.ai/docs/overview)
- [快速开始](https://unigateway.ai/docs/quickstart)
- [鉴权与请求约定](https://unigateway.ai/docs/authentication)
- [聊天补全](https://unigateway.ai/docs/chat-completions)
- [流式输出](https://unigateway.ai/docs/streaming)
- [模型查询](https://unigateway.ai/docs/models)
- [字节（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)
- [接口兼容矩阵](https://unigateway.ai/docs/endpoint-compatibility)
- [模型选择与回退](https://unigateway.ai/docs/model-selection-and-fallback)
- [错误处理与重试](https://unigateway.ai/docs/error-handling-and-retries)
- [OpenAI SDK 接入](https://unigateway.ai/docs/openai-sdk)
- [Dify 接入](https://unigateway.ai/docs/dify)
- [OpenWebUI 接入](https://unigateway.ai/docs/openwebui)
- [编码工具与 Agent 接入](https://unigateway.ai/docs/coding-tools-and-agents)
- [LobeChat 接入](https://unigateway.ai/docs/lobechat)
- [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)

## 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.