sdkHosted AI, explicit consent

Run onboarding

pipeline.runOnboarding

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

TypeScripttypescript

await pipeline.runOnboarding({
  "websiteUrl": "https://example.com",
  "companyName": "example",
  "allowHostedAi": true
})

Response

The operation is available, but its typed response schema has not been published yet.

Exceptions

PipelineError: Thrown for validation, authentication, JSON-RPC, HTTP, and network failures. Inspect code and data when present.