Skip to main content
POST
Create a content research project.

Authorizations

X-API-Key
string
header
required

Company API key - scoped to a specific company. Generate from the Integrations page in your dashboard.

Body

application/json

Fields for the new research project

Fields for a new research project. Create one project per ICP or product line - each run analyses this project's domain, competitors and ICP in isolation.

companyId
string
required

Company ID that will own the project

domain
string
required

Domain to research, e.g. "yourcompany.com". Required.

competitorDomains
string[]

Competitor domains to compare against (max 5 are used per run)

frequency
enum<string>
default:manual

How often the project auto-runs. One of: manual, weekly, monthly. Defaults to "manual" (runs only when triggered).

Available options:
manual,
weekly,
monthly
idealCustomerProfileId
string

ICP to target. Determines the relevance score and brief angle; omit to have the pipeline infer the audience from company info.

name
string

Project name. Defaults to the domain if omitted.

seedKeywords
string[]

Seed keywords to expand from. If omitted the pipeline infers them.

Response

The created project

A single research project

project
object

The project

success
boolean

Whether the operation succeeded