Work

Server

Download schema

获取conversations · conversationId · workset

GET

https://capworks-api-docs.pages.dev/proxy/capworks

/v1/conversations/{conversationId}/workset

获取conversations · conversationId · workset › path Parameters

conversationId

string · required

获取conversations · conversationId · workset › Responses

请求成功

ConversationWorkSetListResponse

WorkSetDetailResponse[] · required

GET/v1/conversations/{conversationId}/workset

curl https://capworks-api-docs.pages.dev/proxy/capworks/v1/conversations/:conversationId/workset

Example Responses

{
  "workSets": [
    {
      "workSet": {
        "id": "id",
        "workspaceId": "workspaceId",
        "projectId": "projectId",
        "conversationId": "conversationId",
        "title": "title",
        "status": "forming",
        "revision": 0,
        "primaryWorkObjectId": "primaryWorkObjectId",
        "placements": [
          {
            "workObjectId": "workObjectId",
            "order": 0,
            "size": "compact",
            "emphasis": "quiet",
            "group": "group"
          }
        ],
        "reviewTaskIds": [
          "string"
        ],
        "actionIds": [
          "string"
        ],
        "preparedAt": "preparedAt",
        "readyAt": "readyAt",
        "createdAt": "createdAt",
        "updatedAt": "updatedAt"
      },
      "workObjects": [
        {
          "id": "id",
          "workspaceId": "workspaceId",
          "projectId": "projectId",
          "conversationId": "conversationId",
          "workOrderId": "workOrderId",
          "family": "task",
          "semanticType": "todo-list",
          "meetingKind": "outcome",
          "meetingStage": "captured",
          "proposalState": "human",
          "stageUpdatedAt": "stageUpdatedAt",
          "title": "title",
          "summary": "summary",
          "ownerRole": "owner",
          "ownerUserId": "ownerUserId",
          "progressState": "todo",
          "responsibilityUpdatedAt": "responsibilityUpdatedAt",
          "dueAt": "dueAt",
          "blockedReason": "blockedReason",
          "completedAt": "completedAt",
          "reviewState": "draft",
          "latestRevisionId": "latestRevisionId",
          "latestRevisionNumber": 0,
          "createdAt": "createdAt",
          "updatedAt": "updatedAt"
        }
      ],
      "revisions": [
        {
          "id": "id",
          "workObjectId": "workObjectId",
          "revision": 0,
          "revisionHash": "revisionHash",
          "title": "title",
          "summary": "summary",
          "content": {
            "kind": "checklist",
            "items": [
              {
                "id": "id",
                "title": "title",
                "detail": "detail",
                "state": "todo",
                "ownerUserId": "ownerUserId",
                "ownerLabel": "ownerLabel",
                "dueAt": "dueAt",
                "priority": "urgent",
                "sourceSegmentIds": [
                  "string"
                ]
              }
            ]
          },
          "confidence": 0,
          "sources": [
            {
              "kind": "transcript",
              "segmentId": "segmentId",
              "excerpt": "excerpt",
              "speakerId": "speakerId"
            }
          ],
          "contextRefs": [
            {
              "sourceType": "sourceType",
              "sourceId": "sourceId",
              "title": "title",
              "excerpt": "excerpt",
              "externalURL": "externalURL"
            }
          ],
          "createdBy": {
            "kind": "agent",
            "role": "role",
            "workOrderId": "workOrderId"
          },
          "createdAt": "createdAt"
        }
      ],
      "reviews": [
        {
          "id": "id",
          "workspaceId": "workspaceId",
          "projectId": "projectId",
          "conversationId": "conversationId",
          "workSetId": "workSetId",
          "workObjectId": "workObjectId",
          "revisionId": "revisionId",
          "assigneeRole": "owner",
          "assigneeUserId": "assigneeUserId",
          "status": "waiting-for-submission",
          "claimedByUserId": "claimedByUserId",
          "requestedAt": "requestedAt",
          "resolvedAt": "resolvedAt",
          "createdAt": "createdAt",
          "updatedAt": "updatedAt"
        }
      ],
      "actions": [
        {
          "id": "id",
          "workspaceId": "workspaceId",
          "projectId": "projectId",
          "conversationId": "conversationId",
          "workSetId": "workSetId",
          "sourceRevisionIds": [
            "string"
          ],
          "actionType": "actionType",
          "title": "title",
          "description": "description",
          "risk": "low",
          "target": {
            "key": "string"
          },
          "payload": {
            "key": "string"
          },
          "status": "prepared",
          "requiresWorkApproval": true,
          "requiresSideEffectApproval": true,
          "idempotencyKey": "idempotencyKey",
          "approvedByUserId": "approvedByUserId",
          "approvedAt": "approvedAt",
          "createdAt": "createdAt",
          "updatedAt": "updatedAt"
        }
      ],
      "executions": [
        {
          "id": "id",
          "workspaceId": "workspaceId",
          "projectId": "projectId",
          "actionId": "actionId",
          "status": "queued",
          "attempt": 0,
          "idempotencyKey": "idempotencyKey",
          "runnerId": "runnerId",
          "externalObjectId": "externalObjectId",
          "externalURL": "externalURL",
          "result": {
            "key": "string"
          },
          "error": {
            "code": "code",
            "message": "message",
            "retryable": true
          },
          "startedAt": "startedAt",
          "completedAt": "completedAt",
          "createdAt": "createdAt",
          "updatedAt": "updatedAt"
        }
      ],
      "actionRecommendationEligibility": {
        "state": "no_provider",
        "providerCount": 0,
        "actionCount": 0
      },
      "actionRecommendationRun": {
        "state": "pending",
        "basedOnWorkSetRevision": 0,
        "recommendationCount": 0,
        "updatedAt": "updatedAt",
        "errorCode": "errorCode"
      },
      "externalActionRecommendations": [
        {
          "id": "id",
          "workspaceId": "workspaceId",
          "projectId": "projectId",
          "workObjectId": "workObjectId",
          "sourceRevisionId": "sourceRevisionId",
          "actionId": "actionId",
          "actionLabel": "actionLabel",
          "service": "service",
          "connectionId": "connectionId",
          "connectionName": "connectionName",
          "suggestedInput": {
            "key": "string"
          },
          "missingFields": [
            "string"
          ],
          "reason": "reason",
          "score": 0,
          "status": "active",
          "preparedActionId": "preparedActionId",
          "createdAt": "createdAt",
          "updatedAt": "updatedAt"
        }
      ],
      "externalPreparedActions": [
        {
          "id": "id",
          "projectId": "projectId",
          "actionId": "actionId",
          "service": "service",
          "connectionId": "connectionId",
          "connectionAlias": "connectionAlias",
          "input": {
            "key": "string"
          },
          "inputDigest": "inputDigest",
          "schemaDigest": "schemaDigest",
          "status": "prepared",
          "requiresApproval": true,
          "expiresAt": "expiresAt",
          "createdAt": "createdAt",
          "updatedAt": "updatedAt",
          "workObjectId": "workObjectId",
          "sourceRevisionId": "sourceRevisionId",
          "recommendationId": "recommendationId"
        }
      ],
      "externalActionReceipts": [
        {
          "id": "id",
          "preparedActionId": "preparedActionId",
          "projectId": "projectId",
          "actionId": "actionId",
          "connectionId": "connectionId",
          "status": "running",
          "openConnectorRunId": "openConnectorRunId",
          "auditPersisted": true,
          "result": "string",
          "error": {
            "code": "code",
            "message": "message",
            "retryable": true
          },
          "createdAt": "createdAt",
          "updatedAt": "updatedAt",
          "workObjectId": "workObjectId",
          "sourceRevisionId": "sourceRevisionId",
          "recommendationId": "recommendationId"
        }
      ],
      "needsRebuild": true,
      "takeover": {
        "id": "id",
        "conversationId": "conversationId",
        "basedOnWorksetRevision": 0,
        "aligned": [
          {
            "text": "text",
            "evidenceSegmentIds": [
              "string"
            ]
          }
        ],
        "now": [
          {
            "workObjectId": "workObjectId",
            "why": "why",
            "evidenceSegmentIds": [
              "string"
            ]
          }
        ],
        "later": [
          {
            "workObjectId": "workObjectId",
            "text": "text",
            "why": "why"
          }
        ],
        "clarify": [
          {
            "id": "id",
            "workObjectId": "workObjectId",
            "question": "question",
            "wouldChange": "wouldChange",
            "status": "open",
            "evidenceSegmentIds": [
              "string"
            ]
          }
        ],
        "generatedAt": "generatedAt",
        "supersededAt": "supersededAt"
      },
      "relations": [
        {
          "id": "id",
          "workSetId": "workSetId",
          "fromWorkObjectId": "fromWorkObjectId",
          "toWorkObjectId": "toWorkObjectId",
          "relationType": "relationType",
          "reason": "reason",
          "sourceSegmentIds": [
            "string"
          ],
          "manualOverride": true,
          "deletedAt": "deletedAt",
          "createdAt": "createdAt",
          "updatedAt": "updatedAt"
        }
      ],
      "decisionWorkstreams": [
        {
          "id": "id",
          "decisionWorkObjectId": "decisionWorkObjectId",
          "decisionRevisionId": "decisionRevisionId",
          "sourceSegmentIds": [
            "string"
          ],
          "items": [
            {
              "workObjectId": "workObjectId",
              "revisionId": "revisionId",
              "discipline": "product",
              "reviewStatus": "waiting-for-submission",
              "reviewTaskId": "reviewTaskId",
              "actionIds": [
                "string"
              ]
            }
          ]
        }
      ],
      "takeoverState": "pending"
    }
  ]
}

json

application/json

创建或执行sessions · sessionId · workobjects

POST

https://capworks-api-docs.pages.dev/proxy/capworks

/v1/sessions/{sessionId}/workobjects

创建或执行sessions · sessionId · workobjects › path Parameters

sessionId

string · required

创建或执行sessions · sessionId · workobjects › Request Body

CaptureMeetingWorkObjectRequest

kind

MeetingWorkKind · enum · required

会议中的统一工作语言。它与更细的 family/semanticType 并存：前者让跨职能团队快速归类，后者继续为执行器和历史客户端提供精确语义。

Enum values:

outcome

decision

action

question

reference

title

string · required

sourceSegmentIds

Identifier[] · required

summary

string

nextStep

MeetingWorkNextStep · enum

成员在捕获讨论时明确选择的下一条生产分支。它只准备内部工作或待确认动作，不授权任何外部副作用。

Enum values:

organize

codex

moodboard

visual-proposal

targetProjectId

Identifier

创建或执行sessions · sessionId · workobjects › Responses

请求成功

CaptureMeetingWorkObjectResponse

WorkSetV2 · required

WorkObject · required

WorkObjectRevision · required

POST/v1/sessions/{sessionId}/workobjects

curl https://capworks-api-docs.pages.dev/proxy/capworks/v1/sessions/:sessionId/workobjects \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "kind": "outcome",
  "title": "title",
  "summary": "summary",
  "sourceSegmentIds": [
    "string"
  ],
  "nextStep": "organize",
  "targetProjectId": "targetProjectId"
}'

Example Request Body

{
  "kind": "outcome",
  "title": "title",
  "summary": "summary",
  "sourceSegmentIds": [
    "string"
  ],
  "nextStep": "organize",
  "targetProjectId": "targetProjectId"
}

json

Example Responses

{
  "workSet": {
    "id": "id",
    "workspaceId": "workspaceId",
    "projectId": "projectId",
    "conversationId": "conversationId",
    "title": "title",
    "status": "forming",
    "revision": 0,
    "primaryWorkObjectId": "primaryWorkObjectId",
    "placements": [
      {
        "workObjectId": "workObjectId",
        "order": 0,
        "size": "compact",
        "emphasis": "quiet",
        "group": "group"
      }
    ],
    "reviewTaskIds": [
      "string"
    ],
    "actionIds": [
      "string"
    ],
    "preparedAt": "preparedAt",
    "readyAt": "readyAt",
    "createdAt": "createdAt",
    "updatedAt": "updatedAt"
  },
  "workObject": {
    "id": "id",
    "workspaceId": "workspaceId",
    "projectId": "projectId",
    "conversationId": "conversationId",
    "workOrderId": "workOrderId",
    "family": "task",
    "semanticType": "todo-list",
    "meetingKind": "outcome",
    "meetingStage": "captured",
    "proposalState": "human",
    "stageUpdatedAt": "stageUpdatedAt",
    "title": "title",
    "summary": "summary",
    "ownerRole": "owner",
    "ownerUserId": "ownerUserId",
    "progressState": "todo",
    "responsibilityUpdatedAt": "responsibilityUpdatedAt",
    "dueAt": "dueAt",
    "blockedReason": "blockedReason",
    "completedAt": "completedAt",
    "reviewState": "draft",
    "latestRevisionId": "latestRevisionId",
    "latestRevisionNumber": 0,
    "createdAt": "createdAt",
    "updatedAt": "updatedAt"
  },
  "revision": {
    "id": "id",
    "workObjectId": "workObjectId",
    "revision": 0,
    "revisionHash": "revisionHash",
    "title": "title",
    "summary": "summary",
    "content": {
      "kind": "checklist",
      "items": [
        {
          "id": "id",
          "title": "title",
          "detail": "detail",
          "state": "todo",
          "ownerUserId": "ownerUserId",
          "ownerLabel": "ownerLabel",
          "dueAt": "dueAt",
          "priority": "urgent",
          "sourceSegmentIds": [
            "string"
          ]
        }
      ]
    },
    "confidence": 0,
    "sources": [
      {
        "kind": "transcript",
        "segmentId": "segmentId",
        "excerpt": "excerpt",
        "speakerId": "speakerId"
      }
    ],
    "contextRefs": [
      {
        "sourceType": "sourceType",
        "sourceId": "sourceId",
        "title": "title",
        "excerpt": "excerpt",
        "externalURL": "externalURL"
      }
    ],
    "createdBy": {
      "kind": "agent",
      "role": "role",
      "workOrderId": "workOrderId"
    },
    "createdAt": "createdAt"
  }
}

json

application/json

创建或执行sessions · sessionId · workobjects · project suggestions

POST

https://capworks-api-docs.pages.dev/proxy/capworks

/v1/sessions/{sessionId}/workobjects/project-suggestions

创建或执行sessions · sessionId · workobjects · project suggestions › path Parameters

sessionId

string · required

创建或执行sessions · sessionId · workobjects · project suggestions › Request Body

SuggestMeetingWorkProjectRequest

sourceSegmentIds

Identifier[] · required

创建或执行sessions · sessionId · workobjects · project suggestions › Responses

请求成功

SuggestMeetingWorkProjectResponse

MeetingWorkProjectSuggestion[] · required

route

string · enum · required

Enum values:

project

inbox

preselectedProjectId

Identifier

获取sessions · sessionId · workset

GET

https://capworks-api-docs.pages.dev/proxy/capworks

/v1/sessions/{sessionId}/workset

获取sessions · sessionId · workset › path Parameters

sessionId

string · required

获取sessions · sessionId · workset › Responses

请求成功

GenericResponse

更新sessions · sessionId · workset

PATCH

https://capworks-api-docs.pages.dev/proxy/capworks

/v1/sessions/{sessionId}/workset

更新sessions · sessionId · workset › path Parameters

sessionId

string · required

更新sessions · sessionId · workset › Request Body

anyOf

At least one variant must match. Multiple variants may match simultaneously.

Decision Table

Variant	Matching Criteria
	type = object · requires: action, clarifyId, resolution +1 more
	type = object · requires: action, idempotencyKey
	type = object · requires: action, relationId, idempotencyKey

Properties for Variant 1:

ClarifyResolveRequest

action

string · const · required

Const value: clarify.resolve

clarifyId

Identifier · required

resolution

string · enum · required

Enum values:

confirmed

deferred

dismissed

idempotencyKey

string · required

更新sessions · sessionId · workset › Responses

请求成功

WorkSetPatchResponse

TakeoverDigest

会后接管摘要：纯派生，钉在某个 workset revision 上，不改写块。

WorkRelation[]

takeoverState

TakeoverState · enum

Enum values:

pending

ready

failed

empty

object

PATCH/v1/sessions/{sessionId}/workset

curl https://capworks-api-docs.pages.dev/proxy/capworks/v1/sessions/:sessionId/workset \
  --request PATCH \
  --header 'Content-Type: application/json' \
  --data '{
  "action": "clarify.resolve",
  "clarifyId": "clarifyId",
  "resolution": "confirmed",
  "idempotencyKey": "idempotencyKey"
}'

Example Request Body

{
  "action": "clarify.resolve",
  "clarifyId": "clarifyId",
  "resolution": "confirmed",
  "idempotencyKey": "idempotencyKey"
}

json

Example Responses

{
  "takeover": {
    "id": "id",
    "conversationId": "conversationId",
    "basedOnWorksetRevision": 0,
    "aligned": [
      {
        "text": "text",
        "evidenceSegmentIds": [
          "string"
        ]
      }
    ],
    "now": [
      {
        "workObjectId": "workObjectId",
        "why": "why",
        "evidenceSegmentIds": [
          "string"
        ]
      }
    ],
    "later": [
      {
        "workObjectId": "workObjectId",
        "text": "text",
        "why": "why"
      }
    ],
    "clarify": [
      {
        "id": "id",
        "workObjectId": "workObjectId",
        "question": "question",
        "wouldChange": "wouldChange",
        "status": "open",
        "evidenceSegmentIds": [
          "string"
        ]
      }
    ],
    "generatedAt": "generatedAt",
    "supersededAt": "supersededAt"
  },
  "relations": [
    {
      "id": "id",
      "workSetId": "workSetId",
      "fromWorkObjectId": "fromWorkObjectId",
      "toWorkObjectId": "toWorkObjectId",
      "relationType": "relationType",
      "reason": "reason",
      "sourceSegmentIds": [
        "string"
      ],
      "manualOverride": true,
      "deletedAt": "deletedAt",
      "createdAt": "createdAt",
      "updatedAt": "updatedAt"
    }
  ],
  "takeoverState": "pending",
  "refinement": {
    "state": "queued"
  }
}

json

application/json

获取sessions · sessionId · worksets

GET

https://capworks-api-docs.pages.dev/proxy/capworks

/v1/sessions/{sessionId}/worksets

获取sessions · sessionId · worksets › path Parameters

sessionId

string · required

获取sessions · sessionId · worksets › Responses

请求成功

GenericResponse

获取work objects · workObjectId · action recommendations

GET

https://capworks-api-docs.pages.dev/proxy/capworks

/v1/work-objects/{workObjectId}/action-recommendations

获取work objects · workObjectId · action recommendations › path Parameters

workObjectId

string · required

获取work objects · workObjectId · action recommendations › Responses

请求成功

ExternalActionRecommendationListResponse

ExternalActionRecommendation[] · required

GET/v1/work-objects/{workObjectId}/action-recommendations

curl https://capworks-api-docs.pages.dev/proxy/capworks/v1/work-objects/:workObjectId/action-recommendations

Example Responses

{
  "recommendations": [
    {
      "id": "id",
      "workspaceId": "workspaceId",
      "projectId": "projectId",
      "workObjectId": "workObjectId",
      "sourceRevisionId": "sourceRevisionId",
      "actionId": "actionId",
      "actionLabel": "actionLabel",
      "service": "service",
      "connectionId": "connectionId",
      "connectionName": "connectionName",
      "suggestedInput": {
        "key": "string"
      },
      "missingFields": [
        "string"
      ],
      "reason": "reason",
      "score": 0,
      "status": "active",
      "preparedActionId": "preparedActionId",
      "createdAt": "createdAt",
      "updatedAt": "updatedAt"
    }
  ]
}

json

application/json

创建或执行work objects · workObjectId · action recommendations · refresh

POST

https://capworks-api-docs.pages.dev/proxy/capworks

/v1/work-objects/{workObjectId}/action-recommendations/refresh

创建或执行work objects · workObjectId · action recommendations · refresh › path Parameters

workObjectId

string · required

创建或执行work objects · workObjectId · action recommendations · refresh › Request Body

GenericRequest

创建或执行work objects · workObjectId · action recommendations · refresh › Responses

请求成功

GenericResponse

创建或执行work sets · workSetId · action recommendations · draft

POST

https://capworks-api-docs.pages.dev/proxy/capworks

/v1/work-sets/{workSetId}/action-recommendations/draft

创建或执行work sets · workSetId · action recommendations · draft › path Parameters

workSetId

string · required

创建或执行work sets · workSetId · action recommendations · draft › Request Body

ExternalActionRecommendationDraftRequest

actionId

string · required

connectionId

string · required

创建或执行work sets · workSetId · action recommendations · draft › Responses

请求成功

ExternalActionRecommendationDraftResponse

ExternalActionRecommendation · required

POST/v1/work-sets/{workSetId}/action-recommendations/draft

curl https://capworks-api-docs.pages.dev/proxy/capworks/v1/work-sets/:workSetId/action-recommendations/draft \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "actionId": "actionId",
  "connectionId": "connectionId"
}'

Example Request Body

{
  "actionId": "actionId",
  "connectionId": "connectionId"
}

json

Example Responses

{
  "recommendation": {
    "id": "id",
    "workspaceId": "workspaceId",
    "projectId": "projectId",
    "workObjectId": "workObjectId",
    "sourceRevisionId": "sourceRevisionId",
    "actionId": "actionId",
    "actionLabel": "actionLabel",
    "service": "service",
    "connectionId": "connectionId",
    "connectionName": "connectionName",
    "suggestedInput": {
      "key": "string"
    },
    "missingFields": [
      "string"
    ],
    "reason": "reason",
    "score": 0,
    "status": "active",
    "preparedActionId": "preparedActionId",
    "createdAt": "createdAt",
    "updatedAt": "updatedAt"
  }
}

json

application/json

创建或执行work sets · workSetId · action recommendations · refresh

POST

https://capworks-api-docs.pages.dev/proxy/capworks

/v1/work-sets/{workSetId}/action-recommendations/refresh

创建或执行work sets · workSetId · action recommendations · refresh › path Parameters

workSetId

string · required

创建或执行work sets · workSetId · action recommendations · refresh › Request Body

GenericRequest

创建或执行work sets · workSetId · action recommendations · refresh › Responses

请求成功

RefreshActionRecommendationsResponse

ActionRecommendationRun · required

更新workobjects · workObjectId

PATCH

https://capworks-api-docs.pages.dev/proxy/capworks

/v1/workobjects/{workObjectId}

更新workobjects · workObjectId › path Parameters

workObjectId

string · required

更新workobjects · workObjectId › Request Body

UpdateWorkObjectRequest

expectedRevisionHash

string · required

WorkObjectContent · required

title

string

summary

string

更新workobjects · workObjectId › Responses

请求成功

GenericResponse

PATCH/v1/workobjects/{workObjectId}

curl https://capworks-api-docs.pages.dev/proxy/capworks/v1/workobjects/:workObjectId \
  --request PATCH \
  --header 'Content-Type: application/json' \
  --data '{
  "expectedRevisionHash": "expectedRevisionHash",
  "title": "title",
  "summary": "summary",
  "content": {
    "kind": "checklist",
    "items": [
      {
        "id": "id",
        "title": "title",
        "detail": "detail",
        "state": "todo",
        "ownerUserId": "ownerUserId",
        "ownerLabel": "ownerLabel",
        "dueAt": "dueAt",
        "priority": "urgent",
        "sourceSegmentIds": [
          "string"
        ]
      }
    ]
  }
}'

Example Request Body

{
  "expectedRevisionHash": "expectedRevisionHash",
  "title": "title",
  "summary": "summary",
  "content": {
    "kind": "checklist",
    "items": [
      {
        "id": "id",
        "title": "title",
        "detail": "detail",
        "state": "todo",
        "ownerUserId": "ownerUserId",
        "ownerLabel": "ownerLabel",
        "dueAt": "dueAt",
        "priority": "urgent",
        "sourceSegmentIds": [
          "string"
        ]
      }
    ]
  }
}

json

Example Responses

{}

json

application/json

创建或执行workobjects · workObjectId · assignment

POST

https://capworks-api-docs.pages.dev/proxy/capworks

/v1/workobjects/{workObjectId}/assignment

创建或执行workobjects · workObjectId · assignment › path Parameters

workObjectId

string · required

创建或执行workobjects · workObjectId · assignment › Request Body

UpdateWorkAssignmentRequest

action

WorkAssignmentAction · enum · required

Enum values:

claim

assign

release

userId

Identifier

创建或执行workobjects · workObjectId · assignment › Responses

请求成功

GenericResponse

获取workobjects · workObjectId · comments

GET

https://capworks-api-docs.pages.dev/proxy/capworks

/v1/workobjects/{workObjectId}/comments

获取workobjects · workObjectId · comments › path Parameters

workObjectId

string · required

获取workobjects · workObjectId · comments › Responses

请求成功

WorkCommentsResponse

WorkComment[] · required

GET/v1/workobjects/{workObjectId}/comments

curl https://capworks-api-docs.pages.dev/proxy/capworks/v1/workobjects/:workObjectId/comments

Example Responses

{
  "comments": [
    {
      "id": "id",
      "workspaceId": "workspaceId",
      "workObjectId": "workObjectId",
      "authorKind": "member",
      "authorUserId": "authorUserId",
      "authorDisplayName": "authorDisplayName",
      "authorAvatarURL": "authorAvatarURL",
      "body": "body",
      "mentionUserIds": [
        "string"
      ],
      "status": "active",
      "editedAt": "editedAt",
      "resolvedAt": "resolvedAt",
      "resolvedByUserId": "resolvedByUserId",
      "createdAt": "createdAt",
      "updatedAt": "updatedAt"
    }
  ]
}

json

application/json

创建或执行workobjects · workObjectId · comments

POST

https://capworks-api-docs.pages.dev/proxy/capworks

/v1/workobjects/{workObjectId}/comments

创建或执行workobjects · workObjectId · comments › path Parameters

workObjectId

string · required

创建或执行workobjects · workObjectId · comments › Request Body

CreateWorkCommentRequest

body

string · required

mentionUserIds

Identifier[]

创建或执行workobjects · workObjectId · comments › Responses

请求成功

GenericResponse

更新workobjects · workObjectId · comments · commentId

PATCH

https://capworks-api-docs.pages.dev/proxy/capworks

/v1/workobjects/{workObjectId}/comments/{commentId}

更新workobjects · workObjectId · comments · commentId › path Parameters

workObjectId

string · required

commentId

string · required

更新workobjects · workObjectId · comments · commentId › Request Body

UpdateWorkCommentRequest

expectedUpdatedAt

ISO8601Timestamp · required

body

string

mentionUserIds

Identifier[]

resolved

boolean

更新workobjects · workObjectId · comments · commentId › Responses

请求成功

GenericResponse

更新workobjects · workObjectId · proposal

PATCH

https://capworks-api-docs.pages.dev/proxy/capworks

/v1/workobjects/{workObjectId}/proposal

更新workobjects · workObjectId · proposal › path Parameters

workObjectId

string · required

更新workobjects · workObjectId · proposal › Request Body

DecideWorkProposalRequest

decision

string · enum · required

Enum values:

reject

expectedRevisionId

Identifier · required

note

string

更新workobjects · workObjectId · proposal › Responses

请求成功

DecideWorkProposalResponse

WorkObject · required

WorkProposalDecision · required

PATCH/v1/workobjects/{workObjectId}/proposal

curl https://capworks-api-docs.pages.dev/proxy/capworks/v1/workobjects/:workObjectId/proposal \
  --request PATCH \
  --header 'Content-Type: application/json' \
  --data '{
  "decision": "accept",
  "expectedRevisionId": "expectedRevisionId",
  "note": "note"
}'

Example Request Body

{
  "decision": "accept",
  "expectedRevisionId": "expectedRevisionId",
  "note": "note"
}

json

Example Responses

{
  "workObject": {
    "id": "id",
    "workspaceId": "workspaceId",
    "projectId": "projectId",
    "conversationId": "conversationId",
    "workOrderId": "workOrderId",
    "family": "task",
    "semanticType": "todo-list",
    "meetingKind": "outcome",
    "meetingStage": "captured",
    "proposalState": "human",
    "stageUpdatedAt": "stageUpdatedAt",
    "title": "title",
    "summary": "summary",
    "ownerRole": "owner",
    "ownerUserId": "ownerUserId",
    "progressState": "todo",
    "responsibilityUpdatedAt": "responsibilityUpdatedAt",
    "dueAt": "dueAt",
    "blockedReason": "blockedReason",
    "completedAt": "completedAt",
    "reviewState": "draft",
    "latestRevisionId": "latestRevisionId",
    "latestRevisionNumber": 0,
    "createdAt": "createdAt",
    "updatedAt": "updatedAt"
  },
  "decision": {
    "id": "id",
    "workObjectId": "workObjectId",
    "revisionId": "revisionId",
    "actorUserId": "actorUserId",
    "decision": "accept",
    "note": "note",
    "createdAt": "createdAt"
  }
}

json

application/json

更新workobjects · workObjectId · responsibility

PATCH

https://capworks-api-docs.pages.dev/proxy/capworks

/v1/workobjects/{workObjectId}/responsibility

更新workobjects · workObjectId · responsibility › path Parameters

workObjectId

string · required

更新workobjects · workObjectId · responsibility › Request Body

UpdateWorkResponsibilityRequest

expectedResponsibilityUpdatedAt

ISO8601Timestamp · required

state

WorkObjectProgressState · enum

责任推进状态与内容审阅状态相互独立：负责人可以推进工作，审阅人负责质量闸。

Enum values:

todo

in-progress

blocked

done

blockedReason

string | null

更新workobjects · workObjectId · responsibility › Responses

请求成功

GenericResponse

获取workobjects · workObjectId · revisions

GET

https://capworks-api-docs.pages.dev/proxy/capworks

/v1/workobjects/{workObjectId}/revisions

获取workobjects · workObjectId · revisions › path Parameters

workObjectId

string · required

获取workobjects · workObjectId · revisions › Responses

请求成功

WorkObjectRevisionHistoryResponse

workObjectId

Identifier · required

WorkObjectRevision[] · required

GET/v1/workobjects/{workObjectId}/revisions

curl https://capworks-api-docs.pages.dev/proxy/capworks/v1/workobjects/:workObjectId/revisions

Example Responses

{
  "workObjectId": "workObjectId",
  "revisions": [
    {
      "id": "id",
      "workObjectId": "workObjectId",
      "revision": 0,
      "revisionHash": "revisionHash",
      "title": "title",
      "summary": "summary",
      "content": {
        "kind": "checklist",
        "items": [
          {
            "id": "id",
            "title": "title",
            "detail": "detail",
            "state": "todo",
            "ownerUserId": "ownerUserId",
            "ownerLabel": "ownerLabel",
            "dueAt": "dueAt",
            "priority": "urgent",
            "sourceSegmentIds": [
              "string"
            ]
          }
        ]
      },
      "confidence": 0,
      "sources": [
        {
          "kind": "transcript",
          "segmentId": "segmentId",
          "excerpt": "excerpt",
          "speakerId": "speakerId"
        }
      ],
      "contextRefs": [
        {
          "sourceType": "sourceType",
          "sourceId": "sourceId",
          "title": "title",
          "excerpt": "excerpt",
          "externalURL": "externalURL"
        }
      ],
      "createdBy": {
        "kind": "agent",
        "role": "role",
        "workOrderId": "workOrderId"
      },
      "createdAt": "createdAt"
    }
  ]
}

json

application/json

更新workobjects · workObjectId · stage

PATCH

https://capworks-api-docs.pages.dev/proxy/capworks

/v1/workobjects/{workObjectId}/stage

更新workobjects · workObjectId · stage › path Parameters

workObjectId

string · required

更新workobjects · workObjectId · stage › Request Body

TransitionMeetingWorkStageRequest

fromStage

MeetingWorkStage · enum · required

人工可审计的推进阶段；AI 建议不得直接改变该字段。

Enum values:

captured

structured

executing

ready-for-review

accepted

toStage

MeetingWorkStage · enum · required

人工可审计的推进阶段；AI 建议不得直接改变该字段。

Enum values:

captured

structured

executing

ready-for-review

accepted

note

string

更新workobjects · workObjectId · stage › Responses

请求成功

TransitionMeetingWorkStageResponse

WorkObject · required

WorkObjectStageTransition · required

PATCH/v1/workobjects/{workObjectId}/stage

curl https://capworks-api-docs.pages.dev/proxy/capworks/v1/workobjects/:workObjectId/stage \
  --request PATCH \
  --header 'Content-Type: application/json' \
  --data '{
  "fromStage": "captured",
  "toStage": "captured",
  "note": "note"
}'

Example Request Body

{
  "fromStage": "captured",
  "toStage": "captured",
  "note": "note"
}

json

Example Responses

{
  "workObject": {
    "id": "id",
    "workspaceId": "workspaceId",
    "projectId": "projectId",
    "conversationId": "conversationId",
    "workOrderId": "workOrderId",
    "family": "task",
    "semanticType": "todo-list",
    "meetingKind": "outcome",
    "meetingStage": "captured",
    "proposalState": "human",
    "stageUpdatedAt": "stageUpdatedAt",
    "title": "title",
    "summary": "summary",
    "ownerRole": "owner",
    "ownerUserId": "ownerUserId",
    "progressState": "todo",
    "responsibilityUpdatedAt": "responsibilityUpdatedAt",
    "dueAt": "dueAt",
    "blockedReason": "blockedReason",
    "completedAt": "completedAt",
    "reviewState": "draft",
    "latestRevisionId": "latestRevisionId",
    "latestRevisionNumber": 0,
    "createdAt": "createdAt",
    "updatedAt": "updatedAt"
  },
  "transition": {
    "id": "id",
    "workObjectId": "workObjectId",
    "actorUserId": "actorUserId",
    "fromStage": "captured",
    "toStage": "captured",
    "note": "note",
    "createdAt": "createdAt"
  }
}

json

application/json

获取worksets · workSetId

GET

https://capworks-api-docs.pages.dev/proxy/capworks

/v1/worksets/{workSetId}

获取worksets · workSetId › path Parameters

workSetId

string · required

获取worksets · workSetId › Responses

请求成功

WorkSetDetailResponse

WorkSetV2 · required

WorkObject[] · required

WorkObjectRevision[] · required

ReviewTask[] · required

ActionV2[] · required

ExecutionV2[] · required

ActionRecommendationEligibility

ActionRecommendationRun

ExternalActionRecommendation[]

PreparedExternalAction[]

ExternalActionReceipt[]

needsRebuild

boolean

True when historical output was hidden by the current quality gate and should be rebuilt from its preserved transcript before presentation.

TakeoverDigest

最新未 supersede 的会后摘要；无真实行动项时缺省，前端不渲染接管条。

WorkRelation[]

DecisionWorkstream[]

P6: one decision's independently reviewed professional branches.

takeoverState

TakeoverState · enum

会后整理诚实态：失败时 UI 显示重试，不静默。

Enum values:

pending

ready

failed

empty

GET/v1/worksets/{workSetId}

curl https://capworks-api-docs.pages.dev/proxy/capworks/v1/worksets/:workSetId

Example Responses

{
  "workSet": {
    "id": "id",
    "workspaceId": "workspaceId",
    "projectId": "projectId",
    "conversationId": "conversationId",
    "title": "title",
    "status": "forming",
    "revision": 0,
    "primaryWorkObjectId": "primaryWorkObjectId",
    "placements": [
      {
        "workObjectId": "workObjectId",
        "order": 0,
        "size": "compact",
        "emphasis": "quiet",
        "group": "group"
      }
    ],
    "reviewTaskIds": [
      "string"
    ],
    "actionIds": [
      "string"
    ],
    "preparedAt": "preparedAt",
    "readyAt": "readyAt",
    "createdAt": "createdAt",
    "updatedAt": "updatedAt"
  },
  "workObjects": [
    {
      "id": "id",
      "workspaceId": "workspaceId",
      "projectId": "projectId",
      "conversationId": "conversationId",
      "workOrderId": "workOrderId",
      "family": "task",
      "semanticType": "todo-list",
      "meetingKind": "outcome",
      "meetingStage": "captured",
      "proposalState": "human",
      "stageUpdatedAt": "stageUpdatedAt",
      "title": "title",
      "summary": "summary",
      "ownerRole": "owner",
      "ownerUserId": "ownerUserId",
      "progressState": "todo",
      "responsibilityUpdatedAt": "responsibilityUpdatedAt",
      "dueAt": "dueAt",
      "blockedReason": "blockedReason",
      "completedAt": "completedAt",
      "reviewState": "draft",
      "latestRevisionId": "latestRevisionId",
      "latestRevisionNumber": 0,
      "createdAt": "createdAt",
      "updatedAt": "updatedAt"
    }
  ],
  "revisions": [
    {
      "id": "id",
      "workObjectId": "workObjectId",
      "revision": 0,
      "revisionHash": "revisionHash",
      "title": "title",
      "summary": "summary",
      "content": {
        "kind": "checklist",
        "items": [
          {
            "id": "id",
            "title": "title",
            "detail": "detail",
            "state": "todo",
            "ownerUserId": "ownerUserId",
            "ownerLabel": "ownerLabel",
            "dueAt": "dueAt",
            "priority": "urgent",
            "sourceSegmentIds": [
              "string"
            ]
          }
        ]
      },
      "confidence": 0,
      "sources": [
        {
          "kind": "transcript",
          "segmentId": "segmentId",
          "excerpt": "excerpt",
          "speakerId": "speakerId"
        }
      ],
      "contextRefs": [
        {
          "sourceType": "sourceType",
          "sourceId": "sourceId",
          "title": "title",
          "excerpt": "excerpt",
          "externalURL": "externalURL"
        }
      ],
      "createdBy": {
        "kind": "agent",
        "role": "role",
        "workOrderId": "workOrderId"
      },
      "createdAt": "createdAt"
    }
  ],
  "reviews": [
    {
      "id": "id",
      "workspaceId": "workspaceId",
      "projectId": "projectId",
      "conversationId": "conversationId",
      "workSetId": "workSetId",
      "workObjectId": "workObjectId",
      "revisionId": "revisionId",
      "assigneeRole": "owner",
      "assigneeUserId": "assigneeUserId",
      "status": "waiting-for-submission",
      "claimedByUserId": "claimedByUserId",
      "requestedAt": "requestedAt",
      "resolvedAt": "resolvedAt",
      "createdAt": "createdAt",
      "updatedAt": "updatedAt"
    }
  ],
  "actions": [
    {
      "id": "id",
      "workspaceId": "workspaceId",
      "projectId": "projectId",
      "conversationId": "conversationId",
      "workSetId": "workSetId",
      "sourceRevisionIds": [
        "string"
      ],
      "actionType": "actionType",
      "title": "title",
      "description": "description",
      "risk": "low",
      "target": {
        "key": "string"
      },
      "payload": {
        "key": "string"
      },
      "status": "prepared",
      "requiresWorkApproval": true,
      "requiresSideEffectApproval": true,
      "idempotencyKey": "idempotencyKey",
      "approvedByUserId": "approvedByUserId",
      "approvedAt": "approvedAt",
      "createdAt": "createdAt",
      "updatedAt": "updatedAt"
    }
  ],
  "executions": [
    {
      "id": "id",
      "workspaceId": "workspaceId",
      "projectId": "projectId",
      "actionId": "actionId",
      "status": "queued",
      "attempt": 0,
      "idempotencyKey": "idempotencyKey",
      "runnerId": "runnerId",
      "externalObjectId": "externalObjectId",
      "externalURL": "externalURL",
      "result": {
        "key": "string"
      },
      "error": {
        "code": "code",
        "message": "message",
        "retryable": true
      },
      "startedAt": "startedAt",
      "completedAt": "completedAt",
      "createdAt": "createdAt",
      "updatedAt": "updatedAt"
    }
  ],
  "actionRecommendationEligibility": {
    "state": "no_provider",
    "providerCount": 0,
    "actionCount": 0
  },
  "actionRecommendationRun": {
    "state": "pending",
    "basedOnWorkSetRevision": 0,
    "recommendationCount": 0,
    "updatedAt": "updatedAt",
    "errorCode": "errorCode"
  },
  "externalActionRecommendations": [
    {
      "id": "id",
      "workspaceId": "workspaceId",
      "projectId": "projectId",
      "workObjectId": "workObjectId",
      "sourceRevisionId": "sourceRevisionId",
      "actionId": "actionId",
      "actionLabel": "actionLabel",
      "service": "service",
      "connectionId": "connectionId",
      "connectionName": "connectionName",
      "suggestedInput": {
        "key": "string"
      },
      "missingFields": [
        "string"
      ],
      "reason": "reason",
      "score": 0,
      "status": "active",
      "preparedActionId": "preparedActionId",
      "createdAt": "createdAt",
      "updatedAt": "updatedAt"
    }
  ],
  "externalPreparedActions": [
    {
      "id": "id",
      "projectId": "projectId",
      "actionId": "actionId",
      "service": "service",
      "connectionId": "connectionId",
      "connectionAlias": "connectionAlias",
      "input": {
        "key": "string"
      },
      "inputDigest": "inputDigest",
      "schemaDigest": "schemaDigest",
      "status": "prepared",
      "requiresApproval": true,
      "expiresAt": "expiresAt",
      "createdAt": "createdAt",
      "updatedAt": "updatedAt",
      "workObjectId": "workObjectId",
      "sourceRevisionId": "sourceRevisionId",
      "recommendationId": "recommendationId"
    }
  ],
  "externalActionReceipts": [
    {
      "id": "id",
      "preparedActionId": "preparedActionId",
      "projectId": "projectId",
      "actionId": "actionId",
      "connectionId": "connectionId",
      "status": "running",
      "openConnectorRunId": "openConnectorRunId",
      "auditPersisted": true,
      "result": "string",
      "error": {
        "code": "code",
        "message": "message",
        "retryable": true
      },
      "createdAt": "createdAt",
      "updatedAt": "updatedAt",
      "workObjectId": "workObjectId",
      "sourceRevisionId": "sourceRevisionId",
      "recommendationId": "recommendationId"
    }
  ],
  "needsRebuild": true,
  "takeover": {
    "id": "id",
    "conversationId": "conversationId",
    "basedOnWorksetRevision": 0,
    "aligned": [
      {
        "text": "text",
        "evidenceSegmentIds": [
          "string"
        ]
      }
    ],
    "now": [
      {
        "workObjectId": "workObjectId",
        "why": "why",
        "evidenceSegmentIds": [
          "string"
        ]
      }
    ],
    "later": [
      {
        "workObjectId": "workObjectId",
        "text": "text",
        "why": "why"
      }
    ],
    "clarify": [
      {
        "id": "id",
        "workObjectId": "workObjectId",
        "question": "question",
        "wouldChange": "wouldChange",
        "status": "open",
        "evidenceSegmentIds": [
          "string"
        ]
      }
    ],
    "generatedAt": "generatedAt",
    "supersededAt": "supersededAt"
  },
  "relations": [
    {
      "id": "id",
      "workSetId": "workSetId",
      "fromWorkObjectId": "fromWorkObjectId",
      "toWorkObjectId": "toWorkObjectId",
      "relationType": "relationType",
      "reason": "reason",
      "sourceSegmentIds": [
        "string"
      ],
      "manualOverride": true,
      "deletedAt": "deletedAt",
      "createdAt": "createdAt",
      "updatedAt": "updatedAt"
    }
  ],
  "decisionWorkstreams": [
    {
      "id": "id",
      "decisionWorkObjectId": "decisionWorkObjectId",
      "decisionRevisionId": "decisionRevisionId",
      "sourceSegmentIds": [
        "string"
      ],
      "items": [
        {
          "workObjectId": "workObjectId",
          "revisionId": "revisionId",
          "discipline": "product",
          "reviewStatus": "waiting-for-submission",
          "reviewTaskId": "reviewTaskId",
          "actionIds": [
            "string"
          ]
        }
      ]
    }
  ],
  "takeoverState": "pending"
}

json

application/json

Sessions Memory