ICP / GTM / REST API

Run onboarding

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.

POST /api/onboarding/analyze-companyBackend AI, consent required

Parameters

workspaceIdOptional · 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: See the input schema for this field.
additionalContextOptional · string: Optional extra context to steer the analysis, max 2000 chars.
allowHostedAiOptional · boolean: Must be true when this operation uses Pipeline hosted inference.

Request example

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}'

Full input schema

Input schema

{
  "type": "object",
  "properties": {
    "workspaceId": {
      "type": "string",
      "minLength": 1,
      "description": "Optional workspace ID or slug. Required when this credential can access multiple workspaces and no workspace was configured on the client."
    },
    "websiteUrl": {
      "type": "string",
      "description": "Company website URL to analyze."
    },
    "companyName": {
      "type": "string"
    },
    "additionalContext": {
      "type": "string",
      "description": "Optional extra context to steer the analysis, max 2000 chars."
    },
    "allowHostedAi": {
      "type": "boolean",
      "description": "Must be true when this operation uses Pipeline hosted inference."
    }
  },
  "required": [
    "websiteUrl",
    "companyName"
  ]
}

See this operation inCLI MCP TypeScript SDK