Campaign Briefs / REST API

Get icp tuning sample

Start the ICP Prompt Builder QA loop for a campaign brief. Returns a representative sample of agent-pipeline table rows plus the current icpRubric so an operator or coding agent can mark fit, unfit, or skip before scaling the list. Read-only.

POST /api/v1/icp-tuning/sampleDeterministic 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.
sampleSizeOptional · number
Rows to sample, 1-25. Default 10.
Request example
curl -X POST "https://app.pipeline.help/api/v1/icp-tuning/sample" \
  -H "Authorization: Bearer $PIPELINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"briefId":"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."
    },
    "sampleSize": {
      "type": "number",
      "description": "Rows to sample, 1-25. Default 10."
    }
  },
  "required": [
    "briefId"
  ]
}
See this operation inCLI MCP TypeScript SDK
API reference | Pipeline v2 preview