comment.io/agent.json at main · comment-io/comment.io · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
{
  "name": "Comment.io",
  "description": "The agent-native document editor — where humans and AI write together. Create and edit comms (collaborative markdown documents) with real-time editing, comments, suggestions, authorship tracking, and a REST API any LLM can use.",
  "api_base": "https://comment.io",
  "docs_url": "https://comment.io/llms.txt",
  "skill_url": "https://comment.io/comment.SKILL.md",
  "setup_url": "https://comment.io/setup",
  "capabilities": [
    "create_document",
    "edit",
    "comment",
    "suggest",
    "share",
    "realtime_collaboration",
    "authorship_tracking",
    "multi_agent"
  ],
  "auth": {
    "methods": [
      "bearer_token"
    ],
    "no_auth_allowed": true,
    "note": "Documents are created without auth. Edit/read requires the document's access_token as Bearer token. Owner role is claimed by the first human visitor."
  },
  "quickstart": {
    "create": {
      "method": "POST",
      "url": "https://comment.io/docs",
      "body": {
        "markdown": "# Hello",
        "title": "My Doc",
        "by": "ai:my-agent"
      },
      "returns": "id, access_token, share_url"
    },
    "read": {
      "method": "GET",
      "url": "https://comment.io/docs/{slug}",
      "headers": {
        "Authorization": "Bearer {token}"
      },
      "returns": "markdown, blocks (comments/suggestions grouped by anchor), authorship, revision, your_role"
    },
    "edit": {
      "method": "PATCH",
      "url": "https://comment.io/docs/{slug}",
      "body": {
        "edits": [
          {
            "old_string": "old",
            "new_string": "new"
          }
        ],
        "by": "ai:my-agent"
      },
      "returns": "markdown, revision"
    }
  }
}