Sessions

Server

Download schema

获取assets · assetId

GET

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

/v1/assets/{assetId}

获取assets · assetId › path Parameters

assetId

string · required

获取assets · assetId › Responses

请求成功

GenericResponse

获取sessions

GET

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

/v1/sessions

获取sessions › query Parameters

projectId

string

archived

boolean

获取sessions › Responses

请求成功

SessionListResponse

SessionSnapshot[] · required

GET/v1/sessions

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

Example Responses

{
  "sessions": [
    {
      "sessionId": "sessionId",
      "workspaceId": "workspaceId",
      "projectId": "projectId",
      "title": "title",
      "status": "ready",
      "captureMode": "microphone",
      "contentLanguage": "contentLanguage",
      "createdAt": "createdAt",
      "updatedAt": "updatedAt",
      "completedAt": "completedAt",
      "archivedAt": "archivedAt",
      "lastSequence": 0,
      "snapshotRevision": 0,
      "participants": [
        {
          "id": "id",
          "displayName": "displayName",
          "isCapturing": true
        }
      ],
      "captureSource": {
        "deviceId": "deviceId",
        "platform": "ios",
        "label": "label"
      },
      "speakerAliases": {
        "key": "string"
      },
      "transcripts": [
        {
          "id": "id",
          "text": "text",
          "speakerId": "speakerId",
          "startedAt": "startedAt",
          "endedAt": "endedAt",
          "createdAt": "createdAt",
          "chunkId": "chunkId"
        }
      ],
      "artifacts": [
        {
          "id": "id",
          "kind": "mind-map",
          "title": "title",
          "revision": 0,
          "nodes": [
            {
              "id": "id",
              "kind": "mind-map",
              "title": "title",
              "body": "body",
              "owner": "owner",
              "due": "due",
              "workStatus": "todo",
              "parentId": "parentId",
              "position": {
                "x": 0,
                "y": 0
              },
              "confidence": 0,
              "sourceSegmentIds": [
                "string"
              ]
            }
          ],
          "updatedAt": "updatedAt",
          "status": "proposed"
        }
      ],
      "orchestration": {
        "revision": 0,
        "chiefOfStaffRole": "chief-of-staff",
        "agents": [
          {
            "role": "chief-of-staff",
            "capabilityPool": "planning",
            "status": "observing",
            "reason": "reason",
            "taskIds": [
              "string"
            ],
            "activatedAt": "activatedAt",
            "updatedAt": "updatedAt"
          }
        ],
        "tasks": [
          {
            "id": "id",
            "role": "chief-of-staff",
            "capabilityPool": "planning",
            "title": "title",
            "objective": "objective",
            "status": "queued",
            "revision": 0,
            "createdAt": "createdAt",
            "updatedAt": "updatedAt",
            "sourceSegmentIds": [
              "string"
            ],
            "outputBlockIds": [
              "string"
            ],
            "dependsOnTaskIds": [
              "string"
            ],
            "note": "note"
          }
        ],
        "updatedAt": "updatedAt"
      },
      "blocks": [
        {
          "id": "id",
          "family": "text",
          "type": "type",
          "title": "title",
          "body": "body",
          "revision": 0,
          "state": "proposed",
          "inference": "verified",
          "sources": [
            {
              "kind": "transcript",
              "segmentId": "segmentId",
              "excerpt": "excerpt"
            }
          ],
          "properties": {
            "key": "string"
          },
          "relationshipIds": [
            "string"
          ],
          "createdAt": "createdAt",
          "updatedAt": "updatedAt",
          "createdBy": {
            "agentRole": "chief-of-staff",
            "taskId": "taskId"
          },
          "compatibility": {
            "artifactId": "artifactId",
            "artifactKind": "mind-map",
            "artifactNodeId": "artifactNodeId"
          }
        }
      ],
      "relationships": [
        {
          "id": "id",
          "fromBlockId": "fromBlockId",
          "toBlockId": "toBlockId",
          "kind": "supports",
          "label": "label",
          "revision": 0,
          "sourceSegmentIds": [
            "string"
          ]
        }
      ],
      "composition": {
        "id": "id",
        "title": "title",
        "kind": "kind",
        "summary": "summary",
        "revision": 0,
        "status": "draft",
        "sections": [
          {
            "id": "id",
            "title": "title",
            "purpose": "purpose",
            "layout": "prose",
            "placements": [
              {
                "id": "id",
                "blockId": "blockId",
                "order": 0,
                "presentation": "prose",
                "column": 0,
                "emphasis": "quiet"
              }
            ]
          }
        ],
        "relationshipIds": [
          "string"
        ],
        "createdAt": "createdAt",
        "updatedAt": "updatedAt"
      },
      "workSet": {
        "id": "id",
        "projectId": "projectId",
        "sessionId": "sessionId",
        "primaryBlockId": "primaryBlockId",
        "compositionId": "compositionId",
        "status": "forming",
        "blockIds": [
          "string"
        ],
        "actionIds": [
          "string"
        ],
        "preparedAt": "preparedAt",
        "createdAt": "createdAt",
        "updatedAt": "updatedAt"
      },
      "suggestions": [
        {
          "id": "id",
          "title": "title",
          "rationale": "rationale",
          "rank": 0,
          "sourceBlockIds": [
            "string"
          ],
          "compositionId": "compositionId",
          "target": {
            "kind": "string",
            "capability": "capability",
            "destination": "destination"
          },
          "requiresConfirmation": true,
          "status": "suggested",
          "createdAt": "createdAt",
          "updatedAt": "updatedAt"
        }
      ]
    }
  ]
}

json

application/json

创建或执行sessions

POST

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

/v1/sessions

创建或执行sessions › Headers

Idempotency-Key

string · minLength: 1 · required

创建或执行sessions › Request Body

CreateSessionRequest

captureMode

CaptureMode · enum · required

Enum values:

microphone

microphone-and-system-audio

projectId

Identifier

title

string

language

string

object

当前唯一收音设备。其它端只同步结果，不得再显示成本机「正在听」。

创建或执行sessions › Responses

请求成功

CreateSessionResponse

SessionSnapshot · required

conversationId

Identifier · required

websocketURL

string · required

workWebsocketURL

string · required

reusedExisting

boolean

true when the account already had this open session; no new row was created.

POST/v1/sessions

curl https://capworks-api-docs.pages.dev/proxy/capworks/v1/sessions \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <string>' \
  --data '{
  "projectId": "projectId",
  "title": "title",
  "language": "language",
  "captureMode": "microphone",
  "captureSource": {
    "deviceId": "deviceId",
    "platform": "ios",
    "label": "label"
  }
}'

Example Request Body

{
  "projectId": "projectId",
  "title": "title",
  "language": "language",
  "captureMode": "microphone",
  "captureSource": {
    "deviceId": "deviceId",
    "platform": "ios",
    "label": "label"
  }
}

json

Example Responses

{
  "snapshot": {
    "sessionId": "sessionId",
    "workspaceId": "workspaceId",
    "projectId": "projectId",
    "title": "title",
    "status": "ready",
    "captureMode": "microphone",
    "contentLanguage": "contentLanguage",
    "createdAt": "createdAt",
    "updatedAt": "updatedAt",
    "completedAt": "completedAt",
    "archivedAt": "archivedAt",
    "lastSequence": 0,
    "snapshotRevision": 0,
    "participants": [
      {
        "id": "id",
        "displayName": "displayName",
        "isCapturing": true
      }
    ],
    "captureSource": {
      "deviceId": "deviceId",
      "platform": "ios",
      "label": "label"
    },
    "speakerAliases": {
      "key": "string"
    },
    "transcripts": [
      {
        "id": "id",
        "text": "text",
        "speakerId": "speakerId",
        "startedAt": "startedAt",
        "endedAt": "endedAt",
        "createdAt": "createdAt",
        "chunkId": "chunkId"
      }
    ],
    "artifacts": [
      {
        "id": "id",
        "kind": "mind-map",
        "title": "title",
        "revision": 0,
        "nodes": [
          {
            "id": "id",
            "kind": "mind-map",
            "title": "title",
            "body": "body",
            "owner": "owner",
            "due": "due",
            "workStatus": "todo",
            "parentId": "parentId",
            "position": {
              "x": 0,
              "y": 0
            },
            "confidence": 0,
            "sourceSegmentIds": [
              "string"
            ]
          }
        ],
        "updatedAt": "updatedAt",
        "status": "proposed"
      }
    ],
    "orchestration": {
      "revision": 0,
      "chiefOfStaffRole": "chief-of-staff",
      "agents": [
        {
          "role": "chief-of-staff",
          "capabilityPool": "planning",
          "status": "observing",
          "reason": "reason",
          "taskIds": [
            "string"
          ],
          "activatedAt": "activatedAt",
          "updatedAt": "updatedAt"
        }
      ],
      "tasks": [
        {
          "id": "id",
          "role": "chief-of-staff",
          "capabilityPool": "planning",
          "title": "title",
          "objective": "objective",
          "status": "queued",
          "revision": 0,
          "createdAt": "createdAt",
          "updatedAt": "updatedAt",
          "sourceSegmentIds": [
            "string"
          ],
          "outputBlockIds": [
            "string"
          ],
          "dependsOnTaskIds": [
            "string"
          ],
          "note": "note"
        }
      ],
      "updatedAt": "updatedAt"
    },
    "blocks": [
      {
        "id": "id",
        "family": "text",
        "type": "type",
        "title": "title",
        "body": "body",
        "revision": 0,
        "state": "proposed",
        "inference": "verified",
        "sources": [
          {
            "kind": "transcript",
            "segmentId": "segmentId",
            "excerpt": "excerpt"
          }
        ],
        "properties": {
          "key": "string"
        },
        "relationshipIds": [
          "string"
        ],
        "createdAt": "createdAt",
        "updatedAt": "updatedAt",
        "createdBy": {
          "agentRole": "chief-of-staff",
          "taskId": "taskId"
        },
        "compatibility": {
          "artifactId": "artifactId",
          "artifactKind": "mind-map",
          "artifactNodeId": "artifactNodeId"
        }
      }
    ],
    "relationships": [
      {
        "id": "id",
        "fromBlockId": "fromBlockId",
        "toBlockId": "toBlockId",
        "kind": "supports",
        "label": "label",
        "revision": 0,
        "sourceSegmentIds": [
          "string"
        ]
      }
    ],
    "composition": {
      "id": "id",
      "title": "title",
      "kind": "kind",
      "summary": "summary",
      "revision": 0,
      "status": "draft",
      "sections": [
        {
          "id": "id",
          "title": "title",
          "purpose": "purpose",
          "layout": "prose",
          "placements": [
            {
              "id": "id",
              "blockId": "blockId",
              "order": 0,
              "presentation": "prose",
              "column": 0,
              "emphasis": "quiet"
            }
          ]
        }
      ],
      "relationshipIds": [
        "string"
      ],
      "createdAt": "createdAt",
      "updatedAt": "updatedAt"
    },
    "workSet": {
      "id": "id",
      "projectId": "projectId",
      "sessionId": "sessionId",
      "primaryBlockId": "primaryBlockId",
      "compositionId": "compositionId",
      "status": "forming",
      "blockIds": [
        "string"
      ],
      "actionIds": [
        "string"
      ],
      "preparedAt": "preparedAt",
      "createdAt": "createdAt",
      "updatedAt": "updatedAt"
    },
    "suggestions": [
      {
        "id": "id",
        "title": "title",
        "rationale": "rationale",
        "rank": 0,
        "sourceBlockIds": [
          "string"
        ],
        "compositionId": "compositionId",
        "target": {
          "kind": "string",
          "capability": "capability",
          "destination": "destination"
        },
        "requiresConfirmation": true,
        "status": "suggested",
        "createdAt": "createdAt",
        "updatedAt": "updatedAt"
      }
    ]
  },
  "conversationId": "conversationId",
  "websocketURL": "websocketURL",
  "workWebsocketURL": "workWebsocketURL",
  "reusedExisting": true
}

json

application/json

获取sessions · sessionId

GET

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

/v1/sessions/{sessionId}

获取sessions · sessionId › path Parameters

sessionId

string · required

获取sessions · sessionId › Responses

请求成功

GenericResponse

删除sessions · sessionId

DELETE

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

/v1/sessions/{sessionId}

删除sessions · sessionId › path Parameters

sessionId

string · required

删除sessions · sessionId › Responses

删除成功

No data returned

更新sessions · sessionId

PATCH

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

/v1/sessions/{sessionId}

更新sessions · sessionId › path Parameters

sessionId

string · required

更新sessions · sessionId › Request Body

GenericRequest

更新sessions · sessionId › Responses

请求成功

GenericResponse

创建或执行sessions · sessionId · audio

POST

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

/v1/sessions/{sessionId}/audio

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

sessionId

string · required

创建或执行sessions · sessionId · audio › Headers

X-CapWorks-Chunk-ID

string · required

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

string

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

请求成功

AudioChunkResponse

accepted

boolean · const · required

Const value:

chunkId

Identifier · required

duplicate

boolean · required

TranscriptSegment

创建或执行sessions · sessionId · end

POST

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

/v1/sessions/{sessionId}/end

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

sessionId

string · required

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

GenericRequest

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

请求成功

GenericResponse

获取sessions · sessionId · events

GET

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

/v1/sessions/{sessionId}/events

获取sessions · sessionId · events › path Parameters

sessionId

string · required

获取sessions · sessionId · events › Responses

切换为 WebSocket 协议；消息定义见实时 API 文档。

No data returned

创建或执行sessions · sessionId · new project

POST

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

/v1/sessions/{sessionId}/new-project

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

sessionId

string · required

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

CreateProjectFromSessionRequest

name

string

创建或执行sessions · sessionId · new project › Responses

请求成功

CreateProjectFromSessionResponse

Project · required

SessionSnapshot · required

created

boolean · required

POST/v1/sessions/{sessionId}/new-project

curl https://capworks-api-docs.pages.dev/proxy/capworks/v1/sessions/:sessionId/new-project \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "name"
}'

Example Request Body

{
  "name": "name"
}

json

Example Responses

{
  "project": {
    "id": "id",
    "workspaceId": "workspaceId",
    "name": "name",
    "status": "active",
    "objective": "objective",
    "description": "description",
    "defaultLanguage": "defaultLanguage",
    "timezone": "timezone",
    "memberIds": [
      "string"
    ],
    "currentMembership": {
      "projectId": "projectId",
      "userId": "userId",
      "accessRole": "owner",
      "primaryRole": "product",
      "secondaryRoles": [
        "product"
      ],
      "roleConfirmedAt": "roleConfirmedAt",
      "joinedAt": "joinedAt"
    },
    "createdAt": "createdAt",
    "updatedAt": "updatedAt",
    "archivedAt": "archivedAt"
  },
  "snapshot": {
    "sessionId": "sessionId",
    "workspaceId": "workspaceId",
    "projectId": "projectId",
    "title": "title",
    "status": "ready",
    "captureMode": "microphone",
    "contentLanguage": "contentLanguage",
    "createdAt": "createdAt",
    "updatedAt": "updatedAt",
    "completedAt": "completedAt",
    "archivedAt": "archivedAt",
    "lastSequence": 0,
    "snapshotRevision": 0,
    "participants": [
      {
        "id": "id",
        "displayName": "displayName",
        "isCapturing": true
      }
    ],
    "captureSource": {
      "deviceId": "deviceId",
      "platform": "ios",
      "label": "label"
    },
    "speakerAliases": {
      "key": "string"
    },
    "transcripts": [
      {
        "id": "id",
        "text": "text",
        "speakerId": "speakerId",
        "startedAt": "startedAt",
        "endedAt": "endedAt",
        "createdAt": "createdAt",
        "chunkId": "chunkId"
      }
    ],
    "artifacts": [
      {
        "id": "id",
        "kind": "mind-map",
        "title": "title",
        "revision": 0,
        "nodes": [
          {
            "id": "id",
            "kind": "mind-map",
            "title": "title",
            "body": "body",
            "owner": "owner",
            "due": "due",
            "workStatus": "todo",
            "parentId": "parentId",
            "position": {
              "x": 0,
              "y": 0
            },
            "confidence": 0,
            "sourceSegmentIds": [
              "string"
            ]
          }
        ],
        "updatedAt": "updatedAt",
        "status": "proposed"
      }
    ],
    "orchestration": {
      "revision": 0,
      "chiefOfStaffRole": "chief-of-staff",
      "agents": [
        {
          "role": "chief-of-staff",
          "capabilityPool": "planning",
          "status": "observing",
          "reason": "reason",
          "taskIds": [
            "string"
          ],
          "activatedAt": "activatedAt",
          "updatedAt": "updatedAt"
        }
      ],
      "tasks": [
        {
          "id": "id",
          "role": "chief-of-staff",
          "capabilityPool": "planning",
          "title": "title",
          "objective": "objective",
          "status": "queued",
          "revision": 0,
          "createdAt": "createdAt",
          "updatedAt": "updatedAt",
          "sourceSegmentIds": [
            "string"
          ],
          "outputBlockIds": [
            "string"
          ],
          "dependsOnTaskIds": [
            "string"
          ],
          "note": "note"
        }
      ],
      "updatedAt": "updatedAt"
    },
    "blocks": [
      {
        "id": "id",
        "family": "text",
        "type": "type",
        "title": "title",
        "body": "body",
        "revision": 0,
        "state": "proposed",
        "inference": "verified",
        "sources": [
          {
            "kind": "transcript",
            "segmentId": "segmentId",
            "excerpt": "excerpt"
          }
        ],
        "properties": {
          "key": "string"
        },
        "relationshipIds": [
          "string"
        ],
        "createdAt": "createdAt",
        "updatedAt": "updatedAt",
        "createdBy": {
          "agentRole": "chief-of-staff",
          "taskId": "taskId"
        },
        "compatibility": {
          "artifactId": "artifactId",
          "artifactKind": "mind-map",
          "artifactNodeId": "artifactNodeId"
        }
      }
    ],
    "relationships": [
      {
        "id": "id",
        "fromBlockId": "fromBlockId",
        "toBlockId": "toBlockId",
        "kind": "supports",
        "label": "label",
        "revision": 0,
        "sourceSegmentIds": [
          "string"
        ]
      }
    ],
    "composition": {
      "id": "id",
      "title": "title",
      "kind": "kind",
      "summary": "summary",
      "revision": 0,
      "status": "draft",
      "sections": [
        {
          "id": "id",
          "title": "title",
          "purpose": "purpose",
          "layout": "prose",
          "placements": [
            {
              "id": "id",
              "blockId": "blockId",
              "order": 0,
              "presentation": "prose",
              "column": 0,
              "emphasis": "quiet"
            }
          ]
        }
      ],
      "relationshipIds": [
        "string"
      ],
      "createdAt": "createdAt",
      "updatedAt": "updatedAt"
    },
    "workSet": {
      "id": "id",
      "projectId": "projectId",
      "sessionId": "sessionId",
      "primaryBlockId": "primaryBlockId",
      "compositionId": "compositionId",
      "status": "forming",
      "blockIds": [
        "string"
      ],
      "actionIds": [
        "string"
      ],
      "preparedAt": "preparedAt",
      "createdAt": "createdAt",
      "updatedAt": "updatedAt"
    },
    "suggestions": [
      {
        "id": "id",
        "title": "title",
        "rationale": "rationale",
        "rank": 0,
        "sourceBlockIds": [
          "string"
        ],
        "compositionId": "compositionId",
        "target": {
          "kind": "string",
          "capability": "capability",
          "destination": "destination"
        },
        "requiresConfirmation": true,
        "status": "suggested",
        "createdAt": "createdAt",
        "updatedAt": "updatedAt"
      }
    ]
  },
  "created": true
}

json

application/json

创建或执行sessions · sessionId · pause

POST

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

/v1/sessions/{sessionId}/pause

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

sessionId

string · required

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

GenericRequest

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

请求成功

GenericResponse

获取sessions · sessionId · pilot lifecycle

GET

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

/v1/sessions/{sessionId}/pilot-lifecycle

获取sessions · sessionId · pilot lifecycle › path Parameters

sessionId

string · required

获取sessions · sessionId · pilot lifecycle › Responses

请求成功

GenericResponse

创建或执行sessions · sessionId · rebuild workset

POST

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

/v1/sessions/{sessionId}/rebuild-workset

创建或执行sessions · sessionId · rebuild workset › path Parameters

sessionId

string · required

创建或执行sessions · sessionId · rebuild workset › Headers

Idempotency-Key

string · minLength: 1 · required

创建或执行sessions · sessionId · rebuild workset › Request Body

GenericRequest

创建或执行sessions · sessionId · rebuild workset › Responses

请求成功

GenericResponse

创建或执行sessions · sessionId · resume

POST

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

/v1/sessions/{sessionId}/resume

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

sessionId

string · required

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

GenericRequest

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

请求成功

GenericResponse

GET

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

/v1/sessions/{sessionId}/share

sessionId

string · required

请求成功

ShareLinkResponse

shareToken

string · required

shareURL

string · required

permission

string · enum · required

Enum values:

read

comment

expiresAt

ISO8601Timestamp

POST

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

/v1/sessions/{sessionId}/share

sessionId

string · required

GenericRequest

请求成功

GenericResponse

DELETE

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

/v1/sessions/{sessionId}/share

sessionId

string · required

删除成功

No data returned

创建或执行sessions · sessionId · speakers

POST

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

/v1/sessions/{sessionId}/speakers

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

sessionId

string · required

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

GenericRequest

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

请求成功

GenericResponse

创建或执行sessions · sessionId · transcript summary

POST

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

/v1/sessions/{sessionId}/transcript-summary

创建或执行sessions · sessionId · transcript summary › path Parameters

sessionId

string · required

创建或执行sessions · sessionId · transcript summary › Request Body

TranscriptSummaryRequest

segmentId

Identifier · required

itemText

string · required

locale

string · enum

Enum values:

zh-Hans

创建或执行sessions · sessionId · transcript summary › Responses

请求成功

TranscriptSummaryResponse

status

string · enum · required

Enum values:

answered

no-evidence

summary

string · required

object · required

generatedBy

string · enum · required

Enum values:

grounded-ai

extractive

获取sessions · sessionId · transcription stream

GET

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

/v1/sessions/{sessionId}/transcription-stream

获取sessions · sessionId · transcription stream › path Parameters

sessionId

string · required

获取sessions · sessionId · transcription stream › Responses

切换为 WebSocket 协议；消息定义见实时 API 文档。

No data returned

创建或执行sessions · sessionId · transcripts

POST

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

/v1/sessions/{sessionId}/transcripts

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

sessionId

string · required

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

GenericRequest

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

请求成功

GenericResponse

删除sessions · sessionId · transcripts · segmentId

DELETE

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

/v1/sessions/{sessionId}/transcripts/{segmentId}

删除sessions · sessionId · transcripts · segmentId › path Parameters

sessionId

string · required

segmentId

string · required

删除sessions · sessionId · transcripts · segmentId › Responses

删除成功

No data returned

获取sessions · sessionId · work refinement

GET

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

/v1/sessions/{sessionId}/work-refinement

获取sessions · sessionId · work refinement › path Parameters

sessionId

string · required

获取sessions · sessionId · work refinement › Responses

请求成功

WorkRefinementResponse

WorkRefinementStatus · required

获取sessions · pilot candidates

GET

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

/v1/sessions/pilot-candidates

获取sessions · pilot candidates › Responses

请求成功

GenericResponse

获取shares · shareToken

GET

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

/v1/shares/{shareToken}

获取shares · shareToken › path Parameters

shareToken

string · required

获取shares · shareToken › Responses

请求成功

SharedSessionResponse

SessionSnapshot · required

required

permission

string · enum · required

Enum values:

read

comment

ShareComment[] · required

expiresAt

ISO8601Timestamp

GET/v1/shares/{shareToken}

curl https://capworks-api-docs.pages.dev/proxy/capworks/v1/shares/:shareToken

Example Responses

{
  "snapshot": {
    "sessionId": "sessionId",
    "workspaceId": "workspaceId",
    "projectId": "projectId",
    "title": "title",
    "status": "ready",
    "captureMode": "microphone",
    "contentLanguage": "contentLanguage",
    "createdAt": "createdAt",
    "updatedAt": "updatedAt",
    "completedAt": "completedAt",
    "archivedAt": "archivedAt",
    "lastSequence": 0,
    "snapshotRevision": 0,
    "participants": [
      {
        "id": "id",
        "displayName": "displayName",
        "isCapturing": true
      }
    ],
    "captureSource": {
      "deviceId": "deviceId",
      "platform": "ios",
      "label": "label"
    },
    "speakerAliases": {
      "key": "string"
    },
    "transcripts": [
      {
        "id": "id",
        "text": "text",
        "speakerId": "speakerId",
        "startedAt": "startedAt",
        "endedAt": "endedAt",
        "createdAt": "createdAt",
        "chunkId": "chunkId"
      }
    ],
    "artifacts": [
      {
        "id": "id",
        "kind": "mind-map",
        "title": "title",
        "revision": 0,
        "nodes": [
          {
            "id": "id",
            "kind": "mind-map",
            "title": "title",
            "body": "body",
            "owner": "owner",
            "due": "due",
            "workStatus": "todo",
            "parentId": "parentId",
            "position": {
              "x": 0,
              "y": 0
            },
            "confidence": 0,
            "sourceSegmentIds": [
              "string"
            ]
          }
        ],
        "updatedAt": "updatedAt",
        "status": "proposed"
      }
    ],
    "orchestration": {
      "revision": 0,
      "chiefOfStaffRole": "chief-of-staff",
      "agents": [
        {
          "role": "chief-of-staff",
          "capabilityPool": "planning",
          "status": "observing",
          "reason": "reason",
          "taskIds": [
            "string"
          ],
          "activatedAt": "activatedAt",
          "updatedAt": "updatedAt"
        }
      ],
      "tasks": [
        {
          "id": "id",
          "role": "chief-of-staff",
          "capabilityPool": "planning",
          "title": "title",
          "objective": "objective",
          "status": "queued",
          "revision": 0,
          "createdAt": "createdAt",
          "updatedAt": "updatedAt",
          "sourceSegmentIds": [
            "string"
          ],
          "outputBlockIds": [
            "string"
          ],
          "dependsOnTaskIds": [
            "string"
          ],
          "note": "note"
        }
      ],
      "updatedAt": "updatedAt"
    },
    "blocks": [
      {
        "id": "id",
        "family": "text",
        "type": "type",
        "title": "title",
        "body": "body",
        "revision": 0,
        "state": "proposed",
        "inference": "verified",
        "sources": [
          {
            "kind": "transcript",
            "segmentId": "segmentId",
            "excerpt": "excerpt"
          }
        ],
        "properties": {
          "key": "string"
        },
        "relationshipIds": [
          "string"
        ],
        "createdAt": "createdAt",
        "updatedAt": "updatedAt",
        "createdBy": {
          "agentRole": "chief-of-staff",
          "taskId": "taskId"
        },
        "compatibility": {
          "artifactId": "artifactId",
          "artifactKind": "mind-map",
          "artifactNodeId": "artifactNodeId"
        }
      }
    ],
    "relationships": [
      {
        "id": "id",
        "fromBlockId": "fromBlockId",
        "toBlockId": "toBlockId",
        "kind": "supports",
        "label": "label",
        "revision": 0,
        "sourceSegmentIds": [
          "string"
        ]
      }
    ],
    "composition": {
      "id": "id",
      "title": "title",
      "kind": "kind",
      "summary": "summary",
      "revision": 0,
      "status": "draft",
      "sections": [
        {
          "id": "id",
          "title": "title",
          "purpose": "purpose",
          "layout": "prose",
          "placements": [
            {
              "id": "id",
              "blockId": "blockId",
              "order": 0,
              "presentation": "prose",
              "column": 0,
              "emphasis": "quiet"
            }
          ]
        }
      ],
      "relationshipIds": [
        "string"
      ],
      "createdAt": "createdAt",
      "updatedAt": "updatedAt"
    },
    "workSet": {
      "id": "id",
      "projectId": "projectId",
      "sessionId": "sessionId",
      "primaryBlockId": "primaryBlockId",
      "compositionId": "compositionId",
      "status": "forming",
      "blockIds": [
        "string"
      ],
      "actionIds": [
        "string"
      ],
      "preparedAt": "preparedAt",
      "createdAt": "createdAt",
      "updatedAt": "updatedAt"
    },
    "suggestions": [
      {
        "id": "id",
        "title": "title",
        "rationale": "rationale",
        "rank": 0,
        "sourceBlockIds": [
          "string"
        ],
        "compositionId": "compositionId",
        "target": {
          "kind": "string",
          "capability": "capability",
          "destination": "destination"
        },
        "requiresConfirmation": true,
        "status": "suggested",
        "createdAt": "createdAt",
        "updatedAt": "updatedAt"
      }
    ]
  },
  "workSet": {
    "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"
  },
  "permission": "read",
  "comments": [
    {
      "id": "id",
      "workObjectId": "workObjectId",
      "authorUserId": "authorUserId",
      "authorDisplayName": "authorDisplayName",
      "body": "body",
      "status": "active",
      "createdAt": "createdAt"
    }
  ],
  "expiresAt": "expiresAt"
}

json

application/json

创建或执行shares · shareToken · comments

POST

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

/v1/shares/{shareToken}/comments

创建或执行shares · shareToken · comments › path Parameters

shareToken

string · required

创建或执行shares · shareToken · comments › Request Body

CreateShareCommentRequest

workObjectId

Identifier · required

body

string · required

创建或执行shares · shareToken · comments › Responses

请求成功

GenericResponse

Projects Work

Sessions

获取assets · assetId

获取assets · assetId › path Parameters

获取assets · assetId › Responses

获取sessions

获取sessions › query Parameters

获取sessions › Responses

创建或执行sessions

创建或执行sessions › Headers

创建或执行sessions › Request Body

创建或执行sessions › Responses

获取sessions · sessionId

获取sessions · sessionId › path Parameters

获取sessions · sessionId › Responses

删除sessions · sessionId

删除sessions · sessionId › path Parameters

删除sessions · sessionId › Responses

更新sessions · sessionId

更新sessions · sessionId › path Parameters

更新sessions · sessionId › Request Body

更新sessions · sessionId › Responses

创建或执行sessions · sessionId · audio

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

创建或执行sessions · sessionId · audio › Headers

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

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

创建或执行sessions · sessionId · end

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

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

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

获取sessions · sessionId · events

获取sessions · sessionId · events › path Parameters

获取sessions · sessionId · events › Responses

创建或执行sessions · sessionId · new project

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

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

创建或执行sessions · sessionId · new project › Responses

创建或执行sessions · sessionId · pause

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

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

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

获取sessions · sessionId · pilot lifecycle

获取sessions · sessionId · pilot lifecycle › path Parameters

获取sessions · sessionId · pilot lifecycle › Responses

创建或执行sessions · sessionId · rebuild workset

创建或执行sessions · sessionId · rebuild workset › path Parameters

创建或执行sessions · sessionId · rebuild workset › Headers

创建或执行sessions · sessionId · rebuild workset › Request Body

创建或执行sessions · sessionId · rebuild workset › Responses

创建或执行sessions · sessionId · resume

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

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

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

获取sessions · sessionId · share

获取sessions · sessionId · share › path Parameters

获取sessions · sessionId · share › Responses

创建或执行sessions · sessionId · share

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

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

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

删除sessions · sessionId · share

删除sessions · sessionId · share › path Parameters

删除sessions · sessionId · share › Responses

创建或执行sessions · sessionId · speakers

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

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

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

创建或执行sessions · sessionId · transcript summary

创建或执行sessions · sessionId · transcript summary › path Parameters

创建或执行sessions · sessionId · transcript summary › Request Body

创建或执行sessions · sessionId · transcript summary › Responses

获取sessions · sessionId · transcription stream

获取sessions · sessionId · transcription stream › path Parameters

获取sessions · sessionId · transcription stream › Responses

创建或执行sessions · sessionId · transcripts

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

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

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

删除sessions · sessionId · transcripts · segmentId

删除sessions · sessionId · transcripts · segmentId › path Parameters