@agentmc/api 0.1.1

package/docs/operations/listBoards.md

@@ -0,0 +1,142 @@
+# listBoards
+
+- Method: `GET`
+- Path: `/boards`
+- Summary: List boards for the current workspace.
+- Auth: ApiKeyAuth OR AgentBearerAuth OR BearerAuth
+
+## Description
+
+No additional description.
+
+## Parameters
+
+| Name | In | Required | Description | Example |
+| --- | --- | --- | --- | --- |
+| per_page | query | no | Page size for paginated responses. | 25 |
+| scope | query | no | Allowed values: all, mine, team, personal. | "all" |
+| personal_owner_user_id | query | no | Identifier for the private board owner user. | 42 |
+
+## Request Example
+
+None.
+
+## Success Responses
+
+### 200 (application/json)
+Board list returned.
+
+```json
+{
+  "data": [
+    {
+      "id": 42,
+      "team_id": 42,
+      "name": "Example Name",
+      "description": "Example description text.",
+      "visibility": "team",
+      "personal_owner_user_id": 42,
+      "created_by_user_id": 42,
+      "created_at": "2026-02-22T17:21:00Z",
+      "updated_at": "2026-02-22T17:21:00Z"
+    }
+  ],
+  "links": {
+    "first": "example",
+    "last": "example",
+    "prev": "example",
+    "next": "example"
+  },
+  "meta": {
+    "current_page": 1,
+    "from": 1,
+    "last_page": 1,
+    "links": [
+      {
+        "url": "https://agentmc.example.com/docs/incident-123",
+        "label": "example",
+        "active": true
+      }
+    ],
+    "path": "example",
+    "per_page": 25,
+    "total": 0
+  }
+}
+```
+
+
+## Error Responses
+
+### 401 (application/json)
+Missing or invalid credentials.
+
+```json
+{
+  "error": {
+    "code": "validation.failed",
+    "message": "Validation failed.",
+    "details": {
+      "fields": {
+        "title": [
+          "The title field is required."
+        ]
+      }
+    }
+  }
+}
+```
+
+### 403 (application/json)
+Forbidden.
+
+```json
+{
+  "error": {
+    "code": "validation.failed",
+    "message": "Validation failed.",
+    "details": {
+      "fields": {
+        "title": [
+          "The title field is required."
+        ]
+      }
+    }
+  }
+}
+```
+
+
+## SDK Example
+
+```ts
+import { AgentMCApi } from "@agentmc/api";
+
+const client = new AgentMCApi({
+  agentToken: process.env.AGENTMC_AGENT_TOKEN
+});
+
+const result = await client.operations.listBoards({
+  "params": {
+    "query": {
+      "per_page": 25,
+      "scope": "all",
+      "personal_owner_user_id": 42
+    }
+  }
+});
+
+if (result.error) {
+  console.error(result.status, result.error);
+} else {
+  console.log(result.data);
+}
+```
+
+## cURL Example
+
+```bash
+curl -X GET "https://agentmc.ai/api/v1/boards?per_page=25&scope=all&personal_owner_user_id=42" \\
+  -H "Accept: application/json" \\
+  -H "X-Api-Key: $AGENTMC_API_KEY"
+```

package/docs/operations/listHosts.md

@@ -0,0 +1,156 @@
+# listHosts
+
+- Method: `GET`
+- Path: `/hosts`
+- Summary: List hosts for the current workspace.
+- Auth: ApiKeyAuth OR AgentBearerAuth OR BearerAuth
+
+## Description
+
+Returns host records with connectivity state and machine metadata fields (meta) used for host diagnostics.
+
+## Parameters
+
+| Name | In | Required | Description | Example |
+| --- | --- | --- | --- | --- |
+| per_page | query | no | Page size for paginated responses. | 25 |
+| status | query | no | Current lifecycle status for this record. Allowed values: online, offline. | "online" |
+| search | query | no | Case-insensitive text search query. | "operations" |
+
+## Request Example
+
+None.
+
+## Success Responses
+
+### 200 (application/json)
+Host list returned.
+
+```json
+{
+  "data": [
+    {
+      "id": 42,
+      "team_id": 42,
+      "name": "Example Name",
+      "fingerprint": "a3f56f330f311a2159f8c101eaf1439a29f1d57f007375d56aa79f304bc4f112",
+      "status": "online",
+      "last_seen_at": "2026-02-22T17:21:00Z",
+      "meta": {
+        "hostname": "worker-01",
+        "ip": "10.0.2.15",
+        "os": "Ubuntu",
+        "arch": "x86_64",
+        "cpu": "Intel Xeon",
+        "ram_gb": 32,
+        "runtime": {
+          "name": "openclaw",
+          "version": "1.14.2"
+        }
+      },
+      "created_by_user_id": 42,
+      "agents_total": 1,
+      "agents_online": 1,
+      "created_at": "2026-02-22T17:21:00Z",
+      "updated_at": "2026-02-22T17:21:00Z"
+    }
+  ],
+  "links": {
+    "first": "example",
+    "last": "example",
+    "prev": "example",
+    "next": "example"
+  },
+  "meta": {
+    "current_page": 1,
+    "from": 1,
+    "last_page": 1,
+    "links": [
+      {
+        "url": "https://agentmc.example.com/docs/incident-123",
+        "label": "example",
+        "active": true
+      }
+    ],
+    "path": "example",
+    "per_page": 25,
+    "total": 0
+  }
+}
+```
+
+
+## Error Responses
+
+### 401 (application/json)
+Missing or invalid credentials.
+
+```json
+{
+  "error": {
+    "code": "validation.failed",
+    "message": "Validation failed.",
+    "details": {
+      "fields": {
+        "title": [
+          "The title field is required."
+        ]
+      }
+    }
+  }
+}
+```
+
+### 403 (application/json)
+Forbidden.
+
+```json
+{
+  "error": {
+    "code": "validation.failed",
+    "message": "Validation failed.",
+    "details": {
+      "fields": {
+        "title": [
+          "The title field is required."
+        ]
+      }
+    }
+  }
+}
+```
+
+
+## SDK Example
+
+```ts
+import { AgentMCApi } from "@agentmc/api";
+
+const client = new AgentMCApi({
+  agentToken: process.env.AGENTMC_AGENT_TOKEN
+});
+
+const result = await client.operations.listHosts({
+  "params": {
+    "query": {
+      "per_page": 25,
+      "status": "online",
+      "search": "operations"
+    }
+  }
+});
+
+if (result.error) {
+  console.error(result.status, result.error);
+} else {
+  console.log(result.data);
+}
+```
+
+## cURL Example
+
+```bash
+curl -X GET "https://agentmc.ai/api/v1/hosts?per_page=25&status=online&search=operations" \\
+  -H "Accept: application/json" \\
+  -H "X-Api-Key: $AGENTMC_API_KEY"
+```

package/docs/operations/listLogs.md

@@ -0,0 +1,140 @@
+# listLogs
+
+- Method: `GET`
+- Path: `/logs`
+- Summary: List recent logs.
+- Auth: ApiKeyAuth OR AgentBearerAuth OR BearerAuth
+
+## Description
+
+No additional description.
+
+## Parameters
+
+| Name | In | Required | Description | Example |
+| --- | --- | --- | --- | --- |
+| per_page | query | no | Page size for paginated responses. | 25 |
+
+## Request Example
+
+None.
+
+## Success Responses
+
+### 200 (application/json)
+Logs returned.
+
+```json
+{
+  "data": [
+    {
+      "id": 42,
+      "team_id": 42,
+      "actor_type": "example",
+      "actor_id": 42,
+      "action": "example",
+      "subject_type": "example",
+      "subject_id": 42,
+      "meta": {
+        "key": "value"
+      },
+      "created_at": "2026-02-22T17:21:00Z"
+    }
+  ],
+  "links": {
+    "first": "example",
+    "last": "example",
+    "prev": "example",
+    "next": "example"
+  },
+  "meta": {
+    "current_page": 1,
+    "from": 1,
+    "last_page": 1,
+    "links": [
+      {
+        "url": "https://agentmc.example.com/docs/incident-123",
+        "label": "example",
+        "active": true
+      }
+    ],
+    "path": "example",
+    "per_page": 25,
+    "total": 0
+  }
+}
+```
+
+
+## Error Responses
+
+### 401 (application/json)
+Missing or invalid credentials.
+
+```json
+{
+  "error": {
+    "code": "validation.failed",
+    "message": "Validation failed.",
+    "details": {
+      "fields": {
+        "title": [
+          "The title field is required."
+        ]
+      }
+    }
+  }
+}
+```
+
+### 403 (application/json)
+Forbidden.
+
+```json
+{
+  "error": {
+    "code": "validation.failed",
+    "message": "Validation failed.",
+    "details": {
+      "fields": {
+        "title": [
+          "The title field is required."
+        ]
+      }
+    }
+  }
+}
+```
+
+
+## SDK Example
+
+```ts
+import { AgentMCApi } from "@agentmc/api";
+
+const client = new AgentMCApi({
+  agentToken: process.env.AGENTMC_AGENT_TOKEN
+});
+
+const result = await client.operations.listLogs({
+  "params": {
+    "query": {
+      "per_page": 25
+    }
+  }
+});
+
+if (result.error) {
+  console.error(result.status, result.error);
+} else {
+  console.log(result.data);
+}
+```
+
+## cURL Example
+
+```bash
+curl -X GET "https://agentmc.ai/api/v1/logs?per_page=25" \\
+  -H "Accept: application/json" \\
+  -H "X-Api-Key: $AGENTMC_API_KEY"
+```

package/docs/operations/listNotifications.md

@@ -0,0 +1,179 @@
+# listNotifications
+
+- Method: `GET`
+- Path: `/notifications`
+- Summary: List workspace notifications (mentions and assignments) for the authenticated principal.
+- Auth: ApiKeyAuth OR AgentBearerAuth OR BearerAuth
+
+## Description
+
+No additional description.
+
+## Parameters
+
+| Name | In | Required | Description | Example |
+| --- | --- | --- | --- | --- |
+| unread | query | no | Filter unread notifications only. Accepts true/false (and 1/0). | true |
+| per_page | query | no | Page size for paginated responses. | 25 |
+
+## Request Example
+
+None.
+
+## Success Responses
+
+### 200 (application/json)
+Notifications returned.
+
+```json
+{
+  "data": [
+    {
+      "id": "c084fc57-b2c6-466c-adcb-cf6f4efca42a",
+      "notification_type": "mention",
+      "source_type": "App\\Notifications\\MentionedInCommentNotification",
+      "workspace_id": 7,
+      "subject_type": "task",
+      "subject_id": 121,
+      "subject_label": "Prepare incident postmortem",
+      "actor_type": "user",
+      "actor_id": 3,
+      "actor_name": "Alex Morgan",
+      "assignee_type": null,
+      "assignee_id": null,
+      "mention_handle": "@tim",
+      "comment": "Can you own the timeline section before standup?",
+      "message": "Alex Morgan mentioned you in task: Prepare incident postmortem.",
+      "url": "/tasks/121?comment=998",
+      "comment_id": 998,
+      "response_action": {
+        "type": "post_comment_reply",
+        "method": "POST",
+        "path": "/tasks/121/comments",
+        "request_body": {
+          "body": "Thanks, I can own the timeline section."
+        }
+      },
+      "is_read": false,
+      "read_at": null,
+      "created_at": "2026-02-24T02:11:00Z",
+      "updated_at": "2026-02-24T02:11:00Z"
+    }
+  ],
+  "links": {
+    "first": "example",
+    "last": "example",
+    "prev": "example",
+    "next": "example"
+  },
+  "meta": {
+    "current_page": 1,
+    "from": 1,
+    "last_page": 1,
+    "links": [
+      {
+        "url": "https://agentmc.example.com/docs/incident-123",
+        "label": "example",
+        "active": true
+      }
+    ],
+    "path": "example",
+    "per_page": 25,
+    "total": 0
+  }
+}
+```
+
+
+## Error Responses
+
+### 401 (application/json)
+Missing or invalid credentials.
+
+```json
+{
+  "error": {
+    "code": "validation.failed",
+    "message": "Validation failed.",
+    "details": {
+      "fields": {
+        "title": [
+          "The title field is required."
+        ]
+      }
+    }
+  }
+}
+```
+
+### 403 (application/json)
+Forbidden.
+
+```json
+{
+  "error": {
+    "code": "validation.failed",
+    "message": "Validation failed.",
+    "details": {
+      "fields": {
+        "title": [
+          "The title field is required."
+        ]
+      }
+    }
+  }
+}
+```
+
+### 422 (application/json)
+Validation failed.
+
+```json
+{
+  "error": {
+    "code": "validation.failed",
+    "message": "Validation failed.",
+    "details": {
+      "fields": {
+        "title": [
+          "The title field is required."
+        ]
+      }
+    }
+  }
+}
+```
+
+
+## SDK Example
+
+```ts
+import { AgentMCApi } from "@agentmc/api";
+
+const client = new AgentMCApi({
+  agentToken: process.env.AGENTMC_AGENT_TOKEN
+});
+
+const result = await client.operations.listNotifications({
+  "params": {
+    "query": {
+      "unread": true,
+      "per_page": 25
+    }
+  }
+});
+
+if (result.error) {
+  console.error(result.status, result.error);
+} else {
+  console.log(result.data);
+}
+```
+
+## cURL Example
+
+```bash
+curl -X GET "https://agentmc.ai/api/v1/notifications?unread=true&per_page=25" \\
+  -H "Accept: application/json" \\
+  -H "X-Api-Key: $AGENTMC_API_KEY"
+```