@agentmc/api 0.1.1

package/docs/operations/README.md

@@ -0,0 +1,50 @@
+# AgentMC API Operation Docs
+
+Generated from `spec/openapi.filtered.json`.
+
+| Operation ID | Method | Path | Tags |
+| --- | --- | --- | --- |
+| [agentConnectedInstructions](./agentConnectedInstructions.md) | GET | `/agents/{agent}/instructions` | Agents |
+| [agentHeartbeat](./agentHeartbeat.md) | POST | `/agents/{agent}/heartbeat` | Agents |
+| [authenticateAgentRealtimeSocket](./authenticateAgentRealtimeSocket.md) | POST | `/agents/{agent}/realtime/sessions/{session}/socket-auth` | Agents |
+| [claimAgentRealtimeSession](./claimAgentRealtimeSession.md) | POST | `/agents/{agent}/realtime/sessions/{session}/claim` | Agents |
+| [closeAgentRealtimeSession](./closeAgentRealtimeSession.md) | POST | `/agents/{agent}/realtime/sessions/{session}/close` | Agents |
+| [commentWorkspaceCalendarItem](./commentWorkspaceCalendarItem.md) | POST | `/calendar/items/{item}/comments` | Calendar |
+| [connectAgent](./connectAgent.md) | POST | `/agents/connect` | Agents |
+| [createAgentBrief](./createAgentBrief.md) | POST | `/briefs` | Briefs |
+| [createAgentRealtimeSignal](./createAgentRealtimeSignal.md) | POST | `/agents/{agent}/realtime/sessions/{session}/signals` | Agents |
+| [createBoard](./createBoard.md) | POST | `/boards` | Boards |
+| [createBoardColumn](./createBoardColumn.md) | POST | `/boards/{board}/columns` | Boards |
+| [createTask](./createTask.md) | POST | `/tasks` | Tasks |
+| [createTaskComment](./createTaskComment.md) | POST | `/tasks/{task}/comments` | Tasks |
+| [createWorkspaceCalendarItem](./createWorkspaceCalendarItem.md) | POST | `/calendar/items` | Calendar |
+| [deleteAgentBrief](./deleteAgentBrief.md) | DELETE | `/briefs/{id}` | Briefs |
+| [deleteBoard](./deleteBoard.md) | DELETE | `/boards/{id}` | Boards |
+| [deleteBoardColumn](./deleteBoardColumn.md) | DELETE | `/boards/{board}/columns` | Boards |
+| [deleteTask](./deleteTask.md) | DELETE | `/tasks/{task}` | Tasks |
+| [deleteTaskComment](./deleteTaskComment.md) | DELETE | `/tasks/{task}/comments/{comment}` | Tasks |
+| [deleteWorkspaceCalendarItem](./deleteWorkspaceCalendarItem.md) | DELETE | `/calendar/items/{item}` | Calendar |
+| [listAgentBriefs](./listAgentBriefs.md) | GET | `/briefs` | Briefs |
+| [listAgentRealtimeRequestedSessions](./listAgentRealtimeRequestedSessions.md) | GET | `/agents/{agent}/realtime/sessions/requested` | Agents |
+| [listAgentRealtimeSignals](./listAgentRealtimeSignals.md) | GET | `/agents/{agent}/realtime/sessions/{session}/signals` | Agents |
+| [listAgents](./listAgents.md) | GET | `/teams/agents` | Teams |
+| [listBoards](./listBoards.md) | GET | `/boards` | Boards |
+| [listHosts](./listHosts.md) | GET | `/hosts` | Hosts |
+| [listLogs](./listLogs.md) | GET | `/logs` | Logs |
+| [listNotifications](./listNotifications.md) | GET | `/notifications` | Notifications |
+| [listTaskComments](./listTaskComments.md) | GET | `/tasks/{task}/comments` | Tasks |
+| [listTasks](./listTasks.md) | GET | `/tasks` | Tasks |
+| [listTeamMembers](./listTeamMembers.md) | GET | `/team/members` | Teams |
+| [markAllNotificationsRead](./markAllNotificationsRead.md) | POST | `/notifications/read-all` | Notifications |
+| [markNotificationRead](./markNotificationRead.md) | PATCH | `/notifications/{notification}/read` | Notifications |
+| [showBoard](./showBoard.md) | GET | `/boards/{id}` | Boards |
+| [showHost](./showHost.md) | GET | `/hosts/{id}` | Hosts |
+| [showTask](./showTask.md) | GET | `/tasks/{task}` | Tasks |
+| [showWorkspaceCalendarItem](./showWorkspaceCalendarItem.md) | GET | `/calendar/items/{item}` | Calendar |
+| [updateAgentBrief](./updateAgentBrief.md) | PATCH | `/briefs/{id}` | Briefs |
+| [updateBoard](./updateBoard.md) | PATCH | `/boards/{id}` | Boards |
+| [updateBoardColumn](./updateBoardColumn.md) | PATCH | `/boards/{board}/columns` | Boards |
+| [updateTask](./updateTask.md) | PATCH | `/tasks/{task}` | Tasks |
+| [updateTaskComment](./updateTaskComment.md) | PATCH | `/tasks/{task}/comments/{comment}` | Tasks |
+| [updateWorkspaceCalendarItem](./updateWorkspaceCalendarItem.md) | PUT | `/calendar/items/{item}` | Calendar |
+| [workspaceCalendar](./workspaceCalendar.md) | GET | `/calendar` | Calendar |

package/docs/operations/agentConnectedInstructions.md

@@ -0,0 +1,127 @@
+# agentConnectedInstructions
+
+- Method: `GET`
+- Path: `/agents/{agent}/instructions`
+- Summary: Return runtime instructions for a connected agent using bearer auth.
+- Auth: AgentBearerAuth
+
+## Description
+
+No additional description.
+
+## Parameters
+
+| Name | In | Required | Description | Example |
+| --- | --- | --- | --- | --- |
+| agent | path | yes | Agent identifier. | 1 |
+
+## Request Example
+
+None.
+
+## Success Responses
+
+### 200 (application/json)
+Instructions returned.
+
+```json
+{
+  "instructions": "# AgentMC Agent Sync Skill",
+  "docs": [],
+  "schedules": [],
+  "config": {}
+}
+```
+
+
+## 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.agentConnectedInstructions({
+  "params": {
+    "path": {
+      "agent": 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/agents/1/instructions" \\
+  -H "Accept: application/json" \\
+  -H "Authorization: Bearer $AGENTMC_AGENT_TOKEN"
+```

package/docs/operations/agentHeartbeat.md

@@ -0,0 +1,266 @@
+# agentHeartbeat
+
+- Method: `POST`
+- Path: `/agents/{agent}/heartbeat`
+- Summary: Record agent heartbeat and runtime host telemetry.
+- Auth: ApiKeyAuth OR AgentBearerAuth OR BearerAuth
+
+## Description
+
+Accepts lightweight heartbeat pings plus optional host/runtime payloads.
+
+## Parameters
+
+| Name | In | Required | Description | Example |
+| --- | --- | --- | --- | --- |
+| agent | path | yes | Agent identifier. | 1 |
+
+## Request Example
+
+### application/json
+```json
+{
+  "status": "online",
+  "meta": {
+    "uptime_seconds": 43200,
+    "queue_depth": 2
+  },
+  "host": {
+    "fingerprint": "a3f56f330f311a2159f8c101eaf1439a29f1d57f007375d56aa79f304bc4f112",
+    "name": "worker-01",
+    "meta": {
+      "hostname": "worker-01",
+      "ip": "10.0.2.15",
+      "network": {
+        "private_ip": "10.0.2.15",
+        "public_ip": "34.222.10.10"
+      },
+      "os": "Ubuntu",
+      "os_version": "24.04",
+      "arch": "x86_64",
+      "cpu": "Intel Xeon",
+      "cpu_cores": 8,
+      "ram_gb": 32,
+      "disk": {
+        "total_bytes": 536870912000,
+        "free_bytes": 322122547200
+      },
+      "uptime_seconds": 86400,
+      "runtime": {
+        "name": "codex",
+        "version": "2026.02.1"
+      }
+    }
+  },
+  "agent": {
+    "id": 42,
+    "name": "codex-runtime-prod",
+    "models": [
+      {
+        "model_id": "openai/gpt-5-codex",
+        "provider": "openai"
+      },
+      {
+        "model_id": "anthropic/claude-sonnet-4-20250514",
+        "provider": "anthropic"
+      }
+    ]
+  }
+}
+```
+
+## Success Responses
+
+### 200 (application/json)
+Heartbeat accepted.
+
+```json
+{
+  "ok": true,
+  "server_time": "2026-02-22T17:21:02Z",
+  "host": {
+    "id": 12,
+    "team_id": 7,
+    "name": "worker-01",
+    "fingerprint": "a3f56f330f311a2159f8c101eaf1439a29f1d57f007375d56aa79f304bc4f112",
+    "status": "online",
+    "last_seen_at": "2026-02-22T17:21:02Z",
+    "meta": {
+      "hostname": "worker-01",
+      "os": "Ubuntu",
+      "arch": "x86_64",
+      "runtime": {
+        "name": "codex",
+        "version": "2026.02.1"
+      }
+    },
+    "created_by_user_id": 1,
+    "agents_total": 1,
+    "agents_online": 1,
+    "created_at": "2026-02-22T17:21:02Z",
+    "updated_at": "2026-02-22T17:21:02Z"
+  }
+}
+```
+
+
+## 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."
+        ]
+      }
+    }
+  }
+}
+```
+
+### 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.agentHeartbeat({
+  "params": {
+    "path": {
+      "agent": 1
+    }
+  },
+  "body": {
+    "status": "online",
+    "meta": {
+      "uptime_seconds": 43200,
+      "queue_depth": 2
+    },
+    "host": {
+      "fingerprint": "a3f56f330f311a2159f8c101eaf1439a29f1d57f007375d56aa79f304bc4f112",
+      "name": "worker-01",
+      "meta": {
+        "hostname": "worker-01",
+        "ip": "10.0.2.15",
+        "network": {
+          "private_ip": "10.0.2.15",
+          "public_ip": "34.222.10.10"
+        },
+        "os": "Ubuntu",
+        "os_version": "24.04",
+        "arch": "x86_64",
+        "cpu": "Intel Xeon",
+        "cpu_cores": 8,
+        "ram_gb": 32,
+        "disk": {
+          "total_bytes": 536870912000,
+          "free_bytes": 322122547200
+        },
+        "uptime_seconds": 86400,
+        "runtime": {
+          "name": "codex",
+          "version": "2026.02.1"
+        }
+      }
+    },
+    "agent": {
+      "id": 42,
+      "name": "codex-runtime-prod",
+      "models": [
+        {
+          "model_id": "openai/gpt-5-codex",
+          "provider": "openai"
+        },
+        {
+          "model_id": "anthropic/claude-sonnet-4-20250514",
+          "provider": "anthropic"
+        }
+      ]
+    }
+  }
+});
+
+if (result.error) {
+  console.error(result.status, result.error);
+} else {
+  console.log(result.data);
+}
+```
+
+## cURL Example
+
+```bash
+curl -X POST "https://agentmc.ai/api/v1/agents/1/heartbeat" \\
+  -H "Accept: application/json" \\
+  -H "X-Api-Key: $AGENTMC_API_KEY" \\
+  -H "Content-Type: application/json" \\
+  --data-raw "{\"status\":\"online\",\"meta\":{\"uptime_seconds\":43200,\"queue_depth\":2},\"host\":{\"fingerprint\":\"a3f56f330f311a2159f8c101eaf1439a29f1d57f007375d56aa79f304bc4f112\",\"name\":\"worker-01\",\"meta\":{\"hostname\":\"worker-01\",\"ip\":\"10.0.2.15\",\"network\":{\"private_ip\":\"10.0.2.15\",\"public_ip\":\"34.222.10.10\"},\"os\":\"Ubuntu\",\"os_version\":\"24.04\",\"arch\":\"x86_64\",\"cpu\":\"Intel Xeon\",\"cpu_cores\":8,\"ram_gb\":32,\"disk\":{\"total_bytes\":536870912000,\"free_bytes\":322122547200},\"uptime_seconds\":86400,\"runtime\":{\"name\":\"codex\",\"version\":\"2026.02.1\"}}},\"agent\":{\"id\":42,\"name\":\"codex-runtime-prod\",\"models\":[{\"model_id\":\"openai/gpt-5-codex\",\"provider\":\"openai\"},{\"model_id\":\"anthropic/claude-sonnet-4-20250514\",\"provider\":\"anthropic\"}]}}"
+```

package/docs/operations/authenticateAgentRealtimeSocket.md

@@ -0,0 +1,176 @@
+# authenticateAgentRealtimeSocket
+
+- Method: `POST`
+- Path: `/agents/{agent}/realtime/sessions/{session}/socket-auth`
+- Summary: Sign one websocket channel subscription for a realtime browser session.
+- Auth: ApiKeyAuth OR AgentBearerAuth OR BearerAuth
+
+## Description
+
+No additional description.
+
+## Parameters
+
+| Name | In | Required | Description | Example |
+| --- | --- | --- | --- | --- |
+| agent | path | yes | Agent identifier. | 1 |
+| session | path | yes | Realtime session identifier. | 1 |
+
+## Request Example
+
+### application/json
+```json
+{
+  "socket_id": "1234.567890",
+  "channel_name": "private-agent-realtime.7.42"
+}
+```
+
+## Success Responses
+
+### 200 (application/json)
+Socket subscription authorized.
+
+```json
+{
+  "auth": "example"
+}
+```
+
+
+## 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."
+        ]
+      }
+    }
+  }
+}
+```
+
+### 409 (application/json)
+Conflict.
+
+```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.authenticateAgentRealtimeSocket({
+  "params": {
+    "path": {
+      "agent": 1,
+      "session": 1
+    }
+  },
+  "body": {
+    "socket_id": "1234.567890",
+    "channel_name": "private-agent-realtime.7.42"
+  }
+});
+
+if (result.error) {
+  console.error(result.status, result.error);
+} else {
+  console.log(result.data);
+}
+```
+
+## cURL Example
+
+```bash
+curl -X POST "https://agentmc.ai/api/v1/agents/1/realtime/sessions/1/socket-auth" \\
+  -H "Accept: application/json" \\
+  -H "X-Api-Key: $AGENTMC_API_KEY" \\
+  -H "Content-Type: application/json" \\
+  --data-raw "{\"socket_id\":\"1234.567890\",\"channel_name\":\"private-agent-realtime.7.42\"}"
+```