@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,165 @@
|
|
|
1
|
+
# showWorkspaceCalendarItem
|
|
2
|
+
|
|
3
|
+
- Method: `GET`
|
|
4
|
+
- Path: `/calendar/items/{item}`
|
|
5
|
+
- Summary: Show one calendar item.
|
|
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
|
+
| item | path | yes | Calendar item identifier. | 1 |
|
|
17
|
+
|
|
18
|
+
## Request Example
|
|
19
|
+
|
|
20
|
+
None.
|
|
21
|
+
|
|
22
|
+
## Success Responses
|
|
23
|
+
|
|
24
|
+
### 200 (application/json)
|
|
25
|
+
Calendar item returned.
|
|
26
|
+
|
|
27
|
+
```json
|
|
28
|
+
{
|
|
29
|
+
"data": {
|
|
30
|
+
"id": 42,
|
|
31
|
+
"workspace_id": 42,
|
|
32
|
+
"type": "event",
|
|
33
|
+
"title": "Example Title",
|
|
34
|
+
"description": "Example description text.",
|
|
35
|
+
"start_at": "2026-02-22T17:21:00Z",
|
|
36
|
+
"end_at": "2026-02-22T17:21:00Z",
|
|
37
|
+
"due_at": "2026-02-22T17:21:00Z",
|
|
38
|
+
"all_day": false,
|
|
39
|
+
"location": "example",
|
|
40
|
+
"timezone": "America/Los_Angeles",
|
|
41
|
+
"status": "todo",
|
|
42
|
+
"priority": "low",
|
|
43
|
+
"visibility": "workspace",
|
|
44
|
+
"created_by": 1,
|
|
45
|
+
"updated_by": 1,
|
|
46
|
+
"assignees": [
|
|
47
|
+
{
|
|
48
|
+
"id": 42,
|
|
49
|
+
"assignee_type": "user",
|
|
50
|
+
"assignee_id": 42,
|
|
51
|
+
"role": "owner",
|
|
52
|
+
"name": "Example Name",
|
|
53
|
+
"created_at": "2026-02-22T17:21:00Z"
|
|
54
|
+
}
|
|
55
|
+
],
|
|
56
|
+
"links": [
|
|
57
|
+
{
|
|
58
|
+
"id": 42,
|
|
59
|
+
"link_type": "example",
|
|
60
|
+
"link_id": 42,
|
|
61
|
+
"url": "https://agentmc.example.com/docs/incident-123",
|
|
62
|
+
"title": "Example Title",
|
|
63
|
+
"created_at": "2026-02-22T17:21:00Z"
|
|
64
|
+
}
|
|
65
|
+
],
|
|
66
|
+
"comments_count": 1,
|
|
67
|
+
"created_at": "2026-02-22T17:21:00Z",
|
|
68
|
+
"updated_at": "2026-02-22T17:21:00Z",
|
|
69
|
+
"deleted_at": "2026-02-22T17:21:00Z"
|
|
70
|
+
}
|
|
71
|
+
}
|
|
72
|
+
```
|
|
73
|
+
|
|
74
|
+
|
|
75
|
+
## Error Responses
|
|
76
|
+
|
|
77
|
+
### 401 (application/json)
|
|
78
|
+
Missing or invalid credentials.
|
|
79
|
+
|
|
80
|
+
```json
|
|
81
|
+
{
|
|
82
|
+
"error": {
|
|
83
|
+
"code": "validation.failed",
|
|
84
|
+
"message": "Validation failed.",
|
|
85
|
+
"details": {
|
|
86
|
+
"fields": {
|
|
87
|
+
"title": [
|
|
88
|
+
"The title field is required."
|
|
89
|
+
]
|
|
90
|
+
}
|
|
91
|
+
}
|
|
92
|
+
}
|
|
93
|
+
}
|
|
94
|
+
```
|
|
95
|
+
|
|
96
|
+
### 403 (application/json)
|
|
97
|
+
Forbidden.
|
|
98
|
+
|
|
99
|
+
```json
|
|
100
|
+
{
|
|
101
|
+
"error": {
|
|
102
|
+
"code": "validation.failed",
|
|
103
|
+
"message": "Validation failed.",
|
|
104
|
+
"details": {
|
|
105
|
+
"fields": {
|
|
106
|
+
"title": [
|
|
107
|
+
"The title field is required."
|
|
108
|
+
]
|
|
109
|
+
}
|
|
110
|
+
}
|
|
111
|
+
}
|
|
112
|
+
}
|
|
113
|
+
```
|
|
114
|
+
|
|
115
|
+
### 404 (application/json)
|
|
116
|
+
Resource not found.
|
|
117
|
+
|
|
118
|
+
```json
|
|
119
|
+
{
|
|
120
|
+
"error": {
|
|
121
|
+
"code": "validation.failed",
|
|
122
|
+
"message": "Validation failed.",
|
|
123
|
+
"details": {
|
|
124
|
+
"fields": {
|
|
125
|
+
"title": [
|
|
126
|
+
"The title field is required."
|
|
127
|
+
]
|
|
128
|
+
}
|
|
129
|
+
}
|
|
130
|
+
}
|
|
131
|
+
}
|
|
132
|
+
```
|
|
133
|
+
|
|
134
|
+
|
|
135
|
+
## SDK Example
|
|
136
|
+
|
|
137
|
+
```ts
|
|
138
|
+
import { AgentMCApi } from "@agentmc/api";
|
|
139
|
+
|
|
140
|
+
const client = new AgentMCApi({
|
|
141
|
+
agentToken: process.env.AGENTMC_AGENT_TOKEN
|
|
142
|
+
});
|
|
143
|
+
|
|
144
|
+
const result = await client.operations.showWorkspaceCalendarItem({
|
|
145
|
+
"params": {
|
|
146
|
+
"path": {
|
|
147
|
+
"item": 1
|
|
148
|
+
}
|
|
149
|
+
}
|
|
150
|
+
});
|
|
151
|
+
|
|
152
|
+
if (result.error) {
|
|
153
|
+
console.error(result.status, result.error);
|
|
154
|
+
} else {
|
|
155
|
+
console.log(result.data);
|
|
156
|
+
}
|
|
157
|
+
```
|
|
158
|
+
|
|
159
|
+
## cURL Example
|
|
160
|
+
|
|
161
|
+
```bash
|
|
162
|
+
curl -X GET "https://agentmc.ai/api/v1/calendar/items/1" \\
|
|
163
|
+
-H "Accept: application/json" \\
|
|
164
|
+
-H "X-Api-Key: $AGENTMC_API_KEY"
|
|
165
|
+
```
|
|
@@ -0,0 +1,257 @@
|
|
|
1
|
+
# updateAgentBrief
|
|
2
|
+
|
|
3
|
+
- Method: `PATCH`
|
|
4
|
+
- Path: `/briefs/{id}`
|
|
5
|
+
- Summary: Edit one brief parent.
|
|
6
|
+
- Auth: ApiKeyAuth OR AgentBearerAuth OR BearerAuth
|
|
7
|
+
|
|
8
|
+
## Description
|
|
9
|
+
|
|
10
|
+
Updates one saved parent brief by id and appends a child entry when entry fields are provided.
|
|
11
|
+
|
|
12
|
+
## Parameters
|
|
13
|
+
|
|
14
|
+
| Name | In | Required | Description | Example |
|
|
15
|
+
| --- | --- | --- | --- | --- |
|
|
16
|
+
| id | path | yes | Brief identifier. | 42 |
|
|
17
|
+
|
|
18
|
+
## Request Example
|
|
19
|
+
|
|
20
|
+
### application/json
|
|
21
|
+
```json
|
|
22
|
+
{
|
|
23
|
+
"brief": {
|
|
24
|
+
"name": "Daily Operations Brief",
|
|
25
|
+
"summary": "Operations handoff digest for the morning window.",
|
|
26
|
+
"timezone": "America/Los_Angeles",
|
|
27
|
+
"sections": [
|
|
28
|
+
{
|
|
29
|
+
"key": "incidents",
|
|
30
|
+
"label": "Incidents"
|
|
31
|
+
},
|
|
32
|
+
{
|
|
33
|
+
"key": "followups",
|
|
34
|
+
"label": "Follow-ups"
|
|
35
|
+
}
|
|
36
|
+
],
|
|
37
|
+
"content_markdown": "## Updates\n- Incident queue cleared\n- Follow-up tasks assigned",
|
|
38
|
+
"meta": {
|
|
39
|
+
"external_source": "daily-ops-job",
|
|
40
|
+
"schedule": "0 7 * * *"
|
|
41
|
+
}
|
|
42
|
+
},
|
|
43
|
+
"source": {
|
|
44
|
+
"agent_id": 42,
|
|
45
|
+
"meta": {
|
|
46
|
+
"runtime": "codex"
|
|
47
|
+
}
|
|
48
|
+
}
|
|
49
|
+
}
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
## Success Responses
|
|
53
|
+
|
|
54
|
+
### 200 (application/json)
|
|
55
|
+
Brief record updated.
|
|
56
|
+
|
|
57
|
+
```json
|
|
58
|
+
{
|
|
59
|
+
"brief": {
|
|
60
|
+
"id": 42,
|
|
61
|
+
"team_id": 42,
|
|
62
|
+
"agent_id": 42,
|
|
63
|
+
"external_key": "daily-operations",
|
|
64
|
+
"external_id": "ops-brief-2026-02-22",
|
|
65
|
+
"name": "Example Name",
|
|
66
|
+
"timezone": "America/Los_Angeles",
|
|
67
|
+
"summary": "Morning operations handoff digest.",
|
|
68
|
+
"include_sections": [
|
|
69
|
+
{
|
|
70
|
+
"key": "value"
|
|
71
|
+
}
|
|
72
|
+
],
|
|
73
|
+
"headline": "3 overdue tasks | 4 upcoming events",
|
|
74
|
+
"content_markdown": "## Highlights\n- Elevated API error rate",
|
|
75
|
+
"content_json": {
|
|
76
|
+
"key": "value"
|
|
77
|
+
},
|
|
78
|
+
"source_meta": {
|
|
79
|
+
"key": "value"
|
|
80
|
+
},
|
|
81
|
+
"received_at": "2026-02-22T17:21:00Z",
|
|
82
|
+
"generated_at": "2026-02-22T17:21:00Z",
|
|
83
|
+
"read_by_user_id": 42,
|
|
84
|
+
"latest_entry_id": 42,
|
|
85
|
+
"entries_count": 0,
|
|
86
|
+
"latest_entry": {
|
|
87
|
+
"id": 42,
|
|
88
|
+
"agent_id": 42,
|
|
89
|
+
"external_id": "ops-brief-2026-02-22",
|
|
90
|
+
"name": "Example Name",
|
|
91
|
+
"timezone": "America/Los_Angeles",
|
|
92
|
+
"summary": "Morning operations handoff digest.",
|
|
93
|
+
"include_sections": [
|
|
94
|
+
{
|
|
95
|
+
"key": "value"
|
|
96
|
+
}
|
|
97
|
+
],
|
|
98
|
+
"headline": "3 overdue tasks | 4 upcoming events",
|
|
99
|
+
"content_markdown": "## Highlights\n- Elevated API error rate",
|
|
100
|
+
"content_json": {
|
|
101
|
+
"key": "value"
|
|
102
|
+
},
|
|
103
|
+
"source_meta": {
|
|
104
|
+
"key": "value"
|
|
105
|
+
},
|
|
106
|
+
"received_at": "2026-02-22T17:21:00Z",
|
|
107
|
+
"generated_at": "2026-02-22T17:21:00Z",
|
|
108
|
+
"created_at": "2026-02-22T17:21:00Z",
|
|
109
|
+
"updated_at": "2026-02-22T17:21:00Z"
|
|
110
|
+
},
|
|
111
|
+
"created_at": "2026-02-22T17:21:00Z",
|
|
112
|
+
"updated_at": "2026-02-22T17:21:00Z"
|
|
113
|
+
}
|
|
114
|
+
}
|
|
115
|
+
```
|
|
116
|
+
|
|
117
|
+
|
|
118
|
+
## Error Responses
|
|
119
|
+
|
|
120
|
+
### 401 (application/json)
|
|
121
|
+
Missing or invalid credentials.
|
|
122
|
+
|
|
123
|
+
```json
|
|
124
|
+
{
|
|
125
|
+
"error": {
|
|
126
|
+
"code": "validation.failed",
|
|
127
|
+
"message": "Validation failed.",
|
|
128
|
+
"details": {
|
|
129
|
+
"fields": {
|
|
130
|
+
"title": [
|
|
131
|
+
"The title field is required."
|
|
132
|
+
]
|
|
133
|
+
}
|
|
134
|
+
}
|
|
135
|
+
}
|
|
136
|
+
}
|
|
137
|
+
```
|
|
138
|
+
|
|
139
|
+
### 403 (application/json)
|
|
140
|
+
Forbidden.
|
|
141
|
+
|
|
142
|
+
```json
|
|
143
|
+
{
|
|
144
|
+
"error": {
|
|
145
|
+
"code": "validation.failed",
|
|
146
|
+
"message": "Validation failed.",
|
|
147
|
+
"details": {
|
|
148
|
+
"fields": {
|
|
149
|
+
"title": [
|
|
150
|
+
"The title field is required."
|
|
151
|
+
]
|
|
152
|
+
}
|
|
153
|
+
}
|
|
154
|
+
}
|
|
155
|
+
}
|
|
156
|
+
```
|
|
157
|
+
|
|
158
|
+
### 404 (application/json)
|
|
159
|
+
Resource not found.
|
|
160
|
+
|
|
161
|
+
```json
|
|
162
|
+
{
|
|
163
|
+
"error": {
|
|
164
|
+
"code": "validation.failed",
|
|
165
|
+
"message": "Validation failed.",
|
|
166
|
+
"details": {
|
|
167
|
+
"fields": {
|
|
168
|
+
"title": [
|
|
169
|
+
"The title field is required."
|
|
170
|
+
]
|
|
171
|
+
}
|
|
172
|
+
}
|
|
173
|
+
}
|
|
174
|
+
}
|
|
175
|
+
```
|
|
176
|
+
|
|
177
|
+
### 422 (application/json)
|
|
178
|
+
Validation failed.
|
|
179
|
+
|
|
180
|
+
```json
|
|
181
|
+
{
|
|
182
|
+
"error": {
|
|
183
|
+
"code": "validation.failed",
|
|
184
|
+
"message": "Validation failed.",
|
|
185
|
+
"details": {
|
|
186
|
+
"fields": {
|
|
187
|
+
"title": [
|
|
188
|
+
"The title field is required."
|
|
189
|
+
]
|
|
190
|
+
}
|
|
191
|
+
}
|
|
192
|
+
}
|
|
193
|
+
}
|
|
194
|
+
```
|
|
195
|
+
|
|
196
|
+
|
|
197
|
+
## SDK Example
|
|
198
|
+
|
|
199
|
+
```ts
|
|
200
|
+
import { AgentMCApi } from "@agentmc/api";
|
|
201
|
+
|
|
202
|
+
const client = new AgentMCApi({
|
|
203
|
+
agentToken: process.env.AGENTMC_AGENT_TOKEN
|
|
204
|
+
});
|
|
205
|
+
|
|
206
|
+
const result = await client.operations.updateAgentBrief({
|
|
207
|
+
"params": {
|
|
208
|
+
"path": {
|
|
209
|
+
"id": 42
|
|
210
|
+
}
|
|
211
|
+
},
|
|
212
|
+
"body": {
|
|
213
|
+
"brief": {
|
|
214
|
+
"name": "Daily Operations Brief",
|
|
215
|
+
"summary": "Operations handoff digest for the morning window.",
|
|
216
|
+
"timezone": "America/Los_Angeles",
|
|
217
|
+
"sections": [
|
|
218
|
+
{
|
|
219
|
+
"key": "incidents",
|
|
220
|
+
"label": "Incidents"
|
|
221
|
+
},
|
|
222
|
+
{
|
|
223
|
+
"key": "followups",
|
|
224
|
+
"label": "Follow-ups"
|
|
225
|
+
}
|
|
226
|
+
],
|
|
227
|
+
"content_markdown": "## Updates\n- Incident queue cleared\n- Follow-up tasks assigned",
|
|
228
|
+
"meta": {
|
|
229
|
+
"external_source": "daily-ops-job",
|
|
230
|
+
"schedule": "0 7 * * *"
|
|
231
|
+
}
|
|
232
|
+
},
|
|
233
|
+
"source": {
|
|
234
|
+
"agent_id": 42,
|
|
235
|
+
"meta": {
|
|
236
|
+
"runtime": "codex"
|
|
237
|
+
}
|
|
238
|
+
}
|
|
239
|
+
}
|
|
240
|
+
});
|
|
241
|
+
|
|
242
|
+
if (result.error) {
|
|
243
|
+
console.error(result.status, result.error);
|
|
244
|
+
} else {
|
|
245
|
+
console.log(result.data);
|
|
246
|
+
}
|
|
247
|
+
```
|
|
248
|
+
|
|
249
|
+
## cURL Example
|
|
250
|
+
|
|
251
|
+
```bash
|
|
252
|
+
curl -X PATCH "https://agentmc.ai/api/v1/briefs/42" \\
|
|
253
|
+
-H "Accept: application/json" \\
|
|
254
|
+
-H "X-Api-Key: $AGENTMC_API_KEY" \\
|
|
255
|
+
-H "Content-Type: application/json" \\
|
|
256
|
+
--data-raw "{\"brief\":{\"name\":\"Daily Operations Brief\",\"summary\":\"Operations handoff digest for the morning window.\",\"timezone\":\"America/Los_Angeles\",\"sections\":[{\"key\":\"incidents\",\"label\":\"Incidents\"},{\"key\":\"followups\",\"label\":\"Follow-ups\"}],\"content_markdown\":\"## Updates\n- Incident queue cleared\n- Follow-up tasks assigned\",\"meta\":{\"external_source\":\"daily-ops-job\",\"schedule\":\"0 7 * * *\"}},\"source\":{\"agent_id\":42,\"meta\":{\"runtime\":\"codex\"}}}"
|
|
257
|
+
```
|
|
@@ -0,0 +1,169 @@
|
|
|
1
|
+
# updateBoard
|
|
2
|
+
|
|
3
|
+
- Method: `PATCH`
|
|
4
|
+
- Path: `/boards/{id}`
|
|
5
|
+
- Summary: Update 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
|
+
### application/json
|
|
21
|
+
```json
|
|
22
|
+
{
|
|
23
|
+
"name": "Incident Response",
|
|
24
|
+
"description": "Updated board description with escalation runbook links.",
|
|
25
|
+
"visibility": "personal",
|
|
26
|
+
"personal_owner_user_id": 8
|
|
27
|
+
}
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
## Success Responses
|
|
31
|
+
|
|
32
|
+
### 200 (application/json)
|
|
33
|
+
Board updated.
|
|
34
|
+
|
|
35
|
+
```json
|
|
36
|
+
{
|
|
37
|
+
"data": {
|
|
38
|
+
"id": 42,
|
|
39
|
+
"team_id": 42,
|
|
40
|
+
"name": "Example Name",
|
|
41
|
+
"description": "Example description text.",
|
|
42
|
+
"visibility": "team",
|
|
43
|
+
"personal_owner_user_id": 42,
|
|
44
|
+
"created_by_user_id": 42,
|
|
45
|
+
"created_at": "2026-02-22T17:21:00Z",
|
|
46
|
+
"updated_at": "2026-02-22T17:21:00Z"
|
|
47
|
+
}
|
|
48
|
+
}
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
|
|
52
|
+
## Error Responses
|
|
53
|
+
|
|
54
|
+
### 401 (application/json)
|
|
55
|
+
Missing or invalid credentials.
|
|
56
|
+
|
|
57
|
+
```json
|
|
58
|
+
{
|
|
59
|
+
"error": {
|
|
60
|
+
"code": "validation.failed",
|
|
61
|
+
"message": "Validation failed.",
|
|
62
|
+
"details": {
|
|
63
|
+
"fields": {
|
|
64
|
+
"title": [
|
|
65
|
+
"The title field is required."
|
|
66
|
+
]
|
|
67
|
+
}
|
|
68
|
+
}
|
|
69
|
+
}
|
|
70
|
+
}
|
|
71
|
+
```
|
|
72
|
+
|
|
73
|
+
### 403 (application/json)
|
|
74
|
+
Forbidden.
|
|
75
|
+
|
|
76
|
+
```json
|
|
77
|
+
{
|
|
78
|
+
"error": {
|
|
79
|
+
"code": "validation.failed",
|
|
80
|
+
"message": "Validation failed.",
|
|
81
|
+
"details": {
|
|
82
|
+
"fields": {
|
|
83
|
+
"title": [
|
|
84
|
+
"The title field is required."
|
|
85
|
+
]
|
|
86
|
+
}
|
|
87
|
+
}
|
|
88
|
+
}
|
|
89
|
+
}
|
|
90
|
+
```
|
|
91
|
+
|
|
92
|
+
### 404 (application/json)
|
|
93
|
+
Resource not found.
|
|
94
|
+
|
|
95
|
+
```json
|
|
96
|
+
{
|
|
97
|
+
"error": {
|
|
98
|
+
"code": "validation.failed",
|
|
99
|
+
"message": "Validation failed.",
|
|
100
|
+
"details": {
|
|
101
|
+
"fields": {
|
|
102
|
+
"title": [
|
|
103
|
+
"The title field is required."
|
|
104
|
+
]
|
|
105
|
+
}
|
|
106
|
+
}
|
|
107
|
+
}
|
|
108
|
+
}
|
|
109
|
+
```
|
|
110
|
+
|
|
111
|
+
### 422 (application/json)
|
|
112
|
+
Validation failed.
|
|
113
|
+
|
|
114
|
+
```json
|
|
115
|
+
{
|
|
116
|
+
"error": {
|
|
117
|
+
"code": "validation.failed",
|
|
118
|
+
"message": "Validation failed.",
|
|
119
|
+
"details": {
|
|
120
|
+
"fields": {
|
|
121
|
+
"title": [
|
|
122
|
+
"The title field is required."
|
|
123
|
+
]
|
|
124
|
+
}
|
|
125
|
+
}
|
|
126
|
+
}
|
|
127
|
+
}
|
|
128
|
+
```
|
|
129
|
+
|
|
130
|
+
|
|
131
|
+
## SDK Example
|
|
132
|
+
|
|
133
|
+
```ts
|
|
134
|
+
import { AgentMCApi } from "@agentmc/api";
|
|
135
|
+
|
|
136
|
+
const client = new AgentMCApi({
|
|
137
|
+
agentToken: process.env.AGENTMC_AGENT_TOKEN
|
|
138
|
+
});
|
|
139
|
+
|
|
140
|
+
const result = await client.operations.updateBoard({
|
|
141
|
+
"params": {
|
|
142
|
+
"path": {
|
|
143
|
+
"id": 42
|
|
144
|
+
}
|
|
145
|
+
},
|
|
146
|
+
"body": {
|
|
147
|
+
"name": "Incident Response",
|
|
148
|
+
"description": "Updated board description with escalation runbook links.",
|
|
149
|
+
"visibility": "personal",
|
|
150
|
+
"personal_owner_user_id": 8
|
|
151
|
+
}
|
|
152
|
+
});
|
|
153
|
+
|
|
154
|
+
if (result.error) {
|
|
155
|
+
console.error(result.status, result.error);
|
|
156
|
+
} else {
|
|
157
|
+
console.log(result.data);
|
|
158
|
+
}
|
|
159
|
+
```
|
|
160
|
+
|
|
161
|
+
## cURL Example
|
|
162
|
+
|
|
163
|
+
```bash
|
|
164
|
+
curl -X PATCH "https://agentmc.ai/api/v1/boards/42" \\
|
|
165
|
+
-H "Accept: application/json" \\
|
|
166
|
+
-H "X-Api-Key: $AGENTMC_API_KEY" \\
|
|
167
|
+
-H "Content-Type: application/json" \\
|
|
168
|
+
--data-raw "{\"name\":\"Incident Response\",\"description\":\"Updated board description with escalation runbook links.\",\"visibility\":\"personal\",\"personal_owner_user_id\":8}"
|
|
169
|
+
```
|