返回首页

API文档

AI驱动内容代理系统的完整API参考文档

快速导航

概述

本文档描述了AI驱动内容代理系统的RESTful API接口。API遵循标准的REST设计原则,支持JSON格式的请求和响应,并提供完整的错误处理机制。

安全认证

支持API密钥认证,确保接口调用的安全性

RESTful设计

遵循REST设计原则,提供直观的API接口

流式响应

支持流式响应,实时获取AI生成内容

MCP兼容

完全符合MCP协议规范,易于集成

基础信息

  • API版本: v1
  • 基础URL: http://localhost:8787/api/v1
  • 内容类型: application/json
  • 认证方式: API密钥(Header: Authorization: Bearer <token>
  • 测试API密钥: aiwenchuang

认证方式

所有需要认证的API请求都需要在请求头中包含有效的API密钥:

# 使用 Authorization 头认证 curl -H "Authorization: Bearer aiwenchuang" http://localhost:8787/api/v1/status

服务状态API

获取服务状态

检查服务运行状态和基本信息。

方法 端点 描述 认证
GET /api/v1/status 获取服务状态

请求示例

curl -s -X GET \ -H "Authorization: Bearer aiwenchuang" \ -H "Content-Type: application/json" \ http://localhost:8787/api/v1/status

响应示例

{ "success": true, "message": "服务运行正常", "data": { "status": "healthy", "uptime": 1755231388856, "version": "v1", "capabilities": { "templates": 6, "workflows": 2, "features": ["content_rendering", "ai_workflows", "template_system"] } }, "meta": { "timestamp": "2025-08-15T04:16:28.856Z", "version": "v1" } }

模板管理API

方法 端点 描述 认证
GET /api/v1/templates 获取模板列表
GET /api/v1/templates/{templateId} 获取特定模板详情

获取模板列表示例

curl -s -X GET \ -H "Authorization: Bearer aiwenchuang" \ -H "Content-Type: application/json" \ http://localhost:8787/api/v1/templates

可用模板

  • article_wechat: 微信医疗文章模板,专为微信公众号设计
  • tech_analysis_wechat: 技术解读模板,专为技术内容解读设计
  • news_modern_wechat: 现代新闻模板,专为新闻资讯设计
  • github_project_wechat: GitHub项目推荐模板,专为开源项目推荐设计
  • ai_benchmark_wechat: AI基准测试模板,专为AI模型评测设计
  • professional_analysis_wechat: 专业分析模板,专为深度技术分析设计

工作流管理API

方法 端点 描述 认证
GET /api/v1/workflows/available 获取所有可用工作流列表
GET /api/v1/workflows/{workflowId} 获取工作流详情
POST /api/v1/workflows/{workflowId}/execute 执行工作流
POST /api/v1/workflows/custom 添加自定义工作流
DELETE /api/v1/workflows/custom/{workflowId} 删除自定义工作流

获取可用工作流示例

curl -s -X GET \ -H "Authorization: Bearer aiwenchuang" \ -H "Content-Type: application/json" \ http://localhost:8787/api/v1/workflows/available

执行工作流示例

# 执行URL内容生成工作流 curl -s -X POST \ -H "Authorization: Bearer aiwenchuang" \ -H "Content-Type: application/json" \ -d '{ "inputs": { "url": "https://github.com/microsoft/TypeScript" } }' \ http://localhost:8787/api/v1/workflows/dify-general/execute # 执行AI文章生成工作流(流式) curl -s -X POST \ -H "Authorization: Bearer aiwenchuang" \ -H "Content-Type: application/json" \ -d '{ "inputs": { "title": "AI技术发展", "style": "专业", "context": "人工智能发展现状" } }' \ http://localhost:8787/api/v1/workflows/dify-article/execute?stream=true

可用工作流

dify-general

URL内容生成
从URL生成内容(默认工作流),支持多种URL格式分析和内容提取。

dify-article

AI文章生成
基于关键词生成文章(默认工作流),支持流式响应和实时内容生成。

内容渲染API

方法 端点 描述 认证
POST /api/v1/content/render 渲染内容
GET /api/v1/content 获取内容列表
GET /api/v1/content/{contentId} 获取内容详情
GET /api/v1/content/{contentId}/html 获取渲染后的HTML
GET /api/v1/content/{contentId}/url 获取内容访问URL
DELETE /api/v1/content/{contentId} 删除内容

内容渲染示例

curl -s -X POST \ -H "Authorization: Bearer aiwenchuang" \ -H "Content-Type: application/json" \ -d '{ "template": "article_wechat", "title": "AI技术发展趋势", "content": "# AI技术发展趋势\n\n## 引言\n\n人工智能技术正在快速发展..." }' \ http://localhost:8787/api/v1/content/render

使用示例

1. 完整的内容渲染流程

# 1. 检查服务状态 curl -X GET "http://localhost:8787/api/v1/status" # 2. 获取可用模板 curl -X GET "http://localhost:8787/api/v1/templates" # 3. 渲染内容 curl -X POST "http://localhost:8787/api/v1/content/render" \ -H "Content-Type: application/json" \ -H "Authorization: Bearer aiwenchuang" \ -d '{ "content": "# AI技术发展趋势\n\n## 引言\n\n人工智能技术正在快速发展...", "template": "article_wechat", "title": "AI技术发展趋势" }' # 4. 查看渲染结果 curl -X GET "http://localhost:8787/api/v1/content/4ad7e901400ace34/html"

2. AI工作流执行

# 1. 获取可用工作流 curl -X GET "http://localhost:8787/api/v1/workflows/available" # 2. 执行URL内容生成工作流 curl -X POST "http://localhost:8787/api/v1/workflows/dify-general/execute" \ -H "Content-Type: application/json" \ -H "Authorization: Bearer aiwenchuang" \ -d '{ "inputs": { "url": "https://github.com/microsoft/TypeScript" } }' # 3. 执行AI文章生成工作流(流式) curl -X POST "http://localhost:8787/api/v1/workflows/dify-article/execute?stream=true" \ -H "Content-Type: application/json" \ -H "Authorization: Bearer aiwenchuang" \ -d '{ "inputs": { "title": "AI技术发展趋势", "style": "专业", "context": "人工智能发展现状" } }'

3. 自定义工作流管理

# 1. 添加自定义工作流 curl -X POST "http://localhost:8787/api/v1/workflows/custom" \ -H "Content-Type: application/json" \ -H "Authorization: Bearer aiwenchuang" \ -d '{ "id": "translate-workflow", "name": "智能翻译", "description": "多语言智能翻译工作流", "type": "url", "apiKey": "app-translate-key", "icon": "ion-md-globe" }' # 2. 删除自定义工作流 curl -X DELETE "http://localhost:8787/api/v1/workflows/custom/translate-workflow" \ -H "Authorization: Bearer aiwenchuang"

MCP协议集成

本API设计完全符合MCP(Model Context Protocol)规范,可以轻松包装为MCP工具。

MCP工具定义示例

{ "name": "ai_content_agent", "description": "AI驱动的内容代理系统", "tools": [ { "name": "get_service_status", "description": "获取服务状态", "inputSchema": { "type": "object", "properties": {} } }, { "name": "render_content", "description": "渲染Markdown内容为HTML", "inputSchema": { "type": "object", "properties": { "content": {"type": "string", "description": "Markdown内容"}, "template": {"type": "string", "description": "模板名称"}, "title": {"type": "string", "description": "文档标题"} }, "required": ["content"] } } ] }

错误代码

错误代码 描述 HTTP状态码
INVALID_API_KEY API密钥无效 403
MISSING_API_KEY API密钥缺失 401
INVALID_INPUT 输入参数无效 400
TEMPLATE_NOT_FOUND 模板不存在 404
CONTENT_NOT_FOUND 内容不存在 404
WORKFLOW_NOT_FOUND 工作流不存在 404
WORKFLOW_ERROR 工作流执行错误 500
ROUTE_NOT_FOUND 路由不存在 404
INTERNAL_ERROR 内部服务器错误 500

限制和配额

  • 内容大小: 最大10MB
  • API调用频率: 无限制(开发环境)
  • 存储时间: 内容默认永久存储,可通过API删除
  • 并发请求: 支持高并发处理
  • 响应时间: 通常在5秒内
  • 支持的模板数量: 6个内置模板
  • 自定义工作流: 支持运行时添加和删除

安全性

  • API密钥认证: 所有写操作需要有效的API密钥
  • CORS支持: 配置了适当的CORS头
  • 输入验证: 所有输入都经过严格验证
  • 错误处理: 不暴露敏感的系统信息