Agent API v1

几分钟内把外部上下文送进 MyInc 工作区。

用一个 API key 即可把笔记、链接、Markdown 和文件送进 MyInc 工作区。同一套 API 可以把这些上下文转化为 pages 和 drafts——但在发布之前,始终等待你的批准。

First request
curl https://myinc.app/api/agent/clips \
  -X POST \
  -H 'Authorization: Bearer tk_your_api_key' \
  -H 'Idempotency-Key: clip-001' \
  -H 'Content-Type: application/json' \
  -d '{
    "title": "每周洞察",
    "text": "保存今天调研中值得留存的最终答案。"
  }'
Clips
POST /api/agent/clips
Ingest
POST /api/agent/ingest
Upload
POST /api/agent/upload
Projects
POST /api/agent/projects

把外部上下文带入工作区

保存单条笔记、链接或回答

一次发送一条,作为 clip 进入 MyInc 工作区,供你的 AI 团队复用。

批量 ingest 链接、文本和 Markdown

把相关条目归入一个 capture,让工作区把它们放在一起以备后用。

创建 pages 并生成 drafts

先把上下文整理成 page,再让 MyInc 生成 draft——结果会保持待你批准的状态。

创建 projects 并添加条目

从你的 agent 打开一个 project,随着工作推进把 clip、page、draft 放入 project 的各个 stage。

Quickstart

1

登录 MyInc,在 Settings → API keys 中创建 scoped API key。

2

在每个请求中以 Bearer 认证发送 key,并在写请求上加 Idempotency-Key。

3

先从一个 clip 或一个 ingest 批次开始,再扩展到 pages、draft 生成、上传和 projects。

身份验证

MyInc Agent API v1 使用个人 API key。在 Settings → API keys 为特定集成创建 scoped key,并作为 Bearer token 保存在服务端。

curl https://myinc.app/api/agent/clips \
  -X POST \
  -H 'Authorization: Bearer tk_your_api_key' \
  -H 'Idempotency-Key: clip-001' \
  -H 'Content-Type: application/json' \
  -d '{
    "title": "每周洞察",
    "text": "保存今天调研中值得留存的最终答案。"
  }'
  • clips、ingest、upload、pages、generation、projects 均支持按范围创建 scoped key。
  • 推荐 scope:clips:write, ingest:write, upload:write, pages:read, pages:generate, projects:write。
  • 可在 Settings → API keys 创建和吊销 key。

额度与限制

Agent API 请求遵循与产品相同的套餐限制。额度在 AI 相关操作上扣除,而非单独的 agent 专用配额。

  • POST /api/agent/ingest 按条目扣除 AI 额度:text 1,markdown 1,url 2。
  • POST /api/agent/pages/:id/generate 使用 AI 额度:custom 6,template set 15。
  • 创建 project 仍遵循你套餐的活跃项目数上限。

幂等写入

写入端点支持 Idempotency-Key。用同一个 key 重发相同请求会返回已存结果;用同一个 key 但不同 body 会返回 409。

curl https://myinc.app/api/agent/projects \
  -X POST \
  -H 'Authorization: Bearer tk_your_api_key' \
  -H 'Idempotency-Key: project-2026-04-launch' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "四月发布计划",
    "template": "goal_milestones"
  }'

核心端点

POST/api/agent/clips

创建一个 clip

用于单条笔记、链接或要保存的回答。

{
  "title": "保存的回答",
  "text": "这是值得留存的最终摘要。",
  "tags": ["research", "launch"]
}
POST/api/agent/ingest

批量 ingest

把文本、URL 和 Markdown 一起发送,并归入同一个 capture。

{
  "items": [
    { "type": "url", "url": "https://example.com/article" },
    { "type": "markdown", "title": "笔记", "text": "# 要点\n- 一\n- 二" }
  ]
}
POST/api/agent/upload

上传文件

当 agent 需要附加文件时,也可通过同一套 Agent API 处理 multipart 上传。

curl https://myinc.app/api/agent/upload \
  -H 'Authorization: Bearer tk_your_api_key' \
  -H 'Idempotency-Key: upload-001' \
  -F '[email protected]'
POST/api/agent/pages/:id/generate

从 page 生成 draft

当保存的 clips 已整理成 page 后,用它从该 page 生成草稿。

{
  "mode": "custom",
  "prompt": "把这个 page 变成一篇可发布的简短简报。"
}
POST/api/agent/projects

创建一个 project

从 agent 工作流以名称、模板和状态开启一个新的 MyInc project。

{
  "name": "四月发布计划",
  "template": "goal_milestones",
  "icon": "🚀"
}
POST/api/agent/projects/:id/items

向 project stage 添加条目

从 agent 工作流把 clip、page、draft 或 published 条目放入 MyInc project 的某个 stage。

{
  "stage": "clip",
  "referenceId": "clip_123"
}

通用响应结构

Agent API v1 以同一个 envelope 返回成功与失败,便于你的集成统一处理。

{
  "success": true,
  "data": {
    "id": "clip_123",
    "title": "保存的回答"
  },
  "error": null
}

为 Hermes 与你自己的 agent 而建

把 Hermes 或你自建的 agent 接入 MyInc 工作区。先从 clips 和 ingest 开始,随着 AI 团队承担更多工作,再加入 pages、generation 和 projects。

外部上下文如何到达工作区

先用 clips 和 ingest 捕获

让 agent 对接 clips 和 ingest,随手把笔记、链接和 Markdown 送进 MyInc 工作区。

查看产品概览

再构建 pages 和 projects

上下文进入工作区后,生成 pages 与 drafts 并把工作整理进 projects——一切都等待你的批准。

查看产品概览

各端点示例参考

展开每个端点即可查看请求体、响应示例和集成说明。

POST/api/agent/clips创建一个 clip
Request body
{
  "title": "保存的回答",
  "text": "这是值得留存的最终摘要。",
  "tags": ["research", "launch"]
}
Response
{
  "success": true,
  "data": {
    "id": "clip_123",
    "title": "保存的回答",
    "text": "这是值得留存的最终摘要。"
  },
  "error": null
}
Notes
  • 适合作为 Hermes 或自有 agent 接入的第一个端点。
  • 一次保存一条好回答时最为简单。
  • GET /api/agent/clips 使用 clips:read 列出 clips。
POST/api/agent/ingest批量 ingest
Request body
{
  "items": [
    { "type": "url", "url": "https://example.com/article" },
    { "type": "markdown", "title": "笔记", "text": "# 要点\n- 一\n- 二" }
  ]
}
Response
{
  "success": true,
  "data": {
    "captureBatchId": "batch_123",
    "created": [
      { "id": "clip_1", "title": "https://example.com/article", "url": "https://example.com/article" },
      { "id": "clip_2", "title": "笔记", "url": null }
    ],
    "failed": []
  },
  "error": null
}
Notes
  • 当 agent 一次发送多个条目时最合适。
  • 一个请求中同时支持 text、url 和 markdown(最多 50 条)。
  • 该路由按条目扣除 AI 额度,额度不足时返回条目级别的 failed。
POST/api/agent/upload上传文件
Request body
curl https://myinc.app/api/agent/upload \
  -H 'Authorization: Bearer tk_your_api_key' \
  -H 'Idempotency-Key: upload-001' \
  -F '[email protected]'
Response
{
  "success": true,
  "data": {
    "id": "clip_upload_123",
    "title": "notes.md"
  },
  "error": null
}
Notes
  • 当 agent 发送真实文件而非纯 JSON 时使用此路由。
  • scoped key 与 idempotency 同样适用于上传。
  • 这是 MyInc 文件上传的公开 agent 外观,而非内部 web 路由。
POST/api/agent/pages/:id/generate从 page 生成 draft
Request body
{
  "mode": "custom",
  "prompt": "把这个 page 变成一篇可发布的简短简报。"
}
Response
{
  "success": true,
  "data": {
    "jobId": "draft_123",
    "type": "page_generation",
    "status": "completed",
    "result": {
      "draftId": "draft_123"
    }
  },
  "error": null
}
Notes
  • 生成的 draft 会在 MyInc 中保持待你批准状态,不会自动发布。
  • 请先把 clips 整理成 page 再调用(POST /api/agent/pages、GET /api/agent/pages/:id)。
  • 用 GET /api/agent/jobs/:id 查询 draft 状态;生成消耗与应用内相同的 AI 额度。
POST/api/agent/projects创建一个 project
Request body
{
  "name": "四月发布计划",
  "template": "goal_milestones",
  "icon": "🚀"
}
Response
{
  "success": true,
  "data": {
    "id": "project_123",
    "name": "四月发布计划",
    "template": "goal_milestones"
  },
  "error": null
}
Notes
  • 当 agent 需要长期工作区而不只是单个 clip 时使用。
  • 模板:goal_milestones 或 pipeline_board。
  • 创建 project 遵循与主应用相同的活跃项目数上限。
POST/api/agent/projects/:id/items向 project stage 添加条目
Request body
{
  "stage": "clip",
  "referenceId": "clip_123"
}
Response
{
  "success": true,
  "data": {
    "id": "project_item_123",
    "stage": "clip",
    "referenceId": "clip_123"
  },
  "error": null
}
Notes
  • 若省略 columnId,MyInc 会解析该 stage 的第一个 workflow column。
  • 在创建 clip 或 page 后立即衔接 project 流程最为自然。

当前 v1 范围

  • 面向早期集成的 Private Agent API,尚不是完全版本化的公开平台。
  • v1 现已包含 scoped API key、idempotency key、上传外观和 project 条目插入。
  • generation job 目前使用包裹现有 MyInc 草稿生成的轻量 job wrapper。

先跑通一个有用的请求,再交给你的 AI 团队继续。

最好的第一个集成很简单:把一条有用的回答、一个链接或一条 Markdown 笔记送进工作区。跑通之后,再把它变成由你的 AI 团队待批准准备好的 pages 和 drafts。

查看首个请求查看产品概览