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

apiDeterministic

Accept coach action

POST /api/agents/coach/accept

Execute a Coach recommendation. Action is a discriminated union by type: pause_brief, archive_brief, refill_campaign, spawn_variant, increase_daily_cap, decrease_daily_cap, switch_framework, tighten_icp_filter. Each type carries its own required fields. Pair with get-coach-performance-reviews to inspect the evidence before accepting.

Parameters

workspaceId

string

Optional workspace ID or slug. Required when this credential can access multiple workspaces and no workspace was configured on the client.

recommendationTextrequired

string

The recommendation text from Coach (used for the audit trail).

proposalId

string

Optional proposal ID from the performance review. Forward it to close the proposal lifecycle atomically.

actionrequired

unknown

No description.

Example

REST requestbash

curl -X POST "https://app.pipeline.help/api/agents/coach/accept" \
  -H "Authorization: Bearer $PIPELINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"recommendationText":"example","action":{"type":"spawn_variant","sourceBriefId":"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.