Search / TypeScript SDK

Source companies

Source companies from the best connected workspace account database. Pipeline resolves AI Ark, Apollo, Parallel Entity Search, Origami, Prospeo, Icypeas, Blitz, or another supported provider by capability. Set providerHint only when the operator explicitly requests a provider. Returns canonical companies plus provider provenance. Does not create a table or campaign.

pipeline.sourceCompaniesDeterministic operation

Parameters

workspaceIdOptional · string: Optional workspace ID or slug. Required when this credential can access multiple workspaces and no workspace was configured on the client.
filtersOptional · object: Structured, provider-independent Scout filters.
providerHintOptional · string: Optional connected-provider override. Omit for automatic capability-first resolution.ai_ark · apollo · prospeo · icypeas · blitz · fullenrich · crustdata · signalbase · wiza · parallel · origami · crunchbase_seeded
providerRequestIdOptional · string: Origami request ID from a prior pending response.
providerAnswersOptional · array: Answers to Origami pending questions.
dryRunOptional · boolean: Prepare and redact the initial provider request without fetching data or recording provider spend. Does not test vendor acceptance; later steps may depend on responses.
limitOptional · number: Maximum companies to return (1-200, default 25).

Request example

await pipeline.sourceCompanies({})

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."
    },
    "filters": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "prompt": {
          "type": "string"
        },
        "keywords": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "account_keywords": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "product_and_services": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Company product/service positioning. AI Ark supports this in people and company search."
        },
        "industries": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "technologies": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "employee_range": {
          "type": "array",
          "items": {
            "type": "number"
          },
          "minItems": 2,
          "maxItems": 2
        },
        "geo_countries": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "countries": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "account_domains": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "maxItems": 25,
          "description": "Exact company domains to include. Use this to hydrate companies returned by people search. Blitz hydration is capped at 25 companies per call."
        },
        "exclude_domains": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "funding_stages": {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "description": "Structured, provider-independent Scout filters."
    },
    "providerHint": {
      "type": "string",
      "enum": [
        "ai_ark",
        "apollo",
        "prospeo",
        "icypeas",
        "blitz",
        "fullenrich",
        "crustdata",
        "signalbase",
        "wiza",
        "parallel",
        "origami",
        "crunchbase_seeded"
      ],
      "description": "Optional connected-provider override. Omit for automatic capability-first resolution."
    },
    "providerRequestId": {
      "type": "string",
      "description": "Origami request ID from a prior pending response."
    },
    "providerAnswers": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Answers to Origami pending questions."
    },
    "dryRun": {
      "type": "boolean",
      "description": "Prepare and redact the initial provider request without fetching data or recording provider spend. Does not test vendor acceptance; later steps may depend on responses."
    },
    "limit": {
      "type": "number",
      "description": "Maximum companies to return (1-200, default 25)."
    }
  }
}

See this operation inCLI MCP REST API