Actions

Server

Download schema

创建或执行actions · actionId · approve

POST

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

/v1/actions/{actionId}/approve

创建或执行actions · actionId · approve › path Parameters

actionId

string · required

创建或执行actions · actionId · approve › Request Body

GenericRequest

创建或执行actions · actionId · approve › Responses

请求成功

ApproveExternalActionResponse

PreparedExternalAction · required

approvalToken

string · required

POST/v1/actions/{actionId}/approve

curl https://capworks-api-docs.pages.dev/proxy/capworks/v1/actions/:actionId/approve \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{}'

Example Request Body

{}

json

Example Responses

{
  "preparedAction": {
    "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"
  },
  "approvalToken": "approvalToken"
}

json

application/json

创建或执行actions · actionId · execute

POST

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

/v1/actions/{actionId}/execute

创建或执行actions · actionId · execute › path Parameters

actionId

string · required

创建或执行actions · actionId · execute › Request Body

ExecuteExternalActionRequest

approvalToken

string · required

创建或执行actions · actionId · execute › Responses

请求成功

ExecuteExternalActionResponse

PreparedExternalAction · required

ExternalActionReceipt · required

POST/v1/actions/{actionId}/execute

curl https://capworks-api-docs.pages.dev/proxy/capworks/v1/actions/:actionId/execute \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "approvalToken": "approvalToken"
}'

Example Request Body

{
  "approvalToken": "approvalToken"
}

json

Example Responses

{
  "preparedAction": {
    "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"
  },
  "receipt": {
    "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"
  }
}

json

application/json

创建或执行local runner · registrations

POST

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

/v1/local-runner/registrations

创建或执行local runner · registrations › Request Body

RegisterLocalRunnerRequest

installationId

Identifier · required

displayName

string · required

supportedRunners

LocalRunnerKind[] · required

Enum values:

codex

claude-code

object[] · required

publicSigningKey

string · required

创建或执行local runner · registrations › Responses

请求成功

GenericResponse

POST/v1/local-runner/registrations

curl https://capworks-api-docs.pages.dev/proxy/capworks/v1/local-runner/registrations \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "installationId": "installationId",
  "displayName": "displayName",
  "supportedRunners": [
    "codex"
  ],
  "authorizedRepositories": [
    {
      "projectId": "projectId",
      "displayName": "displayName",
      "absolutePath": "absolutePath"
    }
  ],
  "publicSigningKey": "publicSigningKey"
}'

Example Request Body

{
  "installationId": "installationId",
  "displayName": "displayName",
  "supportedRunners": [
    "codex"
  ],
  "authorizedRepositories": [
    {
      "projectId": "projectId",
      "displayName": "displayName",
      "absolutePath": "absolutePath"
    }
  ],
  "publicSigningKey": "publicSigningKey"
}

json

Example Responses

{}

json

application/json

获取local runner · signing key

GET

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

/v1/local-runner/signing-key

获取local runner · signing key › Responses

请求成功

GenericResponse

创建或执行local runner · tasks · taskId · complete

POST

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

/v1/local-runner/tasks/{taskId}/complete

创建或执行local runner · tasks · taskId · complete › path Parameters

taskId

string · required

创建或执行local runner · tasks · taskId · complete › Request Body

CompleteLocalRunnerTaskRequest

signature

string · required

status

string · enum · required

Enum values:

complete

failed

object

创建或执行local runner · tasks · taskId · complete › Responses

请求成功

GenericResponse

创建或执行local runner · tasks · claim

POST

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

/v1/local-runner/tasks/claim

创建或执行local runner · tasks · claim › Request Body

GenericRequest

创建或执行local runner · tasks · claim › Responses

请求成功

GenericResponse

Memory Integrations

CapWorks HTTP API

Actions

Server

Download schema

创建或执行actions · actionId · approve

POST

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

/v1/actions/{actionId}/approve

创建或执行actions · actionId · approve › path Parameters

actionId

string · required

创建或执行actions · actionId · approve › Request Body

GenericRequest

创建或执行actions · actionId · approve › Responses

请求成功

ApproveExternalActionResponse

PreparedExternalAction · required

approvalToken

string · required

POST/v1/actions/{actionId}/approve

curl https://capworks-api-docs.pages.dev/proxy/capworks/v1/actions/:actionId/approve \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{}'

Example Request Body

{}

json

Example Responses

{
  "preparedAction": {
    "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"
  },
  "approvalToken": "approvalToken"
}

json

application/json

创建或执行actions · actionId · execute

POST

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

/v1/actions/{actionId}/execute

创建或执行actions · actionId · execute › path Parameters

actionId

string · required

创建或执行actions · actionId · execute › Request Body

ExecuteExternalActionRequest

approvalToken

string · required

创建或执行actions · actionId · execute › Responses

请求成功

ExecuteExternalActionResponse

PreparedExternalAction · required

ExternalActionReceipt · required

POST/v1/actions/{actionId}/execute

curl https://capworks-api-docs.pages.dev/proxy/capworks/v1/actions/:actionId/execute \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "approvalToken": "approvalToken"
}'

Example Request Body

{
  "approvalToken": "approvalToken"
}

json

Example Responses

{
  "preparedAction": {
    "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"
  },
  "receipt": {
    "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"
  }
}

json

application/json

创建或执行local runner · registrations

POST

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

/v1/local-runner/registrations

创建或执行local runner · registrations › Request Body

RegisterLocalRunnerRequest

installationId

Identifier · required

displayName

string · required

supportedRunners

LocalRunnerKind[] · required

Enum values:

codex

claude-code

object[] · required

publicSigningKey

string · required

创建或执行local runner · registrations › Responses

请求成功

GenericResponse

POST/v1/local-runner/registrations

curl https://capworks-api-docs.pages.dev/proxy/capworks/v1/local-runner/registrations \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "installationId": "installationId",
  "displayName": "displayName",
  "supportedRunners": [
    "codex"
  ],
  "authorizedRepositories": [
    {
      "projectId": "projectId",
      "displayName": "displayName",
      "absolutePath": "absolutePath"
    }
  ],
  "publicSigningKey": "publicSigningKey"
}'

Example Request Body

{
  "installationId": "installationId",
  "displayName": "displayName",
  "supportedRunners": [
    "codex"
  ],
  "authorizedRepositories": [
    {
      "projectId": "projectId",
      "displayName": "displayName",
      "absolutePath": "absolutePath"
    }
  ],
  "publicSigningKey": "publicSigningKey"
}

json

Example Responses

{}

json

application/json

获取local runner · signing key

GET

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

/v1/local-runner/signing-key

获取local runner · signing key › Responses

请求成功

GenericResponse

创建或执行local runner · tasks · taskId · complete

POST

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

/v1/local-runner/tasks/{taskId}/complete

创建或执行local runner · tasks · taskId · complete › path Parameters

taskId

string · required

创建或执行local runner · tasks · taskId · complete › Request Body

CompleteLocalRunnerTaskRequest

signature

string · required

status

string · enum · required

Enum values:

complete

failed

object

创建或执行local runner · tasks · taskId · complete › Responses

请求成功

GenericResponse

创建或执行local runner · tasks · claim

POST

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

/v1/local-runner/tasks/claim

创建或执行local runner · tasks · claim › Request Body

GenericRequest

创建或执行local runner · tasks · claim › Responses

请求成功

GenericResponse

Memory Integrations