Operations
Operations

Connect an app (workspace)

Begin connecting an app at the WORKSPACE level and return an authorization link to finish. Connecting alone arms NO agent, the account exists but every agent still loads nothing until it has its own opt-in. Pass shareWithAllAgents: true to give the account to every agent in the workspace as the connect completes. One-click (platform-managed sign-in) and bring-your-own-KEY apps connect through here and return { redirectUrl, status:'pending' } (open the link, then poll list_workspace_connections). Apps needing the operator's OWN OAuth-app credentials can't be connected through a model tool, they return { needsSecret:true, settingsUrl } pointing to Connected apps in the app, which collects them (secrets never pass through this tool). Requires workspace-admin.

POST
/operations/connect_workspace_app

Authorization

bearerAuth
AuthorizationBearer <token>

A personal access token from Settings > API tokens.

In: header

Header Parameters

Idempotency-Key?string

A key you choose, such as a UUID, that makes this POST safe to retry. Within 24 hours the same key and request answers with the first successful answer and runs nothing, the same key with a different request answers 422 idempotency_key_reused, and a key whose request is still running answers 409 idempotency_key_in_use. A failed request keeps nothing, so the same key runs it again.

Length1 <= length <= 255

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X POST "https://example.com/operations/connect_workspace_app" \  -H "Content-Type: application/json" \  -d '{    "workspace": "string",    "toolkit": "string"  }'
{}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "code": "string",
  "errors": [
    {
      "path": "string",
      "message": "string"
    }
  ],
  "estimate": {},
  "retryAfterSeconds": 0
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "code": "string",
  "errors": [
    {
      "path": "string",
      "message": "string"
    }
  ],
  "estimate": {},
  "retryAfterSeconds": 0
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "code": "string",
  "errors": [
    {
      "path": "string",
      "message": "string"
    }
  ],
  "estimate": {},
  "retryAfterSeconds": 0
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "code": "string",
  "errors": [
    {
      "path": "string",
      "message": "string"
    }
  ],
  "estimate": {},
  "retryAfterSeconds": 0
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "code": "string",
  "errors": [
    {
      "path": "string",
      "message": "string"
    }
  ],
  "estimate": {},
  "retryAfterSeconds": 0
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "code": "string",
  "errors": [
    {
      "path": "string",
      "message": "string"
    }
  ],
  "estimate": {},
  "retryAfterSeconds": 0
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "code": "string",
  "errors": [
    {
      "path": "string",
      "message": "string"
    }
  ],
  "estimate": {},
  "retryAfterSeconds": 0
}

Connect Slack channel POST

Connect a Slack channel so call alerts and metric alerts can post to it. Takes the channel's incoming-webhook URL from Slack (Apps → Incoming Webhooks) and returns the channel's `id`, which is what `slackChannelIds` on create_call_alert/update_call_alert accepts. The URL is encrypted before it is stored: it is never returned by this op, never echoed in the approval summary, and no op or model can read it back, only the alert delivery path decrypts it. A URL that is not on https://hooks.slack.com/ is refused rather than stored, because it could never deliver. Requires workspace-admin access. Call list_call_alerts first to see the channels already connected (under `slackChannels`) so you don't connect a duplicate.

Copy variables POST

Copy variables from another agent in the same workspace onto this agent's draft. `agent` is the TARGET; `fromAgent` is the SOURCE. Copies plain, secret and default-only variables from the version the source runs live (its published version, or its latest version when none is published). Secret values are read and stored again server-side in the target's own secret store and are never returned, so use this to give an agent the credentials its tools reference (for example a booking API key) without anyone entering them again. Pass `names` to copy only those variables; a name the source does not have fails the call before anything is written. A name the target already has is left as it is and listed under `skipped` unless `overwrite` is true. Even with `overwrite`, a name the target holds as default-only while the source holds it as plain or secret, or the reverse, is skipped with the reason. Overwriting a secret changes only the target's draft; its other versions keep their own values. A variable that cannot be written, such as a secret with no value saved on the source, is listed under `failed` with the reason, and the rest are still copied. The result lists each copied name with its kind, never a value. You need edit access to both agents, and the target must be a draft: call create_draft first if its latest version is published. To make a new agent from an existing one, use duplicate_agent, which copies the variables itself.