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

apiDeterministic

Save campaign brief

POST /api/v1/strategy/save-brief

Validate and persist a campaign brief authored by the caller. This deterministic write never invokes Pipeline hosted inference and always saves as a draft.

Parameters

workspaceId

string

Optional with API key auth, inferred from the key.

planrequired

object

No description.

ideaId

string

No description.

icpProfileId

string

No description.

idempotencyKey

string

Caller-stable key for retry-safe brief creation.

Example

REST requestbash

curl -X POST "https://app.pipeline.help/api/v1/strategy/save-brief" \
  -H "Authorization: Bearer $PIPELINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"plan":{}}'

Response

Success response schemajson schema

{
  "type": "object",
  "properties": {
    "brief": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "workspaceId": {
          "type": "string"
        },
        "status": {
          "type": "string"
        },
        "plan": {
          "type": "object"
        }
      },
      "required": [
        "id",
        "workspaceId",
        "status",
        "plan"
      ]
    },
    "validation": {
      "type": "object",
      "properties": {
        "valid": {
          "type": "boolean"
        },
        "errors": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "warnings": {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "required": [
        "valid",
        "errors",
        "warnings"
      ]
    }
  },
  "required": [
    "brief",
    "validation"
  ]
}

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.