sdkHosted AI, explicit consent

Activate brief

pipeline.activateBrief

Run the brief: validate it (launch-mode gate), flip it to active, and provision its agent-pipeline enrichment table. scoutExecutionMode defaults to manual, which pauses before hosted Scout work. pipeline_hosted enqueues Scout and requires allowHostedAi=true. A brief that fails always-broken validation is refused (422) unless force=true. Returns { activated, briefId, status, alreadyActive, scoutEnqueued, scoutPaused, scoutExecutionMode, warnings }.

Parameters

workspaceId

string

Optional with an API key (inferred from the key).

briefIdrequired

string

The campaign brief to activate.

force

boolean

Activate even if the validator reports errors.

scoutExecutionMode

string

Defaults to manual so coding-agent subscription workflows do not enqueue hosted Scout execution.

pipeline_hosted | manual

allowHostedAi

boolean

Must be true when this operation uses Pipeline hosted inference.

Example

TypeScripttypescript

await pipeline.activateBrief({
  "briefId": "00000000-0000-4000-8000-000000000000",
  "allowHostedAi": true
})

Response

Success response schemajson schema

{
  "type": "object",
  "properties": {
    "activated": {
      "type": "boolean"
    },
    "briefId": {
      "type": "string"
    },
    "status": {
      "type": "string"
    },
    "alreadyActive": {
      "type": "boolean"
    },
    "scoutEnqueued": {
      "type": "boolean"
    },
    "scoutPaused": {
      "type": "boolean"
    },
    "scoutExecutionMode": {
      "type": "string",
      "enum": [
        "pipeline_hosted",
        "manual"
      ]
    },
    "warnings": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "campaignReadiness": {
      "type": "object",
      "properties": {
        "ready": {
          "type": "boolean"
        },
        "campaignPackageId": {
          "type": "string"
        },
        "missing": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "nextActions": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "action": {
                "type": "string"
              },
              "reason": {
                "type": "string"
              }
            },
            "required": [
              "action",
              "reason"
            ]
          }
        }
      },
      "required": [
        "ready",
        "missing",
        "nextActions"
      ]
    }
  },
  "required": [
    "activated",
    "briefId",
    "status",
    "alreadyActive",
    "scoutEnqueued",
    "scoutPaused",
    "scoutExecutionMode",
    "warnings",
    "campaignReadiness"
  ]
}

Exceptions

PipelineError: Thrown for validation, authentication, JSON-RPC, HTTP, and network failures. Inspect code and data when present.