Account

Server

Download schema

设置account · avatar

PUT

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

/v1/account/avatar

设置account · avatar › Request Body

GenericRequest

设置account · avatar › Responses

请求成功

GenericResponse

创建或执行account · bootstrap

POST

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

/v1/account/bootstrap

创建或执行account · bootstrap › Request Body

AccountBootstrapRequest

inviteToken

string

创建或执行account · bootstrap › Responses

请求成功

AccountBootstrapResponse

CurrentAccountResponse · required

isNewAccount

boolean · required

joinedWorkspaceFromInvite

boolean · required

invitedProjectId

Identifier

POST/v1/account/bootstrap

curl https://capworks-api-docs.pages.dev/proxy/capworks/v1/account/bootstrap \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "inviteToken": "inviteToken"
}'

Example Request Body

{
  "inviteToken": "inviteToken"
}

json

Example Responses

{
  "account": {
    "user": {
      "accessRole": "owner",
      "contentPermission": "edit",
      "id": "id",
      "workspaceId": "workspaceId",
      "displayName": "displayName",
      "email": "email",
      "avatarURL": "avatarURL",
      "roles": [
        "owner"
      ],
      "jobRole": "product",
      "jobRoleConfirmedAt": "jobRoleConfirmedAt",
      "locale": "en"
    },
    "workspace": {
      "id": "id",
      "name": "name"
    },
    "workspaces": [
      {
        "id": "id",
        "name": "name",
        "accessRole": "owner",
        "contentPermission": "edit",
        "jobRole": "product"
      }
    ],
    "authentication": {
      "kind": "email",
      "expiresAt": "expiresAt"
    },
    "features": {
      "liveWorkbench": true
    }
  },
  "isNewAccount": true,
  "joinedWorkspaceFromInvite": true,
  "invitedProjectId": "invitedProjectId"
}

json

application/json

获取account · current

GET

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

/v1/account/current

获取account · current › Responses

请求成功

CurrentAccountResponse

object · required

WorkspaceSummary[] · required

object · required

object

服务端发布开关；旧服务端缺失时客户端必须按关闭处理。

GET/v1/account/current

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

Example Responses

{
  "user": {
    "accessRole": "owner",
    "contentPermission": "edit",
    "id": "id",
    "workspaceId": "workspaceId",
    "displayName": "displayName",
    "email": "email",
    "avatarURL": "avatarURL",
    "roles": [
      "owner"
    ],
    "jobRole": "product",
    "jobRoleConfirmedAt": "jobRoleConfirmedAt",
    "locale": "en"
  },
  "workspace": {
    "id": "id",
    "name": "name"
  },
  "workspaces": [
    {
      "id": "id",
      "name": "name",
      "accessRole": "owner",
      "contentPermission": "edit",
      "jobRole": "product"
    }
  ],
  "authentication": {
    "kind": "email",
    "expiresAt": "expiresAt"
  },
  "features": {
    "liveWorkbench": true
  }
}

json

application/json

更新account · profile

PATCH

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

/v1/account/profile

更新account · profile › Request Body

GenericRequest

更新account · profile › Responses

请求成功

GenericResponse

创建或执行action recommendations · recommendationId · prepare

POST

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

/v1/action-recommendations/{recommendationId}/prepare

创建或执行action recommendations · recommendationId · prepare › path Parameters

recommendationId

string · required

创建或执行action recommendations · recommendationId · prepare › Request Body

GenericRequest

创建或执行action recommendations · recommendationId · prepare › Responses

请求成功

GenericResponse

获取conversations · conversationId · events

GET

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

/v1/conversations/{conversationId}/events

获取conversations · conversationId · events › path Parameters

conversationId

string · required

获取conversations · conversationId · events › Responses

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

No data returned

获取public · authentication providers

GET

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

/v1/public/authentication-providers

获取public · authentication providers › Responses

请求成功

GenericResponse

System Projects

CapWorks HTTP API

Account

Server

Download schema

设置account · avatar

PUT

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

/v1/account/avatar

设置account · avatar › Request Body

GenericRequest

设置account · avatar › Responses

请求成功

GenericResponse

创建或执行account · bootstrap

POST

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

/v1/account/bootstrap

创建或执行account · bootstrap › Request Body

AccountBootstrapRequest

inviteToken

string

创建或执行account · bootstrap › Responses

请求成功

AccountBootstrapResponse

CurrentAccountResponse · required

isNewAccount

boolean · required

joinedWorkspaceFromInvite

boolean · required

invitedProjectId

Identifier

POST/v1/account/bootstrap

curl https://capworks-api-docs.pages.dev/proxy/capworks/v1/account/bootstrap \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "inviteToken": "inviteToken"
}'

Example Request Body

{
  "inviteToken": "inviteToken"
}

json

Example Responses

{
  "account": {
    "user": {
      "accessRole": "owner",
      "contentPermission": "edit",
      "id": "id",
      "workspaceId": "workspaceId",
      "displayName": "displayName",
      "email": "email",
      "avatarURL": "avatarURL",
      "roles": [
        "owner"
      ],
      "jobRole": "product",
      "jobRoleConfirmedAt": "jobRoleConfirmedAt",
      "locale": "en"
    },
    "workspace": {
      "id": "id",
      "name": "name"
    },
    "workspaces": [
      {
        "id": "id",
        "name": "name",
        "accessRole": "owner",
        "contentPermission": "edit",
        "jobRole": "product"
      }
    ],
    "authentication": {
      "kind": "email",
      "expiresAt": "expiresAt"
    },
    "features": {
      "liveWorkbench": true
    }
  },
  "isNewAccount": true,
  "joinedWorkspaceFromInvite": true,
  "invitedProjectId": "invitedProjectId"
}

json

application/json

获取account · current

GET

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

/v1/account/current

获取account · current › Responses

请求成功

CurrentAccountResponse

object · required

WorkspaceSummary[] · required

object · required

object

服务端发布开关；旧服务端缺失时客户端必须按关闭处理。

GET/v1/account/current

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

Example Responses

{
  "user": {
    "accessRole": "owner",
    "contentPermission": "edit",
    "id": "id",
    "workspaceId": "workspaceId",
    "displayName": "displayName",
    "email": "email",
    "avatarURL": "avatarURL",
    "roles": [
      "owner"
    ],
    "jobRole": "product",
    "jobRoleConfirmedAt": "jobRoleConfirmedAt",
    "locale": "en"
  },
  "workspace": {
    "id": "id",
    "name": "name"
  },
  "workspaces": [
    {
      "id": "id",
      "name": "name",
      "accessRole": "owner",
      "contentPermission": "edit",
      "jobRole": "product"
    }
  ],
  "authentication": {
    "kind": "email",
    "expiresAt": "expiresAt"
  },
  "features": {
    "liveWorkbench": true
  }
}

json

application/json

更新account · profile

PATCH

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

/v1/account/profile

更新account · profile › Request Body

GenericRequest

更新account · profile › Responses

请求成功

GenericResponse

创建或执行action recommendations · recommendationId · prepare

POST

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

/v1/action-recommendations/{recommendationId}/prepare

创建或执行action recommendations · recommendationId · prepare › path Parameters

recommendationId

string · required

创建或执行action recommendations · recommendationId · prepare › Request Body

GenericRequest

创建或执行action recommendations · recommendationId · prepare › Responses

请求成功

GenericResponse

获取conversations · conversationId · events

GET

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

/v1/conversations/{conversationId}/events

获取conversations · conversationId · events › path Parameters

conversationId

string · required

获取conversations · conversationId · events › Responses

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

No data returned

获取public · authentication providers

GET

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

/v1/public/authentication-providers

获取public · authentication providers › Responses

请求成功

GenericResponse

System Projects