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

apiHosted AI, explicit consent

Run onboarding

POST /api/onboarding/analyze-company

Analyze a company website (server-side Tavily + Anthropic research, ICP-onboarding path only) to bootstrap GTM setup: service description, ICP summary, target titles/industries, primary/secondary personas, case study summaries, and a default offer/lead magnet suggestion. Read-only, does not persist. Use set-icp-profile to save the resulting ICP criteria.

Parameters

workspaceId

string

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

websiteUrlrequired

string

Company website URL to analyze.

companyNamerequired

string

No description.

additionalContext

string

Optional extra context to steer the analysis, max 2000 chars.

allowHostedAi

boolean

Must be true when this operation uses Pipeline hosted inference.

Example

REST requestbash

curl -X POST "https://app.pipeline.help/api/onboarding/analyze-company" \
  -H "Authorization: Bearer $PIPELINE_API_KEY" \
  -H "X-Pipeline-Execution-Policy: hosted-enabled" \
  -H "Content-Type: application/json" \
  -d '{"websiteUrl":"https://example.com","companyName":"example","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.