Integrations

Server

Download schema

获取agent · external tools

GET

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

/v1/agent/external-tools

获取agent · external tools › Responses

请求成功

GenericResponse

创建或执行agent · external tools · toolName

POST

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

/v1/agent/external-tools/{toolName}

创建或执行agent · external tools · toolName › path Parameters

toolName

string · required

创建或执行agent · external tools · toolName › Request Body

GenericRequest

创建或执行agent · external tools · toolName › Responses

请求成功

GenericResponse

获取executions · executionId

GET

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

/v1/executions/{executionId}

获取executions · executionId › path Parameters

executionId

string · required

获取executions · executionId › Responses

请求成功

GenericResponse

设置integrations · access

PUT

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

/v1/integrations/access

设置integrations · access › Request Body

UpdateIntegrationAccessRequest

projectId

Identifier · required

connectionIds

string[]

actionIds

string[]

object[]

设置integrations · access › Responses

请求成功

GenericResponse

PUT/v1/integrations/access

curl https://capworks-api-docs.pages.dev/proxy/capworks/v1/integrations/access \
  --request PUT \
  --header 'Content-Type: application/json' \
  --data '{
  "projectId": "projectId",
  "connectionIds": [
    "string"
  ],
  "actionIds": [
    "string"
  ],
  "connectionGrants": [
    {
      "connectionId": "connectionId",
      "actionIds": [
        "string"
      ],
      "autoReadActionIds": [
        "string"
      ]
    }
  ]
}'

Example Request Body

{
  "projectId": "projectId",
  "connectionIds": [
    "string"
  ],
  "actionIds": [
    "string"
  ],
  "connectionGrants": [
    {
      "connectionId": "connectionId",
      "actionIds": [
        "string"
      ],
      "autoReadActionIds": [
        "string"
      ]
    }
  ]
}

json

Example Responses

{}

json

application/json

获取integrations · actions · actionId

GET

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

/v1/integrations/actions/{actionId}

获取integrations · actions · actionId › path Parameters

actionId

string · required

获取integrations · actions · actionId › Responses

请求成功

IntegrationActionDescriptorResponse

IntegrationActionDescriptor · required

创建或执行integrations · actions · field options

POST

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

/v1/integrations/actions/field-options

创建或执行integrations · actions · field options › Request Body

ResolveIntegrationActionFieldOptionsRequest

projectId

Identifier · required

connectionId

string · required

actionId

string · required

field

string · required

object · required

query

string

创建或执行integrations · actions · field options › Responses

请求成功

ResolveIntegrationActionFieldOptionsResponse

field

string · required

IntegrationActionFieldOption[] · required

sourceActionId

string

POST/v1/integrations/actions/field-options

curl https://capworks-api-docs.pages.dev/proxy/capworks/v1/integrations/actions/field-options \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "projectId": "projectId",
  "connectionId": "connectionId",
  "actionId": "actionId",
  "field": "field",
  "input": {
    "key": "string"
  },
  "query": "query"
}'

Example Request Body

{
  "projectId": "projectId",
  "connectionId": "connectionId",
  "actionId": "actionId",
  "field": "field",
  "input": {
    "key": "string"
  },
  "query": "query"
}

json

Example Responses

{
  "field": "field",
  "options": [
    {
      "value": "value",
      "label": "label",
      "description": "description"
    }
  ],
  "sourceActionId": "sourceActionId"
}

json

application/json

创建或执行integrations · actions · prepare

POST

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

/v1/integrations/actions/prepare

创建或执行integrations · actions · prepare › Request Body

PrepareExternalActionRequest

projectId

Identifier · required

actionId

string · required

connectionId

string · required

object · required

workObjectId

Identifier

sourceRevisionId

Identifier

recommendationId

Identifier

创建或执行integrations · actions · prepare › Responses

请求成功

PrepareExternalActionResponse

PreparedExternalAction · required

POST/v1/integrations/actions/prepare

curl https://capworks-api-docs.pages.dev/proxy/capworks/v1/integrations/actions/prepare \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "projectId": "projectId",
  "actionId": "actionId",
  "connectionId": "connectionId",
  "input": {
    "key": "string"
  },
  "workObjectId": "workObjectId",
  "sourceRevisionId": "sourceRevisionId",
  "recommendationId": "recommendationId"
}'

Example Request Body

{
  "projectId": "projectId",
  "actionId": "actionId",
  "connectionId": "connectionId",
  "input": {
    "key": "string"
  },
  "workObjectId": "workObjectId",
  "sourceRevisionId": "sourceRevisionId",
  "recommendationId": "recommendationId"
}

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

json

application/json

获取integrations · actions · search

GET

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

/v1/integrations/actions/search

获取integrations · actions · search › query Parameters

q

string

获取integrations · actions · search › Responses

请求成功

IntegrationActionSearchResponse

IntegrationActionCard[] · required

获取integrations · connections

GET

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

/v1/integrations/connections

获取integrations · connections › Responses

请求成功

IntegrationConnectionListResponse

IntegrationConnectionCard[] · required

删除integrations · connections · connectionId

DELETE

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

/v1/integrations/connections/{connectionId}

删除integrations · connections · connectionId › path Parameters

connectionId

string · required

删除integrations · connections · connectionId › Responses

删除成功

No data returned

创建或执行integrations · connections · credential

POST

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

/v1/integrations/connections/credential

创建或执行integrations · connections · credential › Request Body

CreateIntegrationCredentialRequest

projectId

Identifier · required

service

string · required

authType

string · enum · required

Enum values:

api_key

custom_credential

no_auth

object · required

actionIds

string[]

创建或执行integrations · connections · credential › Responses

请求成功

GenericResponse

创建或执行integrations · connections · oauth

POST

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

/v1/integrations/connections/oauth

创建或执行integrations · connections · oauth › Request Body

StartIntegrationOAuthRequest

projectId

Identifier · required

service

string · required

actionIds

string[]

创建或执行integrations · connections · oauth › Responses

请求成功

StartIntegrationOAuthResponse

authorizationURL

string · required

connectionAlias

string · required

expiresAt

ISO8601Timestamp · required

创建或执行integrations · openconnector · admin session

POST

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

/v1/integrations/openconnector/admin-session

创建或执行integrations · openconnector · admin session › Request Body

GenericRequest

创建或执行integrations · openconnector · admin session › Responses

请求成功

GenericResponse

获取integrations · providers

GET

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

/v1/integrations/providers

获取integrations · providers › Responses

请求成功

IntegrationProviderListResponse

IntegrationProviderCard[] · required

GET/v1/integrations/providers

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

Example Responses

{
  "providers": [
    {
      "service": "service",
      "displayName": "displayName",
      "iconURL": "iconURL",
      "homepageURL": "homepageURL",
      "description": "description",
      "categories": [
        {
          "id": "id",
          "displayName": "displayName"
        }
      ],
      "scenario": "scenario",
      "authTypes": [
        "string"
      ],
      "capabilityCount": 0,
      "capabilityHighlights": [
        {
          "name": "name",
          "description": "description"
        }
      ],
      "locallyExecutable": true,
      "auth": [
        {
          "type": "no_auth",
          "configured": true,
          "fields": [
            {
              "key": "key",
              "label": "label",
              "inputType": "text",
              "required": true,
              "secret": true,
              "placeholder": "placeholder",
              "description": "description",
              "defaultValue": "defaultValue"
            }
          ]
        }
      ]
    }
  ]
}

json

application/json

获取integrations · providers · service · actions

GET

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

/v1/integrations/providers/{service}/actions

获取integrations · providers · service · actions › path Parameters

service

string · required

获取integrations · providers · service · actions › Responses

请求成功

IntegrationProviderActionListResponse

IntegrationActionCard[] · required

Actions Workspace