OverviewAuthenticationMindsKnowledgeChatLatencyErrors
Minds Team

API 概览

Minds API 介绍 —— 以编程方式访问 mind 和管理知识。

欢迎使用 Minds API 文档。我们的 API 允许你以编程方式创建与管理 AI mind、上传知识,并与它们交互。

快速开始

Minds API 遵循 REST 原则设计。我们的 API 拥有可预测的面向资源的 URL、接受 JSON 编码的请求体、返回 JSON 编码的响应,并使用标准的 HTTP 响应码、身份验证和动词。

Base URL

生产环境: https://getminds.ai/api/v1 或 https://api.getminds.ai/v1

本地开发: http://localhost:3000/api/v1

两个生产环境 base URL 完全等价。推荐使用 api.getminds.ai 子域名以获得更简洁的集成 URL。

身份验证

所有 API endpoint 都需要通过 API key 进行身份验证。你可以在 Settings → API Keys 中生成和管理 API key。

在 Authorization header 中包含你的 API key:

Authorization: Bearer minds_your_api_key_here

OpenAPI 规范

机器可读的 OpenAPI 3.1.0 规范发布在 /_openapi.json。使用该规范生成带类型的客户端（TypeScript、Python 等），或将其投入 LLM 以一次性生成集成代码。示例见 OpenAPI。

Content Type

所有发送数据的请求应包含 Content-Type header:

Content-Type: application/json

对于文件上传,使用:

Content-Type: multipart/form-data

可用 Endpoint

Sparks

使用自定义配置创建和管理 AI mind(agent)。

  • GET /api/v1/sparks - 列出所有 spark
  • GET /api/v1/sparks/{sparkId} - 获取 spark 详情
  • POST /api/v1/sparks - 创建新的 spark
  • PUT /api/v1/sparks/{sparkId} - 更新 spark
  • DELETE /api/v1/sparks/{sparkId} - 删除 spark
  • POST /api/v1/sparks/{sparkId}/regenerate-prompt - 基于知识重新生成 system prompt

Knowledge

管理你的 mind 的知识。

  • GET /api/v1/sparks/{sparkId}/knowledge - 列出知识条目
  • POST /api/v1/sparks/{sparkId}/knowledge - 添加知识(链接、文件或关键词搜索)
  • PUT /api/v1/sparks/{sparkId}/knowledge/{itemId} - 更新知识条目
  • DELETE /api/v1/sparks/{sparkId}/knowledge/{itemId} - 删除知识条目
  • POST /api/v1/sparks/{sparkId}/knowledge/enrich - 通过关键词搜索丰富知识(便利别名)
  • GET /api/v1/sparks/{sparkId}/knowledge/patterns - 按框架获取知识模式

Chat

通过 chat 补全与你的 mind 交互。

  • POST /api/v1/sparks/{sparkId}/completion - 发送消息并获取响应

Panels

创建和管理用于调研多个 mind 的 AI 面板。

  • GET /api/v1/panels - 列出所有面板
  • POST /api/v1/panels - 创建新面板
  • GET /api/v1/panels/{panelId} - 获取面板详情及消息历史
  • POST /api/v1/panels/{panelId}/ask - 向所有面板 mind 提问(SSE 流)
  • POST /api/v1/panels/{panelId}/export - 将面板结果导出为报告
  • GET /api/v1/panels/{panelId}/export-status - 查询导出作业状态
  • GET /api/v1/panels/{panelId}/export-download - 下载导出的 PDF

User

用户相关 endpoint。

  • GET /api/v1/auth/me - 获取当前已认证用户
  • GET /api/v1/user/shareable-sparks - 列出可分享的 mind

API Keys

管理你的身份验证 API key。

  • GET /api/v1/api-keys - 列出你的 API key
  • POST /api/v1/api-keys - 创建新的 API key
  • DELETE /api/v1/api-keys/{keyId} - 删除 API key

快速示例

下面是一个创建 mind 并与之聊天的快速示例:

# 1. Create a mind (keywords mode)
curl -X POST "https://getminds.ai/api/v1/sparks" \
  -H "Authorization: Bearer minds_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Marketing Expert",
    "description": "Expert in digital marketing strategies",
    "mode": "keywords",
    "type": "expert",
    "discipline": "Marketing",
    "keywords": ["SEO", "content marketing", "social media", "analytics"]
  }'

# Response: { "data": { "id": "spark-id", ... }, "processing": { "queued": true, ... } }

# 2. Create a mind from social profile (clone mode)
curl -X POST "https://getminds.ai/api/v1/sparks" \
  -H "Authorization: Bearer minds_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Influencer Clone",
    "description": "AI trained on influencer social presence",
    "mode": "clone",
    "type": "creative",
    "discipline": "Social Media Marketing",
    "personaContext": "https://twitter.com/username"
  }'

# 3. Chat with the mind
curl -X POST "https://getminds.ai/api/v1/sparks/spark-id/completion" \
  -H "Authorization: Bearer minds_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "messages": [
      {
        "role": "user",
        "content": "What are the top social media trends for 2025?"
      }
    ]
  }'

下一步

计划限制

API 使用情况取决于你的订阅计划:

计划MindFlow每个 Flow 的消息数
Free10(锁定)100
Premium无限制无限制无限制
Team无限制无限制无限制

查看计划

需要帮助?

如果你对 API 有疑问或需要支持:

  • 查看我们的 指南
  • 通过反馈表单联系我们
  • 加入社区讨论