@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,234 @@
|
|
|
1
|
+
# createWorkspaceCalendarItem
|
|
2
|
+
|
|
3
|
+
- Method: `POST`
|
|
4
|
+
- Path: `/calendar/items`
|
|
5
|
+
- Summary: Create a calendar item.
|
|
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
|
+
"type": "task",
|
|
22
|
+
"title": "Review outage timeline",
|
|
23
|
+
"description": "Confirm sequence of events with on-call notes.",
|
|
24
|
+
"due_at": "2026-02-24T09:00:00Z",
|
|
25
|
+
"timezone": "America/Los_Angeles",
|
|
26
|
+
"status": "todo",
|
|
27
|
+
"priority": "high",
|
|
28
|
+
"visibility": "workspace",
|
|
29
|
+
"assignees": [
|
|
30
|
+
{
|
|
31
|
+
"assignee_type": "user",
|
|
32
|
+
"assignee_id": 8,
|
|
33
|
+
"role": "owner"
|
|
34
|
+
}
|
|
35
|
+
]
|
|
36
|
+
}
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
## Success Responses
|
|
40
|
+
|
|
41
|
+
### 201 (application/json)
|
|
42
|
+
Calendar item created.
|
|
43
|
+
|
|
44
|
+
```json
|
|
45
|
+
{
|
|
46
|
+
"data": {
|
|
47
|
+
"id": 42,
|
|
48
|
+
"workspace_id": 42,
|
|
49
|
+
"type": "event",
|
|
50
|
+
"title": "Example Title",
|
|
51
|
+
"description": "Example description text.",
|
|
52
|
+
"start_at": "2026-02-22T17:21:00Z",
|
|
53
|
+
"end_at": "2026-02-22T17:21:00Z",
|
|
54
|
+
"due_at": "2026-02-22T17:21:00Z",
|
|
55
|
+
"all_day": false,
|
|
56
|
+
"location": "example",
|
|
57
|
+
"timezone": "America/Los_Angeles",
|
|
58
|
+
"status": "todo",
|
|
59
|
+
"priority": "low",
|
|
60
|
+
"visibility": "workspace",
|
|
61
|
+
"created_by": 1,
|
|
62
|
+
"updated_by": 1,
|
|
63
|
+
"assignees": [
|
|
64
|
+
{
|
|
65
|
+
"id": 42,
|
|
66
|
+
"assignee_type": "user",
|
|
67
|
+
"assignee_id": 42,
|
|
68
|
+
"role": "owner",
|
|
69
|
+
"name": "Example Name",
|
|
70
|
+
"created_at": "2026-02-22T17:21:00Z"
|
|
71
|
+
}
|
|
72
|
+
],
|
|
73
|
+
"links": [
|
|
74
|
+
{
|
|
75
|
+
"id": 42,
|
|
76
|
+
"link_type": "example",
|
|
77
|
+
"link_id": 42,
|
|
78
|
+
"url": "https://agentmc.example.com/docs/incident-123",
|
|
79
|
+
"title": "Example Title",
|
|
80
|
+
"created_at": "2026-02-22T17:21:00Z"
|
|
81
|
+
}
|
|
82
|
+
],
|
|
83
|
+
"comments_count": 1,
|
|
84
|
+
"created_at": "2026-02-22T17:21:00Z",
|
|
85
|
+
"updated_at": "2026-02-22T17:21:00Z",
|
|
86
|
+
"deleted_at": "2026-02-22T17:21:00Z"
|
|
87
|
+
}
|
|
88
|
+
}
|
|
89
|
+
```
|
|
90
|
+
|
|
91
|
+
|
|
92
|
+
## Error Responses
|
|
93
|
+
|
|
94
|
+
### 401 (application/json)
|
|
95
|
+
Missing or invalid credentials.
|
|
96
|
+
|
|
97
|
+
```json
|
|
98
|
+
{
|
|
99
|
+
"error": {
|
|
100
|
+
"code": "validation.failed",
|
|
101
|
+
"message": "Validation failed.",
|
|
102
|
+
"details": {
|
|
103
|
+
"fields": {
|
|
104
|
+
"title": [
|
|
105
|
+
"The title field is required."
|
|
106
|
+
]
|
|
107
|
+
}
|
|
108
|
+
}
|
|
109
|
+
}
|
|
110
|
+
}
|
|
111
|
+
```
|
|
112
|
+
|
|
113
|
+
### 402 (application/json)
|
|
114
|
+
Plan limit reached.
|
|
115
|
+
|
|
116
|
+
```json
|
|
117
|
+
{
|
|
118
|
+
"error": {
|
|
119
|
+
"code": "validation.failed",
|
|
120
|
+
"message": "Validation failed.",
|
|
121
|
+
"details": {
|
|
122
|
+
"fields": {
|
|
123
|
+
"title": [
|
|
124
|
+
"The title field is required."
|
|
125
|
+
]
|
|
126
|
+
}
|
|
127
|
+
}
|
|
128
|
+
}
|
|
129
|
+
}
|
|
130
|
+
```
|
|
131
|
+
|
|
132
|
+
### 403 (application/json)
|
|
133
|
+
Forbidden.
|
|
134
|
+
|
|
135
|
+
```json
|
|
136
|
+
{
|
|
137
|
+
"error": {
|
|
138
|
+
"code": "validation.failed",
|
|
139
|
+
"message": "Validation failed.",
|
|
140
|
+
"details": {
|
|
141
|
+
"fields": {
|
|
142
|
+
"title": [
|
|
143
|
+
"The title field is required."
|
|
144
|
+
]
|
|
145
|
+
}
|
|
146
|
+
}
|
|
147
|
+
}
|
|
148
|
+
}
|
|
149
|
+
```
|
|
150
|
+
|
|
151
|
+
### 404 (application/json)
|
|
152
|
+
Resource not found.
|
|
153
|
+
|
|
154
|
+
```json
|
|
155
|
+
{
|
|
156
|
+
"error": {
|
|
157
|
+
"code": "validation.failed",
|
|
158
|
+
"message": "Validation failed.",
|
|
159
|
+
"details": {
|
|
160
|
+
"fields": {
|
|
161
|
+
"title": [
|
|
162
|
+
"The title field is required."
|
|
163
|
+
]
|
|
164
|
+
}
|
|
165
|
+
}
|
|
166
|
+
}
|
|
167
|
+
}
|
|
168
|
+
```
|
|
169
|
+
|
|
170
|
+
### 422 (application/json)
|
|
171
|
+
Validation failed.
|
|
172
|
+
|
|
173
|
+
```json
|
|
174
|
+
{
|
|
175
|
+
"error": {
|
|
176
|
+
"code": "validation.failed",
|
|
177
|
+
"message": "Validation failed.",
|
|
178
|
+
"details": {
|
|
179
|
+
"fields": {
|
|
180
|
+
"title": [
|
|
181
|
+
"The title field is required."
|
|
182
|
+
]
|
|
183
|
+
}
|
|
184
|
+
}
|
|
185
|
+
}
|
|
186
|
+
}
|
|
187
|
+
```
|
|
188
|
+
|
|
189
|
+
|
|
190
|
+
## SDK Example
|
|
191
|
+
|
|
192
|
+
```ts
|
|
193
|
+
import { AgentMCApi } from "@agentmc/api";
|
|
194
|
+
|
|
195
|
+
const client = new AgentMCApi({
|
|
196
|
+
agentToken: process.env.AGENTMC_AGENT_TOKEN
|
|
197
|
+
});
|
|
198
|
+
|
|
199
|
+
const result = await client.operations.createWorkspaceCalendarItem({
|
|
200
|
+
"body": {
|
|
201
|
+
"type": "task",
|
|
202
|
+
"title": "Review outage timeline",
|
|
203
|
+
"description": "Confirm sequence of events with on-call notes.",
|
|
204
|
+
"due_at": "2026-02-24T09:00:00Z",
|
|
205
|
+
"timezone": "America/Los_Angeles",
|
|
206
|
+
"status": "todo",
|
|
207
|
+
"priority": "high",
|
|
208
|
+
"visibility": "workspace",
|
|
209
|
+
"assignees": [
|
|
210
|
+
{
|
|
211
|
+
"assignee_type": "user",
|
|
212
|
+
"assignee_id": 8,
|
|
213
|
+
"role": "owner"
|
|
214
|
+
}
|
|
215
|
+
]
|
|
216
|
+
}
|
|
217
|
+
});
|
|
218
|
+
|
|
219
|
+
if (result.error) {
|
|
220
|
+
console.error(result.status, result.error);
|
|
221
|
+
} else {
|
|
222
|
+
console.log(result.data);
|
|
223
|
+
}
|
|
224
|
+
```
|
|
225
|
+
|
|
226
|
+
## cURL Example
|
|
227
|
+
|
|
228
|
+
```bash
|
|
229
|
+
curl -X POST "https://agentmc.ai/api/v1/calendar/items" \\
|
|
230
|
+
-H "Accept: application/json" \\
|
|
231
|
+
-H "X-Api-Key: $AGENTMC_API_KEY" \\
|
|
232
|
+
-H "Content-Type: application/json" \\
|
|
233
|
+
--data-raw "{\"type\":\"task\",\"title\":\"Review outage timeline\",\"description\":\"Confirm sequence of events with on-call notes.\",\"due_at\":\"2026-02-24T09:00:00Z\",\"timezone\":\"America/Los_Angeles\",\"status\":\"todo\",\"priority\":\"high\",\"visibility\":\"workspace\",\"assignees\":[{\"assignee_type\":\"user\",\"assignee_id\":8,\"role\":\"owner\"}]}"
|
|
234
|
+
```
|
|
@@ -0,0 +1,145 @@
|
|
|
1
|
+
# deleteAgentBrief
|
|
2
|
+
|
|
3
|
+
- Method: `DELETE`
|
|
4
|
+
- Path: `/briefs/{id}`
|
|
5
|
+
- Summary: Delete one saved brief.
|
|
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
|
+
| id | path | yes | Brief identifier. | 42 |
|
|
17
|
+
|
|
18
|
+
## Request Example
|
|
19
|
+
|
|
20
|
+
None.
|
|
21
|
+
|
|
22
|
+
## Success Responses
|
|
23
|
+
|
|
24
|
+
### 204 (application/json)
|
|
25
|
+
No content.
|
|
26
|
+
|
|
27
|
+
```json
|
|
28
|
+
{
|
|
29
|
+
"data": {
|
|
30
|
+
"key": "value"
|
|
31
|
+
}
|
|
32
|
+
}
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
|
|
36
|
+
## Error Responses
|
|
37
|
+
|
|
38
|
+
### 401 (application/json)
|
|
39
|
+
Missing or invalid credentials.
|
|
40
|
+
|
|
41
|
+
```json
|
|
42
|
+
{
|
|
43
|
+
"error": {
|
|
44
|
+
"code": "validation.failed",
|
|
45
|
+
"message": "Validation failed.",
|
|
46
|
+
"details": {
|
|
47
|
+
"fields": {
|
|
48
|
+
"title": [
|
|
49
|
+
"The title field is required."
|
|
50
|
+
]
|
|
51
|
+
}
|
|
52
|
+
}
|
|
53
|
+
}
|
|
54
|
+
}
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
### 403 (application/json)
|
|
58
|
+
Forbidden.
|
|
59
|
+
|
|
60
|
+
```json
|
|
61
|
+
{
|
|
62
|
+
"error": {
|
|
63
|
+
"code": "validation.failed",
|
|
64
|
+
"message": "Validation failed.",
|
|
65
|
+
"details": {
|
|
66
|
+
"fields": {
|
|
67
|
+
"title": [
|
|
68
|
+
"The title field is required."
|
|
69
|
+
]
|
|
70
|
+
}
|
|
71
|
+
}
|
|
72
|
+
}
|
|
73
|
+
}
|
|
74
|
+
```
|
|
75
|
+
|
|
76
|
+
### 404 (application/json)
|
|
77
|
+
Resource not found.
|
|
78
|
+
|
|
79
|
+
```json
|
|
80
|
+
{
|
|
81
|
+
"error": {
|
|
82
|
+
"code": "validation.failed",
|
|
83
|
+
"message": "Validation failed.",
|
|
84
|
+
"details": {
|
|
85
|
+
"fields": {
|
|
86
|
+
"title": [
|
|
87
|
+
"The title field is required."
|
|
88
|
+
]
|
|
89
|
+
}
|
|
90
|
+
}
|
|
91
|
+
}
|
|
92
|
+
}
|
|
93
|
+
```
|
|
94
|
+
|
|
95
|
+
### 422 (application/json)
|
|
96
|
+
Validation failed.
|
|
97
|
+
|
|
98
|
+
```json
|
|
99
|
+
{
|
|
100
|
+
"error": {
|
|
101
|
+
"code": "validation.failed",
|
|
102
|
+
"message": "Validation failed.",
|
|
103
|
+
"details": {
|
|
104
|
+
"fields": {
|
|
105
|
+
"title": [
|
|
106
|
+
"The title field is required."
|
|
107
|
+
]
|
|
108
|
+
}
|
|
109
|
+
}
|
|
110
|
+
}
|
|
111
|
+
}
|
|
112
|
+
```
|
|
113
|
+
|
|
114
|
+
|
|
115
|
+
## SDK Example
|
|
116
|
+
|
|
117
|
+
```ts
|
|
118
|
+
import { AgentMCApi } from "@agentmc/api";
|
|
119
|
+
|
|
120
|
+
const client = new AgentMCApi({
|
|
121
|
+
agentToken: process.env.AGENTMC_AGENT_TOKEN
|
|
122
|
+
});
|
|
123
|
+
|
|
124
|
+
const result = await client.operations.deleteAgentBrief({
|
|
125
|
+
"params": {
|
|
126
|
+
"path": {
|
|
127
|
+
"id": 42
|
|
128
|
+
}
|
|
129
|
+
}
|
|
130
|
+
});
|
|
131
|
+
|
|
132
|
+
if (result.error) {
|
|
133
|
+
console.error(result.status, result.error);
|
|
134
|
+
} else {
|
|
135
|
+
console.log(result.data);
|
|
136
|
+
}
|
|
137
|
+
```
|
|
138
|
+
|
|
139
|
+
## cURL Example
|
|
140
|
+
|
|
141
|
+
```bash
|
|
142
|
+
curl -X DELETE "https://agentmc.ai/api/v1/briefs/42" \\
|
|
143
|
+
-H "Accept: application/json" \\
|
|
144
|
+
-H "X-Api-Key: $AGENTMC_API_KEY"
|
|
145
|
+
```
|
|
@@ -0,0 +1,126 @@
|
|
|
1
|
+
# deleteBoard
|
|
2
|
+
|
|
3
|
+
- Method: `DELETE`
|
|
4
|
+
- Path: `/boards/{id}`
|
|
5
|
+
- Summary: Delete a board.
|
|
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
|
+
| id | path | yes | Board identifier. | 42 |
|
|
17
|
+
|
|
18
|
+
## Request Example
|
|
19
|
+
|
|
20
|
+
None.
|
|
21
|
+
|
|
22
|
+
## Success Responses
|
|
23
|
+
|
|
24
|
+
### 204 (application/json)
|
|
25
|
+
No content.
|
|
26
|
+
|
|
27
|
+
```json
|
|
28
|
+
{
|
|
29
|
+
"data": {
|
|
30
|
+
"key": "value"
|
|
31
|
+
}
|
|
32
|
+
}
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
|
|
36
|
+
## Error Responses
|
|
37
|
+
|
|
38
|
+
### 401 (application/json)
|
|
39
|
+
Missing or invalid credentials.
|
|
40
|
+
|
|
41
|
+
```json
|
|
42
|
+
{
|
|
43
|
+
"error": {
|
|
44
|
+
"code": "validation.failed",
|
|
45
|
+
"message": "Validation failed.",
|
|
46
|
+
"details": {
|
|
47
|
+
"fields": {
|
|
48
|
+
"title": [
|
|
49
|
+
"The title field is required."
|
|
50
|
+
]
|
|
51
|
+
}
|
|
52
|
+
}
|
|
53
|
+
}
|
|
54
|
+
}
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
### 403 (application/json)
|
|
58
|
+
Forbidden.
|
|
59
|
+
|
|
60
|
+
```json
|
|
61
|
+
{
|
|
62
|
+
"error": {
|
|
63
|
+
"code": "validation.failed",
|
|
64
|
+
"message": "Validation failed.",
|
|
65
|
+
"details": {
|
|
66
|
+
"fields": {
|
|
67
|
+
"title": [
|
|
68
|
+
"The title field is required."
|
|
69
|
+
]
|
|
70
|
+
}
|
|
71
|
+
}
|
|
72
|
+
}
|
|
73
|
+
}
|
|
74
|
+
```
|
|
75
|
+
|
|
76
|
+
### 404 (application/json)
|
|
77
|
+
Resource not found.
|
|
78
|
+
|
|
79
|
+
```json
|
|
80
|
+
{
|
|
81
|
+
"error": {
|
|
82
|
+
"code": "validation.failed",
|
|
83
|
+
"message": "Validation failed.",
|
|
84
|
+
"details": {
|
|
85
|
+
"fields": {
|
|
86
|
+
"title": [
|
|
87
|
+
"The title field is required."
|
|
88
|
+
]
|
|
89
|
+
}
|
|
90
|
+
}
|
|
91
|
+
}
|
|
92
|
+
}
|
|
93
|
+
```
|
|
94
|
+
|
|
95
|
+
|
|
96
|
+
## SDK Example
|
|
97
|
+
|
|
98
|
+
```ts
|
|
99
|
+
import { AgentMCApi } from "@agentmc/api";
|
|
100
|
+
|
|
101
|
+
const client = new AgentMCApi({
|
|
102
|
+
agentToken: process.env.AGENTMC_AGENT_TOKEN
|
|
103
|
+
});
|
|
104
|
+
|
|
105
|
+
const result = await client.operations.deleteBoard({
|
|
106
|
+
"params": {
|
|
107
|
+
"path": {
|
|
108
|
+
"id": 42
|
|
109
|
+
}
|
|
110
|
+
}
|
|
111
|
+
});
|
|
112
|
+
|
|
113
|
+
if (result.error) {
|
|
114
|
+
console.error(result.status, result.error);
|
|
115
|
+
} else {
|
|
116
|
+
console.log(result.data);
|
|
117
|
+
}
|
|
118
|
+
```
|
|
119
|
+
|
|
120
|
+
## cURL Example
|
|
121
|
+
|
|
122
|
+
```bash
|
|
123
|
+
curl -X DELETE "https://agentmc.ai/api/v1/boards/42" \\
|
|
124
|
+
-H "Accept: application/json" \\
|
|
125
|
+
-H "X-Api-Key: $AGENTMC_API_KEY"
|
|
126
|
+
```
|
|
@@ -0,0 +1,155 @@
|
|
|
1
|
+
# deleteBoardColumn
|
|
2
|
+
|
|
3
|
+
- Method: `DELETE`
|
|
4
|
+
- Path: `/boards/{board}/columns`
|
|
5
|
+
- Summary: Delete a board column.
|
|
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 | path | yes | Board identifier. | 1 |
|
|
17
|
+
|
|
18
|
+
## Request Example
|
|
19
|
+
|
|
20
|
+
### application/json
|
|
21
|
+
```json
|
|
22
|
+
{
|
|
23
|
+
"column_id": 13
|
|
24
|
+
}
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
## Success Responses
|
|
28
|
+
|
|
29
|
+
### 204 (application/json)
|
|
30
|
+
No content.
|
|
31
|
+
|
|
32
|
+
```json
|
|
33
|
+
{
|
|
34
|
+
"data": {
|
|
35
|
+
"key": "value"
|
|
36
|
+
}
|
|
37
|
+
}
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
|
|
41
|
+
## Error Responses
|
|
42
|
+
|
|
43
|
+
### 401 (application/json)
|
|
44
|
+
Missing or invalid credentials.
|
|
45
|
+
|
|
46
|
+
```json
|
|
47
|
+
{
|
|
48
|
+
"error": {
|
|
49
|
+
"code": "validation.failed",
|
|
50
|
+
"message": "Validation failed.",
|
|
51
|
+
"details": {
|
|
52
|
+
"fields": {
|
|
53
|
+
"title": [
|
|
54
|
+
"The title field is required."
|
|
55
|
+
]
|
|
56
|
+
}
|
|
57
|
+
}
|
|
58
|
+
}
|
|
59
|
+
}
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
### 403 (application/json)
|
|
63
|
+
Forbidden.
|
|
64
|
+
|
|
65
|
+
```json
|
|
66
|
+
{
|
|
67
|
+
"error": {
|
|
68
|
+
"code": "validation.failed",
|
|
69
|
+
"message": "Validation failed.",
|
|
70
|
+
"details": {
|
|
71
|
+
"fields": {
|
|
72
|
+
"title": [
|
|
73
|
+
"The title field is required."
|
|
74
|
+
]
|
|
75
|
+
}
|
|
76
|
+
}
|
|
77
|
+
}
|
|
78
|
+
}
|
|
79
|
+
```
|
|
80
|
+
|
|
81
|
+
### 404 (application/json)
|
|
82
|
+
Resource not found.
|
|
83
|
+
|
|
84
|
+
```json
|
|
85
|
+
{
|
|
86
|
+
"error": {
|
|
87
|
+
"code": "validation.failed",
|
|
88
|
+
"message": "Validation failed.",
|
|
89
|
+
"details": {
|
|
90
|
+
"fields": {
|
|
91
|
+
"title": [
|
|
92
|
+
"The title field is required."
|
|
93
|
+
]
|
|
94
|
+
}
|
|
95
|
+
}
|
|
96
|
+
}
|
|
97
|
+
}
|
|
98
|
+
```
|
|
99
|
+
|
|
100
|
+
### 422 (application/json)
|
|
101
|
+
Validation failed.
|
|
102
|
+
|
|
103
|
+
```json
|
|
104
|
+
{
|
|
105
|
+
"error": {
|
|
106
|
+
"code": "validation.failed",
|
|
107
|
+
"message": "Validation failed.",
|
|
108
|
+
"details": {
|
|
109
|
+
"fields": {
|
|
110
|
+
"title": [
|
|
111
|
+
"The title field is required."
|
|
112
|
+
]
|
|
113
|
+
}
|
|
114
|
+
}
|
|
115
|
+
}
|
|
116
|
+
}
|
|
117
|
+
```
|
|
118
|
+
|
|
119
|
+
|
|
120
|
+
## SDK Example
|
|
121
|
+
|
|
122
|
+
```ts
|
|
123
|
+
import { AgentMCApi } from "@agentmc/api";
|
|
124
|
+
|
|
125
|
+
const client = new AgentMCApi({
|
|
126
|
+
agentToken: process.env.AGENTMC_AGENT_TOKEN
|
|
127
|
+
});
|
|
128
|
+
|
|
129
|
+
const result = await client.operations.deleteBoardColumn({
|
|
130
|
+
"params": {
|
|
131
|
+
"path": {
|
|
132
|
+
"board": 1
|
|
133
|
+
}
|
|
134
|
+
},
|
|
135
|
+
"body": {
|
|
136
|
+
"column_id": 13
|
|
137
|
+
}
|
|
138
|
+
});
|
|
139
|
+
|
|
140
|
+
if (result.error) {
|
|
141
|
+
console.error(result.status, result.error);
|
|
142
|
+
} else {
|
|
143
|
+
console.log(result.data);
|
|
144
|
+
}
|
|
145
|
+
```
|
|
146
|
+
|
|
147
|
+
## cURL Example
|
|
148
|
+
|
|
149
|
+
```bash
|
|
150
|
+
curl -X DELETE "https://agentmc.ai/api/v1/boards/1/columns" \\
|
|
151
|
+
-H "Accept: application/json" \\
|
|
152
|
+
-H "X-Api-Key: $AGENTMC_API_KEY" \\
|
|
153
|
+
-H "Content-Type: application/json" \\
|
|
154
|
+
--data-raw "{\"column_id\":13}"
|
|
155
|
+
```
|