/ Docs
APIPacks

Install Packs

Install pack versions on bots: every one, or none. Re-installing the version a bot already runs is `unchanged`. What the install could not bind by itself is reported in `setups`, each with the action it asks next (run it, a connect link, a secret to store, a server to choose); carry them on with the setups routes.

POST
/v1/orgs/{org_id}/packs/installs

Authorization

BearerAuth
AuthorizationBearer <token>

Botyard API key — see /docs/authentication.

In: header

Path Parameters

org_id*Org Id

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Pack versions to install, one per bot.

Response Body

application/json

curl -X POST "https://example.com/v1/orgs/string/packs/installs" \  -H "Content-Type: application/json" \  -d '{    "installs": [      {        "bot_id": "string",        "pack_version_id": "string"      }    ]  }'
{
  "installs": [
    {
      "bot_pack_install_id": "string",
      "plan": {
        "bot_id": "string",
        "pack_id": "string",
        "pack_version_id": "string",
        "status": "install",
        "bot_pack_install_id": "string",
        "support": {
          "level": "full",
          "unsupported": [
            {
              "reason": "string",
              "kind": "soul"
            }
          ]
        },
        "items": [
          {
            "action": "add",
            "reason": "string",
            "kind": "soul"
          }
        ],
        "connections": [
          {
            "pack_version_connection_id": "string",
            "action": "add",
            "reason": "string",
            "kind": "mcp_catalog_entry",
            "mcp_server_ids": [
              "string"
            ],
            "missing_tools": [
              "string"
            ],
            "unsupported_tools": [
              "string"
            ]
          }
        ],
        "recommended_model": {
          "provider": "botyard",
          "model": "string"
        }
      }
    }
  ],
  "setups": [
    {
      "bot_pack_install_id": "string",
      "pack_version_connection_id": "string",
      "bot_pack_connection_setup_id": "string",
      "action": {
        "kind": "setup_form",
        "mcp_catalog_entry_id": "string",
        "fields": [
          "string"
        ]
      },
      "state": "needs_input"
    }
  ]
}
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "error_code": "string",
  "errors": [
    {
      "pointer": "string",
      "detail": "string",
      "type": "string"
    }
  ],
  "trace_id": "string"
}