@agentmc/api 0.1.1

package/docs/operations/listAgentBriefs.md

@@ -0,0 +1,207 @@
+# listAgentBriefs
+
+- Method: `GET`
+- Path: `/briefs`
+- Summary: List brief parents for the current workspace.
+- Auth: ApiKeyAuth OR AgentBearerAuth OR BearerAuth
+
+## Description
+
+No additional description.
+
+## Parameters
+
+| Name | In | Required | Description | Example |
+| --- | --- | --- | --- | --- |
+| search | query | no | Case-insensitive text search query. | "operations" |
+| external_key | query | no | Stable external key used for upsert/idempotent writes. | "daily-operations" |
+| agent_id | query | no | Identifier for agent. | 42 |
+| per_page | query | no | Page size for paginated responses. | 25 |
+
+## Request Example
+
+None.
+
+## Success Responses
+
+### 200 (application/json)
+Brief list returned.
+
+```json
+{
+  "data": [
+    {
+      "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"
+    }
+  ],
+  "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.listAgentBriefs({
+  "params": {
+    "query": {
+      "search": "operations",
+      "external_key": "daily-operations",
+      "agent_id": 42,
+      "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/briefs?search=operations&external_key=daily-operations&agent_id=42&per_page=25" \\
+  -H "Accept: application/json" \\
+  -H "X-Api-Key: $AGENTMC_API_KEY"
+```

package/docs/operations/listAgentRealtimeRequestedSessions.md

@@ -0,0 +1,166 @@
+# listAgentRealtimeRequestedSessions
+
+- Method: `GET`
+- Path: `/agents/{agent}/realtime/sessions/requested`
+- Summary: List requested realtime browser sessions for an agent.
+- Auth: ApiKeyAuth OR AgentBearerAuth OR BearerAuth
+
+## Description
+
+No additional description.
+
+## Parameters
+
+| Name | In | Required | Description | Example |
+| --- | --- | --- | --- | --- |
+| agent | path | yes | Agent identifier. | 1 |
+| limit | query | no | Maximum number of records to return. | 20 |
+
+## Request Example
+
+None.
+
+## Success Responses
+
+### 200 (application/json)
+Requested realtime sessions returned.
+
+```json
+{
+  "data": [
+    {
+      "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."
+        ]
+      }
+    }
+  }
+}
+```
+
+### 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.listAgentRealtimeRequestedSessions({
+  "params": {
+    "path": {
+      "agent": 1
+    },
+    "query": {
+      "limit": 20
+    }
+  }
+});
+
+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/realtime/sessions/requested?limit=20" \\
+  -H "Accept: application/json" \\
+  -H "X-Api-Key: $AGENTMC_API_KEY"
+```

package/docs/operations/listAgentRealtimeSignals.md

@@ -0,0 +1,185 @@
+# listAgentRealtimeSignals
+
+- Method: `GET`
+- Path: `/agents/{agent}/realtime/sessions/{session}/signals`
+- Summary: Read realtime events 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 |
+| after_id | query | no | Return only records with id greater than this value. | 120 |
+| limit | query | no | Maximum number of records to return. | 20 |
+| exclude_sender | query | no | Allowed values: agent, browser, system. | "agent" |
+
+## Request Example
+
+None.
+
+## Success Responses
+
+### 200 (application/json)
+Realtime signaling events returned.
+
+```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."
+        ]
+      }
+    }
+  }
+}
+```
+
+### 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.listAgentRealtimeSignals({
+  "params": {
+    "path": {
+      "agent": 1,
+      "session": 1
+    },
+    "query": {
+      "after_id": 120,
+      "limit": 20,
+      "exclude_sender": "agent"
+    }
+  }
+});
+
+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/realtime/sessions/1/signals?after_id=120&limit=20&exclude_sender=agent" \\
+  -H "Accept: application/json" \\
+  -H "X-Api-Key: $AGENTMC_API_KEY"
+```

package/docs/operations/listAgents.md

@@ -0,0 +1,162 @@
+# listAgents
+
+- Method: `GET`
+- Path: `/teams/agents`
+- Summary: List agents for the current workspace team.
+- 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 |
+| search | query | no | Case-insensitive text search query. | "operations" |
+
+## Request Example
+
+None.
+
+## Success Responses
+
+### 200 (application/json)
+Agents returned.
+
+```json
+{
+  "data": [
+    {
+      "id": 42,
+      "workspace_id": 7,
+      "host_id": 11,
+      "host": {
+        "id": 11,
+        "name": "worker-01"
+      },
+      "name": "codex-runtime-prod",
+      "type": "generic",
+      "status": "online",
+      "runtime_host": "worker-01",
+      "runtime_version": "2026.02.1",
+      "capabilities": [
+        "tasks",
+        "calendar",
+        "realtime"
+      ],
+      "meta": {
+        "runtime": "codex",
+        "models": [
+          {
+            "model_id": "openai/gpt-5-codex",
+            "provider": "openai"
+          }
+        ]
+      },
+      "last_seen_at": "2026-02-24T02:11:00Z",
+      "first_sync_at": "2026-02-24T02:01:00Z",
+      "tasks_count": 3,
+      "created_at": "2026-02-24T01:56: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."
+        ]
+      }
+    }
+  }
+}
+```
+
+
+## SDK Example
+
+```ts
+import { AgentMCApi } from "@agentmc/api";
+
+const client = new AgentMCApi({
+  agentToken: process.env.AGENTMC_AGENT_TOKEN
+});
+
+const result = await client.operations.listAgents({
+  "params": {
+    "query": {
+      "per_page": 25,
+      "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/teams/agents?per_page=25&search=operations" \\
+  -H "Accept: application/json" \\
+  -H "X-Api-Key: $AGENTMC_API_KEY"
+```