Docs / Reference / act: install connector

act: install connector.

The connector, the ways chosen, and the identity for each to an installed connector, ready or not ready with its reason

Figure 1POST /v1/act/install_connectorspecified

The caller sends InstallConnectorInput to /v1/act/install_connector. The platform returns a card whose body is InstalledConnector.

POST/v1/act/install_connector

Install a connector. The call needs the brand rung under a token with the act grant, and it is served by the platform.

The route takes InstallConnectorInput and returns a card whose body is InstalledConnector.

Request body#

The request body is InstallConnectorInput.

field	type	required	note
`installed`	InstalledConnector	yes

Response#

The route returns a card whose body is InstalledConnector. Every card ends with a foot that states the basis of each number, the scope of the call, and the time when the facts were true.

Headers#

header	required	meaning
`Scale-Scope`	yes	the scope the call runs in: tenant/, then /brand/, then /strategy/
`Scale-As-True-On`	no	the date the facts must have been true on; defaults to now
`Scale-As-Known-On`	no	the date the facts must have been known on; defaults to now
`Scale-Key`	no	for a change, the key made from the input; a repeat under the same key returns the unit held and writes nothing

A caller needs the brand rung and a token with the act grant. The platform serves this route.

Example#

The example sends the smallest body that InstallConnectorInput allows. The build validates it against the schema of InstallConnectorInput.

Example

curl -X POST https://api.scaleintelligence.co/v1/act/install_connector \
  -H "Scale-Key: $SCALE_KEY" -H "Scale-Scope: tenant/<id>" \
  -H "content-type: application/json" \
  -d '{ "installed": { "connector": "…", "ways": [], "identity": "…", "settings": null, "state": { "ready": false, "since": "…" } } }'

import { client } from "@scale/sdk";
const answer = await client.act.install_connector({
    "installed": {
      "connector": "…",
      "ways": [],
      "identity": "…",
      "settings": null,
      "state": {
        "ready": false,
        "since": "…"
      }
    }
  });
// answer.body is a InstalledConnector. answer.foot holds the basis, the scope and the time.

import requests
answer = requests.post("https://api.scaleintelligence.co/v1/act/install_connector",
    headers={"Scale-Key": KEY, "Scale-Scope": "tenant/<id>"},
    json={
      "installed": {
        "connector": "…",
        "ways": [],
        "identity": "…",
        "settings": null,
        "state": {
          "ready": false,
          "since": "…"
        }
      }
    }).json()

let answer: Card = client.post("https://api.scaleintelligence.co/v1/act/install_connector")
    .header("Scale-Key", key).header("Scale-Scope", "tenant/<id>")
    .json(&InstallConnectorInput { /* the fields of the page */ }).send().await?.json().await?;

MCP tool#

The MCP tool si.act.install_connector takes the same input and returns the same card. The tool changes data and needs a grant. An MCP host that renders cards draws this card from ui://scale-intelligence/cards/InstalledConnector. The tool’s page describes it.

POST /v1/act/install_connector
Scale-Scope: …
Scale-As-True-On: …
Scale-As-Known-On: …
Scale-Key: …
content-type: application/json

{
  "installed": {
    "connector": "…",
    "ways": [],
    "identity": "…",
    "settings": null,
    "state": {
      "ready": false,
      "since": "…"
    }
  }
}

Without a key, this page shows the request only. The request body is InstallConnectorInput, and the route returns a card whose body is InstalledConnector.

Claims#

claim	state	route or tool
The platform serves the route /v1/act/install_connector at contract 0476e35e6e275db5.	target	`/v1/act/install_connector`