开始使用
API Reference
维护与部署
Information
System
获取 · healthz
get
Account
设置account · avatar
put
创建或执行account · bootstrap
post
获取account · current
get
更新account · profile
patch
创建或执行action recommendations · recommendationId · prepare
post
获取conversations · conversationId · events
get
获取public · authentication providers
get
Projects
获取projects
get
创建或执行projects
post
获取projects · projectId
get
更新projects · projectId
patch
获取projects · projectId · members
get
获取projects · projectId · membership
get
设置projects · projectId · membership
put
获取projects · projectId · references
get
创建或执行projects · projectId · references
post
删除projects · projectId · references · referenceId
delete
Sessions
获取assets · assetId
get
获取sessions
get
创建或执行sessions
post
获取sessions · sessionId
get
删除sessions · sessionId
delete
更新sessions · sessionId
patch
创建或执行sessions · sessionId · audio
post
创建或执行sessions · sessionId · end
post
获取sessions · sessionId · events
get
创建或执行sessions · sessionId · new project
post
创建或执行sessions · sessionId · pause
post
获取sessions · sessionId · pilot lifecycle
get
创建或执行sessions · sessionId · rebuild workset
post
创建或执行sessions · sessionId · resume
post
获取sessions · sessionId · share
get
创建或执行sessions · sessionId · share
post
删除sessions · sessionId · share
delete
创建或执行sessions · sessionId · speakers
post
创建或执行sessions · sessionId · transcript summary
post
获取sessions · sessionId · transcription stream
get
创建或执行sessions · sessionId · transcripts
post
删除sessions · sessionId · transcripts · segmentId
delete
获取sessions · sessionId · work refinement
get
获取sessions · pilot candidates
get
获取shares · shareToken
get
创建或执行shares · shareToken · comments
post
Work
获取conversations · conversationId · workset
get
创建或执行sessions · sessionId · workobjects
post
创建或执行sessions · sessionId · workobjects · project suggestions
post
获取sessions · sessionId · workset
get
更新sessions · sessionId · workset
patch
获取sessions · sessionId · worksets
get
获取work objects · workObjectId · action recommendations
get
创建或执行work objects · workObjectId · action recommendations · refresh
post
创建或执行work sets · workSetId · action recommendations · draft
post
创建或执行work sets · workSetId · action recommendations · refresh
post
更新workobjects · workObjectId
patch
创建或执行workobjects · workObjectId · assignment
post
获取workobjects · workObjectId · comments
get
创建或执行workobjects · workObjectId · comments
post
更新workobjects · workObjectId · comments · commentId
patch
更新workobjects · workObjectId · proposal
patch
更新workobjects · workObjectId · responsibility
patch
获取workobjects · workObjectId · revisions
get
更新workobjects · workObjectId · stage
patch
获取worksets · workSetId
get
Memory
创建或执行projects · projectId · external context · query
post
获取projects · projectId · memory
get
创建或执行projects · projectId · memory · claims
post
创建或执行projects · projectId · memory · codebase
post
创建或执行projects · projectId · memory · conflicts · conflictId · resolve
post
创建或执行projects · projectId · memory · external sources
post
创建或执行projects · projectId · memory · search
post
获取projects · projectId · memory · sources
get
获取projects · projectId · memory · sources · sourceId
get
删除projects · projectId · memory · sources · sourceId
delete
创建或执行search · answer
post
获取search · sessions
get
Actions
创建或执行actions · actionId · approve
post
创建或执行actions · actionId · execute
post
创建或执行local runner · registrations
post
获取local runner · signing key
get
创建或执行local runner · tasks · taskId · complete
post
创建或执行local runner · tasks · claim
post
Integrations
获取agent · external tools
get
创建或执行agent · external tools · toolName
post
获取executions · executionId
get
设置integrations · access
put
获取integrations · actions · actionId
get
创建或执行integrations · actions · field options
post
创建或执行integrations · actions · prepare
post
获取integrations · actions · search
get
获取integrations · connections
get
删除integrations · connections · connectionId
delete
创建或执行integrations · connections · credential
post
创建或执行integrations · connections · oauth
post
创建或执行integrations · openconnector · admin session
post
获取integrations · providers
get
获取integrations · providers · service · actions
get
Workspace
获取collaboration · notifications
get
更新collaboration · notifications
patch
获取invitations · invitationToken
get
创建或执行invitations · invitationToken · accept
post
创建或执行invitations · invitationToken · login intent
post
创建或执行workspace · invitations
post
删除workspace · invitations · invitationId
delete
创建或执行workspace · invitations · invitationId · resend
post
获取workspace · members
get
删除workspace · members · userId
delete
更新workspace · members · userId
patch
创建或执行workspace · presence
post
创建或执行workspaces · workspaceId · switch
post
Reviews
获取reviews
get
创建或执行reviews · reviewId · assignment
post
创建或执行reviews · reviewId · claim
post
创建或执行reviews · reviewId · decisions
post
创建或执行reviews · reviewId · request
post
Voice
获取account · voice profile
get
删除account · voice profile
delete
创建或执行account · voice profile · enrollments
post
设置account · voice profile · enrollments · enrollmentId
put
获取account · voice profile · models · modelVersion
get
创建或执行sessions · sessionId · speakers · speakerId · voice opt out
post
获取workspace · voice identities
get
获取workspace · voice identities · identityId
get
删除workspace · voice identities · identityId
delete
更新workspace · voice identities · identityId
patch
创建或执行workspace · voice identities · identityId · merge
post
获取workspace · voice identities · identityId · preview
get
创建或执行workspace · voice identities · identityId · split
post
获取workspace · voice identities · model
get
获取workspace · voice identities · model · download
get
Billing
获取billing
get
创建或执行billing · checkout
post
创建或执行billing · portal
post
创建或执行billing · webhook
post
Schemas
powered by Zudoku
Menu
CapWorks HTTP API
CapWorks HTTP API
System
Server
https://capworks-api-docs.pages.dev/proxy/capworks
http://localhost:8787
Download schema
获取 · healthz
GET
https://capworks-api-docs.pages.dev/proxy/capworks
/healthz
获取 · healthz ›
Responses
200
400
401
500
请求成功
GenericResponse
Account
