Runs

Server

Local action execution and recent run history.

Execute a runtime action.

POST

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

/v1/actions/{actionId}

Use the action catalog to discover provider-specific input and output schemas. For a compact strongly typed OpenAPI document for one action, request /openapi.json?actionId=. Requests with the same Idempotency-Key, action, input, effective connection, and stored runtime token identity replay the original HTTP status and body of completed successes and failures during the 24-hour replay window. Requests that are still in progress, or whose outcome is uncertain, are not automatically dispatched again. Duplicate suppression does not guarantee exactly-once execution by the provider.

Execute a runtime action. › path Parameters

actionId

string · required

Action id, usually ..

Execute a runtime action. › query Parameters

connectionName

string

Named connection. Same fact as MCP connectionName; HTTP alias, connectionName, and x-oo-connector-alias are equivalent. Defaults to default.

alias

string

Named connection. Same fact as MCP connectionName; HTTP alias, connectionName, and x-oo-connector-alias are equivalent. Defaults to default.

Execute a runtime action. › Headers

Idempotency-Key

string · minLength: 1

Optional runtime-wide key for deduplicating retries of the same action request. Leading and trailing whitespace is trimmed; the remaining value must be non-empty and must not exceed 255 UTF-8 bytes. Reuse a key only for retries with the same action, input, effective connection, and stored runtime token. When this header is present, the action input must not exceed an object/array nesting depth of 100 levels.

x-oo-connector-alias

string

Named connection. Same fact as MCP connectionName; HTTP alias, connectionName, and x-oo-connector-alias are equivalent. Defaults to default.

Execute a runtime action. › Request Body

Generic action run creation request.

object

Action input matching the catalog schema. Omitted input is treated as {}.

connectionName

string

Named connection. Same fact as MCP connectionName; HTTP alias, connectionName, and x-oo-connector-alias are equivalent. Defaults to default.

alias

string

Named connection. Same fact as MCP connectionName; HTTP alias, connectionName, and x-oo-connector-alias are equivalent. Defaults to default.

Execute a runtime action. › Responses

JSON response.

Runtime success envelope.

success

boolean · const · required

Const value:

message

string · const · required

Const value: OK

data

required

Action output matching the catalog schema.

object · required

Action execution metadata.

List recent local action runs.

GET

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

/api/runs

List recent local action runs. › query Parameters

limit

integer · min: 1 · max: 100

Maximum number of runs to return.

Default: 50

cursor

string

Cursor returned by the previous page.

service

string

Only return runs whose action id belongs to this service.

actionId

string · maxLength: 256

Only return runs for this exact action id.

caller

string · enum

Only return runs from this runtime entry point.

Enum values:

http

mcp

web

ok

boolean

Only return successful or failed runs.

List recent local action runs. › Responses

200

JSON response.

Paginated action run list.

RunLogPage

RunLog[] · required

Run entries for this page.

nextCursor

string

Cursor for the next page, when more runs are available.

GET/api/runs

curl https://capworks-api-docs.pages.dev/proxy/openconnector/api/runs

Example Responses

{
  "items": [
    {
      "id": "id",
      "service": "service",
      "actionId": "actionId",
      "caller": "caller",
      "startedAt": "startedAt",
      "completedAt": "completedAt",
      "durationMs": 0,
      "ok": true,
      "connectionProfile": {},
      "connectionId": "connectionId",
      "runtimeTokenId": "runtimeTokenId",
      "policy": {
        "allowed": true,
        "code": "action_not_allowed",
        "message": "message",
        "checks": [
          {
            "source": "deployment",
            "outcome": "allow_match",
            "rule": "rule"
          }
        ]
      },
      "inputSummary": {},
      "outputSummary": {},
      "errorCode": "errorCode",
      "errorMessage": "errorMessage"
    }
  ],
  "nextCursor": "nextCursor"
}

json

application/json

Get one local action run.

GET

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

/api/runs/{id}

Get one local action run. › path Parameters

id

string · required

Action execution identifier.

Get one local action run. › Responses

JSON response.

Recent action run entry.

RunLog

id

string · required

Run identifier.

service

string · required

Provider service that owns the executed action.

actionId

string · required

Executed action id.

caller

string · required

Runtime entry point that executed the run.

startedAt

string · required

Start timestamp.

completedAt

string · required

Completion timestamp.

durationMs

number · required

Run duration in milliseconds.

ok

boolean · required

Whether the run succeeded.

object

Provider account identity that the action used, when a connection was available.

connectionId

string

Stable connection identifier used by the run.

runtimeTokenId

string

Stored runtime token identifier used by the run.

PolicyDecision

Layered execution policy decision. code and message are present on denial.

inputSummary

Redacted action input summary.

outputSummary

Redacted action output summary.

errorCode

string

Error code when the run failed.

errorMessage

string

Error message when the run failed.

GET/api/runs/{id}

curl https://capworks-api-docs.pages.dev/proxy/openconnector/api/runs/:id

Example Responses

{
  "id": "id",
  "service": "service",
  "actionId": "actionId",
  "caller": "caller",
  "startedAt": "startedAt",
  "completedAt": "completedAt",
  "durationMs": 0,
  "ok": true,
  "connectionProfile": {},
  "connectionId": "connectionId",
  "runtimeTokenId": "runtimeTokenId",
  "policy": {
    "allowed": true,
    "code": "action_not_allowed",
    "message": "message",
    "checks": [
      {
        "source": "deployment",
        "outcome": "allow_match",
        "rule": "rule"
      }
    ]
  },
  "inputSummary": {},
  "outputSummary": {},
  "errorCode": "errorCode",
  "errorMessage": "errorMessage"
}

json

application/json

Files Proxy

Execute a runtime action.

POST

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

/v1/actions/{actionId}

Execute a runtime action. › path Parameters

actionId

string · required

Action id, usually ..

Execute a runtime action. › query Parameters

connectionName

string

Named connection. Same fact as MCP connectionName; HTTP alias, connectionName, and x-oo-connector-alias are equivalent. Defaults to default.

alias

string

Named connection. Same fact as MCP connectionName; HTTP alias, connectionName, and x-oo-connector-alias are equivalent. Defaults to default.

Execute a runtime action. › Headers

Idempotency-Key

string · minLength: 1

x-oo-connector-alias

string

Named connection. Same fact as MCP connectionName; HTTP alias, connectionName, and x-oo-connector-alias are equivalent. Defaults to default.

Execute a runtime action. › Request Body

Generic action run creation request.

object

Action input matching the catalog schema. Omitted input is treated as {}.

connectionName

string

Named connection. Same fact as MCP connectionName; HTTP alias, connectionName, and x-oo-connector-alias are equivalent. Defaults to default.

alias

string

Named connection. Same fact as MCP connectionName; HTTP alias, connectionName, and x-oo-connector-alias are equivalent. Defaults to default.

Execute a runtime action. › Responses

JSON response.

Runtime success envelope.

success

boolean · const · required

Const value:

message

string · const · required

Const value: OK

data

required

Action output matching the catalog schema.

object · required

Action execution metadata.

List recent local action runs.

GET

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

/api/runs

List recent local action runs. › query Parameters

limit

integer · min: 1 · max: 100

Maximum number of runs to return.

Default: 50

cursor

string

Cursor returned by the previous page.

service

string

Only return runs whose action id belongs to this service.

actionId

string · maxLength: 256

Only return runs for this exact action id.

caller

string · enum

Only return runs from this runtime entry point.

Enum values:

http

mcp

web

ok

boolean

Only return successful or failed runs.

List recent local action runs. › Responses

200

JSON response.

Paginated action run list.

RunLogPage

RunLog[] · required

Run entries for this page.

nextCursor

string

Cursor for the next page, when more runs are available.

Get one local action run.

GET

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

/api/runs/{id}

Get one local action run. › path Parameters

id

string · required

Action execution identifier.

Get one local action run. › Responses

JSON response.

Recent action run entry.

RunLog

id

string · required

Run identifier.

service

string · required

Provider service that owns the executed action.

actionId

string · required

Executed action id.

caller

string · required

Runtime entry point that executed the run.

startedAt

string · required

Start timestamp.

completedAt

string · required

Completion timestamp.

durationMs

number · required

Run duration in milliseconds.

ok

boolean · required

Whether the run succeeded.

object

Provider account identity that the action used, when a connection was available.

connectionId

string

Stable connection identifier used by the run.

runtimeTokenId

string

Stored runtime token identifier used by the run.

PolicyDecision

Layered execution policy decision. code and message are present on denial.

inputSummary

Redacted action input summary.

outputSummary

Redacted action output summary.

errorCode

string

Error code when the run failed.

errorMessage

string

Error message when the run failed.