IHUI AIIHUI AI
插件市场
自动化
任务列表
请先登录
首页
生态市场
AI 智能体
空工作区

请先登录

拖拽调整宽度
暂无打开的页面
跳到主内容

开发文档

平台开发与集成指南

概览

文档

概览使用说明手册快速开始

工具

私有化部署Agent 开发RAG 检索多模型调度MCP 协议工作流编排

开发者

API 文档团队协作

基础信息

Base URL

https://api.aizhs.top/v1          # 生产
https://api-staging.aizhs.top/v1  # 预发
http://localhost:8802/v1          # 自托管

认证方式

  • JWT:用户登录态,Authorization: Bearer <jwt>
  • API Key:服务端调用,X-API-Key: <key>,在 /settings/api-keys 生成
  • Webhook 签名:HMAC-SHA256,X-Webhook-Signature: <hmac>

速率限制

默认 60 req/min,Pro 200/min,Team 500/min。超限返回 429,响应头含:

X-RateLimit-Limit: 60
X-RateLimit-Remaining: 0
X-RateLimit-Reset: 1699900000

AI 对话 API

POST /v1/chat/completions

OpenAI 兼容接口,支持流式(SSE)和非流式。

curl -X POST https://api.aizhs.top/v1/chat/completions \
  -H "Authorization: Bearer <jwt>" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "gpt-4o",
    "messages": [
      {"role": "user", "content": "你好"}
    ],
    "stream": true,
    "temperature": 0.7
  }'

# 流式响应(SSE)
data: {"id":"...","choices":[{"delta":{"content":"你"},"index":0}]}
data: {"id":"...","choices":[{"delta":{"content":"好"},"index":0}]}
data: [DONE]

POST /v1/chat/agents/:agentId

调用指定 Agent(带知识库 + MCP 工具 + 工作流)。

curl -X POST https://api.aizhs.top/v1/chat/agents/agent_abc123 \
  -H "X-API-Key: <key>" \
  -H "Content-Type: application/json" \
  -d '{
    "message": "帮我分析这份简历",
    "files": ["file_xyz"],
    "context": { "userId": "u_123" }
  }'

Agent 管理 API

方法
路径
说明
GET
/v1/agents
列表(分页 + 筛选)
POST
/v1/agents
创建 Agent
GET
/v1/agents/:id
详情
PATCH
/v1/agents/:id
更新
POST
/v1/agents/:id/publish
发布到市场
DELETE
/v1/agents/:id
删除

错误码

统一响应格式:

{
  "code": 0,          // 0=成功, 非 0=失败
  "message": "ok",
  "data": { ... }     // 成功时的数据
}
HTTP
code
说明
200
0
成功
400
1001
参数错误
401
1002
未认证
403
1003
无权限
404
1004
资源不存在
429
1005
速率超限
500
5000
服务器错误

SDK

JavaScript

npm i @ihui/api-client
import { chat } from '@ihui/api-client'
await chat({ message: '你好' })

Python

pip install ihui-ai
from ihui import IHUI
client = IHUI(api_key='...')
client.chat(message='你好')

Go

go get github.com/ihui/ihui-go
client := ihui.New("key")
client.Chat(ctx, "你好")

下一步

MCP 工具集成Agent 开发返回快速开始