Docs · methods

Projects

A project is the container everything else lives in: an anchor company, its competitors, and the feeds collected for them. Every other method takes a projectId from list_projects.

list_projects · prepare_create_project · create_project

01

List projects

list_projectsread

Every project in the connected organization, with the number of competitors each one tracks. Call this first: it maps the project name a user says to the id every other method needs.

Parameters2

  • limitintegerOptionalRows to return. Defaults to 20, clamped to 100.
  • cursorstringOptionalnextCursor from the previous page of this same method.

Returns4

  • orgNamestring | null
  • projects[]projectid, name, industry, description, competitorCount.
  • nextCursorstring | nullPass back as cursor to read the next page. Null when done.
  • hasMoreboolean
02

Draft a project from a company website

prepare_create_projectwrite

Fills create_project's arguments by reading one company website. Writes nothing. It scrapes and calls a model, so it takes seconds, not milliseconds. Placeholder addresses (example.com, localhost, ip addresses) come back as needs_input without being read.

Parameters2

  • urlstringRequiredThe company website the project should be about. The only argument the user has to supply.
  • hintstringOptionalAnything the user already said: a product to focus on, a market, a name.

Returns6

  • statusenumready: show the draft, then call create_project. needs_choice: the domain hosts several products, ask which. needs_input: ask for the fields in missingFields.
  • draftobject | nullcreate_project's arguments, filled from the site: name, industry, subIndustry, targetMarket, description, anchorName, anchorUrl.
  • missingFields[]stringRequired arguments still empty. Ask for these and nothing else.
  • saasProducts[]productSet on needs_choice: name, url, description per product found.
  • feedbackstring
  • sourceUrlstring
03

Create a project

create_projectwrite

Creates a project and its anchor company (your own company) in one call, then queues competitor research automatically. Do not add the anchor again with add_competitor. Best used with a draft the user confirmed from prepare_create_project.

Parameters9

  • namestringRequired
  • industrystringRequiredThe industry the product competes in.
  • subIndustrystring[]RequiredAt least one entry.
  • targetMarketstring[]RequiredAt least one entry, e.g. ["SMB", "Mid-market"].
  • descriptionstringRequiredWhat the product does. Drives the competitor-research prompt.
  • anchorNamestringRequiredYour own company name.
  • anchorUrlstringRequiredYour own company website. Placeholder domains are rejected.
  • trackingFrequencyenumOptionalbi-weekly, weekly, monthly or manual. Defaults to manual.
  • trackSeo / trackAds / trackSocial / trackWebsitebooleanOptionalWhich trackers run for this project.

Returns4

  • projectprojectid, name, industry, subIndustry, targetMarket, description, trackingFrequency.
  • anchorobject | nullid, name, url of the anchor company.
  • competitorResearchQueuedbooleanWhether automatic competitor discovery was dispatched.
  • anchorResearchQueuedbooleanWhether reviews, news and page discovery were queued for the anchor.
Competitors →