@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
|
+
# updateBoardColumn
|
|
2
|
+
|
|
3
|
+
- Method: `PATCH`
|
|
4
|
+
- Path: `/boards/{board}/columns`
|
|
5
|
+
- Summary: Update one or more board columns.
|
|
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
|
+
"name": "Review",
|
|
25
|
+
"position": 3
|
|
26
|
+
}
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
## Success Responses
|
|
30
|
+
|
|
31
|
+
### 200 (application/json)
|
|
32
|
+
Columns updated.
|
|
33
|
+
|
|
34
|
+
```json
|
|
35
|
+
{
|
|
36
|
+
"data": {
|
|
37
|
+
"id": 42,
|
|
38
|
+
"board_id": 42,
|
|
39
|
+
"team_id": 42,
|
|
40
|
+
"name": "Example Name",
|
|
41
|
+
"position": 1,
|
|
42
|
+
"created_at": "2026-02-22T17:21:00Z",
|
|
43
|
+
"updated_at": "2026-02-22T17:21:00Z"
|
|
44
|
+
}
|
|
45
|
+
}
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
|
|
49
|
+
## Error Responses
|
|
50
|
+
|
|
51
|
+
### 401 (application/json)
|
|
52
|
+
Missing or invalid credentials.
|
|
53
|
+
|
|
54
|
+
```json
|
|
55
|
+
{
|
|
56
|
+
"error": {
|
|
57
|
+
"code": "validation.failed",
|
|
58
|
+
"message": "Validation failed.",
|
|
59
|
+
"details": {
|
|
60
|
+
"fields": {
|
|
61
|
+
"title": [
|
|
62
|
+
"The title field is required."
|
|
63
|
+
]
|
|
64
|
+
}
|
|
65
|
+
}
|
|
66
|
+
}
|
|
67
|
+
}
|
|
68
|
+
```
|
|
69
|
+
|
|
70
|
+
### 403 (application/json)
|
|
71
|
+
Forbidden.
|
|
72
|
+
|
|
73
|
+
```json
|
|
74
|
+
{
|
|
75
|
+
"error": {
|
|
76
|
+
"code": "validation.failed",
|
|
77
|
+
"message": "Validation failed.",
|
|
78
|
+
"details": {
|
|
79
|
+
"fields": {
|
|
80
|
+
"title": [
|
|
81
|
+
"The title field is required."
|
|
82
|
+
]
|
|
83
|
+
}
|
|
84
|
+
}
|
|
85
|
+
}
|
|
86
|
+
}
|
|
87
|
+
```
|
|
88
|
+
|
|
89
|
+
### 404 (application/json)
|
|
90
|
+
Resource not found.
|
|
91
|
+
|
|
92
|
+
```json
|
|
93
|
+
{
|
|
94
|
+
"error": {
|
|
95
|
+
"code": "validation.failed",
|
|
96
|
+
"message": "Validation failed.",
|
|
97
|
+
"details": {
|
|
98
|
+
"fields": {
|
|
99
|
+
"title": [
|
|
100
|
+
"The title field is required."
|
|
101
|
+
]
|
|
102
|
+
}
|
|
103
|
+
}
|
|
104
|
+
}
|
|
105
|
+
}
|
|
106
|
+
```
|
|
107
|
+
|
|
108
|
+
### 422 (application/json)
|
|
109
|
+
Validation failed.
|
|
110
|
+
|
|
111
|
+
```json
|
|
112
|
+
{
|
|
113
|
+
"error": {
|
|
114
|
+
"code": "validation.failed",
|
|
115
|
+
"message": "Validation failed.",
|
|
116
|
+
"details": {
|
|
117
|
+
"fields": {
|
|
118
|
+
"title": [
|
|
119
|
+
"The title field is required."
|
|
120
|
+
]
|
|
121
|
+
}
|
|
122
|
+
}
|
|
123
|
+
}
|
|
124
|
+
}
|
|
125
|
+
```
|
|
126
|
+
|
|
127
|
+
|
|
128
|
+
## SDK Example
|
|
129
|
+
|
|
130
|
+
```ts
|
|
131
|
+
import { AgentMCApi } from "@agentmc/api";
|
|
132
|
+
|
|
133
|
+
const client = new AgentMCApi({
|
|
134
|
+
agentToken: process.env.AGENTMC_AGENT_TOKEN
|
|
135
|
+
});
|
|
136
|
+
|
|
137
|
+
const result = await client.operations.updateBoardColumn({
|
|
138
|
+
"params": {
|
|
139
|
+
"path": {
|
|
140
|
+
"board": 1
|
|
141
|
+
}
|
|
142
|
+
},
|
|
143
|
+
"body": {
|
|
144
|
+
"column_id": 13,
|
|
145
|
+
"name": "Review",
|
|
146
|
+
"position": 3
|
|
147
|
+
}
|
|
148
|
+
});
|
|
149
|
+
|
|
150
|
+
if (result.error) {
|
|
151
|
+
console.error(result.status, result.error);
|
|
152
|
+
} else {
|
|
153
|
+
console.log(result.data);
|
|
154
|
+
}
|
|
155
|
+
```
|
|
156
|
+
|
|
157
|
+
## cURL Example
|
|
158
|
+
|
|
159
|
+
```bash
|
|
160
|
+
curl -X PATCH "https://agentmc.ai/api/v1/boards/1/columns" \\
|
|
161
|
+
-H "Accept: application/json" \\
|
|
162
|
+
-H "X-Api-Key: $AGENTMC_API_KEY" \\
|
|
163
|
+
-H "Content-Type: application/json" \\
|
|
164
|
+
--data-raw "{\"column_id\":13,\"name\":\"Review\",\"position\":3}"
|
|
165
|
+
```
|
|
@@ -0,0 +1,175 @@
|
|
|
1
|
+
# updateTask
|
|
2
|
+
|
|
3
|
+
- Method: `PATCH`
|
|
4
|
+
- Path: `/tasks/{task}`
|
|
5
|
+
- Summary: Update a 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
|
+
|
|
18
|
+
## Request Example
|
|
19
|
+
|
|
20
|
+
### application/json
|
|
21
|
+
```json
|
|
22
|
+
{
|
|
23
|
+
"title": "Draft post-incident summary",
|
|
24
|
+
"status": "review",
|
|
25
|
+
"due_at": "2026-02-24T19:00:00Z",
|
|
26
|
+
"assigned_to_agent_id": 42
|
|
27
|
+
}
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
## Success Responses
|
|
31
|
+
|
|
32
|
+
### 200 (application/json)
|
|
33
|
+
Task updated.
|
|
34
|
+
|
|
35
|
+
```json
|
|
36
|
+
{
|
|
37
|
+
"data": {
|
|
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
|
+
```
|
|
56
|
+
|
|
57
|
+
|
|
58
|
+
## Error Responses
|
|
59
|
+
|
|
60
|
+
### 401 (application/json)
|
|
61
|
+
Missing or invalid credentials.
|
|
62
|
+
|
|
63
|
+
```json
|
|
64
|
+
{
|
|
65
|
+
"error": {
|
|
66
|
+
"code": "validation.failed",
|
|
67
|
+
"message": "Validation failed.",
|
|
68
|
+
"details": {
|
|
69
|
+
"fields": {
|
|
70
|
+
"title": [
|
|
71
|
+
"The title field is required."
|
|
72
|
+
]
|
|
73
|
+
}
|
|
74
|
+
}
|
|
75
|
+
}
|
|
76
|
+
}
|
|
77
|
+
```
|
|
78
|
+
|
|
79
|
+
### 403 (application/json)
|
|
80
|
+
Forbidden.
|
|
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
|
+
### 404 (application/json)
|
|
99
|
+
Resource not found.
|
|
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
|
+
### 422 (application/json)
|
|
118
|
+
Validation failed.
|
|
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.updateTask({
|
|
147
|
+
"params": {
|
|
148
|
+
"path": {
|
|
149
|
+
"task": 1
|
|
150
|
+
}
|
|
151
|
+
},
|
|
152
|
+
"body": {
|
|
153
|
+
"title": "Draft post-incident summary",
|
|
154
|
+
"status": "review",
|
|
155
|
+
"due_at": "2026-02-24T19:00:00Z",
|
|
156
|
+
"assigned_to_agent_id": 42
|
|
157
|
+
}
|
|
158
|
+
});
|
|
159
|
+
|
|
160
|
+
if (result.error) {
|
|
161
|
+
console.error(result.status, result.error);
|
|
162
|
+
} else {
|
|
163
|
+
console.log(result.data);
|
|
164
|
+
}
|
|
165
|
+
```
|
|
166
|
+
|
|
167
|
+
## cURL Example
|
|
168
|
+
|
|
169
|
+
```bash
|
|
170
|
+
curl -X PATCH "https://agentmc.ai/api/v1/tasks/1" \\
|
|
171
|
+
-H "Accept: application/json" \\
|
|
172
|
+
-H "X-Api-Key: $AGENTMC_API_KEY" \\
|
|
173
|
+
-H "Content-Type: application/json" \\
|
|
174
|
+
--data-raw "{\"title\":\"Draft post-incident summary\",\"status\":\"review\",\"due_at\":\"2026-02-24T19:00:00Z\",\"assigned_to_agent_id\":42}"
|
|
175
|
+
```
|
|
@@ -0,0 +1,174 @@
|
|
|
1
|
+
# updateTaskComment
|
|
2
|
+
|
|
3
|
+
- Method: `PATCH`
|
|
4
|
+
- Path: `/tasks/{task}/comments/{comment}`
|
|
5
|
+
- Summary: Update one existing task comment.
|
|
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
|
+
| comment | path | yes | Task comment identifier. | 1 |
|
|
18
|
+
|
|
19
|
+
## Request Example
|
|
20
|
+
|
|
21
|
+
### application/json
|
|
22
|
+
```json
|
|
23
|
+
{
|
|
24
|
+
"body": "Updated handoff note with the latest timeline and log links."
|
|
25
|
+
}
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
## Success Responses
|
|
29
|
+
|
|
30
|
+
### 200 (application/json)
|
|
31
|
+
Task comment updated.
|
|
32
|
+
|
|
33
|
+
```json
|
|
34
|
+
{
|
|
35
|
+
"data": {
|
|
36
|
+
"id": 42,
|
|
37
|
+
"task_id": 42,
|
|
38
|
+
"actor_type": "user",
|
|
39
|
+
"actor_id": 42,
|
|
40
|
+
"actor_name": "Example Name",
|
|
41
|
+
"body": "Example content.",
|
|
42
|
+
"mentions": [
|
|
43
|
+
{
|
|
44
|
+
"key": "example",
|
|
45
|
+
"type": "user",
|
|
46
|
+
"id": 42,
|
|
47
|
+
"label": "example",
|
|
48
|
+
"handle": "example",
|
|
49
|
+
"token": "example"
|
|
50
|
+
}
|
|
51
|
+
],
|
|
52
|
+
"edited_at": "2026-02-22T17:21:00Z",
|
|
53
|
+
"created_at": "2026-02-22T17:21:00Z"
|
|
54
|
+
}
|
|
55
|
+
}
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
|
|
59
|
+
## Error Responses
|
|
60
|
+
|
|
61
|
+
### 401 (application/json)
|
|
62
|
+
Missing or invalid credentials.
|
|
63
|
+
|
|
64
|
+
```json
|
|
65
|
+
{
|
|
66
|
+
"error": {
|
|
67
|
+
"code": "validation.failed",
|
|
68
|
+
"message": "Validation failed.",
|
|
69
|
+
"details": {
|
|
70
|
+
"fields": {
|
|
71
|
+
"title": [
|
|
72
|
+
"The title field is required."
|
|
73
|
+
]
|
|
74
|
+
}
|
|
75
|
+
}
|
|
76
|
+
}
|
|
77
|
+
}
|
|
78
|
+
```
|
|
79
|
+
|
|
80
|
+
### 403 (application/json)
|
|
81
|
+
Forbidden.
|
|
82
|
+
|
|
83
|
+
```json
|
|
84
|
+
{
|
|
85
|
+
"error": {
|
|
86
|
+
"code": "validation.failed",
|
|
87
|
+
"message": "Validation failed.",
|
|
88
|
+
"details": {
|
|
89
|
+
"fields": {
|
|
90
|
+
"title": [
|
|
91
|
+
"The title field is required."
|
|
92
|
+
]
|
|
93
|
+
}
|
|
94
|
+
}
|
|
95
|
+
}
|
|
96
|
+
}
|
|
97
|
+
```
|
|
98
|
+
|
|
99
|
+
### 404 (application/json)
|
|
100
|
+
Resource not found.
|
|
101
|
+
|
|
102
|
+
```json
|
|
103
|
+
{
|
|
104
|
+
"error": {
|
|
105
|
+
"code": "validation.failed",
|
|
106
|
+
"message": "Validation failed.",
|
|
107
|
+
"details": {
|
|
108
|
+
"fields": {
|
|
109
|
+
"title": [
|
|
110
|
+
"The title field is required."
|
|
111
|
+
]
|
|
112
|
+
}
|
|
113
|
+
}
|
|
114
|
+
}
|
|
115
|
+
}
|
|
116
|
+
```
|
|
117
|
+
|
|
118
|
+
### 422 (application/json)
|
|
119
|
+
Validation failed.
|
|
120
|
+
|
|
121
|
+
```json
|
|
122
|
+
{
|
|
123
|
+
"error": {
|
|
124
|
+
"code": "validation.failed",
|
|
125
|
+
"message": "Validation failed.",
|
|
126
|
+
"details": {
|
|
127
|
+
"fields": {
|
|
128
|
+
"title": [
|
|
129
|
+
"The title field is required."
|
|
130
|
+
]
|
|
131
|
+
}
|
|
132
|
+
}
|
|
133
|
+
}
|
|
134
|
+
}
|
|
135
|
+
```
|
|
136
|
+
|
|
137
|
+
|
|
138
|
+
## SDK Example
|
|
139
|
+
|
|
140
|
+
```ts
|
|
141
|
+
import { AgentMCApi } from "@agentmc/api";
|
|
142
|
+
|
|
143
|
+
const client = new AgentMCApi({
|
|
144
|
+
agentToken: process.env.AGENTMC_AGENT_TOKEN
|
|
145
|
+
});
|
|
146
|
+
|
|
147
|
+
const result = await client.operations.updateTaskComment({
|
|
148
|
+
"params": {
|
|
149
|
+
"path": {
|
|
150
|
+
"task": 1,
|
|
151
|
+
"comment": 1
|
|
152
|
+
}
|
|
153
|
+
},
|
|
154
|
+
"body": {
|
|
155
|
+
"body": "Updated handoff note with the latest timeline and log links."
|
|
156
|
+
}
|
|
157
|
+
});
|
|
158
|
+
|
|
159
|
+
if (result.error) {
|
|
160
|
+
console.error(result.status, result.error);
|
|
161
|
+
} else {
|
|
162
|
+
console.log(result.data);
|
|
163
|
+
}
|
|
164
|
+
```
|
|
165
|
+
|
|
166
|
+
## cURL Example
|
|
167
|
+
|
|
168
|
+
```bash
|
|
169
|
+
curl -X PATCH "https://agentmc.ai/api/v1/tasks/1/comments/1" \\
|
|
170
|
+
-H "Accept: application/json" \\
|
|
171
|
+
-H "X-Api-Key: $AGENTMC_API_KEY" \\
|
|
172
|
+
-H "Content-Type: application/json" \\
|
|
173
|
+
--data-raw "{\"body\":\"Updated handoff note with the latest timeline and log links.\"}"
|
|
174
|
+
```
|
|
@@ -0,0 +1,204 @@
|
|
|
1
|
+
# updateWorkspaceCalendarItem
|
|
2
|
+
|
|
3
|
+
- Method: `PUT`
|
|
4
|
+
- Path: `/calendar/items/{item}`
|
|
5
|
+
- Summary: Update a 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
|
+
### application/json
|
|
21
|
+
```json
|
|
22
|
+
{
|
|
23
|
+
"title": "Review outage timeline",
|
|
24
|
+
"description": "Add links to root-cause analysis notes.",
|
|
25
|
+
"due_at": "2026-02-24T11:00:00Z",
|
|
26
|
+
"status": "in_progress",
|
|
27
|
+
"priority": "urgent",
|
|
28
|
+
"visibility": "workspace"
|
|
29
|
+
}
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
## Success Responses
|
|
33
|
+
|
|
34
|
+
### 200 (application/json)
|
|
35
|
+
Calendar item updated.
|
|
36
|
+
|
|
37
|
+
```json
|
|
38
|
+
{
|
|
39
|
+
"data": {
|
|
40
|
+
"id": 42,
|
|
41
|
+
"workspace_id": 42,
|
|
42
|
+
"type": "event",
|
|
43
|
+
"title": "Example Title",
|
|
44
|
+
"description": "Example description text.",
|
|
45
|
+
"start_at": "2026-02-22T17:21:00Z",
|
|
46
|
+
"end_at": "2026-02-22T17:21:00Z",
|
|
47
|
+
"due_at": "2026-02-22T17:21:00Z",
|
|
48
|
+
"all_day": false,
|
|
49
|
+
"location": "example",
|
|
50
|
+
"timezone": "America/Los_Angeles",
|
|
51
|
+
"status": "todo",
|
|
52
|
+
"priority": "low",
|
|
53
|
+
"visibility": "workspace",
|
|
54
|
+
"created_by": 1,
|
|
55
|
+
"updated_by": 1,
|
|
56
|
+
"assignees": [
|
|
57
|
+
{
|
|
58
|
+
"id": 42,
|
|
59
|
+
"assignee_type": "user",
|
|
60
|
+
"assignee_id": 42,
|
|
61
|
+
"role": "owner",
|
|
62
|
+
"name": "Example Name",
|
|
63
|
+
"created_at": "2026-02-22T17:21:00Z"
|
|
64
|
+
}
|
|
65
|
+
],
|
|
66
|
+
"links": [
|
|
67
|
+
{
|
|
68
|
+
"id": 42,
|
|
69
|
+
"link_type": "example",
|
|
70
|
+
"link_id": 42,
|
|
71
|
+
"url": "https://agentmc.example.com/docs/incident-123",
|
|
72
|
+
"title": "Example Title",
|
|
73
|
+
"created_at": "2026-02-22T17:21:00Z"
|
|
74
|
+
}
|
|
75
|
+
],
|
|
76
|
+
"comments_count": 1,
|
|
77
|
+
"created_at": "2026-02-22T17:21:00Z",
|
|
78
|
+
"updated_at": "2026-02-22T17:21:00Z",
|
|
79
|
+
"deleted_at": "2026-02-22T17:21:00Z"
|
|
80
|
+
}
|
|
81
|
+
}
|
|
82
|
+
```
|
|
83
|
+
|
|
84
|
+
|
|
85
|
+
## Error Responses
|
|
86
|
+
|
|
87
|
+
### 401 (application/json)
|
|
88
|
+
Missing or invalid credentials.
|
|
89
|
+
|
|
90
|
+
```json
|
|
91
|
+
{
|
|
92
|
+
"error": {
|
|
93
|
+
"code": "validation.failed",
|
|
94
|
+
"message": "Validation failed.",
|
|
95
|
+
"details": {
|
|
96
|
+
"fields": {
|
|
97
|
+
"title": [
|
|
98
|
+
"The title field is required."
|
|
99
|
+
]
|
|
100
|
+
}
|
|
101
|
+
}
|
|
102
|
+
}
|
|
103
|
+
}
|
|
104
|
+
```
|
|
105
|
+
|
|
106
|
+
### 403 (application/json)
|
|
107
|
+
Forbidden.
|
|
108
|
+
|
|
109
|
+
```json
|
|
110
|
+
{
|
|
111
|
+
"error": {
|
|
112
|
+
"code": "validation.failed",
|
|
113
|
+
"message": "Validation failed.",
|
|
114
|
+
"details": {
|
|
115
|
+
"fields": {
|
|
116
|
+
"title": [
|
|
117
|
+
"The title field is required."
|
|
118
|
+
]
|
|
119
|
+
}
|
|
120
|
+
}
|
|
121
|
+
}
|
|
122
|
+
}
|
|
123
|
+
```
|
|
124
|
+
|
|
125
|
+
### 404 (application/json)
|
|
126
|
+
Resource not found.
|
|
127
|
+
|
|
128
|
+
```json
|
|
129
|
+
{
|
|
130
|
+
"error": {
|
|
131
|
+
"code": "validation.failed",
|
|
132
|
+
"message": "Validation failed.",
|
|
133
|
+
"details": {
|
|
134
|
+
"fields": {
|
|
135
|
+
"title": [
|
|
136
|
+
"The title field is required."
|
|
137
|
+
]
|
|
138
|
+
}
|
|
139
|
+
}
|
|
140
|
+
}
|
|
141
|
+
}
|
|
142
|
+
```
|
|
143
|
+
|
|
144
|
+
### 422 (application/json)
|
|
145
|
+
Validation failed.
|
|
146
|
+
|
|
147
|
+
```json
|
|
148
|
+
{
|
|
149
|
+
"error": {
|
|
150
|
+
"code": "validation.failed",
|
|
151
|
+
"message": "Validation failed.",
|
|
152
|
+
"details": {
|
|
153
|
+
"fields": {
|
|
154
|
+
"title": [
|
|
155
|
+
"The title field is required."
|
|
156
|
+
]
|
|
157
|
+
}
|
|
158
|
+
}
|
|
159
|
+
}
|
|
160
|
+
}
|
|
161
|
+
```
|
|
162
|
+
|
|
163
|
+
|
|
164
|
+
## SDK Example
|
|
165
|
+
|
|
166
|
+
```ts
|
|
167
|
+
import { AgentMCApi } from "@agentmc/api";
|
|
168
|
+
|
|
169
|
+
const client = new AgentMCApi({
|
|
170
|
+
agentToken: process.env.AGENTMC_AGENT_TOKEN
|
|
171
|
+
});
|
|
172
|
+
|
|
173
|
+
const result = await client.operations.updateWorkspaceCalendarItem({
|
|
174
|
+
"params": {
|
|
175
|
+
"path": {
|
|
176
|
+
"item": 1
|
|
177
|
+
}
|
|
178
|
+
},
|
|
179
|
+
"body": {
|
|
180
|
+
"title": "Review outage timeline",
|
|
181
|
+
"description": "Add links to root-cause analysis notes.",
|
|
182
|
+
"due_at": "2026-02-24T11:00:00Z",
|
|
183
|
+
"status": "in_progress",
|
|
184
|
+
"priority": "urgent",
|
|
185
|
+
"visibility": "workspace"
|
|
186
|
+
}
|
|
187
|
+
});
|
|
188
|
+
|
|
189
|
+
if (result.error) {
|
|
190
|
+
console.error(result.status, result.error);
|
|
191
|
+
} else {
|
|
192
|
+
console.log(result.data);
|
|
193
|
+
}
|
|
194
|
+
```
|
|
195
|
+
|
|
196
|
+
## cURL Example
|
|
197
|
+
|
|
198
|
+
```bash
|
|
199
|
+
curl -X PUT "https://agentmc.ai/api/v1/calendar/items/1" \\
|
|
200
|
+
-H "Accept: application/json" \\
|
|
201
|
+
-H "X-Api-Key: $AGENTMC_API_KEY" \\
|
|
202
|
+
-H "Content-Type: application/json" \\
|
|
203
|
+
--data-raw "{\"title\":\"Review outage timeline\",\"description\":\"Add links to root-cause analysis notes.\",\"due_at\":\"2026-02-24T11:00:00Z\",\"status\":\"in_progress\",\"priority\":\"urgent\",\"visibility\":\"workspace\"}"
|
|
204
|
+
```
|