@agentmc/api 0.1.1

package/docs/operations/markNotificationRead.md

@@ -0,0 +1,160 @@
+# markNotificationRead
+
+- Method: `PATCH`
+- Path: `/notifications/{notification}/read`
+- Summary: Mark one workspace notification as read.
+- Auth: ApiKeyAuth OR AgentBearerAuth OR BearerAuth
+
+## Description
+
+No additional description.
+
+## Parameters
+
+| Name | In | Required | Description | Example |
+| --- | --- | --- | --- | --- |
+| notification | path | yes | Notification UUID. | "11111111-1111-4111-8111-111111111111" |
+
+## Request Example
+
+### application/json
+```json
+{}
+```
+
+## Success Responses
+
+### 200 (application/json)
+Notification updated.
+
+```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"
+  }
+}
+```
+
+
+## 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."
+        ]
+      }
+    }
+  }
+}
+```
+
+### 404 (application/json)
+Resource not found.
+
+```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.markNotificationRead({
+  "params": {
+    "path": {
+      "notification": "11111111-1111-4111-8111-111111111111"
+    }
+  },
+  "body": {}
+});
+
+if (result.error) {
+  console.error(result.status, result.error);
+} else {
+  console.log(result.data);
+}
+```
+
+## cURL Example
+
+```bash
+curl -X PATCH "https://agentmc.ai/api/v1/notifications/11111111-1111-4111-8111-111111111111/read" \\
+  -H "Accept: application/json" \\
+  -H "X-Api-Key: $AGENTMC_API_KEY" \\
+  -H "Content-Type: application/json" \\
+  --data-raw "{}"
+```

package/docs/operations/showBoard.md

@@ -0,0 +1,134 @@
+# showBoard
+
+- Method: `GET`
+- Path: `/boards/{id}`
+- Summary: Show one board.
+- Auth: ApiKeyAuth OR AgentBearerAuth OR BearerAuth
+
+## Description
+
+No additional description.
+
+## Parameters
+
+| Name | In | Required | Description | Example |
+| --- | --- | --- | --- | --- |
+| id | path | yes | Board identifier. | 42 |
+
+## Request Example
+
+None.
+
+## Success Responses
+
+### 200 (application/json)
+Board 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"
+  }
+}
+```
+
+
+## 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."
+        ]
+      }
+    }
+  }
+}
+```
+
+### 404 (application/json)
+Resource not found.
+
+```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.showBoard({
+  "params": {
+    "path": {
+      "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/42" \\
+  -H "Accept: application/json" \\
+  -H "X-Api-Key: $AGENTMC_API_KEY"
+```

package/docs/operations/showHost.md

@@ -0,0 +1,172 @@
+# showHost
+
+- Method: `GET`
+- Path: `/hosts/{id}`
+- Summary: Show one host.
+- Auth: ApiKeyAuth OR AgentBearerAuth OR BearerAuth
+
+## Description
+
+Returns one host record including id/team/name/fingerprint, status + last_seen_at, metadata snapshot, and assigned-agent totals.
+
+## Parameters
+
+| Name | In | Required | Description | Example |
+| --- | --- | --- | --- | --- |
+| id | path | yes | Host identifier. | 42 |
+| agents_per_page | query | no | Agents per page. | 25 |
+
+## Request Example
+
+None.
+
+## Success Responses
+
+### 200 (application/json)
+Host 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"
+  },
+  "agents": [
+    {
+      "id": 42,
+      "workspace_id": 42,
+      "host_id": 42,
+      "name": "Example Name",
+      "type": "example",
+      "status": "pending",
+      "tasks_count": 0,
+      "last_seen_at": "2026-02-22T17:21:00Z",
+      "created_at": "2026-02-22T17:21:00Z",
+      "updated_at": "2026-02-22T17:21:00Z"
+    }
+  ],
+  "agents_meta": {
+    "current_page": 1,
+    "last_page": 1,
+    "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."
+        ]
+      }
+    }
+  }
+}
+```
+
+### 404 (application/json)
+Resource not found.
+
+```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.showHost({
+  "params": {
+    "path": {
+      "id": 42
+    },
+    "query": {
+      "agents_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/hosts/42?agents_per_page=25" \\
+  -H "Accept: application/json" \\
+  -H "X-Api-Key: $AGENTMC_API_KEY"
+```

package/docs/operations/showTask.md

@@ -0,0 +1,140 @@
+# showTask
+
+- Method: `GET`
+- Path: `/tasks/{task}`
+- Summary: Show one task.
+- Auth: ApiKeyAuth OR AgentBearerAuth OR BearerAuth
+
+## Description
+
+No additional description.
+
+## Parameters
+
+| Name | In | Required | Description | Example |
+| --- | --- | --- | --- | --- |
+| task | path | yes | Task identifier. | 1 |
+
+## Request Example
+
+None.
+
+## Success Responses
+
+### 200 (application/json)
+Task returned.
+
+```json
+{
+  "data": {
+    "id": 42,
+    "team_id": 42,
+    "board_id": 42,
+    "column_id": 42,
+    "title": "Example Title",
+    "description": "Example description text.",
+    "status": "backlog",
+    "position": 1,
+    "due_at": "2026-02-22T17:21:00Z",
+    "created_by_user_id": 42,
+    "assigned_to_user_id": 42,
+    "assigned_to_agent_id": 42,
+    "assignee_type": "human",
+    "created_at": "2026-02-22T17:21:00Z",
+    "updated_at": "2026-02-22T17:21:00Z"
+  }
+}
+```
+
+
+## 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."
+        ]
+      }
+    }
+  }
+}
+```
+
+### 404 (application/json)
+Resource not found.
+
+```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.showTask({
+  "params": {
+    "path": {
+      "task": 1
+    }
+  }
+});
+
+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/tasks/1" \\
+  -H "Accept: application/json" \\
+  -H "X-Api-Key: $AGENTMC_API_KEY"
+```