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

apiHosted AI, explicit consent

Create campaign brief

POST /api/v1/strategy/brief

Expand a chosen idea into a full structured campaign brief (ICP rubric, targeting filters, required research signals, message decision tree, frameworks, cadence). For kind=campaign pass the ideaId from create-strategy-ideas. kind=content or engagement build single-shot from workspace context (no ideaId). The brief persists as draft; run activate-brief to launch it. Returns { agentRunId, brief, kind }.

Parameters

workspaceId

string

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

kind

string

Brief kind. Default campaign.

campaign | content | engagement

ideaId

string

Required when kind=campaign: the campaign idea to expand.

allowHostedAi

boolean

Must be true when this operation uses Pipeline hosted inference.

Example

REST requestbash

curl -X POST "https://app.pipeline.help/api/v1/strategy/brief" \
  -H "Authorization: Bearer $PIPELINE_API_KEY" \
  -H "X-Pipeline-Execution-Policy: hosted-enabled" \
  -H "Content-Type: application/json" \
  -d '{"allowHostedAi":true}'

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.