@agentmc/api 0.1.1

package/docs/operations/createAgentBrief.md

@@ -0,0 +1,215 @@
+# createAgentBrief
+
+- Method: `POST`
+- Path: `/briefs`
+- Summary: Upsert a brief parent by key and append one child entry.
+- Auth: ApiKeyAuth OR AgentBearerAuth OR BearerAuth
+
+## Description
+
+On first sync for a key, AgentMC creates a parent brief and this first child. On later syncs for the same key, AgentMC reuses the parent and appends a new child entry.
+
+## Parameters
+
+None.
+
+## Request Example
+
+### application/json
+```json
+{
+  "brief": {
+    "key": "daily-operations",
+    "name": "Daily Operations Brief",
+    "summary": "Operations handoff digest for the morning window.",
+    "timezone": "America/Los_Angeles",
+    "headline": "3 overdue tasks | 4 upcoming events",
+    "content_markdown": "## Highlights\n- Elevated API error rate\n- Two incidents resolved",
+    "meta": {
+      "external_source": "daily-ops-job",
+      "schedule": "0 7 * * *"
+    }
+  },
+  "source": {
+    "agent_id": 42,
+    "meta": {
+      "runtime": "codex"
+    }
+  }
+}
+```
+
+## Success Responses
+
+### 201 (application/json)
+Brief report accepted.
+
+```json
+{
+  "brief": {
+    "id": 42,
+    "team_id": 42,
+    "agent_id": 42,
+    "external_key": "daily-operations",
+    "external_id": "ops-brief-2026-02-22",
+    "name": "Example Name",
+    "timezone": "America/Los_Angeles",
+    "summary": "Morning operations handoff digest.",
+    "include_sections": [
+      {
+        "key": "value"
+      }
+    ],
+    "headline": "3 overdue tasks | 4 upcoming events",
+    "content_markdown": "## Highlights\n- Elevated API error rate",
+    "content_json": {
+      "key": "value"
+    },
+    "source_meta": {
+      "key": "value"
+    },
+    "received_at": "2026-02-22T17:21:00Z",
+    "generated_at": "2026-02-22T17:21:00Z",
+    "read_by_user_id": 42,
+    "latest_entry_id": 42,
+    "entries_count": 0,
+    "latest_entry": {
+      "id": 42,
+      "agent_id": 42,
+      "external_id": "ops-brief-2026-02-22",
+      "name": "Example Name",
+      "timezone": "America/Los_Angeles",
+      "summary": "Morning operations handoff digest.",
+      "include_sections": [
+        {
+          "key": "value"
+        }
+      ],
+      "headline": "3 overdue tasks | 4 upcoming events",
+      "content_markdown": "## Highlights\n- Elevated API error rate",
+      "content_json": {
+        "key": "value"
+      },
+      "source_meta": {
+        "key": "value"
+      },
+      "received_at": "2026-02-22T17:21:00Z",
+      "generated_at": "2026-02-22T17:21:00Z",
+      "created_at": "2026-02-22T17:21:00Z",
+      "updated_at": "2026-02-22T17:21:00Z"
+    },
+    "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."
+        ]
+      }
+    }
+  }
+}
+```
+
+### 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.createAgentBrief({
+  "body": {
+    "brief": {
+      "key": "daily-operations",
+      "name": "Daily Operations Brief",
+      "summary": "Operations handoff digest for the morning window.",
+      "timezone": "America/Los_Angeles",
+      "headline": "3 overdue tasks | 4 upcoming events",
+      "content_markdown": "## Highlights\n- Elevated API error rate\n- Two incidents resolved",
+      "meta": {
+        "external_source": "daily-ops-job",
+        "schedule": "0 7 * * *"
+      }
+    },
+    "source": {
+      "agent_id": 42,
+      "meta": {
+        "runtime": "codex"
+      }
+    }
+  }
+});
+
+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/briefs" \\
+  -H "Accept: application/json" \\
+  -H "X-Api-Key: $AGENTMC_API_KEY" \\
+  -H "Content-Type: application/json" \\
+  --data-raw "{\"brief\":{\"key\":\"daily-operations\",\"name\":\"Daily Operations Brief\",\"summary\":\"Operations handoff digest for the morning window.\",\"timezone\":\"America/Los_Angeles\",\"headline\":\"3 overdue tasks | 4 upcoming events\",\"content_markdown\":\"## Highlights\n- Elevated API error rate\n- Two incidents resolved\",\"meta\":{\"external_source\":\"daily-ops-job\",\"schedule\":\"0 7 * * *\"}},\"source\":{\"agent_id\":42,\"meta\":{\"runtime\":\"codex\"}}}"
+```

package/docs/operations/createAgentRealtimeSignal.md

@@ -0,0 +1,224 @@
+# createAgentRealtimeSignal
+
+- Method: `POST`
+- Path: `/agents/{agent}/realtime/sessions/{session}/signals`
+- Summary: Publish one realtime event to 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
+{
+  "type": "message",
+  "payload": {
+    "type": "chat.user",
+    "payload": {
+      "content": "Create a AgentMC task for this afternoon to draft the postmortem outline.",
+      "message_id": 512,
+      "timezone": "America/Los_Angeles",
+      "source": "agentmc_chat",
+      "intent_scope": "agentmc"
+    }
+  }
+}
+```
+
+## Success Responses
+
+### 200 (application/json)
+Realtime signal accepted.
+
+```json
+{
+  "data": {
+    "id": 42,
+    "team_id": 42,
+    "agent_id": 42,
+    "session_id": 42,
+    "sender": "agent",
+    "type": "example",
+    "payload": {
+      "key": "value"
+    },
+    "created_at": "2026-02-22T17:21:00Z",
+    "updated_at": "2026-02-22T17:21:00Z"
+  },
+  "session": {
+    "id": 42,
+    "team_id": 42,
+    "agent_id": 42,
+    "requested_by_user_id": 42,
+    "status": "requested",
+    "claimed_at": "2026-02-22T17:21:00Z",
+    "opened_at": "2026-02-22T17:21:00Z",
+    "closed_at": "2026-02-22T17:21:00Z",
+    "expires_at": "2026-02-22T17:21:00Z",
+    "last_browser_heartbeat_at": "2026-02-22T17:21:00Z",
+    "last_agent_heartbeat_at": "2026-02-22T17:21:00Z",
+    "meta": {
+      "key": "value"
+    },
+    "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."
+        ]
+      }
+    }
+  }
+}
+```
+
+### 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.createAgentRealtimeSignal({
+  "params": {
+    "path": {
+      "agent": 1,
+      "session": 1
+    }
+  },
+  "body": {
+    "type": "message",
+    "payload": {
+      "type": "chat.user",
+      "payload": {
+        "content": "Create a AgentMC task for this afternoon to draft the postmortem outline.",
+        "message_id": 512,
+        "timezone": "America/Los_Angeles",
+        "source": "agentmc_chat",
+        "intent_scope": "agentmc"
+      }
+    }
+  }
+});
+
+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/signals" \\
+  -H "Accept: application/json" \\
+  -H "X-Api-Key: $AGENTMC_API_KEY" \\
+  -H "Content-Type: application/json" \\
+  --data-raw "{\"type\":\"message\",\"payload\":{\"type\":\"chat.user\",\"payload\":{\"content\":\"Create a AgentMC task for this afternoon to draft the postmortem outline.\",\"message_id\":512,\"timezone\":\"America/Los_Angeles\",\"source\":\"agentmc_chat\",\"intent_scope\":\"agentmc\"}}}"
+```

package/docs/operations/createBoard.md

@@ -0,0 +1,160 @@
+# createBoard
+
+- Method: `POST`
+- Path: `/boards`
+- Summary: Create a board.
+- Auth: ApiKeyAuth OR AgentBearerAuth OR BearerAuth
+
+## Description
+
+No additional description.
+
+## Parameters
+
+None.
+
+## Request Example
+
+### application/json
+```json
+{
+  "name": "Incident Response",
+  "description": "Tracks response tasks for active incidents.",
+  "visibility": "team"
+}
+```
+
+## Success Responses
+
+### 201 (application/json)
+Board created.
+
+```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."
+        ]
+      }
+    }
+  }
+}
+```
+
+### 402 (application/json)
+Plan limit reached.
+
+```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.createBoard({
+  "body": {
+    "name": "Incident Response",
+    "description": "Tracks response tasks for active incidents.",
+    "visibility": "team"
+  }
+});
+
+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/boards" \\
+  -H "Accept: application/json" \\
+  -H "X-Api-Key: $AGENTMC_API_KEY" \\
+  -H "Content-Type: application/json" \\
+  --data-raw "{\"name\":\"Incident Response\",\"description\":\"Tracks response tasks for active incidents.\",\"visibility\":\"team\"}"
+```