Create Stream
create_streamCreate a new research stream (external profile, company, topic, person interests, hiring signals, or ad watch). Running the stream on its schedule costs credits (see get_cost_estimate for the per-type cost). own_profile streams are not created here — they come from subscription checkout.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | User-facing label for this stream | |
| type | Yes | Stream type | |
| params | No | Type-specific config: topic uses {query, authorsIndustryId?, contentType?, postedLimit?, sortBy?}; hiring_signals/ad_watch use {company?, keywords?, ...} | |
| schedule | No | Run schedule. Defaults to 'weekly'. 'monthly' runs every 30 days — the cheapest recurring cadence, and the usual choice for client profiles reported on monthly. | |
| source_url | No | LinkedIn URL for external_profile / company / person_interests streams | |
| history_days | No | How far back the first run should reach, in days. Bounds the walk by TIME where initial_max_pages bounds it by COST — the run stops at whichever limit it hits first, so pair a window with enough pages to reach it. Honoured for external_profile, company and person_interests; the search types ignore it. Applies to this pull alone and is never saved on the stream, so scheduled runs keep topping up from where the last one stopped rather than re-fetching the window. | |
| initial_max_pages | No | Opt-in deep first-run for external_profile, company and person_interests streams (1-5, default 1). A budget, not a price — you are billed for pages actually walked. A page is ~50 posts for profile/company feeds and ~100 engagement events for person_interests. Other stream types ignore this. Later scheduled runs pull one page in the steady state; a person_interests stream may walk further to close a gap after a missed tick, and is billed only for what it walks. |