Projects

Server

Download schema

获取projects

GET

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

/v1/projects

获取projects › Responses

请求成功

ProjectListResponse

Project[] · required

GET/v1/projects

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

Example Responses

{
  "projects": [
    {
      "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"
    }
  ]
}

json

application/json

创建或执行projects

POST

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

/v1/projects

创建或执行projects › Headers

Idempotency-Key

string · minLength: 1 · required

创建或执行projects › Request Body

CreateProjectRequest

name

string · required

objective

string

description

string

defaultLanguage

string

timezone

string

创建或执行projects › Responses

请求成功

CreateProjectResponse

Project · required

POST/v1/projects

curl https://capworks-api-docs.pages.dev/proxy/capworks/v1/projects \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <string>' \
  --data '{
  "name": "name",
  "objective": "objective",
  "description": "description",
  "defaultLanguage": "defaultLanguage",
  "timezone": "timezone"
}'

Example Request Body

{
  "name": "name",
  "objective": "objective",
  "description": "description",
  "defaultLanguage": "defaultLanguage",
  "timezone": "timezone"
}

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"
  }
}

json

application/json

获取projects · projectId

GET

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

/v1/projects/{projectId}

获取projects · projectId › path Parameters

projectId

string · required

获取projects · projectId › Responses

请求成功

ProjectContextResponse

Project · required

SessionSnapshot[] · required

GET/v1/projects/{projectId}

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

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"
  },
  "recentSessions": [
    {
      "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

更新projects · projectId

PATCH

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

/v1/projects/{projectId}

更新projects · projectId › path Parameters

projectId

string · required

更新projects · projectId › Request Body

UpdateProjectRequest

name

string

status

ProjectStatus · enum

Enum values:

active

archived

objective

string

description

string

defaultLanguage

string

timezone

string

更新projects · projectId › Responses

请求成功

GenericResponse

获取projects · projectId · members

GET

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

/v1/projects/{projectId}/members

获取projects · projectId · members › path Parameters

projectId

string · required

获取projects · projectId · members › Responses

请求成功

ProjectMembershipListResponse

ProjectMembership[] · required

获取projects · projectId · membership

GET

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

/v1/projects/{projectId}/membership

获取projects · projectId · membership › path Parameters

projectId

string · required

获取projects · projectId · membership › Responses

请求成功

ProjectMembershipResponse

required

设置projects · projectId · membership

PUT

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

/v1/projects/{projectId}/membership

设置projects · projectId · membership › path Parameters

projectId

string · required

设置projects · projectId · membership › Request Body

UpsertProjectMembershipRequest

primaryRole

ProjectRole · enum · required

项目中的工作视角；只决定默认工具和建议，不授予任何权限。

Enum values:

product

design

engineering

operations

project-management

other

secondaryRoles

ProjectRole[]

Enum values:

product

design

engineering

operations

project-management

other

设置projects · projectId · membership › Responses

请求成功

GenericResponse

获取projects · projectId · references

GET

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

/v1/projects/{projectId}/references

获取projects · projectId · references › path Parameters

projectId

string · required

获取projects · projectId · references › Responses

请求成功

ProjectReferenceDocumentListResponse

ProjectReferenceDocument[] · required

创建或执行projects · projectId · references

POST

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

/v1/projects/{projectId}/references

创建或执行projects · projectId · references › path Parameters

projectId

string · required

创建或执行projects · projectId · references › Request Body

file

string · required

创建或执行projects · projectId · references › Responses

请求成功

ProjectReferenceDocumentResponse

ProjectReferenceDocument · required

删除projects · projectId · references · referenceId

DELETE

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

/v1/projects/{projectId}/references/{referenceId}

删除projects · projectId · references · referenceId › path Parameters

projectId

string · required

referenceId

string · required

删除projects · projectId · references · referenceId › Responses

删除成功

No data returned

Account Sessions

CapWorks HTTP API

Projects

Server

Download schema

获取projects

GET

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

/v1/projects

获取projects › Responses

请求成功

ProjectListResponse

Project[] · required

GET/v1/projects

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

Example Responses

{
  "projects": [
    {
      "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"
    }
  ]
}

json

application/json

创建或执行projects

POST

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

/v1/projects

创建或执行projects › Headers

Idempotency-Key

string · minLength: 1 · required

创建或执行projects › Request Body

CreateProjectRequest

name

string · required

objective

string

description

string

defaultLanguage

string

timezone

string

创建或执行projects › Responses

请求成功

CreateProjectResponse

Project · required

POST/v1/projects

curl https://capworks-api-docs.pages.dev/proxy/capworks/v1/projects \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <string>' \
  --data '{
  "name": "name",
  "objective": "objective",
  "description": "description",
  "defaultLanguage": "defaultLanguage",
  "timezone": "timezone"
}'

Example Request Body

{
  "name": "name",
  "objective": "objective",
  "description": "description",
  "defaultLanguage": "defaultLanguage",
  "timezone": "timezone"
}

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"
  }
}

json

application/json

获取projects · projectId

GET

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

/v1/projects/{projectId}

获取projects · projectId › path Parameters

projectId

string · required

获取projects · projectId › Responses

请求成功

ProjectContextResponse

Project · required

SessionSnapshot[] · required

GET/v1/projects/{projectId}

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

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"
  },
  "recentSessions": [
    {
      "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

更新projects · projectId

PATCH

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

/v1/projects/{projectId}

更新projects · projectId › path Parameters

projectId

string · required

更新projects · projectId › Request Body

UpdateProjectRequest

name

string

status

ProjectStatus · enum

Enum values:

active

archived

objective

string

description

string

defaultLanguage

string

timezone

string

更新projects · projectId › Responses

请求成功

GenericResponse

获取projects · projectId · members

GET

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

/v1/projects/{projectId}/members

获取projects · projectId · members › path Parameters

projectId

string · required

获取projects · projectId · members › Responses

请求成功

ProjectMembershipListResponse

ProjectMembership[] · required

获取projects · projectId · membership

GET

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

/v1/projects/{projectId}/membership

获取projects · projectId · membership › path Parameters

projectId

string · required

获取projects · projectId · membership › Responses

请求成功

ProjectMembershipResponse

required

设置projects · projectId · membership

PUT

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

/v1/projects/{projectId}/membership

设置projects · projectId · membership › path Parameters

projectId

string · required

设置projects · projectId · membership › Request Body

UpsertProjectMembershipRequest

primaryRole

ProjectRole · enum · required

项目中的工作视角；只决定默认工具和建议，不授予任何权限。

Enum values:

product

design

engineering

operations

project-management

other

secondaryRoles

ProjectRole[]

Enum values:

product

design

engineering

operations

project-management

other

设置projects · projectId · membership › Responses

请求成功

GenericResponse

获取projects · projectId · references

GET

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

/v1/projects/{projectId}/references

获取projects · projectId · references › path Parameters

projectId

string · required

获取projects · projectId · references › Responses

请求成功

ProjectReferenceDocumentListResponse

ProjectReferenceDocument[] · required

创建或执行projects · projectId · references

POST

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

/v1/projects/{projectId}/references

创建或执行projects · projectId · references › path Parameters

projectId

string · required

创建或执行projects · projectId · references › Request Body

file

string · required

创建或执行projects · projectId · references › Responses

请求成功

ProjectReferenceDocumentResponse

ProjectReferenceDocument · required

删除projects · projectId · references · referenceId

DELETE

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

/v1/projects/{projectId}/references/{referenceId}

删除projects · projectId · references · referenceId › path Parameters

projectId

string · required

referenceId

string · required

删除projects · projectId · references · referenceId › Responses

删除成功

No data returned

Account Sessions