Strategy / TypeScript SDK
Activate brief
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 }.
pipeline.activateBriefBackend AI, consent requiredParameters
workspaceIdOptional · string- Optional with an API key (inferred from the key).
briefIdRequired · string- The campaign brief to activate.
forceOptional · boolean- Activate even if the validator reports errors.
scoutExecutionModeOptional · string- Defaults to manual so coding-agent subscription workflows do not enqueue hosted Scout execution.pipeline_hosted · manual
allowHostedAiOptional · boolean- Must be true when this operation uses Pipeline hosted inference.
await pipeline.activateBrief({
"briefId": "00000000-0000-4000-8000-000000000000",
"allowHostedAi": true
})Full input schema
{
"type": "object",
"properties": {
"workspaceId": {
"type": "string",
"description": "Optional with an API key (inferred from the key)."
},
"briefId": {
"type": "string",
"description": "The campaign brief to activate."
},
"force": {
"type": "boolean",
"description": "Activate even if the validator reports errors."
},
"scoutExecutionMode": {
"type": "string",
"enum": [
"pipeline_hosted",
"manual"
],
"description": "Defaults to manual so coding-agent subscription workflows do not enqueue hosted Scout execution."
},
"allowHostedAi": {
"type": "boolean",
"description": "Must be true when this operation uses Pipeline hosted inference."
}
},
"required": [
"briefId"
]
}