Building a webhook integration? Read the webhook guide for signatures, retries, event schemas, and troubleshooting.

apiDeterministic

Run icp canary gate

POST /api/v1/icp-tuning/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.

Parameters

workspaceId

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.

requireIcpScoredRows

boolean

Default true. When true, returns a reason instead of scoring unscored rows.

Example

REST requestbash

curl -X POST "https://app.pipeline.help/api/v1/icp-tuning/canary-gate" \
  -H "Authorization: Bearer $PIPELINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"briefId":"00000000-0000-4000-8000-000000000000"}'

Response

The operation is available, but its typed response schema has not been published yet.

HTTP errors

401: Missing or invalid API key.
403: Authenticated but not permitted for the workspace or resource.
404: The requested resource was not found.