OpenRouter-AI API参考手册全面了解绘图与对话接口【免费下载链接】openrouter-aian all-in-one, open-source platform for managing ComfyUI workflows and AI models. Features load balancing, visual forms, a user system with credits, and a full admin panel. Ready for self-hosting.项目地址: https://gitcode.com/gh_mirrors/su/openrouter-aiOpenRouter-AI是一个功能强大的开源AI绘图与对话平台提供完整的API接口体系支持图像生成、AI对话、工作流管理等核心功能。本手册将详细介绍OpenRouter-AI的API接口帮助开发者快速集成和使用各项AI能力。 核心功能概述OpenRouter-AI平台基于ComfyUI构建提供以下主要功能AI绘图功能支持多种图像生成工作流实时对话基于WebSocket的AI对话服务工作流管理自定义和分享绘图工作流用户系统完整的用户认证和积分管理任务管理实时查看绘图任务进度 认证与用户API微信登录接口POST /auth/wechat/login用于用户微信登录认证返回用户令牌token用于后续API调用。请求参数code微信登录codeencryptedData加密数据iv加密算法的初始向量响应示例{ code: 200, data: { token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..., userInfo: { id: 1, nickName: 用户昵称, avatar: 头像URL } } }获取用户信息GET /user/get/userInfo获取当前登录用户的详细信息。请求头Authorization: Bearer {token}响应示例{ code: 200, data: { id: 1, nickName: 用户昵称, avatar: 头像URL, energy: 100, createTime: 2024-01-01 12:00:00 } }更新用户昵称POST /user/upload/nickName更新当前用户的昵称信息。请求参数{ nickName: 新的昵称 }上传用户头像POST /user/upload/avatar上传并更新用户头像。请求格式multipart/form-datafile头像图片文件 绘图任务API提交绘图任务POST /drawing-task/submit/task提交一个新的绘图任务支持多种工作流和参数配置。请求参数{ workflowsId: 1, prompt: 一个美丽的风景画, negativePrompt: 模糊, 低质量, parameters: { width: 512, height: 512, steps: 20, cfgScale: 7.5 } }参数说明workflowsId工作流IDprompt正向提示词negativePrompt负向提示词parameters绘图参数配置获取任务进度GET /drawing-task/get/task/progress?taskId{taskId}根据任务ID获取绘图任务的实时进度。响应示例{ code: 200, data: { taskId: task_123456, status: PROCESSING, progress: 65, estimatedTime: 00:01:30, resultUrl: null } }获取任务进度列表GET /drawing-task/get/task/progress/list获取当前用户的所有任务进度列表。响应示例{ code: 200, data: [ { taskId: task_123456, workflowsName: 风景画生成, status: COMPLETED, progress: 100, createTime: 2024-01-01 12:00:00, resultUrl: https://example.com/image.jpg } ] } 工作流管理API获取工作流分类列表GET /drawing-workflows/get/workflows/category/list获取所有工作流分类信息。响应示例{ code: 200, data: [ { id: 1, name: 风景画, description: 自然风景相关的工作流, icon: category_icon_url }, { id: 2, name: 人物肖像, description: 人像生成工作流, icon: category_icon_url } ] }获取工作流接口信息GET /drawing-workflows/get/workflows/interface?workflowsId{workflowsId}获取特定工作流的接口参数配置信息。响应示例{ code: 200, data: { workflowsId: 1, name: 风景画生成, parameters: [ { name: prompt, type: string, required: true, description: 正向提示词 }, { name: negativePrompt, type: string, required: false, description: 负向提示词 }, { name: width, type: number, required: true, default: 512, description: 图片宽度 } ] } }获取工作流详情GET /drawing-workflows/get/workflows?workflowsId{workflowsId}获取工作流的完整详情信息。分页获取工作流列表GET /drawing-workflows/get/workflows/page?pageNum1prompt风景workflowsCategoryId1根据条件分页查询工作流列表。查询参数pageNum页码默认1prompt搜索关键词workflowsCategoryId分类ID上传工作流组件文件POST /drawing-workflows/upload/file上传工作流相关的组件文件。请求格式multipart/form-datafile工作流组件文件解析工作流JSON文件POST /drawing-workflows/parsing/workflows/json解析上传的工作流JSON配置文件。请求格式multipart/form-datafile工作流JSON文件更新工作流POST /drawing-workflows/update/workflows上传或更新工作流配置。请求参数{ workflowsId: 1, name: 新的工作流名称, description: 工作流描述, categoryId: 1, config: 工作流JSON配置 } AI对话API获取模型列表GET /chat-config/get/model/list获取可用的AI对话模型列表。响应示例{ code: 200, data: [ { id: 1, name: GPT-4, description: OpenAI GPT-4模型, maxTokens: 8192, enabled: true }, { id: 2, name: Claude-3, description: Anthropic Claude-3模型, maxTokens: 4096, enabled: true } ] }WebSocket对话接口WebSocket /chat/{token}建立WebSocket连接进行实时AI对话。连接URLws://your-domain.com/chat/{token}消息格式{ modelId: 1, message: 你好请介绍一下OpenRouter-AI, temperature: 0.7, maxTokens: 1000 }响应格式流式响应逐段返回AI生成的内容。 评论与作品API获取作品评论GET /drawing-comments/get/comments/page?worksId1pageNum1获取指定作品的评论列表。创建评论POST /drawing-comments/create/comments为作品创建评论。请求参数{ worksId: 1, content: 这个作品真棒, parentId: null }删除评论POST /drawing-comments/delete/comments删除指定的评论。获取用户作品GET /drawing-works/get/works/page?pageNum1获取当前用户的作品列表。删除作品POST /drawing-works/delete/works删除指定的作品。 广告API获取广告列表GET /ad/get/ad/list获取广告信息列表。 伪装功能API获取伪装状态GET /disguise/get/status获取用户的伪装状态信息。更新伪装状态POST /disguise/update/status更新用户的伪装状态。 接口认证说明认证方式OpenRouter-AI使用基于Token的认证机制通过微信登录接口获取Token在后续请求的Header中携带TokenToken格式Authorization: Bearer {token}错误码说明200请求成功400请求参数错误401未授权或Token无效403权限不足404资源不存在500服务器内部错误 快速开始指南1. 环境准备确保已安装以下环境Java 21MySQL 8Redis 7Maven 32. 项目部署# 克隆项目 git clone https://gitcode.com/gh_mirrors/su/openrouter-ai # 配置数据库 # 导入项目中的SQL文件 # 修改配置文件 # 编辑 ts-application/src/main/resources/application-prod.yml # 打包部署 mvn clean package java -jar ts-application/target/ts-application-1.0-SNAPSHOT.jar3. API调用示例// 微信登录 const login async () { const response await fetch(/auth/wechat/login, { method: POST, headers: { Content-Type: application/json }, body: JSON.stringify({ code: wx_login_code, encryptedData: encrypted_data, iv: encryption_iv }) }); const data await response.json(); return data.data.token; }; // 提交绘图任务 const submitDrawingTask async (token, taskData) { const response await fetch(/drawing-task/submit/task, { method: POST, headers: { Content-Type: application/json, Authorization: Bearer ${token} }, body: JSON.stringify(taskData) }); return await response.json(); }; 小程序端集成OpenRouter-AI提供了完整的小程序端实现位于miniProgram/目录中。小程序端已经封装了所有API调用开发者可以直接参考使用。主要API模块miniProgram/api/auth.js- 认证相关APIminiProgram/api/drawingTask.js- 绘图任务APIminiProgram/api/drawingWorkflows.js- 工作流APIminiProgram/api/chatConfig.js- 对话配置API 高级功能工作流自定义OpenRouter-AI支持自定义ComfyUI工作流开发者可以通过以下方式上传自定义工作流准备ComfyUI工作流JSON文件使用/drawing-workflows/parsing/workflows/json接口解析使用/drawing-workflows/update/workflows接口上传实时进度监控通过WebSocket或轮询/drawing-task/get/task/progress接口可以实时监控绘图任务的进度状态。批量任务处理支持同时提交多个绘图任务系统会自动进行负载均衡和队列管理。 最佳实践错误处理try { const response await fetch(/api/endpoint, options); const data await response.json(); if (data.code ! 200) { console.error(API错误:, data.message); // 根据错误码进行相应处理 } return data.data; } catch (error) { console.error(网络错误:, error); // 重试逻辑或用户提示 }性能优化使用WebSocket进行实时对话减少HTTP请求开销合理设置轮询间隔避免频繁请求缓存常用数据如工作流列表、模型列表使用分页查询避免一次性加载大量数据安全建议保护用户Token避免在客户端存储敏感信息验证输入参数防止注入攻击限制上传文件大小和类型使用HTTPS进行生产环境部署 相关资源官方文档项目详细文档位于docs/official.md包含完整的部署指南和配置说明。AI功能源码AI对话和绘图的核心实现位于plugins/ai/目录中开发者可以深入学习和定制。数据库设计数据库表结构位于singleton/.sql/目录包含完整的DDL语句。 总结OpenRouter-AI提供了一套完整、易用的AI绘图与对话API接口无论是个人开发者还是企业用户都可以快速集成到自己的应用中。通过本参考手册您可以全面了解各个API的功能和使用方法快速开始您的AI应用开发之旅。核心优势✅ 完整的API接口体系✅ 实时绘图任务监控✅ WebSocket对话支持✅ 灵活的工作流管理✅ 完善的用户系统✅ 开源可定制现在就开始使用OpenRouter-AI为您的应用添加强大的AI绘图和对话能力吧【免费下载链接】openrouter-aian all-in-one, open-source platform for managing ComfyUI workflows and AI models. Features load balancing, visual forms, a user system with credits, and a full admin panel. Ready for self-hosting.项目地址: https://gitcode.com/gh_mirrors/su/openrouter-ai创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考