Spaces:
Sleeping
Sleeping
File size: 16,846 Bytes
99caad5 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 | {
"version": "1.0",
"status": "design_not_implemented",
"operations": [
{
"operation_id": "login",
"method": "POST",
"path": "/api/v1/auth/login",
"summary": "演示账号登录",
"owner": "Identity",
"phase": "PC",
"scope": "public",
"request_schema": "LoginInput",
"response_schema": "Token",
"status": 200,
"idempotency_required": false
},
{
"operation_id": "logout",
"method": "POST",
"path": "/api/v1/auth/logout",
"summary": "撤销当前会话",
"owner": "Identity",
"phase": "PC",
"scope": "authenticated",
"request_schema": null,
"response_schema": null,
"status": 204,
"idempotency_required": false
},
{
"operation_id": "me",
"method": "GET",
"path": "/api/v1/me",
"summary": "读取本人身份与权限",
"owner": "Identity",
"phase": "PC",
"scope": "authenticated",
"request_schema": null,
"response_schema": "Me",
"status": 200,
"idempotency_required": false
},
{
"operation_id": "capabilities",
"method": "GET",
"path": "/api/v1/capabilities",
"summary": "获取当前用户可见能力",
"owner": "Agent",
"phase": "PC",
"scope": "authenticated",
"request_schema": null,
"response_schema": "CapabilityPage",
"status": 200,
"idempotency_required": false
},
{
"operation_id": "listWorkspaces",
"method": "GET",
"path": "/api/v1/workspaces",
"summary": "列出本人的事项",
"owner": "Workspace",
"phase": "PC",
"scope": "workspace:read",
"request_schema": null,
"response_schema": "WorkspacePage",
"status": 200,
"idempotency_required": false
},
{
"operation_id": "createWorkspace",
"method": "POST",
"path": "/api/v1/workspaces",
"summary": "建立个人事项",
"owner": "Workspace",
"phase": "PC",
"scope": "workspace:write",
"request_schema": "WorkspaceCreate",
"response_schema": "Workspace",
"status": 201,
"idempotency_required": true
},
{
"operation_id": "getWorkspace",
"method": "GET",
"path": "/api/v1/workspaces/{workspace_id}",
"summary": "进入事项",
"owner": "Workspace",
"phase": "PC",
"scope": "workspace:read",
"request_schema": null,
"response_schema": "Workspace",
"status": 200,
"idempotency_required": false
},
{
"operation_id": "renameWorkspace",
"method": "PATCH",
"path": "/api/v1/workspaces/{workspace_id}",
"summary": "按版本重命名事项",
"owner": "Workspace",
"phase": "PC",
"scope": "workspace:write",
"request_schema": "WorkspacePatch",
"response_schema": "Workspace",
"status": 200,
"idempotency_required": false
},
{
"operation_id": "listMessages",
"method": "GET",
"path": "/api/v1/workspaces/{workspace_id}/messages",
"summary": "读取对话历史",
"owner": "Workspace",
"phase": "PC",
"scope": "workspace:read",
"request_schema": null,
"response_schema": "MessagePage",
"status": 200,
"idempotency_required": false
},
{
"operation_id": "createMessage",
"method": "POST",
"path": "/api/v1/workspaces/{workspace_id}/messages",
"summary": "追加用户消息",
"owner": "Workspace",
"phase": "PC",
"scope": "workspace:write",
"request_schema": "MessageCreate",
"response_schema": "Message",
"status": 201,
"idempotency_required": true
},
{
"operation_id": "listAttachments",
"method": "GET",
"path": "/api/v1/workspaces/{workspace_id}/attachments",
"summary": "列出事项附件",
"owner": "Workspace",
"phase": "PC",
"scope": "workspace:read",
"request_schema": null,
"response_schema": "AttachmentPage",
"status": 200,
"idempotency_required": false
},
{
"operation_id": "uploadAttachment",
"method": "POST",
"path": "/api/v1/workspaces/{workspace_id}/attachments",
"summary": "上传一个附件并安排解析",
"owner": "Workspace",
"phase": "PC",
"scope": "workspace:write",
"request_schema": "Upload",
"response_schema": "Attachment",
"status": 201,
"idempotency_required": true
},
{
"operation_id": "downloadAttachment",
"method": "GET",
"path": "/api/v1/attachments/{attachment_id}/content",
"summary": "授权下载附件",
"owner": "Workspace",
"phase": "PC",
"scope": "workspace:read",
"request_schema": null,
"response_schema": "Binary",
"status": 200,
"idempotency_required": false
},
{
"operation_id": "readContextSummary",
"method": "GET",
"path": "/api/v1/workspaces/{workspace_id}/context",
"summary": "读取授权事实与来源摘要",
"owner": "Context",
"phase": "PC",
"scope": "workspace:read",
"request_schema": null,
"response_schema": "ContextSummary",
"status": 200,
"idempotency_required": false
},
{
"operation_id": "listKnowledgeBases",
"method": "GET",
"path": "/api/v1/knowledge-bases",
"summary": "列出授权知识库",
"owner": "Knowledge",
"phase": "PC",
"scope": "knowledge:read",
"request_schema": null,
"response_schema": "KnowledgeBasePage",
"status": 200,
"idempotency_required": false
},
{
"operation_id": "searchKnowledge",
"method": "POST",
"path": "/api/v1/knowledge/search",
"summary": "授权范围内检索",
"owner": "Knowledge",
"phase": "PC",
"scope": "knowledge:read",
"request_schema": "SearchInput",
"response_schema": "CitationPage",
"status": 200,
"idempotency_required": false
},
{
"operation_id": "getCitation",
"method": "GET",
"path": "/api/v1/citations/{citation_id}",
"summary": "查看授权原文定位片段",
"owner": "Knowledge",
"phase": "PC",
"scope": "knowledge:read",
"request_schema": null,
"response_schema": "Citation",
"status": 200,
"idempotency_required": false
},
{
"operation_id": "listEmployees",
"method": "GET",
"path": "/api/v1/employees",
"summary": "数字员工目录",
"owner": "Agent",
"phase": "PC",
"scope": "authenticated",
"request_schema": null,
"response_schema": "EmployeePage",
"status": 200,
"idempotency_required": false
},
{
"operation_id": "listSkills",
"method": "GET",
"path": "/api/v1/skills",
"summary": "个人及共享技能目录",
"owner": "Agent",
"phase": "PC",
"scope": "authenticated",
"request_schema": null,
"response_schema": "SkillPage",
"status": 200,
"idempotency_required": false
},
{
"operation_id": "createSkill",
"method": "POST",
"path": "/api/v1/skills",
"summary": "保存个人 Skill",
"owner": "Agent",
"phase": "PC",
"scope": "skill:write",
"request_schema": "SkillCreate",
"response_schema": "Skill",
"status": 201,
"idempotency_required": true
},
{
"operation_id": "updateSkill",
"method": "PUT",
"path": "/api/v1/skills/{skill_id}",
"summary": "按版本更新个人 Skill",
"owner": "Agent",
"phase": "PC",
"scope": "skill:write",
"request_schema": "SkillUpdate",
"response_schema": "Skill",
"status": 200,
"idempotency_required": false
},
{
"operation_id": "bindWorkspaceSkills",
"method": "PUT",
"path": "/api/v1/workspaces/{workspace_id}/skills",
"summary": "按版本更新事项技能选项",
"owner": "Workspace",
"phase": "PC",
"scope": "workspace:write",
"request_schema": "WorkspaceSkillsInput",
"response_schema": "WorkspaceSkills",
"status": 200,
"idempotency_required": false
},
{
"operation_id": "startRun",
"method": "POST",
"path": "/api/v1/workspaces/{workspace_id}/runs",
"summary": "调用数字员工并注入技能",
"owner": "Agent",
"phase": "PC",
"scope": "run:write",
"request_schema": "StartRun",
"response_schema": "Run",
"status": 202,
"idempotency_required": true
},
{
"operation_id": "getRun",
"method": "GET",
"path": "/api/v1/runs/{run_id}",
"summary": "任务快照与游标",
"owner": "Agent",
"phase": "PC",
"scope": "run:read",
"request_schema": null,
"response_schema": "Run",
"status": 200,
"idempotency_required": false
},
{
"operation_id": "subscribeRunEvents",
"method": "GET",
"path": "/api/v1/runs/{run_id}/events",
"summary": "授权进度流与续读",
"owner": "Agent",
"phase": "PC",
"scope": "run:read",
"request_schema": null,
"response_schema": "SSE",
"status": 200,
"idempotency_required": false
},
{
"operation_id": "cancelRun",
"method": "POST",
"path": "/api/v1/runs/{run_id}/cancel",
"summary": "请求在安全边界取消",
"owner": "Agent",
"phase": "PC",
"scope": "run:write",
"request_schema": null,
"response_schema": "Run",
"status": 202,
"idempotency_required": true
},
{
"operation_id": "approveRun",
"method": "POST",
"path": "/api/v1/runs/{run_id}/approval",
"summary": "批准指定草稿版本并续跑",
"owner": "Agent",
"phase": "PC",
"scope": "run:approve",
"request_schema": "ApprovalInput",
"response_schema": "Run",
"status": 202,
"idempotency_required": true
},
{
"operation_id": "getArtifact",
"method": "GET",
"path": "/api/v1/artifacts/{artifact_id}",
"summary": "读取本人草稿当前版本",
"owner": "Workspace",
"phase": "PC",
"scope": "workspace:read",
"request_schema": null,
"response_schema": "Artifact",
"status": 200,
"idempotency_required": false
},
{
"operation_id": "editArtifact",
"method": "PATCH",
"path": "/api/v1/artifacts/{artifact_id}",
"summary": "乐观锁修改草稿",
"owner": "Workspace",
"phase": "PC",
"scope": "workspace:write",
"request_schema": "ArtifactPatch",
"response_schema": "Artifact",
"status": 200,
"idempotency_required": false
},
{
"operation_id": "downloadArtifact",
"method": "GET",
"path": "/api/v1/artifacts/{artifact_id}/versions/{version}/content",
"summary": "下载已生成的版本文件",
"owner": "Workspace",
"phase": "PC",
"scope": "workspace:read",
"request_schema": null,
"response_schema": "Binary",
"status": 200,
"idempotency_required": false
},
{
"operation_id": "listTools",
"method": "GET",
"path": "/api/v1/tools",
"summary": "查看允许的工具能力",
"owner": "Tool",
"phase": "PC",
"scope": "authenticated",
"request_schema": null,
"response_schema": "ToolCapabilityPage",
"status": 200,
"idempotency_required": false
},
{
"operation_id": "getToolReceipt",
"method": "GET",
"path": "/api/v1/tool-receipts/{receipt_id}",
"summary": "读取本人工具回执",
"owner": "Tool",
"phase": "PC",
"scope": "workspace:read",
"request_schema": null,
"response_schema": "ToolReceipt",
"status": 200,
"idempotency_required": false
},
{
"operation_id": "listNotifications",
"method": "GET",
"path": "/api/v1/notifications",
"summary": "本人通知与投递结果",
"owner": "Notification",
"phase": "PC",
"scope": "authenticated",
"request_schema": null,
"response_schema": "NotificationPage",
"status": 200,
"idempotency_required": false
},
{
"operation_id": "markNotificationRead",
"method": "POST",
"path": "/api/v1/notifications/{notification_id}/read",
"summary": "标记本人通知已读",
"owner": "Notification",
"phase": "PC",
"scope": "authenticated",
"request_schema": null,
"response_schema": "Notification",
"status": 200,
"idempotency_required": false
},
{
"operation_id": "liveness",
"method": "GET",
"path": "/health/live",
"summary": "进程存活",
"owner": "Gateway",
"phase": "PC",
"scope": "public",
"request_schema": null,
"response_schema": "Liveness",
"status": 200,
"idempotency_required": false
},
{
"operation_id": "readiness",
"method": "GET",
"path": "/health/ready",
"summary": "诊断模块就绪与运行模式",
"owner": "Gateway",
"phase": "PC",
"scope": "ops:read",
"request_schema": null,
"response_schema": "Readiness",
"status": 200,
"idempotency_required": false
},
{
"operation_id": "pauseRun",
"method": "POST",
"path": "/api/v1/runs/{run_id}/pause",
"summary": "请求暂停;需 Runtime 扩展 pausing/paused 状态",
"owner": "Agent",
"phase": "P1/P2",
"scope": "admin/ops or resource scope",
"status": "contract pending",
"idempotency_required": true
},
{
"operation_id": "resumeRun",
"method": "POST",
"path": "/api/v1/runs/{run_id}/resume",
"summary": "恢复已暂停任务",
"owner": "Agent",
"phase": "P1/P2",
"scope": "admin/ops or resource scope",
"status": "contract pending",
"idempotency_required": true
},
{
"operation_id": "adminModules",
"method": "GET",
"path": "/admin/v1/modules",
"summary": "管理员模块状态",
"owner": "Gateway",
"phase": "P1/P2",
"scope": "admin/ops or resource scope",
"status": "contract pending",
"idempotency_required": false
},
{
"operation_id": "ingestKnowledge",
"method": "POST",
"path": "/admin/v1/knowledge-bases/{base_id}/ingestions",
"summary": "知识管理者发起材料入库",
"owner": "Knowledge",
"phase": "P1/P2",
"scope": "admin/ops or resource scope",
"status": "contract pending",
"idempotency_required": true
},
{
"operation_id": "claimDeviceJob",
"method": "POST",
"path": "/device/v1/jobs/claim",
"summary": "设备身份领取本人设备任务",
"owner": "Tool",
"phase": "P1/P2",
"scope": "device credential",
"status": "contract pending",
"idempotency_required": true
},
{
"operation_id": "deviceReceipt",
"method": "POST",
"path": "/device/v1/jobs/{job_id}/receipts",
"summary": "设备回传幂等执行回执",
"owner": "Tool",
"phase": "P1/P2",
"scope": "device credential",
"status": "contract pending",
"idempotency_required": true
},
{
"operation_id": "metrics",
"method": "GET",
"path": "/metrics",
"summary": "受保护的内网指标",
"owner": "Gateway",
"phase": "P1/P2",
"scope": "admin/ops or resource scope",
"status": "contract pending",
"idempotency_required": false
},
{
"operation_id": "directChat",
"method": "POST",
"path": "/api/v1/workspaces/{workspace_id}/chat",
"summary": "不选数字员工时直接模型对话并持久化消息",
"owner": "LLM",
"phase": "PC",
"scope": "workspace:write",
"request_schema": "DirectChatInput",
"response_schema": "DirectChatResponse",
"status": 201,
"idempotency_required": true
}
]
}
|