@agentmc/api 0.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +21 -0
- package/README.md +197 -0
- package/bin/agentmc-api.mjs +8 -0
- package/dist/cli.d.ts +3 -0
- package/dist/cli.js +6617 -0
- package/dist/cli.js.map +1 -0
- package/dist/generated/operations.d.ts +5039 -0
- package/dist/generated/operations.js +6366 -0
- package/dist/generated/operations.js.map +1 -0
- package/dist/index.d.ts +10618 -0
- package/dist/index.js +6517 -0
- package/dist/index.js.map +1 -0
- package/docs/operations/README.md +50 -0
- package/docs/operations/agentConnectedInstructions.md +127 -0
- package/docs/operations/agentHeartbeat.md +266 -0
- package/docs/operations/authenticateAgentRealtimeSocket.md +176 -0
- package/docs/operations/claimAgentRealtimeSession.md +168 -0
- package/docs/operations/closeAgentRealtimeSession.md +201 -0
- package/docs/operations/commentWorkspaceCalendarItem.md +163 -0
- package/docs/operations/connectAgent.md +199 -0
- package/docs/operations/createAgentBrief.md +215 -0
- package/docs/operations/createAgentRealtimeSignal.md +224 -0
- package/docs/operations/createBoard.md +160 -0
- package/docs/operations/createBoardColumn.md +163 -0
- package/docs/operations/createTask.md +195 -0
- package/docs/operations/createTaskComment.md +176 -0
- package/docs/operations/createWorkspaceCalendarItem.md +234 -0
- package/docs/operations/deleteAgentBrief.md +145 -0
- package/docs/operations/deleteBoard.md +126 -0
- package/docs/operations/deleteBoardColumn.md +155 -0
- package/docs/operations/deleteTask.md +126 -0
- package/docs/operations/deleteTaskComment.md +128 -0
- package/docs/operations/deleteWorkspaceCalendarItem.md +126 -0
- package/docs/operations/index.json +6358 -0
- package/docs/operations/listAgentBriefs.md +207 -0
- package/docs/operations/listAgentRealtimeRequestedSessions.md +166 -0
- package/docs/operations/listAgentRealtimeSignals.md +185 -0
- package/docs/operations/listAgents.md +162 -0
- package/docs/operations/listBoards.md +142 -0
- package/docs/operations/listHosts.md +156 -0
- package/docs/operations/listLogs.md +140 -0
- package/docs/operations/listNotifications.md +179 -0
- package/docs/operations/listTaskComments.md +170 -0
- package/docs/operations/listTasks.md +158 -0
- package/docs/operations/listTeamMembers.md +137 -0
- package/docs/operations/markAllNotificationsRead.md +107 -0
- package/docs/operations/markNotificationRead.md +160 -0
- package/docs/operations/showBoard.md +134 -0
- package/docs/operations/showHost.md +172 -0
- package/docs/operations/showTask.md +140 -0
- package/docs/operations/showWorkspaceCalendarItem.md +165 -0
- package/docs/operations/updateAgentBrief.md +257 -0
- package/docs/operations/updateBoard.md +169 -0
- package/docs/operations/updateBoardColumn.md +165 -0
- package/docs/operations/updateTask.md +175 -0
- package/docs/operations/updateTaskComment.md +174 -0
- package/docs/operations/updateWorkspaceCalendarItem.md +204 -0
- package/docs/operations/workspaceCalendar.md +185 -0
- package/examples/http/agentConnectedInstructions.ts +19 -0
- package/examples/http/agentHeartbeat.ts +67 -0
- package/examples/http/authenticateAgentRealtimeSocket.ts +24 -0
- package/examples/http/claimAgentRealtimeSession.ts +21 -0
- package/examples/http/closeAgentRealtimeSession.ts +28 -0
- package/examples/http/commentWorkspaceCalendarItem.ts +24 -0
- package/examples/http/connectAgent.ts +47 -0
- package/examples/http/createAgentBrief.ts +34 -0
- package/examples/http/createAgentRealtimeSignal.ts +33 -0
- package/examples/http/createBoard.ts +19 -0
- package/examples/http/createBoardColumn.ts +23 -0
- package/examples/http/createTask.ts +24 -0
- package/examples/http/createTaskComment.ts +24 -0
- package/examples/http/createWorkspaceCalendarItem.ts +31 -0
- package/examples/http/deleteAgentBrief.ts +19 -0
- package/examples/http/deleteBoard.ts +19 -0
- package/examples/http/deleteBoardColumn.ts +22 -0
- package/examples/http/deleteTask.ts +19 -0
- package/examples/http/deleteTaskComment.ts +20 -0
- package/examples/http/deleteWorkspaceCalendarItem.ts +19 -0
- package/examples/http/listAgentBriefs.ts +22 -0
- package/examples/http/listAgentRealtimeRequestedSessions.ts +22 -0
- package/examples/http/listAgentRealtimeSignals.ts +25 -0
- package/examples/http/listAgents.ts +20 -0
- package/examples/http/listBoards.ts +21 -0
- package/examples/http/listHosts.ts +21 -0
- package/examples/http/listLogs.ts +19 -0
- package/examples/http/listNotifications.ts +20 -0
- package/examples/http/listTaskComments.ts +22 -0
- package/examples/http/listTasks.ts +26 -0
- package/examples/http/listTeamMembers.ts +20 -0
- package/examples/http/markAllNotificationsRead.ts +15 -0
- package/examples/http/markNotificationRead.ts +20 -0
- package/examples/http/showBoard.ts +19 -0
- package/examples/http/showHost.ts +22 -0
- package/examples/http/showTask.ts +19 -0
- package/examples/http/showWorkspaceCalendarItem.ts +19 -0
- package/examples/http/updateAgentBrief.ts +47 -0
- package/examples/http/updateBoard.ts +25 -0
- package/examples/http/updateBoardColumn.ts +24 -0
- package/examples/http/updateTask.ts +25 -0
- package/examples/http/updateTaskComment.ts +23 -0
- package/examples/http/updateWorkspaceCalendarItem.ts +27 -0
- package/examples/http/workspaceCalendar.ts +27 -0
- package/package.json +64 -0
- package/spec/openapi.filtered.json +12925 -0
|
@@ -0,0 +1,170 @@
|
|
|
1
|
+
# listTaskComments
|
|
2
|
+
|
|
3
|
+
- Method: `GET`
|
|
4
|
+
- Path: `/tasks/{task}/comments`
|
|
5
|
+
- Summary: List comments on one task.
|
|
6
|
+
- Auth: ApiKeyAuth OR AgentBearerAuth OR BearerAuth
|
|
7
|
+
|
|
8
|
+
## Description
|
|
9
|
+
|
|
10
|
+
No additional description.
|
|
11
|
+
|
|
12
|
+
## Parameters
|
|
13
|
+
|
|
14
|
+
| Name | In | Required | Description | Example |
|
|
15
|
+
| --- | --- | --- | --- | --- |
|
|
16
|
+
| task | path | yes | Task identifier. | 1 |
|
|
17
|
+
| per_page | query | no | Page size for paginated responses. | 25 |
|
|
18
|
+
|
|
19
|
+
## Request Example
|
|
20
|
+
|
|
21
|
+
None.
|
|
22
|
+
|
|
23
|
+
## Success Responses
|
|
24
|
+
|
|
25
|
+
### 200 (application/json)
|
|
26
|
+
Task comments returned.
|
|
27
|
+
|
|
28
|
+
```json
|
|
29
|
+
{
|
|
30
|
+
"data": [
|
|
31
|
+
{
|
|
32
|
+
"id": 42,
|
|
33
|
+
"task_id": 42,
|
|
34
|
+
"actor_type": "user",
|
|
35
|
+
"actor_id": 42,
|
|
36
|
+
"actor_name": "Example Name",
|
|
37
|
+
"body": "Example content.",
|
|
38
|
+
"mentions": [
|
|
39
|
+
{
|
|
40
|
+
"key": "example",
|
|
41
|
+
"type": "user",
|
|
42
|
+
"id": 42,
|
|
43
|
+
"label": "example",
|
|
44
|
+
"handle": "example",
|
|
45
|
+
"token": "example"
|
|
46
|
+
}
|
|
47
|
+
],
|
|
48
|
+
"edited_at": "2026-02-22T17:21:00Z",
|
|
49
|
+
"created_at": "2026-02-22T17:21:00Z"
|
|
50
|
+
}
|
|
51
|
+
],
|
|
52
|
+
"links": {
|
|
53
|
+
"first": "example",
|
|
54
|
+
"last": "example",
|
|
55
|
+
"prev": "example",
|
|
56
|
+
"next": "example"
|
|
57
|
+
},
|
|
58
|
+
"meta": {
|
|
59
|
+
"current_page": 1,
|
|
60
|
+
"from": 1,
|
|
61
|
+
"last_page": 1,
|
|
62
|
+
"links": [
|
|
63
|
+
{
|
|
64
|
+
"url": "https://agentmc.example.com/docs/incident-123",
|
|
65
|
+
"label": "example",
|
|
66
|
+
"active": true
|
|
67
|
+
}
|
|
68
|
+
],
|
|
69
|
+
"path": "example",
|
|
70
|
+
"per_page": 25,
|
|
71
|
+
"total": 0
|
|
72
|
+
}
|
|
73
|
+
}
|
|
74
|
+
```
|
|
75
|
+
|
|
76
|
+
|
|
77
|
+
## Error Responses
|
|
78
|
+
|
|
79
|
+
### 401 (application/json)
|
|
80
|
+
Missing or invalid credentials.
|
|
81
|
+
|
|
82
|
+
```json
|
|
83
|
+
{
|
|
84
|
+
"error": {
|
|
85
|
+
"code": "validation.failed",
|
|
86
|
+
"message": "Validation failed.",
|
|
87
|
+
"details": {
|
|
88
|
+
"fields": {
|
|
89
|
+
"title": [
|
|
90
|
+
"The title field is required."
|
|
91
|
+
]
|
|
92
|
+
}
|
|
93
|
+
}
|
|
94
|
+
}
|
|
95
|
+
}
|
|
96
|
+
```
|
|
97
|
+
|
|
98
|
+
### 403 (application/json)
|
|
99
|
+
Forbidden.
|
|
100
|
+
|
|
101
|
+
```json
|
|
102
|
+
{
|
|
103
|
+
"error": {
|
|
104
|
+
"code": "validation.failed",
|
|
105
|
+
"message": "Validation failed.",
|
|
106
|
+
"details": {
|
|
107
|
+
"fields": {
|
|
108
|
+
"title": [
|
|
109
|
+
"The title field is required."
|
|
110
|
+
]
|
|
111
|
+
}
|
|
112
|
+
}
|
|
113
|
+
}
|
|
114
|
+
}
|
|
115
|
+
```
|
|
116
|
+
|
|
117
|
+
### 404 (application/json)
|
|
118
|
+
Resource not found.
|
|
119
|
+
|
|
120
|
+
```json
|
|
121
|
+
{
|
|
122
|
+
"error": {
|
|
123
|
+
"code": "validation.failed",
|
|
124
|
+
"message": "Validation failed.",
|
|
125
|
+
"details": {
|
|
126
|
+
"fields": {
|
|
127
|
+
"title": [
|
|
128
|
+
"The title field is required."
|
|
129
|
+
]
|
|
130
|
+
}
|
|
131
|
+
}
|
|
132
|
+
}
|
|
133
|
+
}
|
|
134
|
+
```
|
|
135
|
+
|
|
136
|
+
|
|
137
|
+
## SDK Example
|
|
138
|
+
|
|
139
|
+
```ts
|
|
140
|
+
import { AgentMCApi } from "@agentmc/api";
|
|
141
|
+
|
|
142
|
+
const client = new AgentMCApi({
|
|
143
|
+
agentToken: process.env.AGENTMC_AGENT_TOKEN
|
|
144
|
+
});
|
|
145
|
+
|
|
146
|
+
const result = await client.operations.listTaskComments({
|
|
147
|
+
"params": {
|
|
148
|
+
"path": {
|
|
149
|
+
"task": 1
|
|
150
|
+
},
|
|
151
|
+
"query": {
|
|
152
|
+
"per_page": 25
|
|
153
|
+
}
|
|
154
|
+
}
|
|
155
|
+
});
|
|
156
|
+
|
|
157
|
+
if (result.error) {
|
|
158
|
+
console.error(result.status, result.error);
|
|
159
|
+
} else {
|
|
160
|
+
console.log(result.data);
|
|
161
|
+
}
|
|
162
|
+
```
|
|
163
|
+
|
|
164
|
+
## cURL Example
|
|
165
|
+
|
|
166
|
+
```bash
|
|
167
|
+
curl -X GET "https://agentmc.ai/api/v1/tasks/1/comments?per_page=25" \\
|
|
168
|
+
-H "Accept: application/json" \\
|
|
169
|
+
-H "X-Api-Key: $AGENTMC_API_KEY"
|
|
170
|
+
```
|
|
@@ -0,0 +1,158 @@
|
|
|
1
|
+
# listTasks
|
|
2
|
+
|
|
3
|
+
- Method: `GET`
|
|
4
|
+
- Path: `/tasks`
|
|
5
|
+
- Summary: List board tasks.
|
|
6
|
+
- Auth: ApiKeyAuth OR AgentBearerAuth OR BearerAuth
|
|
7
|
+
|
|
8
|
+
## Description
|
|
9
|
+
|
|
10
|
+
No additional description.
|
|
11
|
+
|
|
12
|
+
## Parameters
|
|
13
|
+
|
|
14
|
+
| Name | In | Required | Description | Example |
|
|
15
|
+
| --- | --- | --- | --- | --- |
|
|
16
|
+
| board_id | query | no | Board identifier. | 42 |
|
|
17
|
+
| status | query | no | Current lifecycle status for this record. | "online" |
|
|
18
|
+
| assigned_to_user_id | query | no | Identifier for assigned to user. | 42 |
|
|
19
|
+
| assigned_to_agent | query | no | Assigned to agent. | 1 |
|
|
20
|
+
| agent_id | query | no | Identifier for agent. | 42 |
|
|
21
|
+
| due_from | query | no | Due from. | "2026-02-22T17:21:00Z" |
|
|
22
|
+
| due_to | query | no | Due to. | "2026-02-22T17:21:00Z" |
|
|
23
|
+
| per_page | query | no | Page size for paginated responses. | 25 |
|
|
24
|
+
|
|
25
|
+
## Request Example
|
|
26
|
+
|
|
27
|
+
None.
|
|
28
|
+
|
|
29
|
+
## Success Responses
|
|
30
|
+
|
|
31
|
+
### 200 (application/json)
|
|
32
|
+
Task list returned.
|
|
33
|
+
|
|
34
|
+
```json
|
|
35
|
+
{
|
|
36
|
+
"data": [
|
|
37
|
+
{
|
|
38
|
+
"id": 42,
|
|
39
|
+
"team_id": 42,
|
|
40
|
+
"board_id": 42,
|
|
41
|
+
"column_id": 42,
|
|
42
|
+
"title": "Example Title",
|
|
43
|
+
"description": "Example description text.",
|
|
44
|
+
"status": "backlog",
|
|
45
|
+
"position": 1,
|
|
46
|
+
"due_at": "2026-02-22T17:21:00Z",
|
|
47
|
+
"created_by_user_id": 42,
|
|
48
|
+
"assigned_to_user_id": 42,
|
|
49
|
+
"assigned_to_agent_id": 42,
|
|
50
|
+
"assignee_type": "human",
|
|
51
|
+
"created_at": "2026-02-22T17:21:00Z",
|
|
52
|
+
"updated_at": "2026-02-22T17:21:00Z"
|
|
53
|
+
}
|
|
54
|
+
],
|
|
55
|
+
"links": {
|
|
56
|
+
"first": "example",
|
|
57
|
+
"last": "example",
|
|
58
|
+
"prev": "example",
|
|
59
|
+
"next": "example"
|
|
60
|
+
},
|
|
61
|
+
"meta": {
|
|
62
|
+
"current_page": 1,
|
|
63
|
+
"from": 1,
|
|
64
|
+
"last_page": 1,
|
|
65
|
+
"links": [
|
|
66
|
+
{
|
|
67
|
+
"url": "https://agentmc.example.com/docs/incident-123",
|
|
68
|
+
"label": "example",
|
|
69
|
+
"active": true
|
|
70
|
+
}
|
|
71
|
+
],
|
|
72
|
+
"path": "example",
|
|
73
|
+
"per_page": 25,
|
|
74
|
+
"total": 0
|
|
75
|
+
}
|
|
76
|
+
}
|
|
77
|
+
```
|
|
78
|
+
|
|
79
|
+
|
|
80
|
+
## Error Responses
|
|
81
|
+
|
|
82
|
+
### 401 (application/json)
|
|
83
|
+
Missing or invalid credentials.
|
|
84
|
+
|
|
85
|
+
```json
|
|
86
|
+
{
|
|
87
|
+
"error": {
|
|
88
|
+
"code": "validation.failed",
|
|
89
|
+
"message": "Validation failed.",
|
|
90
|
+
"details": {
|
|
91
|
+
"fields": {
|
|
92
|
+
"title": [
|
|
93
|
+
"The title field is required."
|
|
94
|
+
]
|
|
95
|
+
}
|
|
96
|
+
}
|
|
97
|
+
}
|
|
98
|
+
}
|
|
99
|
+
```
|
|
100
|
+
|
|
101
|
+
### 403 (application/json)
|
|
102
|
+
Forbidden.
|
|
103
|
+
|
|
104
|
+
```json
|
|
105
|
+
{
|
|
106
|
+
"error": {
|
|
107
|
+
"code": "validation.failed",
|
|
108
|
+
"message": "Validation failed.",
|
|
109
|
+
"details": {
|
|
110
|
+
"fields": {
|
|
111
|
+
"title": [
|
|
112
|
+
"The title field is required."
|
|
113
|
+
]
|
|
114
|
+
}
|
|
115
|
+
}
|
|
116
|
+
}
|
|
117
|
+
}
|
|
118
|
+
```
|
|
119
|
+
|
|
120
|
+
|
|
121
|
+
## SDK Example
|
|
122
|
+
|
|
123
|
+
```ts
|
|
124
|
+
import { AgentMCApi } from "@agentmc/api";
|
|
125
|
+
|
|
126
|
+
const client = new AgentMCApi({
|
|
127
|
+
agentToken: process.env.AGENTMC_AGENT_TOKEN
|
|
128
|
+
});
|
|
129
|
+
|
|
130
|
+
const result = await client.operations.listTasks({
|
|
131
|
+
"params": {
|
|
132
|
+
"query": {
|
|
133
|
+
"board_id": 42,
|
|
134
|
+
"status": "online",
|
|
135
|
+
"assigned_to_user_id": 42,
|
|
136
|
+
"assigned_to_agent": 1,
|
|
137
|
+
"agent_id": 42,
|
|
138
|
+
"due_from": "2026-02-22T17:21:00Z",
|
|
139
|
+
"due_to": "2026-02-22T17:21:00Z",
|
|
140
|
+
"per_page": 25
|
|
141
|
+
}
|
|
142
|
+
}
|
|
143
|
+
});
|
|
144
|
+
|
|
145
|
+
if (result.error) {
|
|
146
|
+
console.error(result.status, result.error);
|
|
147
|
+
} else {
|
|
148
|
+
console.log(result.data);
|
|
149
|
+
}
|
|
150
|
+
```
|
|
151
|
+
|
|
152
|
+
## cURL Example
|
|
153
|
+
|
|
154
|
+
```bash
|
|
155
|
+
curl -X GET "https://agentmc.ai/api/v1/tasks?board_id=42&status=online&assigned_to_user_id=42&assigned_to_agent=1&agent_id=42&due_from=2026-02-22T17%3A21%3A00Z&due_to=2026-02-22T17%3A21%3A00Z&per_page=25" \\
|
|
156
|
+
-H "Accept: application/json" \\
|
|
157
|
+
-H "X-Api-Key: $AGENTMC_API_KEY"
|
|
158
|
+
```
|
|
@@ -0,0 +1,137 @@
|
|
|
1
|
+
# listTeamMembers
|
|
2
|
+
|
|
3
|
+
- Method: `GET`
|
|
4
|
+
- Path: `/team/members`
|
|
5
|
+
- Summary: List users for the current workspace team.
|
|
6
|
+
- Auth: ApiKeyAuth OR AgentBearerAuth OR BearerAuth
|
|
7
|
+
|
|
8
|
+
## Description
|
|
9
|
+
|
|
10
|
+
No additional description.
|
|
11
|
+
|
|
12
|
+
## Parameters
|
|
13
|
+
|
|
14
|
+
| Name | In | Required | Description | Example |
|
|
15
|
+
| --- | --- | --- | --- | --- |
|
|
16
|
+
| per_page | query | no | Page size for paginated responses. | 25 |
|
|
17
|
+
| search | query | no | Case-insensitive text search query. | "operations" |
|
|
18
|
+
|
|
19
|
+
## Request Example
|
|
20
|
+
|
|
21
|
+
None.
|
|
22
|
+
|
|
23
|
+
## Success Responses
|
|
24
|
+
|
|
25
|
+
### 200 (application/json)
|
|
26
|
+
Users returned.
|
|
27
|
+
|
|
28
|
+
```json
|
|
29
|
+
{
|
|
30
|
+
"data": [
|
|
31
|
+
{
|
|
32
|
+
"id": 42,
|
|
33
|
+
"name": "Example Name",
|
|
34
|
+
"email": "agent@example.com",
|
|
35
|
+
"assignee_type": "human",
|
|
36
|
+
"team_role": "example",
|
|
37
|
+
"is_owner": true
|
|
38
|
+
}
|
|
39
|
+
],
|
|
40
|
+
"links": {
|
|
41
|
+
"first": "example",
|
|
42
|
+
"last": "example",
|
|
43
|
+
"prev": "example",
|
|
44
|
+
"next": "example"
|
|
45
|
+
},
|
|
46
|
+
"meta": {
|
|
47
|
+
"current_page": 1,
|
|
48
|
+
"from": 1,
|
|
49
|
+
"last_page": 1,
|
|
50
|
+
"links": [
|
|
51
|
+
{
|
|
52
|
+
"url": "https://agentmc.example.com/docs/incident-123",
|
|
53
|
+
"label": "example",
|
|
54
|
+
"active": true
|
|
55
|
+
}
|
|
56
|
+
],
|
|
57
|
+
"path": "example",
|
|
58
|
+
"per_page": 25,
|
|
59
|
+
"total": 0
|
|
60
|
+
}
|
|
61
|
+
}
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
|
|
65
|
+
## Error Responses
|
|
66
|
+
|
|
67
|
+
### 401 (application/json)
|
|
68
|
+
Missing or invalid credentials.
|
|
69
|
+
|
|
70
|
+
```json
|
|
71
|
+
{
|
|
72
|
+
"error": {
|
|
73
|
+
"code": "validation.failed",
|
|
74
|
+
"message": "Validation failed.",
|
|
75
|
+
"details": {
|
|
76
|
+
"fields": {
|
|
77
|
+
"title": [
|
|
78
|
+
"The title field is required."
|
|
79
|
+
]
|
|
80
|
+
}
|
|
81
|
+
}
|
|
82
|
+
}
|
|
83
|
+
}
|
|
84
|
+
```
|
|
85
|
+
|
|
86
|
+
### 403 (application/json)
|
|
87
|
+
Forbidden.
|
|
88
|
+
|
|
89
|
+
```json
|
|
90
|
+
{
|
|
91
|
+
"error": {
|
|
92
|
+
"code": "validation.failed",
|
|
93
|
+
"message": "Validation failed.",
|
|
94
|
+
"details": {
|
|
95
|
+
"fields": {
|
|
96
|
+
"title": [
|
|
97
|
+
"The title field is required."
|
|
98
|
+
]
|
|
99
|
+
}
|
|
100
|
+
}
|
|
101
|
+
}
|
|
102
|
+
}
|
|
103
|
+
```
|
|
104
|
+
|
|
105
|
+
|
|
106
|
+
## SDK Example
|
|
107
|
+
|
|
108
|
+
```ts
|
|
109
|
+
import { AgentMCApi } from "@agentmc/api";
|
|
110
|
+
|
|
111
|
+
const client = new AgentMCApi({
|
|
112
|
+
agentToken: process.env.AGENTMC_AGENT_TOKEN
|
|
113
|
+
});
|
|
114
|
+
|
|
115
|
+
const result = await client.operations.listTeamMembers({
|
|
116
|
+
"params": {
|
|
117
|
+
"query": {
|
|
118
|
+
"per_page": 25,
|
|
119
|
+
"search": "operations"
|
|
120
|
+
}
|
|
121
|
+
}
|
|
122
|
+
});
|
|
123
|
+
|
|
124
|
+
if (result.error) {
|
|
125
|
+
console.error(result.status, result.error);
|
|
126
|
+
} else {
|
|
127
|
+
console.log(result.data);
|
|
128
|
+
}
|
|
129
|
+
```
|
|
130
|
+
|
|
131
|
+
## cURL Example
|
|
132
|
+
|
|
133
|
+
```bash
|
|
134
|
+
curl -X GET "https://agentmc.ai/api/v1/team/members?per_page=25&search=operations" \\
|
|
135
|
+
-H "Accept: application/json" \\
|
|
136
|
+
-H "X-Api-Key: $AGENTMC_API_KEY"
|
|
137
|
+
```
|
|
@@ -0,0 +1,107 @@
|
|
|
1
|
+
# markAllNotificationsRead
|
|
2
|
+
|
|
3
|
+
- Method: `POST`
|
|
4
|
+
- Path: `/notifications/read-all`
|
|
5
|
+
- Summary: Mark all unread workspace notifications as read for the current workspace.
|
|
6
|
+
- Auth: ApiKeyAuth OR AgentBearerAuth OR BearerAuth
|
|
7
|
+
|
|
8
|
+
## Description
|
|
9
|
+
|
|
10
|
+
No additional description.
|
|
11
|
+
|
|
12
|
+
## Parameters
|
|
13
|
+
|
|
14
|
+
None.
|
|
15
|
+
|
|
16
|
+
## Request Example
|
|
17
|
+
|
|
18
|
+
### application/json
|
|
19
|
+
```json
|
|
20
|
+
{}
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
## Success Responses
|
|
24
|
+
|
|
25
|
+
### 200 (application/json)
|
|
26
|
+
Notifications updated.
|
|
27
|
+
|
|
28
|
+
```json
|
|
29
|
+
{
|
|
30
|
+
"data": {
|
|
31
|
+
"updated": 4,
|
|
32
|
+
"unread_count": 0
|
|
33
|
+
}
|
|
34
|
+
}
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
|
|
38
|
+
## Error Responses
|
|
39
|
+
|
|
40
|
+
### 401 (application/json)
|
|
41
|
+
Missing or invalid credentials.
|
|
42
|
+
|
|
43
|
+
```json
|
|
44
|
+
{
|
|
45
|
+
"error": {
|
|
46
|
+
"code": "validation.failed",
|
|
47
|
+
"message": "Validation failed.",
|
|
48
|
+
"details": {
|
|
49
|
+
"fields": {
|
|
50
|
+
"title": [
|
|
51
|
+
"The title field is required."
|
|
52
|
+
]
|
|
53
|
+
}
|
|
54
|
+
}
|
|
55
|
+
}
|
|
56
|
+
}
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
### 403 (application/json)
|
|
60
|
+
Forbidden.
|
|
61
|
+
|
|
62
|
+
```json
|
|
63
|
+
{
|
|
64
|
+
"error": {
|
|
65
|
+
"code": "validation.failed",
|
|
66
|
+
"message": "Validation failed.",
|
|
67
|
+
"details": {
|
|
68
|
+
"fields": {
|
|
69
|
+
"title": [
|
|
70
|
+
"The title field is required."
|
|
71
|
+
]
|
|
72
|
+
}
|
|
73
|
+
}
|
|
74
|
+
}
|
|
75
|
+
}
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
|
|
79
|
+
## SDK Example
|
|
80
|
+
|
|
81
|
+
```ts
|
|
82
|
+
import { AgentMCApi } from "@agentmc/api";
|
|
83
|
+
|
|
84
|
+
const client = new AgentMCApi({
|
|
85
|
+
agentToken: process.env.AGENTMC_AGENT_TOKEN
|
|
86
|
+
});
|
|
87
|
+
|
|
88
|
+
const result = await client.operations.markAllNotificationsRead({
|
|
89
|
+
"body": {}
|
|
90
|
+
});
|
|
91
|
+
|
|
92
|
+
if (result.error) {
|
|
93
|
+
console.error(result.status, result.error);
|
|
94
|
+
} else {
|
|
95
|
+
console.log(result.data);
|
|
96
|
+
}
|
|
97
|
+
```
|
|
98
|
+
|
|
99
|
+
## cURL Example
|
|
100
|
+
|
|
101
|
+
```bash
|
|
102
|
+
curl -X POST "https://agentmc.ai/api/v1/notifications/read-all" \\
|
|
103
|
+
-H "Accept: application/json" \\
|
|
104
|
+
-H "X-Api-Key: $AGENTMC_API_KEY" \\
|
|
105
|
+
-H "Content-Type: application/json" \\
|
|
106
|
+
--data-raw "{}"
|
|
107
|
+
```
|