Campaign Briefs / CLI

Run icp canary gate

Run the canary quality gate for a brief after ICP scoring a sample. Computes the shared list-quality scorecard, persists latestScorecard, and returns pass/fail evidence so Scout can scale, pause, or ask for another ICP tuning round.

pipeline run-icp-canary-gateDeterministic operation

Parameters

workspaceIdOptional · string
Optional workspace ID or slug. Required when this credential can access multiple workspaces and no workspace was configured on the client.
briefIdRequired · string
Campaign brief id.
requireIcpScoredRowsOptional · boolean
Default true. When true, returns a reason instead of scoring unscored rows.
Request example
pipeline run-icp-canary-gate \
  --brief-id "00000000-0000-4000-8000-000000000000"
Full input schema
Input schema
{
  "type": "object",
  "properties": {
    "workspaceId": {
      "type": "string",
      "minLength": 1,
      "description": "Optional workspace ID or slug. Required when this credential can access multiple workspaces and no workspace was configured on the client."
    },
    "briefId": {
      "type": "string",
      "description": "Campaign brief id."
    },
    "requireIcpScoredRows": {
      "type": "boolean",
      "description": "Default true. When true, returns a reason instead of scoring unscored rows."
    }
  },
  "required": [
    "briefId"
  ]
}
See this operation inMCP REST API TypeScript SDK
CLI guide | Pipeline v2 preview