cliDeterministic

Get onboarding readiness

pipeline get-onboarding-readiness

Inspect connected website-search, LinkedIn, lead-source, email-finder, and optional hosted-LLM capabilities. External-agent readiness never requires a workspace model key and returns exact connection hints for missing capabilities.

Parameters

workspaceId

string

Optional with API-key auth, inferred from the key.

campaignPackageId

string

Optional authoritative campaign brief/package ID. When supplied, returns canonical campaign readiness.

Example

CLI commandbash

pipeline get-onboarding-readiness

Response

Success response schemajson schema

{
  "type": "object",
  "properties": {
    "linkedin": {
      "type": "boolean"
    },
    "llm": {
      "type": "boolean"
    },
    "search": {
      "type": "boolean"
    },
    "b2bDatabase": {
      "type": "boolean"
    },
    "emailFinder": {
      "type": "boolean"
    },
    "researchReady": {
      "type": "boolean"
    },
    "outreachReady": {
      "type": "boolean"
    },
    "externalAgentResearchReady": {
      "type": "boolean"
    },
    "externalAgentOutreachReady": {
      "type": "boolean"
    },
    "missingExternalAgentCapabilities": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "connectionHints": {
      "type": "object"
    },
    "connectedServices": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "campaignReadiness": {
      "type": "object",
      "properties": {
        "ready": {
          "type": "boolean"
        },
        "campaignPackageId": {
          "type": "string"
        },
        "missing": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "nextActions": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "action": {
                "type": "string"
              },
              "reason": {
                "type": "string"
              }
            },
            "required": [
              "action",
              "reason"
            ]
          }
        }
      },
      "required": [
        "ready",
        "missing",
        "nextActions"
      ]
    }
  },
  "required": [
    "linkedin",
    "llm",
    "search",
    "b2bDatabase",
    "emailFinder",
    "researchReady",
    "outreachReady",
    "externalAgentResearchReady",
    "externalAgentOutreachReady",
    "missingExternalAgentCapabilities",
    "connectionHints",
    "connectedServices"
  ]
}

Exit codes

1: Invalid input or local configuration.
2: The API or tool returned an error.
3: Authentication failed.
4: A network request failed.